Wiki source code of Queue browser
Last modified by Erik Bakker on 2024/02/21 21:57
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}}{{container layoutStyle="columns"}}((( | ||
| 2 | |||
| 3 | In this microlearning, we will focus on the queue browser functionality. This new feature within our 3rd generation runtime allows you to view data flowing through your system. On top of that, it enables you to wiretap information for analysis purposes and even delete messages that should not be in a specific queue. | ||
| 4 | |||
| 5 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 6 | |||
| 7 | == 1. Prerequisites == | ||
| 8 | |||
| 9 | * Basic knowledge of the eMagiz platform | ||
| 10 | * Understanding of the flow testing functionality | ||
| 11 | |||
| 12 | == 2. Key concepts == | ||
| 13 | |||
| 14 | This microlearning centers around the queue browser. | ||
| 15 | |||
| 16 | * The queue browser can be used to view data on the queue | ||
| 17 | * The queue browser can be used to wiretap a queue to see all future messages (in the next five minutes) | ||
| 18 | * Message payloads above 100KB are not shown | ||
| 19 | * The queue browser allows you to delete one (or all) message(s) from the queue | ||
| 20 | |||
| 21 | == 3. Queue browser == | ||
| 22 | |||
| 23 | To enhance the observability of your integration landscape while running in the 3rd generation runtime architecture, we have added a new feature to our Manage phase called the "Queue browser." You can access this functionality via the "Explore" menu in Manage. Then, with the help of the queue browser, you can browse your queue as the name suggests. | ||
| 24 | |||
| 25 | To do so, we offer two options within this functionality. First, we have the Explore function, and we have the Wiretap function. When selecting a queue and opting for the Explore option, you get a live view of the current data in the queue. Then, when choosing the Wiretap functionality, you automatically wiretap your queue and are presented with copies (on a particular queue) of your actual message that passes through the queue from the moment you press the Wiretap button. | ||
| 26 | |||
| 27 | [[image:Main.Images.Release Blog.WebHome@190-release-blog--queue-browser-overview.png]] | ||
| 28 | |||
| 29 | After selecting the queue and choosing the option, eMagiz will show you the list of messages (oldest first) that are currently on the queue (Explore option) or that have passed the queue since the moment you activate the option (Wiretap option). For each message, you have various options at your disposal. | ||
| 30 | |||
| 31 | * Delete the message from the queue (Explore option) | ||
| 32 | ** This means throwing away live data, which can be helpful in a test or acceptance environment where you inadvertently put many messages on a queue. | ||
| 33 | * Clear message from the wiretap queue (Wiretap option) | ||
| 34 | ** Once you are done with the analysis of a specific message in the wiretap functionality, you can clear it from the overview, so it does not clutter the view anymore | ||
| 35 | * Refresh messages list (both options) | ||
| 36 | ** By pressing this button, you can refresh the list of messages displayed to you. Note that the list is sorted in such a way that the oldest messages are shown first | ||
| 37 | * Save as test message | ||
| 38 | ** By pressing this button, you can save the message and use it in our flow testing functionality in Create. Note that we link the message to the corresponding flow if we can. Should we not be able to do so, we link the message to your model so you can still use it in the flow testing functionality. | ||
| 39 | * Download | ||
| 40 | ** By pressing this button, you can download the message and use it outside of the tooling should that be needed. | ||
| 41 | |||
| 42 | [[image:Main.Images.Release Blog.WebHome@190-release-blog--queue-browser-explore-overview.png]] | ||
| 43 | |||
| 44 | [[image:Main.Images.Release Blog.WebHome@190-release-blog--queue-browser-wiretap-overview.png]] | ||
| 45 | |||
| 46 | {{info}} | ||
| 47 | The following restrictions apply to this functionality: | ||
| 48 | * Message payloads above 100KB are not shown in the queue browser as they constitute a "large message." | ||
| 49 | * The wiretap functionality works for five minutes, during which you can use the refresh button to see new messages coming in. | ||
| 50 | ** After five minutes, the wiretap functionality will be shut down automatically underwater. | ||
| 51 | ** To see new messages after five minutes, you must access the wiretap functionality from scratch. | ||
| 52 | {{/info}} | ||
| 53 | |||
| 54 | == 4. Key takeaways == | ||
| 55 | |||
| 56 | * The queue browser can be used to view data on the queue | ||
| 57 | * The queue browser can be used to wiretap a queue to see all future messages (in the next five minutes) | ||
| 58 | * Message payloads in excess of 100KB are not shown | ||
| 59 | * The queue browser allows you to delete one (or all) message(s) from the queue | ||
| 60 | |||
| 61 | == 5. Suggested Additional Readings == | ||
| 62 | |||
| 63 | If you are interested in this topic and want more information, please read the help texts in eMagiz. | ||
| 64 | |||
| 65 | |||
| 66 | )))((({{toc/}}))){{/container}}{{/container}} |