Purpose
Reports queue-related monitoring data.
URI
Use the Eclipse Amlen REST API GET method with the
following Eclipse Amlen monitoring URI:
http://<admin-endpoint-IP:Port>/ima/v1/monitor/Queue
Object configuration data
Provide query parameters requesting the
statistics that you want returned in the JSON payload. The following example uses cURL to create
queue-related statistics:
curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Queue?Name=Name%26StatType=StatType%26ResultCount=ResultCount
where:
- Name
- Specifies the name of a queue to collect data about.
- You can use an asterisk (*) to match 0 or more characters.
- The default value is *
- ResultCount
- Specifies the maximum number of results to return
- This value can be one of the following values: 10, 25, 50, 100.
- The default value is 25.
- StatType
- Specifies the type of data to order the results by.
- This value can be one of the following values:
-
- BufferedMsgsHighest
- Orders the monitoring data by starting with the queues with the highest backlog of
messages.
- This value is the default value.
-
- BufferedMsgsLowest
- Orders the monitoring data by starting with queues with the lowest backlog of
messages.
-
- BufferedPercentageHighest
- Orders the monitoring data by starting with queues with the highest relative number of
messages that are buffered, as a percentage of the total number of messages that can be
buffered.
-
- BufferedPercentageLowest
- Orders the monitoring data by starting with queues with the lowest relative number of
messages that are buffered, as a percentage of the total number of messages that can be
buffered.
-
- BufferedHWMPercentHighest
- Queues with the highest peaks of buffered messages as a percentage of the total number
of messages that can be buffered.
-
- BufferedHWMPercentLowest
- Queues with the lowest peaks of buffered messages as a percentage of the total number
of messages that can be buffered.
-
- ProducedMsgsHighest
- Orders the monitoring data by starting with queues that have the highest number of
messages produced.
-
- ProducedMsgsLowest
- Orders the monitoring data by starting with queues that have the lowest number of
messages produced.
-
- ConsumedMsgsHighest
- Orders the monitoring data by starting with queues with the greatest number of
messages consumed.
-
- ConsumedMsgsLowest
- Orders the monitoring data by starting with queues with the least number of messages
consumed.
-
- ConsumersHighest
- Orders the monitoring data by starting with queues with the highest number of
consumers.
-
- ConsumersLowest
- Orders the monitoring data by starting with queues with the lowest number of
consumers.
-
- ProducersHighest
- Orders the monitoring data by starting with queues with the highest number of
producers.
-
- ProducersLowest
- Orders the monitoring data by starting with queues with the lowest number of
producers.
-
- ExpiredMsgsHighest
- Orders the monitoring data by starting with queues with the highest number of expired
messages.
-
- ExpiredMsgsLowest
- Orders the monitoring data by starting with queues with the lowest number of expired
messages.
Usage Notes®
- The command must be capitalized as shown.
- The command must use the double quotation marks as shown.
- The statistics that are produced can be up to 60 seconds out of date.
The following fields are returned:
-
- Name
- String
- The name of the queue.
-
- Producers
- Numeric
- The number of active producers on the queue.
-
- Consumers
- Numeric
- The number of active consumers on the queue.
-
- BufferedMsgs
- Numeric
- The number of messages that are buffered on the queue and waiting to be consumed.
-
- BufferedMsgsHWM
- Numeric
- The highest number of messages that are buffered on the queue since the server was
started or the queue was created, whichever is most recent.
-
- BufferedHWMPercent
- Numeric
- The peak number of buffered messages, as a percentage of the maximum number of
messages that can be buffered.
-
- BufferedPercent
- Numeric
- The number of buffered messages as a percentage of the maximum number of buffered
messages.
-
- MaxMessages
- Numeric
- The maximum number of buffered messages that are allowed on the queue. This value is a
guideline, rather than an absolute limit. If the system is running under stress, then the
number of buffered messages on a queue might be slightly higher than the
MaxMessages value.
-
- ProducedMsgs
- Numeric
- The number of messages that are sent to the queue since the server was started or the
queue was created, whichever is most recent.
-
- ConsumedMsgs
- Numeric
- The number of messages consumed from the queue since the server was started or the
queue was created, whichever is most recent.
-
- RejectedMsgs
- Numeric
- The number of messages that are not sent to the queue because the maximum number of
buffered messages is reached.
-
- ExpiredMsgs
- Numeric
- The number of messages that expired on the queue since the server was started or the
queue was created, whichever is most recent.
Example
The following example uses cURL to show how a GET method is used to create statistics about
queues with the highest backlog of messages:
curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Queue?Name=*%26StatType=BufferedMsgsHighest%26ResultCount=10
The following example shows a successful example response to the GET method that was used to
create statistics about queues with the highest backlog of messages:
{ "Version":"v1", "Queue": [ { "Name":"MyQueue","Producers":5,"Consumers":2,"BufferedMsgs":50,"BufferedMsgsHWM":40,"BufferedHWMPercent":25,
"BufferedPercent":14,"MaxMessages":134,"ProducedMsgs":14670,"ConsumedMsgs":10145,"RejectedMsgs":100,"ExpiredMsgs":10 }
] }