Snooping on Queues

Edit online

About this task

When you select a queue on the Universal-Messaging-instanceName > Administration > Queues page in Command Central, you can perform the following operations:

  • Start snooping on events on the queue.
  • Stop snooping on events on the queue.
  • View details about a snooped event.
  • Purge all events from the queue.

Considerations When Snooping on Queues

Edit online

Consider the following information when you want to snoop on events on a queue:

  • Snooping on events on a queue is performed per user. Only the user who started snooping can stop it. However, Command Central allows more than one person to log in as Administrator at the same time, which might result in simultaneous attempts to perform various snooping operations on the same queue.
  • When snooping is inactive for five minutes, for example, because the user logged off or navigated away from the queue details page, the snoop stops automatically.
  • If the Universal Messaging server becomes unavailable after the snoop on the queue started, Command Central stops snooping on all queues on that Universal Messaging server for all Command Central users. If you try to start snooping while the Universal Messaging server is still unavailable, Command Central returns an error.

Starting the Queue Snoop

Edit online

About this task

To start snooping on events on a queue

Procedure

  1. In Command Central, go to Environments > Instances > All > Universal-Messaging-instanceName > Administration > Queues.
  2. Select the queue on which you want to start snooping on events, and then click the Snoop tab.
  3. Do one of the following:
    • To snoop on all events published on the queue, click Start.
    • To snoop on a range of events, in the From Event ID field specify the ID of the first event in the range, and in the To Event ID field, specify the ID of the last event in the range. Click Start. You can also specify additional filtering criteria based on the properties of the event.
      Note: If you do not specify a value in the From Event ID field, the range of events starts with the first event on the queue and ends with the event specified in the To Event ID field. If you do not specify a value in the To Event ID field, the range of events starts with the event specified in the From Event ID field and ends with the last event on the queue.

Results

Command Central populates the snooped events table with the events published on the queue.

Stopping the Queue Snoop

Edit online

About this task

To stop snooping on events on a queue

Procedure

  1. In Command Central, go to Environments > Instances > All > Universal-Messaging-instanceName > Administration > Queues.
  2. Select the queue on which you want to stop snooping.
  3. Click the Snoop tab, and then click Stop.

Viewing Queue Event Details

Edit online

About this task

After you start snooping on a queue in the Command Central web user interface, the snooped events table on the queue details page displays information about each event including the event ID, tag, time to live (TTL), and data, as well as whether the event is persistent.

When you select an event in the table, you can view additional details about the event including the type of event (persistent or Protobuf event), a hexadecimal view of the event data, an ASCII representation of the event data, the header and properties of the event, and the Protobuf descriptor for Protobuf events.

If the event is a Protobuf event and its Protobuf descriptor matches the name of a Protobuf file descriptor that has already been uploaded on the queue, the ASCII representation of the event is the decoded Protobuf content in JSON format.

Purging Snooped Events from a Queue

Edit online

About this task

After you start snooping on a queue, you can purge all snooped events from the queue.

For information about how to start snooping, see Starting the Queue Snoop.

To purge events

Procedure

  1. In Command Central, go to Environments > Instances > All > Universal-Messaging-instanceName > Administration > Queues.
  2. Select the queue on which you want to purge snooped events, and then click the Snoop tab.
  3. (Optional) To purge a single event directly from the snooped events table, click .
  4. Click Purge Events and on the Purge Events page, do one of the following:
    • To purge all events, click Purge.
    • To purge a range of events, in the From Event ID field specify the ID of the first event in the range, and in the To Event ID field, specify the ID of the last event in the range. Then click Purge.
      Note: If you do not specify a value in the From Event ID field, the range of events to purge starts with the first event on the queue and ends with the event specified in the To Event ID field. If you do not specify a value in the To Event ID field, the range of events to purge starts with the event specified in the From Event ID field and ends with the last event on the queue.