queues (instance statistics)
The queues resource lists available information regarding the queues defined for this instance.
| Metric | Description | Type |
|---|---|---|
age_of_oldest_lease | The age of the oldest current lease, in seconds. | snapshot |
backlog | The number of leased messages awaiting acknowledgment. | snapshot |
deferred_ack_count | The number of acknowledgments received for messages that have not yet become active in the queue. | snapshot |
expired_leases | The number of leases that have expired for this queue. This counter resets when the instance is restarted. | cumulative |
inactive_message_count | The number of messages for this queue that are present in the transaction log, but have not yet become active because they are beyond current active limit of the queue (as set by TargetQueueDepth, when that option is present). | snapshot |
max_backlog | The configured MaxBacklog for the queue. | fixed |
target_queue_depth | The configured TargetQueueDepth for the queue. | fixed |
message_type | The message type for the queue. | fixed |
queue_depth | Total number of unacknowledged messages currently active in the queue. For queues that do not set a For queues that set a Messages that are present, but not yet active are shown in the | snapshot |
seconds_behind | Age of the oldest unacknowledged message in the queue. This counter resets when the instance is restarted. This statistic is measured in seconds, at the resolution of the system clock. | snapshot |
owned | Number of messages currently owned by this instance of the queue. | snapshot |
proxied_transfer | State of the proxied transfer setting. | fixed |
topic | Name of the queue topic. | fixed |
transferred_in | The number of messages originally published to another instance that have been transferred to this instance for delivery from this queue. | cumulative |
transferred_out | The number of messages originally published to this instance that have been transferred to another instance for delivery from the replicated instance of this queue. | cumulative |
Statistics Database Tables: IQUEUES_STATIC, IQUEUES_DYNAMIC
Admin Path: /amps/instance/queues/<identifier>/<metric>
The queues resource also contains the following resource that produces information on the current live state of the queue. This information is produced directly from the internal state of AMPS, and is not recorded in the statistics database.
| Metric | Description | Type |
|---|---|---|
details | Detailed information about the state of the queue. This information is produced in JSON format, and includes detailed internal metrics for the queue as well as the current depth of the queue and information about the individual messages at the head of the queue (up to the first 1000 messages). This information is produced on demand from the current state, and is not produced from the statistics database. | live state |
The details element returns a document in JSON format that contains the following information:
| Metric | Description | Type |
|---|---|---|
internal_depth | The current amount of space the queue has reserved for metadata entries. If the queue has grown and then messages have been acknowledged, this can be larger than the current number of messages in the queue. | live state |
insert_count | The number of messages inserted into the queue. This is the metric that will be recorded in the SOW metrics for the queue topic. | live state |
delete_count | The number of messages removed from the queue due to being acknowledged or having expired. This is the metric that will be recorded in the SOW metrics for the queue topic. | live state |
depth | Current number of unacknowledged messages in the queue. This is the metric that will be recorded in the SOW metrics for the queue topic. | live state |
last_queued_txid | The local transaction ID of the last transaction processed for the queue. | live state |
last_acked_txid | The local transaction ID of the last acknowledged point in the queue. | live state |
priority_count | The number of distinct priority values for the queue. (This will be 0 if the queue does not have a priority expression configured.) | live state |
seconds_behind | The point in the transaction log of the oldest message in the queue, in seconds, as measured by the time between the time the message was added to the local transaction log and the current time. | live state |
age_of_oldest_lease | The amount of time, in seconds, that the oldest current lease has been held by a client. | live state |
backlog | Number of messages currently leased from the queue. | live state |
expired_leases | Number of leases that have expired from this queue. | cumulative live state |
locally_owned | Number of messages owned by this instance. | live state |
transferred_in | Number of messages that have had ownership transferred to this instance. | cumulative live state |
cursors | Details of delivery cursors for this queue. | live state |
messages | Details for messages currently in this queue. | live state |
The cursors element of the queue details contains the following information:
| Metric | Description | Type |
|---|---|---|
cursor_id | The internal ID of the cursor. | live state |
state | Current state of the cursor. | live state |
last_processed_txid | Last local transaction ID processed by this cursor. | live state |
last_delivered_txid | Last local transaction ID delivered to a subscription from this cursor. | live state |
last_result | Last result recorded by the cursor when evaluating a message for delivery to a subscriber. | live state |
processing_count | Count of delivery evaluations by this cursor. | live state |
cursor_subscriptions | Details for the subscriptions serviced by this cursor, including the client name, filter in use by the client, current and maximum backlog for the subscription, and so on. | live state |
The messages element of the queue details contains the following information:
| Metric | Description | Type |
|---|---|---|
txid | The local transaction ID of the message. | live state |
bookmark | The bookmark of the message. | live state |
journal | The path to the journal file that contains the message. | live state |
deliverable | Flag indicating whether the message is currently deliverable (1 is true, 0 is false). A message may not be deliverable if this instance does not currently own the message, or if it is already leased to a subscriber. | live state |
age | The age of the message, as measured by the time between the time the message was added to the local transaction log and the current time. | live state |
locally_owned | Flag indicating whether the message is currently owned by this instance (1 is true, 0 is false). | live state |
priority | Priority value of this message. | live state |
leased_to | If the message is currently leased, the client name of the connection the message is leased to. This field is not present if the message is not currently leased. | live state |
leased_age | If the message is currently leased, the amount of time, in seconds, the message has been leased. This field is not present if the message is not currently leased. | live state |
Admin Path: /amps/instance/queues/<identifier>/details