rabbitmq agent reference - ibm · v the historical tr end of memory usage of the node in the...

46
Monitoring Agent for RabbitMQ Version 08.19.03.00 Reference IBM

Upload: others

Post on 24-May-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Monitoring Agent for RabbitMQVersion 08.19.03.00

Reference

IBM

Page 2: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical
Page 3: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Monitoring Agent for RabbitMQVersion 08.19.03.00

Reference

IBM

Page 4: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

NoteBefore using this information and the product it supports, read the information in “Notices” on page 33.

This edition applies to version 08.19.03.00 of the Monitoring Agent for RabbitMQ and to all subsequent releases andmodifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2017, 2019.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 5: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Contents

Chapter 1. Monitoring Agent forRabbitMQ . . . . . . . . . . . . . . 1

Chapter 2. Dashboards . . . . . . . . 3Default dashboards . . . . . . . . . . . . 3Widgets for the Default dashboards. . . . . . . 4Custom views . . . . . . . . . . . . . 11

Chapter 3. Thresholds . . . . . . . . 13Predefined thresholds . . . . . . . . . . . 13Customized thresholds . . . . . . . . . . 14

Chapter 4. Attributes . . . . . . . . . 15Data sets for the monitoring agent. . . . . . . 16Attribute descriptions . . . . . . . . . . . 16

Channel Details data set . . . . . . . . . 16

Cluster Config Info data set . . . . . . . . 18Node Information data set . . . . . . . . 19Performance Object Status data set . . . . . 21Queue Details data set. . . . . . . . . . 24RabbitMQ Cluster Status data set . . . . . . 26Thread Pool Status data set . . . . . . . . 27

Accessibility features . . . . . . . . 31

Notices . . . . . . . . . . . . . . 33Trademarks . . . . . . . . . . . . . . 35Terms and conditions for product documentation. . 35IBM Online Privacy Statement . . . . . . . . 36

Index . . . . . . . . . . . . . . . 37

© Copyright IBM Corp. 2017, 2019 iii

Page 6: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

iv RabbitMQ Agent Reference

Page 7: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Chapter 1. Monitoring Agent for RabbitMQ

The Monitoring Agent for RabbitMQ offers a central point of management for your RabbitMQenvironment or application.

The software provides a comprehensive means for gathering the information that is required to detectproblems early and to prevent them. Information is standardized across the system. You can monitormultiple servers from a single console. By using the RabbitMQ Agent you can easily collect and analyzeRabbitMQ specific information.

Installing and configuring the agent

Install the monitoring agent on the system where the application that you want to monitor is located.

For more information, see the following documentation in IBM Knowledge Center:v IBM Cloud Application Performance Managementv IBM Cloud Application Performance Management, Private

© Copyright IBM Corp. 2017, 2019 1

Page 8: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

2 RabbitMQ Agent Reference

Page 9: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Chapter 2. Dashboards

Open the Application Performance Dashboard in the Cloud APM console to see a status summary of allyour applications. As you drill down to dashboards for specific applications and their supportingelements, more details are available about the selected item.

Use the RabbitMQ Agent dashboards to proactively monitor your RabbitMQ deployment. Eachdashboard page contains views with key performance indicators.

When an application that includes RabbitMQ managed resources is selected, the navigator and the StatusOverview tab show RabbitMQ in the Components group:v Click Components to see a single RabbitMQ group widget that is displayed along with a group widget

for every other data source type in the application.v Click the RabbitMQ subgroup to see a group widget for each managed resource in the application.v Click inside a RabbitMQ group widget or click a RabbitMQ managed resource from the navigator

Instances section to open a dashboard with KPIs from the selected managed resource.

For more information about the KPIs, click

in the view or click

in the dashboard banner.

Default dashboardsChannel Details

Use the Channel Details page to know the following details:v The details of the channelv The details about the messages of the channelv The historical trend of the number of unacknowledged messages, uncommitted messages,

unconfirmed messages, and uncommitted acknowledgements

Node DetailsUse the Node Details page to know the following details:v The details of all the channels in the nodev The details of all the queues in the nodev The historical trend of memory usage of the node in the clusterv The historical trend of Erlang processes usage by the nodev The historical trend of socket descriptors usage by the nodev The historical trend of the amount of free disk space for the node

Queue DetailsUse the Queue Details page to know the following details:v The details of the queuev The details of the queue messagesv The historical trend of the rate at which the queue messages are delivered and publishedv The historical trend of the rate at which the queue messages are returnedv The historical trend of the rate at which the messages are getting ready to be delivered in the

queue.

RabbitMQThe RabbitMQ page provides an overall status of the RabbitMQ cluster instance that is beingmonitored by the agent instance. Click anywhere on the group widget to drill down to open the

© Copyright IBM Corp. 2017, 2019 3

Page 10: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

detail dashboard. Review the resource usage and investigate any warning or critical thresholds. Ifthe Events tab shows a warning or critical status indicator, open the tab to see the open eventsand status for the application.

RabbitMQ DashboardUse the RabbitMQ Dashboard page to know the following details:v The status of all the nodes in the serverv The status of top twenty queues based on their statusv The status of top twenty channels based on their status

Widgets for the Default dashboardsChannel Details

Use the Channel Details page to know the following details:v The details of the channelv The details about the messages of the channelv The historical trend of the number of unacknowledged messages, uncommitted messages,

unconfirmed messages, and uncommitted acknowledgements

The following widgets are available in this dashboard:

Channel DetailsThe Channel Details group widget provides a table that contains information about thechannel, such as the status of the channel, name of the node, and the name of the virtualhost in which the channel is operating.

The following KPIs for the widget are derived from the attributes as described:v Node: The name of the node. This data is derived from the NodeName attribute in the

KZR CHANNEL DETAILS data set.v State: The state of the channel, such as running or down. This data is derived from the

State attribute in the KZR CHANNEL DETAILS data set.v Vhost: The name of the virtual host in which the channel is operating. This data is

derived from the Vhost attribute in the KZR CHANNEL DETAILS data set.

Message DetailsThe Message Details group widget provides a table that contains information about themessages of the channel, such as number of unacknowledged messages and unconfirmedmessages and number of uncommitted acknowledgements.

The following KPIs for the widget are derived from the attributes as described:v Unacknowledged Messages: The number of messages in the channel for which the

node has not received an acknowledgement. This data is derived from theMsgsUnacknowledged attribute in the KZR CHANNEL DETAILS data set.

v Uncommitted Acknowledgements: The number of acknowledgements that are receivedby the node for transactions that are not yet committed. This data is derived from theAcksUncommited attribute in the KZR CHANNEL DETAILS data set.

v Uncommitted Messages: The number of messages that are received by the consumerfor transactions that are not yet committed. This data is derived from theMsgsUncommited attribute in the KZR CHANNEL DETAILS data set.

v Unconfirmed Messages: The number of messages in the channel that are not confirmed.This data is derived from the MsgsUnconfirmed attribute in the KZR CHANNELDETAILS data set.

Message Traffic (history)The Message Traffic (history) group widget provides a line chart that contains

4 RabbitMQ Agent Reference

Page 11: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

information about unacknowledged messages, uncommitted messages, unconfirmedmessages, and uncommitted acknowledgements.

The following KPIs for the widget are derived from the attributes as described:v Time: The local time at the agent when the data was collected. This data is derived

from the Timestamp attribute in the KZR CHANNEL DETAILS data set.v Unacknowledged Messages: The number of messages in the channel for which the

node has not received an acknowledgement. This data is derived from theMsgsUnacknowledged attribute in the KZR CHANNEL DETAILS data set.

v Uncommitted Acknowledgements: The number of acknowledgements that are receivedby the node for transactions that are not yet committed. This data is derived from theAcksUncommited attribute in the KZR CHANNEL DETAILS data set.

v Uncommitted Messages: The number of messages that are received by the consumerfor transactions that are not yet committed. This data is derived from theMsgsUncommited attribute in the KZR CHANNEL DETAILS data set.

v Unconfirmed Messages: The number of messages in the channel that are not confirmed.This data is derived from the MsgsUnconfirmed attribute in the KZR CHANNELDETAILS data set.

Node DetailsUse the Node Details page to know the following details:v The details of all the channels in the nodev The details of all the queues in the nodev The historical trend of memory usage of the node in the clusterv The historical trend of Erlang processes usage by the nodev The historical trend of socket descriptors usage by the nodev The historical trend of the amount of free disk space for the node

The following widgets are available in this dashboard:

Channels On NodeThe Channels On Node group widget provides a table that contains information aboutthe channels in the node, such as status of channels and the number of messages in thechannels that are waiting for an acknowledgement.

The following KPIs for the widget are derived from the attributes as described:v Channel: The name of the channel. This data is derived from the ChannelName

attribute in the KZR CHANNEL DETAILS data set.v Consumer Count: The number of consumers that are attached to the channel. This data

is derived from the ConsumerCount attribute in the KZR CHANNEL DETAILS dataset.

v Status: Channel status according to state, count of unacknowledged messages.v Unacknowledged Messages: The number of messages in the channel for which the

node has not received an acknowledgement. This data is derived from theMsgsUnacknowledged attribute in the KZR CHANNEL DETAILS data set.

Disk Space Free (history)The Disk Space Free (history) group widget provides a line chart that containsinformation about the amount of free disk space in the node.

The following KPIs for the widget are derived from the attributes as described:v Available Disk Memory: The disk memory (in GB) that is available in the node of the

cluster. This data is derived from the DiskFree attribute in the KZR NODEINFORMATION data set.

Chapter 2. Dashboards 5

Page 12: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

v Disk Memory Threshold: The threshold value for disk memory that is available in thenode of the cluster. This data is derived from the DiskLimit attribute in the KZR NODEINFORMATION data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR NODE INFORMATION data set.

Erlang Processes Used (history)The Erlang Processes Used (history) group widget provides a line chart that containsinformation about the usage of Erlang processes by the node.

The following KPIs for the widget are derived from the attributes as described:v Erlang Processes Usage Threshold: The threshold value for the number of Erlang

processes that are being used by the node. This data is derived from theErlangProcessTotal attribute in the KZR NODE INFORMATION data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR NODE INFORMATION data set.

v Used Erlang Processes: The number of Erlang processes that are being used by thenode. This data is derived from the ErlangProcessUsed attribute in the KZR NODEINFORMATION data set.

Memory Used (history)The Memory Used (history) group widget provides a line chart that contains informationabout the memory usage of the cluster node.

The following KPIs for the widget are derived from the attributes as described:v Memory In Use: The memory (in MB) that is being used by RabbitMQ. This data is

derived from the MemoryUsed attribute in the KZR NODE INFORMATION data set.v Memory Usage Threshold: The threshold limit for usage of memory. This data is

derived from the MemoryLimit attribute in the KZR NODE INFORMATION data set.v Time: The local time at the agent when the data was collected. This data is derived

from the Timestamp attribute in the KZR NODE INFORMATION data set.

Queues On NodeThe Queues On Node group widget provides a table that contains information about thequeues in the node, such as status of the queue, the number of messages returned to thenode, and the number of messages that are ready to be delivered.

The following KPIs for the widget are derived from the attributes as described:v Consumer Count: The number of consumers that are attached to the queue. This data

is derived from the ConsumerCount attribute in the KZR QUEUE DETAILS data set.v Queue: The name of the queue. This data is derived from the QueueName attribute in

the KZR QUEUE DETAILS data set.v Ready Messages: The number of messages that are ready to be delivered to the

consumer. This data is derived from the MessagesReady attribute in the KZR QUEUEDETAILS data set.

v Returned Messages: The number of messages that have been returned to the nodebecause they failed to deliver. This data is derived from the ReturnUnroutable attributein the KZR QUEUE DETAILS data set.

v Status: Queue status according to state, count of ready and returned messages.

Server DetailsThe Server Details group widget provides a table that displays the Hostname, RabbitMQversion and Erlang version for monitored RabbitMQ node.

The following KPIs for the widget are derived from the attributes as described:

6 RabbitMQ Agent Reference

Page 13: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

v Erlang Version: The version of Erlang that is used to run the Rabbit MQ server. Thisdata is derived from the ErlangVersion attribute in the KZR CLUSTER CONFIG INFOdata set.

v Host Name: The IP address of the cluster. This data is derived from the HostNameattribute in the KZR CLUSTER CONFIG INFO data set.

v RabbitMQ Version: The version of RabbitMQ server. This data is derived from theRabbitMQVersion attribute in the KZR CLUSTER CONFIG INFO data set.

Socket Descriptors Used (history)The Socket Descriptors Used (history) group widget provides a line chart that containsinformation about the usage of socket descriptors by the node.

The following KPIs for the widget are derived from the attributes as described:v Socket Descriptors Usage Threshold: The threshold value for the number of socket

descriptors that are being used by the node. This data is derived from the SocketLimitattribute in the KZR NODE INFORMATION data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR NODE INFORMATION data set.

v Used Socket Descriptors: The number of Socket descriptors that are being used by thenode. This data is derived from the SocketUsed attribute in the KZR NODEINFORMATION data set.

Queue DetailsUse the Queue Details page to know the following details:v The details of the queuev The details of the queue messagesv The historical trend of the rate at which the queue messages are delivered and publishedv The historical trend of the rate at which the queue messages are returnedv The historical trend of the rate at which the messages are getting ready to be delivered in the

queue.

The following widgets are available in this dashboard:

Message DetailsThe Message Details group widget provides a table that contains information about thestatus of messages in the queue, such as number of messages that are returned to thenode, the number of messages that are ready to be delivered to the customer, the numberof messages that are delivered, and the number of messages that are published.

The following KPIs for the widget are derived from the attributes as described:v Delivered Messages: The number of messages that have been delivered to the

consumer in each data collection interval. This data is derived from the DeliveredDeltaattribute in the KZR QUEUE DETAILS data set.

v Published Messages: The number of messages that have been published in each datacollection interval. This data is derived from the PublishedDelta attribute in the KZRQUEUE DETAILS data set.

v Ready Messages: The number of messages that are ready to be delivered to theconsumer. This data is derived from the MessagesReady attribute in the KZR QUEUEDETAILS data set.

v Returned Messages: The number of messages that have been returned to the nodebecause they failed to deliver. This data is derived from the ReturnUnroutable attributein the KZR QUEUE DETAILS data set.

Message Traffic (history)The Message Traffic (history) group widget provides a line chart that contains

Chapter 2. Dashboards 7

Page 14: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

information about the historical trend of number of messages of the queue that aredelivered and published in last collection interval.

The following KPIs for the widget are derived from the attributes as described:v Delivered Messages : The number of messages that have been delivered to the

consumer in each data collection interval. This data is derived from the DeliveredDeltaattribute in the KZR QUEUE DETAILS data set.

v Published Messages : The number of messages that have been published in each datacollection interval. This data is derived from the PublishedDelta attribute in the KZRQUEUE DETAILS data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR QUEUE DETAILS data set.

Queue DetailsThe Queue Details group widget provides a table that contains information about thequeue, such as the name of the node and the virtual host of the queue.

The following KPIs for the widget are derived from the attributes as described:v Node: The name of the node. This data is derived from the NodeName attribute in the

KZR QUEUE DETAILS data set.v State: The state of the queue, such as running or down. This data is derived from the

State attribute in the KZR QUEUE DETAILS data set.v Vhost: The name of the virtual host. This data is derived from the Vhost attribute in

the KZR QUEUE DETAILS data set.

Ready Message Traffic (history)The Ready Message Traffic (history) group widget provides a line chart that containsinformation about the historical trend of number of messages that are getting ready to bedelivered in the queue.

The following KPIs for the widget are derived from the attributes as described:v Ready Messages: The number of messages that are ready to be delivered to the

consumer. This data is derived from the MessagesReady attribute in the KZR QUEUEDETAILS data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR QUEUE DETAILS data set.

Returned Message Traffic (history)The Returned Message Traffic (history) group widget provides a line chart that shows thehistorical trend of number of messages of the queue that are returned.

The following KPIs for the widget are derived from the attributes as described:v Returned Messages: The number of messages that have been returned to the node

because they failed to deliver. This data is derived from the ReturnUnroutable attributein the KZR QUEUE DETAILS data set.

v Time: The local time at the agent when the data was collected. This data is derivedfrom the Timestamp attribute in the KZR QUEUE DETAILS data set.

RabbitMQThe RabbitMQ page provides an overall status of the RabbitMQ cluster instance that is beingmonitored by the agent instance. Click anywhere on the group widget to drill down to open thedetail dashboard. Review the resource usage and investigate any warning or critical thresholds. Ifthe Events tab shows a warning or critical status indicator, open the tab to see the open eventsand status for the application.

The following widgets are available in this dashboard:

8 RabbitMQ Agent Reference

Page 15: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

RabbitMQThe RabbitMQ group widget provides the overall status of the RabbitMQ cluster, such asthe number of queues and channels that are not running, the health of all nodes, and thenumber of messages that are in the ready, returned, and unacknowledged state.

The following KPIs for the widget are derived from the attributes as described:v Channels not running: The number of channels in the cluster that are not running. This

data is derived from the ChannelNotRunning attribute in the KZR RABBITMQCLUSTER STATUS data set.

v Cluster name: The name of the cluster. This data is derived from the ClusterNameattribute in the KZR CLUSTER CONFIG INFO data set.

v Nodes (Critical): The number of nodes that are in the critical state. This data is derivedfrom the NodeName attribute in the KZR NODE INFORMATION data set.

v Nodes (Normal): The number of nodes that are in the normal state. This data isderived from the NodeName attribute in the KZR NODE INFORMATION data set.

v Nodes (Warning): The number of nodes that are in the warning state. This data isderived from the NodeName attribute in the KZR NODE INFORMATION data set.

v Queues not running: The number of queues in the cluster that are not running. Thisdata is derived from the QueuesNotRunning attribute in the KZR RABBITMQCLUSTER STATUS data set.

v Ready: The number of messages that are ready to be delivered to the consumer in eachdata collection interval. This data is derived from the ReadyCount attribute in the KZRRABBITMQ CLUSTER STATUS data set.

v Returned: The number of messages that have been returned to the node because theyfailed to deliver in each data collection interval. This data is derived from theReturnedCount attribute in the KZR RABBITMQ CLUSTER STATUS data set.

v Unacknowledged: The number of messages for which the node has not received anacknowledgement in each data collection interval. This data is derived from theUnackedCount attribute in the KZR RABBITMQ CLUSTER STATUS data set.

RabbitMQ DashboardUse the RabbitMQ Dashboard page to know the following details:v The status of all the nodes in the serverv The status of top twenty queues based on their statusv The status of top twenty channels based on their status

The following widgets are available in this dashboard:

Channel Summary - Top 20The Channel Summary- Top 20 group widget provides a table that contains informationabout the top 20 channels of the cluster based on their status, such as name, state, andmode of the channel, the number of consumers that are attached to the channel, the nameof the connection where the channel is running, and the number of messages in thechannel that are unacknowledged. For more details about the channel, click the channelname to navigate to the Channel Details page.

The following KPIs for the widget are derived from the attributes as described:v Channel: The name of the channel. This data is derived from the ChannelName

attribute in the KZR CHANNEL DETAILS data set.v Connection: The name of the connection where the channel is running. This data is

derived from the ConnectionName attribute in the KZR CHANNEL DETAILS data set.v Consumer Count: The number of consumers that are attached to the channel. This data

is derived from the ConsumerCount attribute in the KZR CHANNEL DETAILS dataset.

Chapter 2. Dashboards 9

Page 16: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

v Mode: The mode of the channel, such as transaction or confirm. This data is derivedfrom the Mode attribute in the KZR CHANNEL DETAILS data set.

v Node: The name of the node. This data is derived from the NodeName attribute in theKZR CHANNEL DETAILS data set.

v Status: Channel status according to state, count of unacknowledged messages.v Unacknowledged Messages: The number of messages in the channel for which the

node has not received an acknowledgement. This data is derived from theMsgsUnacknowledged attribute in the KZR CHANNEL DETAILS data set.

Node SummaryThe Node Summary group widget provides a table that contains information about thenodes of the cluster, such as the name and status of the node, status of disk space,percentage of Erlang processes and socket descriptors, and percentage of node memorythat is used by the Erlang processes. For more details about a node, click the node nameto navigate to the Node Details page.

The following KPIs for the widget are derived from the attributes as described:v Disk Free Status: The status of disk memory that is available in the node of the cluster.

The status can be 'Normal' or 'Warning'. When available disk space is less than orequal to the minimum threshold value configured, the disk space status will be in'Warning' state. If available disk space is higher than minimum disk space threshold,disk space status will be in 'Normal' state. This data is derived from theDiskSpaceStatus attribute in the KZR NODE INFORMATION data set.

v Erlang Processes Used (%): The percentage of Erlang processes that are being used bythe node. This data is derived from the ErlangProcUsedPerc attribute in the KZRNODE INFORMATION data set.

v Memory Used(%): The percentage of memory that is being used by the Erlangprocesses that are associated with the node. This data is derived from theMemUsedPerc attribute in the KZR NODE INFORMATION data set.

v Node: The name of the node. This data is derived from the NodeName attribute in theKZR NODE INFORMATION data set.

v Socket Descriptors Used(%): The percentage of socket descriptors that are being usedby the node. This data is derived from the SocketsUsedPerc attribute in the KZRNODE INFORMATION data set.

v State: The status of the node. This data is derived from the Status attribute in the KZRNODE INFORMATION data set.

Queue Summary - Top 20The Queue Summary- Top 20 group widget provides a table that contains informationabout the top 20 queues of the cluster based on their status, such as name and status ofthe queue, the number of consumers that are attached to the queue, the number ofmessages in the queue that are ready to be delivered, the number of messages in thequeue that are returned, and the policy that is applied to the queue. For more detailsabout a queue, click the queue name to navigate to the Queue Details page.

The following KPIs for the widget are derived from the attributes as described:v Consumer Count: The number of consumers that are attached to the queue. This data

is derived from the ConsumerCount attribute in the KZR QUEUE DETAILS data set.v Node: The name of the node. This data is derived from the NodeName attribute in the

KZR QUEUE DETAILS data set.v Policy Name: The name of the policy that is applied to the queue. This data is derived

from the Policy attribute in the KZR QUEUE DETAILS data set.v Queue: The name of the queue. This data is derived from the QueueName attribute in

the KZR QUEUE DETAILS data set.

10 RabbitMQ Agent Reference

Page 17: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

v Ready Messages: The number of messages that are ready to be delivered to theconsumer. This data is derived from the MessagesReady attribute in the KZR QUEUEDETAILS data set.

v Returned Messages: The number of messages that have been returned to the nodebecause they failed to deliver. This data is derived from the ReturnUnroutable attributein the KZR QUEUE DETAILS data set.

v Status: Queue status according to state, count of ready and returned messages.

Custom viewsAfter you select an application that includes a RabbitMQ managed resource, the Custom Views tab isavailable for displaying and building custom dashboard pages with attribute values from the RabbitMQAgent. You can quickly build monitoring pages for an application and save them for viewing.

Only a subset of RabbitMQ Agent attributes, which are the most useful for reporting, are available forcustom views. These attributes are shown in italic in Chapter 4, “Attributes,” on page 15.

Chapter 2. Dashboards 11

Page 18: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

12 RabbitMQ Agent Reference

Page 19: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Chapter 3. Thresholds

Thresholds test for certain conditions on your managed resources, such as memory usage over 95%, andraise an event when the conditions have been met.

The agent comes with predefined thresholds that you can use to monitor your RabbitMQ environment.You can create additional thresholds for the areas of interest.

After you click

System Configuration > Threshold Manager, select RabbitMQ as the data sourcetype to see all the available thresholds.

Predefined thresholdsThe thresholds are organized in the Cloud APM console Threshold Manager by the data set for whichthey were written. The RabbitMQ Agent has the following predefined thresholds:

KZR_Channel_not_running_CritThe state of the channel is 'down'.

The default configuration has the following SQL syntax:

*IF *VALUE KZR_CHANNEL_DETAILS.State *EQ ’Down’

This threshold is evaluated every 1 minute.

The severity of this threshold is Critical.

The threshold is evaluated for each distinct value of the ChannelName attribute.

This threshold uses the following attributes: Channel_Details.State[CHANNEL.STATE],Channel_Details.ChannelName[CHANNEL.CHANNELNAM].

KZR_Node_Health_Status_CritThe health of the node is down.

The default configuration has the following SQL syntax:

*IF *VALUE KZR_NODE_INFORMATION.Status *EQ ’Not_Running’ *OR *VALUEKZR_NODE_INFORMATION.NodeHealth *EQ ’Critical’

This threshold is evaluated every 5 minutes.

The severity of this threshold is Critical.

The threshold is evaluated for each distinct value of the NodeName attribute.

This threshold uses the following attributes: Node_Information.Status[NODEINF.STATUS],Node_Information.NodeHealth[NODEINF.NODEHEALTH],Node_Information.NodeName[NODEINF.NODENAME].

KZR_Node_Health_Status_WarnThe health of the node is in the warning state.

The default configuration has the following SQL syntax:

*IF *VALUE KZR_NODE_INFORMATION.Status *EQ ’Running’ *AND *VALUEKZR_NODE_INFORMATION.NodeHealth *EQ ’Warning’

This threshold is evaluated every 5 minutes.

The severity of this threshold is Warning.

The threshold is evaluated for each distinct value of the NodeName attribute.

© Copyright IBM Corp. 2017, 2019 13

Page 20: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

This threshold uses the following attributes: Node_Information.Status[NODEINF.STATUS],Node_Information.NodeHealth[NODEINF.NODEHEALTH],Node_Information.NodeName[NODEINF.NODENAME].

KZR_Queue_not_running_CritThe state of the queue is 'down'.

The default configuration has the following SQL syntax:

*IF *VALUE KZR_QUEUE_DETAILS.State *EQ ’Down’

This threshold is evaluated every 1 minute.

The severity of this threshold is Critical.

The threshold is evaluated for each distinct value of the QueueName attribute.

This threshold uses the following attributes: Queue_Details.State[QUEUEDE.STATE],Queue_Details.QueueName[QUEUEDE.QUEUENAME].

Customized thresholdsYou can use the predefined thresholds as a starting point for event monitoring, and create your ownthresholds as conditions arise that you want to monitor.

The RabbitMQ Agent has many data sets that you can use to create thresholds to monitor for specificconditions. For descriptions of the data sets, see Chapter 4, “Attributes,” on page 15.

Tip: The hover help for the Threshold Editor Data set field has a Learn more link to the attributedescriptions for the selected data set.

14 RabbitMQ Agent Reference

Page 21: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Chapter 4. Attributes

Attributes are the application properties that are being measured and reported by the Monitoring Agentfor RabbitMQ. Attributes make up the key performance indicators (KPIs) that are reported, and you canuse them to create thresholds for conditions that you want to monitor.

About attributes

Attributes are organized into data sets (also referred to as attribute groups). The values can be selectivelydisplayed in dashboards or used to define a threshold.

The most recent data sample of the attributes in the data set are used after you open a dashboard or starta threshold.

DashboardsOnly a subset of RabbitMQ Agent attributes is displayed in the dashboards. Queries to thedashboard data provider specify which attribute values to request from the managed resource.These attributes are shown in italic in this chapter. You can use these attributes to create thecharts and tables in custom dashboard pages.

ThresholdsYou can define thresholds that monitor the state of your operating system, database, orapplication and open an event when the threshold is exceeded. You use attributes to definethresholds that describe a condition that you want to test. After the threshold is started, theattribute values that are specified in the threshold are compared with the values collected by theRabbitMQ Agent. After the condition is met, an event is registered and you are alerted byindicators in the Application Performance Dashboard navigator, All My Applications summaryboxes, and the Events tab.

The RabbitMQ Agent comes with predefined thresholds that are enabled and started with the agentor data collector. If you edit a predefined threshold, such as to change the condition or severity, itis no longer treated as a predefined threshold but considered a custom threshold.

All RabbitMQ Agent attributes, unless otherwise noted, can be used to create custom thresholds.The Events tab has a table of open events with information, including threshold name, severity,source, and display item. You can expand an event row to see the formula and drill down to thedashboard for the managed resource.

Some attributes names display differently in the Threshold Editor, as shown in parentheses afterthe name, such as “Object Count (OBJECT_COUNT)”.

Historical data configurationsThe RabbitMQ Agent collects historical data for key data sets that are shown in the dashboards.A dashboard page that includes historical views from the managed resource instance has a timeselector tool for adjusting the time range. With line charts, you can also compare the values witha previous day, up to the number of days that have been saved.

Additional information about attributes

Note the following conditions:v When no data can be collected for a data set, an empty result is returned (no rows of data)v When a specific attribute cannot be collected, the value 0 or “” is returned unless otherwise specified in

a particular attribute (for example, “N/A”)v Any numeric attribute value that is greater than the largest (positive or negative) number that can be

represented by that type returns the corresponding maximum or minimum value (for example, the

© Copyright IBM Corp. 2017, 2019 15

Page 22: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

maximum value for a 32-bit number is 2,147,483,647). These values are displayed as text values that aredefined by the data set, such as “Value Exceeds Maximum” or “Value Exceeds Minimum”.

Numeric attributes have characteristics that are indicated in parentheses after the data type, such as“(32-bit numeric property)”. A numeric attribute value can be 32-bit or 64-bit or some other size. Thevalue type can be gauge, which means it varies, like a speedometer; counter, which counts and alwaysincreases; or numeric property, such as disk size.

For a list of the data sets, a list of the attributes in each data set, and descriptions of the attributes in theRabbitMQ Agent, see “Data sets for the monitoring agent” and “Attribute descriptions.”

Data sets for the monitoring agentThe RabbitMQ Agent contains the following data sets.v Data set name: Channel Details

– Table name: KZRCHANNEL– Historical table name: KZR_CHANNEL_DETAILS or KZRCHANNEL

v Data set name: Cluster Config Info– Table name: KZRCLUSTER– Historical table name: KZR_CLUSTER_CONFIG_INFO or KZRCLUSTER

v Data set name: Node Information– Table name: KZRNODEINF– Historical table name: KZR_NODE_INFORMATION or KZRNODEINF

v Data set name: Performance Object Status– Table name: KZRPOBJST– Historical table name: KZR_PERFORMANCE_OBJECT_STATUS or KZRPOBJST

v Data set name: Queue Details– Table name: KZRQUEUEDE– Historical table name: KZR_QUEUE_DETAILS or KZRQUEUEDE

v Data set name: RabbitMQ Cluster Status– Table name: KZRRABBITM– Historical table name: KZR_RABBITMQ_CLUSTER_STATUS or KZRRABBITM

v Data set name: Thread Pool Status– Table name: KZRTHPLST– Historical table name: KZR_THREAD_POOL_STATUS or KZRTHPLST

Attribute descriptionsAttributes in each RabbitMQ Agent data set collect data that the agent uses for monitoring.

The descriptions of the data sets contain information such as description, type, and names for eachattribute in the data set. Some attributes are designated as key attributes, which are identifier attributesfor the data set. An attribute in italic indicates that it is available for display in the ApplicationPerformance Dashboard pages.

Channel Details data setThis data set provides details the about RabbitMQ channels. Thresholds for this data set are associatedwith the RabbitMQ component. This data set is displayed as KZR CHANNEL_DETAILS in the thresholdeditor. A data sample is sent to the server every minute and is maintained for 8 days by default. Theattributes shown in italic are visible in the UI. All attributes are available for thresholds.

16 RabbitMQ Agent Reference

Page 23: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

This data set contains the following attributes:

Acknowledgements UncommittedThe number of acknowledgements that are received by the node for transactions that are not yetcommitted. The type is integer with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: ACKSUNCOMMITED or ACKSUNCOMM(historical name), Acknowledgements Uncommitted (caption), AcksUncommited (attribute name),and ACKSUNCOMM (column name).

Channel NameThe name of the channel. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: CHANNELNAME or CHANNELNAM(historical name), Channel Name (caption), ChannelName (attribute name), and CHANNELNAM(column name).

Connection NameThe name of the connection where the channel is running. The type is string.

The following names are defined for this attribute: CONNECTIONNAME or CONNECTION(historical name), Connection Name (caption), ConnectionName (attribute name), andCONNECTION (column name).

Consumer CountThe number of consumers that are attached to the channel. The type is integer with enumeratedvalues. The following values are defined: No Value (-1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: CONSUMERCOUNT or CONSUMERCO(historical name), Consumer Count (caption), ConsumerCount (attribute name), andCONSUMERCO (column name).

Mode The mode of the channel, such as transaction or confirm. The type is string.

The following names are defined for this attribute: MODE (historical name), Mode (caption),Mode (attribute name), and MODE (column name).

Node NameThe name of the node. The type is string.

The following names are defined for this attribute: NODENAME (historical name), Node Name(caption), NodeName (attribute name), and NODENAME (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

State The state of the channel, such as running or down. The type is string with enumerated values.The following values are defined: Running (running), Down (down), Flow (flow). Any value thatdoes not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: STATE (historical name), State (caption), State(attribute name), and STATE (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Unacknowledged MessagesThe number of messages in the channel for which the node has not received an

Chapter 4. Attributes 17

Page 24: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

acknowledgement. The type is integer with enumerated values. The following values are defined:No Value (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: MSGSUNACKNOWLEDGED orMSGSUNACKN (historical name), Unacknowledged Messages (caption), MsgsUnacknowledged(attribute name), and MSGSUNACKN (column name).

Uncommitted MessagesThe number of messages that are received by the consumer for transactions that are not yetcommitted. The type is integer with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: MSGSUNCOMMITED or MSGSUNCOMM(historical name), Uncommitted Messages (caption), MsgsUncommited (attribute name), andMSGSUNCOMM (column name).

Unconfirmed MessagesThe number of messages in the channel that are not confirmed. The type is integer withenumerated values. The following values are defined: No Value (-1). Any value that does nothave a definition here is displayed in the User Interface.

The following names are defined for this attribute: MSGSUNCONFIRMED or MSGSUNCONF(historical name), Unconfirmed Messages (caption), MsgsUnconfirmed (attribute name), andMSGSUNCONF (column name).

Vhost The name of the virtual host in which the channel is operating. The type is string.

The following names are defined for this attribute: VHOST (historical name), Vhost (caption),Vhost (attribute name), and VHOST (column name).

Cluster Config Info data setThis group of data provides the configuration information of the RabbitMQ cluster. Thresholds for thisdata set are associated with the RabbitMQ component. This data set is displayed as KZRCLUSTER_CONFIG_INFO in the threshold editor. A data sample is sent to the server every 8 minutesand is maintained for 8 days by default. The attributes shown in italic are visible in the UI. All attributesare available for thresholds.

This data set contains the following attributes:

Cluster NameThe name of the cluster. The type is string.

The following names are defined for this attribute: CLUSTERNAME or CLUSTERNAM (historicalname), Cluster Name (caption), ClusterName (attribute name), and CLUSTERNAM (columnname).

Erlang VersionThe version of Erlang that is used to run the Rabbit MQ server. The type is string.

The following names are defined for this attribute: ERLANGVERSION or ERLANGVERS(historical name), Erlang Version (caption), ErlangVersion (attribute name), and ERLANGVERS(column name).

Host NameThe IP address of the cluster. The type is string.

The following names are defined for this attribute: HOSTNAME (historical name), Host Name(caption), HostName (attribute name), and HOSTNAME (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

18 RabbitMQ Agent Reference

Page 25: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

RabbitMQ VersionThe version of RabbitMQ server. The type is string.

The following names are defined for this attribute: RABBITMQVERSION or RABBITVERS(historical name), RabbitMQ Version (caption), RabbitMQVersion (attribute name), andRABBITVERS (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Node Information data setThis group of data provides details about each node in a RabbitMQ cluster. Thresholds for this data setare associated with the RabbitMQ component. This data set is displayed as KZR NODE_INFORMATIONin the threshold editor. A data sample is sent to the server every minute and is maintained for 8 days bydefault. The attributes shown in italic are visible in the UI. All attributes are available for thresholds.

This data set contains the following attributes:

Available Disk SpaceThe disk memory (in GB) that is available in the node of the cluster. The type is real number withtwo decimal places of precision with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: DISKFREE (historical name), Available DiskSpace (caption), DiskFree (attribute name), and DISKFREE (column name).

Disk Free StatusThe status of disk memory that is available in the node of the cluster. The status can be 'Normal'or 'Warning'. When available disk space is less than or equal to the minimum threshold valueconfigured, the disk space status will be in 'Warning' state. If available disk space is higher thanminimum disk space threshold, disk space status will be in 'Normal' state. The type is string.

The following names are defined for this attribute: DISKSPACESTATUS or DISKSPACES(historical name), Disk Free Status (caption), DiskSpaceStatus (attribute name), and DISKSPACES(column name).

Disk Space ThresholdThe threshold value for disk memory that is available in the node of the cluster. The type is realnumber with two decimal places of precision with enumerated values. The following values aredefined: No Value (-1). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: DISKLIMIT (historical name), Disk SpaceThreshold (caption), DiskLimit (attribute name), and DISKLIMIT (column name).

Erlang Processes ThresholdThe threshold value for the number of Erlang processes that are being used by the node. Thetype is real number with two decimal places of precision with enumerated values. The followingvalues are defined: No Value (-1). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: ERLANGPROCESSTOTAL or ERLANGPRO1(historical name), Erlang Processes Threshold (caption), ErlangProcessTotal (attribute name), andERLANGPRO1 (column name).

Erlang Processes Used(%)The percentage of Erlang processes that are being used by the node. The type is real number with

Chapter 4. Attributes 19

Page 26: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

two decimal places of precision with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: ERLANGPROCUSEDPERC or ERLANGPROC(historical name), Erlang Processes Used(%) (caption), ErlangProcUsedPerc (attribute name), andERLANGPROC (column name).

IP AddressThe IP address of the machine where RabbitMQ node is running. The type is string.

The following names are defined for this attribute: IPADDRESS (historical name), IP Address(caption), IPAddress (attribute name), and IPADDRESS (column name).

Memory in UseThe memory (in MB) that is being used by RabbitMQ. The type is real number with two decimalplaces of precision with enumerated values. The following values are defined: No Value (-1). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: MEMORYUSED (historical name), Memory inUse (caption), MemoryUsed (attribute name), and MEMORYUSED (column name).

Memory Usage ThresholdThe threshold limit for usage of memory. The type is real number with two decimal places ofprecision with enumerated values. The following values are defined: No Value (-1). Any valuethat does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: MEMORYLIMIT or MEMORYLIMI (historicalname), Memory Usage Threshold (caption), MemoryLimit (attribute name), and MEMORYLIMI(column name).

Memory Used(%)The percentage of memory that is being used by the Erlang processes that are associated with thenode. The type is real number with two decimal places of precision with enumerated values. Thefollowing values are defined: No Value (-1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: MEMUSEDPERC or MEMUSEDPER (historicalname), Memory Used(%) (caption), MemUsedPerc (attribute name), and MEMUSEDPER (columnname).

Node HealthThe value of node health depends upon the Memory Used(%), Erlang Processes Used(%), SocketsDescriptors Used(%) and Disk Free Status attributes. If all these attributes are in normal thresholdthen value of 'Node Health' is 'Normal'. If percentage of Memory Used(%) or Erlang ProcessesUsed(%) or Sockets Descriptors Used(%) is greater than 75% but less than 90% or Disk FreeStatus is in 'warning' state then value of 'Node Health' will be 'Warning'. If value of any of theMemory Used(%) or Erlang Processes Used(%)or Sockets Descriptors Used(%) is greater than 90%and Disk Free Status is in 'Warning' state then value of 'Node Health ' is 'Critical'. The type isstring.

The following names are defined for this attribute: NODEHEALTH (historical name), Node Health(caption), NodeHealth (attribute name), and NODEHEALTH (column name).

Node NameThe name of the node. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODENAME (historical name), Node Name(caption), NodeName (attribute name), and NODENAME (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

20 RabbitMQ Agent Reference

Page 27: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Port NumberThe port number of the RabbitMQ node. The type is integer with enumerated values. Thefollowing values are defined: No Value (-1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: PORTNUMBER (historical name), Port Number(caption), PortNumber (attribute name), and PORTNUMBER (column name).

Sockets Descriptors Used(%)The percentage of socket descriptors that are being used by the node. The type is real numberwith two decimal places of precision with enumerated values. The following values are defined:No Value (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: SOCKETSUSEDPERC or SOCKETSUSE(historical name), Sockets Descriptors Used(%) (caption), SocketsUsedPerc (attribute name), andSOCKETSUSE (column name).

Sockets Descriptors UsedThe number of Socket descriptors that are being used by the node. The type is real number withtwo decimal places of precision with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: SOCKETUSED (historical name), SocketsDescriptors Used (caption), SocketUsed (attribute name), and SOCKETUSED (column name).

Sockets Used ThresholdThe threshold value for the number of socket descriptors that are being used by the node. Thetype is real number with two decimal places of precision with enumerated values. The followingvalues are defined: No Value (-1). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: SOCKETLIMIT or SOCKETLIMI (historicalname), Sockets Used Threshold (caption), SocketLimit (attribute name), and SOCKETLIMI (columnname).

Status The status of the node. The type is string with enumerated values. The following values aredefined: Running (true), Not Running (false). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: STATUS (historical name), Status (caption),Status (attribute name), and STATUS (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Used Erlang ProcessThe number of Erlang processes that are being used by the node. The type is real number withtwo decimal places of precision with enumerated values. The following values are defined: NoValue (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: ERLANGPROCESSUSED or ERLANGPRO0(historical name), Used Erlang Process (caption), ErlangProcessUsed (attribute name), andERLANGPRO0 (column name).

Performance Object Status data setThe Performance Object Status data set contains information that reflects the status of other data sets soyou can see the status of all performance objects that make up this application all at once. Each of theseother performance data sets is represented by a row in this table (or other type of view). The status for adata set reflects the result of the last attempt to collect data for that data set, so you can see whether the

Chapter 4. Attributes 21

Page 28: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

agent is collecting data correctly. Unlike other data sets, the Performance Object Status data set does notreflect the state of the monitored application. This data set is most often used to determine why data isnot available for one of the performance data sets.

This data set contains the following attributes:

Average Collection DurationThe average duration of all data collections of this group in seconds. The type is real number(32-bit counter) with two decimal places of precision with enumerated values. The followingvalues are defined: NO DATA (-100). Any value that does not have a definition here is displayedin the User Interface.

The following names are defined for this attribute: AVERAGE_COLLECTION_DURATION orCOLAVGD (historical name), Average Collection Duration (caption), Average_Collection_Duration(attribute name), and COLAVGD (column name).

Cache Hit PercentThe percentage of external data requests for this group that were satisfied from the cache. Thetype is real number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: CACHE_HIT_PERCENT or CACHPCT(historical name), Cache Hit Percent (caption), Cache_Hit_Percent (attribute name), andCACHPCT (column name).

Cache HitsThe number of times an external data request for this group was satisfied from the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_HITS or CACHEHT (historicalname), Cache Hits (caption), Cache_Hits (attribute name), and CACHEHT (column name).

Cache MissesThe number of times an external data request for this group was not available in the cache. Thetype is integer (32-bit counter).

The following names are defined for this attribute: CACHE_MISSES or CACHEMS (historicalname), Cache Misses (caption), Cache_Misses (attribute name), and CACHEMS (column name).

Error CodeThe error code associated with the query. The type is integer with enumerated values. Thefollowing values are defined: NO ERROR (0), GENERAL ERROR (1), OBJECT NOT FOUND (2),COUNTER NOT FOUND (3), NAMESPACE ERROR (4), OBJECT CURRENTLY UNAVAILABLE(5), COM LIBRARY INIT FAILURE (6), SECURITY INIT FAILURE (7), PROXY SECURITYFAILURE (9), NO INSTANCES RETURNED (10), ASSOCIATOR QUERY FAILED (11),REFERENCE QUERY FAILED (12), NO RESPONSE RECEIVED (13), CANNOT FIND JOINEDQUERY (14), CANNOT FIND JOIN ATTRIBUTE IN QUERY 1 RESULTS (15), CANNOT FINDJOIN ATTRIBUTE IN QUERY 2 RESULTS (16), QUERY 1 NOT A SINGLETON (17), QUERY 2NOT A SINGLETON (18), NO INSTANCES RETURNED IN QUERY 1 (19), NO INSTANCESRETURNED IN QUERY 2 (20), CANNOT FIND ROLLUP QUERY (21), CANNOT FIND ROLLUPATTRIBUTE (22), FILE OFFLINE (23), NO HOSTNAME (24), MISSING LIBRARY (25),ATTRIBUTE COUNT MISMATCH (26), ATTRIBUTE NAME MISMATCH (27), COMMON DATAPROVIDER NOT STARTED (28), CALLBACK REGISTRATION ERROR (29), MDL LOAD ERROR(30), AUTHENTICATION FAILED (31), CANNOT RESOLVE HOST NAME (32), SUBNODEUNAVAILABLE (33), SUBNODE NOT FOUND IN CONFIG (34), ATTRIBUTE ERROR (35),CLASSPATH ERROR (36), CONNECTION FAILURE (37), FILTER SYNTAX ERROR (38), FILENAME MISSING (39), SQL QUERY ERROR (40), SQL FILTER QUERY ERROR (41), SQL DBQUERY ERROR (42), SQL DB FILTER QUERY ERROR (43), PORT OPEN FAILED (44), ACCESSDENIED (45), TIMEOUT (46), NOT IMPLEMENTED (47), REQUESTED A BAD VALUE (48),RESPONSE TOO BIG (49), GENERAL RESPONSE ERROR (50), SCRIPT NONZERO RETURN(51), SCRIPT NOT FOUND (52), SCRIPT LAUNCH ERROR (53), CONF FILE DOES NOT EXIST

22 RabbitMQ Agent Reference

Page 29: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

(54), CONF FILE ACCESS DENIED (55), INVALID CONF FILE (56), EIF INITIALIZATIONFAILED (57), CANNOT OPEN FORMAT FILE (58), FORMAT FILE SYNTAX ERROR (59),REMOTE HOST UNAVAILABLE (60), EVENT LOG DOES NOT EXIST (61), PING FILE DOESNOT EXIST (62), NO PING DEVICE FILES (63), PING DEVICE LIST FILE MISSING (64), SNMPMISSING PASSWORD (65), DISABLED (66), URLS FILE NOT FOUND (67), XML PARSE ERROR(68), NOT INITIALIZED (69), ICMP SOCKETS FAILED (70), DUPLICATE CONF FILE (71),DELETED CONFIGURATION (72). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: ERROR_CODE or ERRCODE (historicalname), Error Code (caption), Error_Code (attribute name), and ERRCODE (column name).

Intervals SkippedThe number of times a background data collection for this group was skipped because theprevious collection was still running when the next one was due to start. The type is integer(32-bit counter).

The following names are defined for this attribute: INTERVALS_SKIPPED or INTSKIP (historicalname), Intervals Skipped (caption), Intervals_Skipped (attribute name), and INTSKIP (columnname).

Last Collection DurationThe duration of the most recently completed data collection of this group in seconds. The type isreal number (32-bit counter) with two decimal places of precision.

The following names are defined for this attribute: LAST_COLLECTION_DURATION orCOLDURA (historical name), Last Collection Duration (caption), Last_Collection_Duration(attribute name), and COLDURA (column name).

Last Collection FinishedThe most recent time a data collection of this group finished. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: LAST_COLLECTION_FINISHED or COLFINI(historical name), Last Collection Finished (caption), Last_Collection_Finished (attribute name),and COLFINI (column name).

Last Collection StartThe most recent time a data collection of this group started. The type is timestamp withenumerated values. The following values are defined: NOT COLLECTED (0691231190000000),NOT COLLECTED (0000000000000001). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: LAST_COLLECTION_START or COLSTRT(historical name), Last Collection Start (caption), Last_Collection_Start (attribute name), andCOLSTRT (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Number of CollectionsThe number of data collections for this group since the agent started. The type is integer (32-bitcounter).

The following names are defined for this attribute: NUMBER_OF_COLLECTIONS or NUMCOLL(historical name), Number of Collections (caption), Number_of_Collections (attribute name), andNUMCOLL (column name).

Chapter 4. Attributes 23

Page 30: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Object NameThe name of the performance object. The type is string.

The following names are defined for this attribute: OBJECT_NAME or OBJNAME (historicalname), Object Name (caption), Object_Name (attribute name), and OBJNAME (column name).

Object StatusThe status of the performance object. The type is integer with enumerated values. The followingvalues are defined: ACTIVE (0), INACTIVE (1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: OBJECT_STATUS or OBJSTTS (historicalname), Object Status (caption), Object_Status (attribute name), and OBJSTTS (column name).

Object TypeThe type of the performance object. The type is integer with enumerated values. The followingvalues are defined: WMI (0), PERFMON (1), WMI ASSOCIATION GROUP (2), JMX (3), SNMP(4), SHELL COMMAND (5), JOINED GROUPS (6), CIMOM (7), CUSTOM (8), ROLLUP DATA (9),WMI REMOTE DATA (10), LOG FILE (11), JDBC (12), CONFIG DISCOVERY (13), NT EVENTLOG (14), FILTER (15), SNMP EVENT (16), PING (17), DIRECTOR DATA (18), DIRECTOREVENT (19), SSH REMOTE SHELL COMMAND (20). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: OBJECT_TYPE or OBJTYPE (historical name),Object Type (caption), Object_Type (attribute name), and OBJTYPE (column name).

Query NameThe name of the attribute group. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: QUERY_NAME or ATTRGRP (historicalname), Query Name (caption), Query_Name (attribute name), and ATTRGRP (column name).

Refresh IntervalThe interval at which this group is refreshed in seconds. The type is integer (32-bit counter).

The following names are defined for this attribute: REFRESH_INTERVAL or REFRINT (historicalname), Refresh Interval (caption), Refresh_Interval (attribute name), and REFRINT (columnname).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Queue Details data setThis set of data provides details about the RabbitMQ queues. Thresholds for this data set are associatedwith the RabbitMQ component. This data set is displayed as KZR QUEUE_DETAILS in the thresholdeditor. A data sample is sent to the server every minute and is maintained for 8 days by default. Theattributes shown in italic are visible in the UI. All attributes are available for thresholds.

This data set contains the following attributes:

Consumer CountThe number of consumers that are attached to the queue. The type is integer with enumeratedvalues. The following values are defined: No Value (-1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: CONSUMERCOUNT or CONSUMERCO(historical name), Consumer Count (caption), ConsumerCount (attribute name), andCONSUMERCO (column name).

24 RabbitMQ Agent Reference

Page 31: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Messages Delivered in last collection intervalThe number of messages that have been delivered to the consumer in each data collectioninterval The type is DEFAULT(2).

The following names are defined for this attribute: DELIVEREDDELTA or DELIVEREDD(historical name), Messages Delivered in last collection interval (caption), DeliveredDelta (attributename), and DELIVEREDD (column name).

Messages Published in last collection intervalThe number of messages that have been published in each data collection interval The type isDEFAULT(2).

The following names are defined for this attribute: PUBLISHEDDELTA or PUBLISHEDD(historical name), Messages Published in last collection interval (caption), PublishedDelta (attributename), and PUBLISHEDD (column name).

Node NameThe name of the node. The type is string.

The following names are defined for this attribute: NODENAME (historical name), Node Name(caption), NodeName (attribute name), and NODENAME (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Policy The name of the policy that is applied to the queue. The type is string.

The following names are defined for this attribute: POLICY (historical name), Policy (caption),Policy (attribute name), and POLICY (column name).

Queue NameThe name of the queue. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: QUEUENAME (historical name), Queue Name(caption), QueueName (attribute name), and QUEUENAME (column name).

Ready MessagesThe number of messages that are ready to be delivered to the consumer. The type is integer withenumerated values. The following values are defined: No Value (-1). Any value that does nothave a definition here is displayed in the User Interface.

The following names are defined for this attribute: MESSAGESREADY or MESSAGESRE(historical name), Ready Messages (caption), MessagesReady (attribute name), and MESSAGESRE(column name).

Returned MessagesThe number of messages that have been returned to the node because they failed to deliver. Thetype is integer with enumerated values. The following values are defined: No Value (-1). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: RETURNUNROUTABLE or RETURNUNRO(historical name), Returned Messages (caption), ReturnUnroutable (attribute name), andRETURNUNRO (column name).

State The state of the queue, such as running or down. The type is string with enumerated values. Thefollowing values are defined: Running (running), Down (down). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: STATE (historical name), State (caption), State(attribute name), and STATE (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

Chapter 4. Attributes 25

Page 32: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Vhost The name of the virtual host. The type is string.

The following names are defined for this attribute: VHOST (historical name), Vhost (caption),Vhost (attribute name), and VHOST (column name).

Messages DeliveredThe number of messages that have been delivered to the consumer. The type is integer withenumerated values. The following values are defined: No Value (-1). Any value that does nothave a definition here is displayed in the User Interface.

The following names are defined for this attribute: DELIVEREDMESSAGES or DELIVEREDM(historical name), Messages Delivered (caption), DeliveredMessages (attribute name), andDELIVEREDM (column name).

Messages PublishedThe number of messages that have been published. The type is integer with enumerated values.The following values are defined: No Value (-1). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: PUBLISHEDMESSAGES or PUBLISHEDM(historical name), Messages Published (caption), PublishedMessages (attribute name), andPUBLISHEDM (column name).

RabbitMQ Cluster Status data setThis group of data provides details about the status of the RabbitMQ cluster. Thresholds for this data setare associated with the RabbitMQ component. This data set is displayed as KZRRABBITMQ_CLUSTER_STATUS in the threshold editor. A data sample is sent to the server every minuteand is maintained for 8 days by default. The attributes shown in italic are visible in the UI. All attributesare available for thresholds.

This data set contains the following attributes:

Channels Not RunningThe number of channels in the cluster that are not running. The type is integer with enumeratedvalues. The following values are defined: No Value (-1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: CHANNELNOTRUNNING orCHANNELNOT (historical name), Channels Not Running (caption), ChannelNotRunning (attributename), and CHANNELNOT (column name).

Messages ReadyThe number of messages that are ready to be delivered to the consumer in each data collectioninterval The type is integer with enumerated values. The following values are defined: No Value(-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: READYCOUNT or CREADYCNT (historicalname), Messages Ready (caption), ReadyCount (attribute name), and CREADYCNT (column name).

Messages ReturnedThe number of messages that have been returned to the node because they failed to deliver ineach data collection interval The type is integer with enumerated values. The following values aredefined: No Value (-1). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: RETURNEDCOUNT or CRETURNCNT(historical name), Messages Returned (caption), ReturnedCount (attribute name), andCRETURNCNT (column name).

26 RabbitMQ Agent Reference

Page 33: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Messages UnacknowledgedThe number of messages for which the node has not received an acknowledgement in each datacollection interval The type is integer with enumerated values. The following values are defined:No Value (-1). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: UNACKEDCOUNT or CUNACKCNT(historical name), Messages Unacknowledged (caption), UnackedCount (attribute name), andCUNACKCNT (column name).

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Queues Not RunningThe number of queues in the cluster that are not running. The type is integer with enumeratedvalues. The following values are defined: No Value (-1). Any value that does not have a definitionhere is displayed in the User Interface.

The following names are defined for this attribute: QUEUESNOTRUNNING or QUEUESNOTR(historical name), Queues Not Running (caption), QueuesNotRunning (attribute name), andQUEUESNOTR (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Thread Pool Status data setThe Thread Pool Status data set contains information that reflects the status of the internal thread poolused to collect data asynchronously.

This data set contains the following attributes:

Node The managed system name of the agent. This attribute is a key attribute. The type is string.

The following names are defined for this attribute: NODE (historical name), Node (caption),ORIGINNODE (attribute name), and ORIGINNODE (column name).

Thread Pool Active ThreadsThe number of threads in the thread pool currently active doing work. The type is integer (32-bitgauge) with enumerated values. The following values are defined: NO DATA (-1), NO DATA(-100). Any value that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_ACTIVE_THREADS orTPACTTH (historical name), Thread Pool Active Threads (caption), Thread_Pool_Active_Threads(attribute name), and TPACTTH (column name).

Thread Pool Avg Active ThreadsThe average number of threads in the thread pool simultaneously active doing work. The type isreal number (32-bit gauge) with two decimal places of precision with enumerated values. Thefollowing values are defined: NO DATA (-1), NO DATA (-100). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_ACTIVE_THREADS orTPAVGAT (historical name), Thread Pool Avg Active Threads (caption),Thread_Pool_Avg_Active_Threads (attribute name), and TPAVGAT (column name).

Thread Pool Avg Job WaitThe average time a job spends waiting on the thread pool queue in seconds. The type is real

Chapter 4. Attributes 27

Page 34: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

number (32-bit gauge) with two decimal places of precision with enumerated values. Thefollowing values are defined: NO DATA (-1), NO DATA (-100). Any value that does not have adefinition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_JOB_WAIT orTPAVJBW (historical name), Thread Pool Avg Job Wait (caption), Thread_Pool_Avg_Job_Wait(attribute name), and TPAVJBW (column name).

Thread Pool Avg Queue LengthThe average length of the thread pool queue during this run. The type is real number (32-bitgauge) with two decimal places of precision with enumerated values. The following values aredefined: NO DATA (-1), NO DATA (-100). Any value that does not have a definition here isdisplayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_AVG_QUEUE_LENGTH orTPAVGQL (historical name), Thread Pool Avg Queue Length (caption),Thread_Pool_Avg_Queue_Length (attribute name), and TPAVGQL (column name).

Thread Pool Max Active ThreadsThe peak number of threads in the thread pool that were simultaneously active doing work. Thetype is integer (32-bit counter) with enumerated values. The following values are defined: NODATA (-1), NO DATA (-100). Any value that does not have a definition here is displayed in theUser Interface.

The following names are defined for this attribute: THREAD_POOL_MAX_ACTIVE_THREADSor TPMAXAT (historical name), Thread Pool Max Active Threads (caption),Thread_Pool_Max_Active_Threads (attribute name), and TPMAXAT (column name).

Thread Pool Max Queue LengthThe peak length the thread pool queue reached. The type is integer (32-bit counter) withenumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_MAX_QUEUE_LENGTH orTPMAXQL (historical name), Thread Pool Max Queue Length (caption),Thread_Pool_Max_Queue_Length (attribute name), and TPMAXQL (column name).

Thread Pool Max SizeThe maximum number of threads that are allowed to exist in the thread pool. The type is integer(32-bit numeric property) with enumerated values. The following values are defined: NO DATA(-1), NO DATA (-100). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: THREAD_POOL_MAX_SIZE or TPMAXSZ(historical name), Thread Pool Max Size (caption), Thread_Pool_Max_Size (attribute name), andTPMAXSZ (column name).

Thread Pool Min Active ThreadsThe smallest number of threads in the thread pool that were simultaneously active doing work.The type is integer (32-bit counter) with enumerated values. The following values are defined:NO DATA (-1), NO DATA (-100). Any value that does not have a definition here is displayed inthe User Interface.

The following names are defined for this attribute: THREAD_POOL_MIN_ACTIVE_THREADS orTPMINAT (historical name), Thread Pool Min Active Threads (caption),Thread_Pool_Min_Active_Threads (attribute name), and TPMINAT (column name).

Thread Pool Min Queue LengthThe minimum length the thread pool queue reached. The type is integer (32-bit counter) withenumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

28 RabbitMQ Agent Reference

Page 35: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

The following names are defined for this attribute: THREAD_POOL_MIN_QUEUE_LENGTH orTPMINQL (historical name), Thread Pool Min Queue Length (caption),Thread_Pool_Min_Queue_Length (attribute name), and TPMINQL (column name).

Thread Pool Queue LengthThe number of jobs currently waiting in the thread pool queue. The type is integer (32-bit gauge)with enumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_QUEUE_LENGTH orTPQLGTH (historical name), Thread Pool Queue Length (caption), Thread_Pool_Queue_Length(attribute name), and TPQLGTH (column name).

Thread Pool SizeThe number of threads currently existing in the thread pool. The type is integer (32-bit gauge)with enumerated values. The following values are defined: NO DATA (-1), NO DATA (-100). Anyvalue that does not have a definition here is displayed in the User Interface.

The following names are defined for this attribute: THREAD_POOL_SIZE or THPSIZE (historicalname), Thread Pool Size (caption), Thread_Pool_Size (attribute name), and THPSIZE (columnname).

Thread Pool Total JobsThe number of jobs that are completed by all threads in the pool since agent start. The type isinteger (32-bit counter) with enumerated values. The following values are defined: NO DATA (-1),NO DATA (-100). Any value that does not have a definition here is displayed in the UserInterface.

The following names are defined for this attribute: THREAD_POOL_TOTAL_JOBS or TPTJOBS(historical name), Thread Pool Total Jobs (caption), Thread_Pool_Total_Jobs (attribute name), andTPTJOBS (column name).

TimestampThe local time at the agent when the data was collected. The type is string.

The following names are defined for this attribute: TIMESTAMP (historical name), Timestamp(caption), Timestamp (attribute name), and TIMESTAMP (column name).

Chapter 4. Attributes 29

Page 36: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

30 RabbitMQ Agent Reference

Page 37: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Accessibility features

Accessibility features assist users who have a disability, such as restricted mobility or limited vision, touse information technology content successfully.

Accessibility features

The web-based interface of IBM® Cloud Application Performance Management is the Cloud APMconsole. The console includes the following major accessibility features:v Enables users to use assistive technologies, such as screen-reader software and digital speech

synthesizer, to hear what is displayed on the screen.1 Consult the product documentation of theassistive technology for details on using those technologies with this product.

v Enables users to operate specific or equivalent features using only the keyboard.v Communicates all information independently of color.2

The Cloud APM console uses the latest W3C Standard, WAI-ARIA 1.0, US Section 508, and Web ContentAccessibility Guidelines (WCAG) 2.0. To take advantage of accessibility features, use the latest release ofyour screen reader in combination with the latest web browser that is supported by this product.

The Cloud APM console online product documentation in IBM Knowledge Center is enabled foraccessibility. The accessibility features of IBM Knowledge Center are described at IBM Knowledge Centerrelease notes.

Keyboard navigation

This product uses standard navigation keys.

Interface information

The Cloud APM console web user interface does not rely on cascading style sheets to render contentproperly and to provide a usable experience. However, the product documentation does rely oncascading style sheets. IBM Knowledge Center provides an equivalent way for low-vision users to usetheir custom display settings, including high-contrast mode. You can control font size by using the deviceor browser settings.

The Cloud APM console web user interface includes WAI-ARIA navigational landmarks that you can useto quickly navigate to functional areas in the application.

The Cloud APM console user interface does not have content that flashes 2 - 55 times per second.

Related accessibility information

In addition to standard IBM help desk and support websites, IBM has established a TTY telephoneservice for use by deaf or hard of hearing customers to access sales and support services:

TTY service 800-IBM-3383 (800-426-3383) (within North America)

1. Exceptions include some of the Agent Configuration pages and historical line charts in the Cloud APM console.

2. Exceptions include some Agent Configuration pages of the Cloud APM console.

© Copyright IBM Corp. 2017, 2019 31

Page 38: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

IBM and accessibility

For more information about the commitment that IBM has to accessibility, see IBM Accessibility .

32 RabbitMQ Agent Reference

Page 39: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Notices

This information was developed for products and services offered in the US. This material might beavailable from IBM in other languages. However, you may be required to own a copy of the product orproduct version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries.Consult your local IBM representative for information on the products and services currently available inyour area. Any reference to an IBM product, program, or service is not intended to state or imply thatonly that IBM product, program, or service may be used. Any functionally equivalent product, program,or service that does not infringe any IBM intellectual property right may be used instead. However, it isthe user's responsibility to evaluate and verify the operation of any non-IBM product, program, orservice.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not grant you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

For license inquiries regarding double-byte character set (DBCS) information, contact the IBM IntellectualProperty Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided for convenience only and do not inany manner serve as an endorsement of those websites. The materials at those websites are not part ofthe materials for this IBM product and use of those websites is at your own risk.

IBM may use or distribute any of the information you provide in any way it believes appropriate withoutincurring any obligation to you.

© Copyright IBM Corp. 2017, 2019 33

Page 40: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

Such information may be available, subject to appropriate terms and conditions, including in some cases,payment of a fee.

The licensed program described in this document and all licensed material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement orany equivalent agreement between us.

The performance data discussed herein is presented as derived under specific operating conditions.Actual results may vary.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related tonon-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

Statements regarding IBM's future direction or intent are subject to change or withdrawal without notice,and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject to change before theproducts described become available.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to actual people or business enterprises isentirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programsin any form without payment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for the operating platform forwhich the sample programs are written. These examples have not been thoroughly tested under allconditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of theseprograms. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative workmust include a copyrightnotice as follows:© (your company name) (year).Portions of this code are derived from IBM Corp. Sample Programs.© Copyright IBM Corp. 2014, 2015.

34 RabbitMQ Agent Reference

Page 41: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International BusinessMachines Corp., registered in many jurisdictions worldwide. Other product and service names might betrademarks of IBM or other companies. A current list of IBM trademarks is available on the web at"Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.

Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in theUnited States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java™ and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

Terms and conditions for product documentationPermissions for the use of these publications are granted subject to the following terms and conditions.

Applicability

These terms and conditions are in addition to any terms of use for the IBM website.

Personal use

You may reproduce these publications for your personal, noncommercial use provided that allproprietary notices are preserved. You may not distribute, display or make derivative work of thesepublications, or any portion thereof, without the express consent of IBM.

Commercial use

You may reproduce, distribute and display these publications solely within your enterprise provided thatall proprietary notices are preserved. You may not make derivative works of these publications, orreproduce, distribute or display these publications or any portion thereof outside your enterprise, withoutthe express consent of IBM.

Rights

Except as expressly granted in this permission, no other permissions, licenses or rights are granted, eitherexpress or implied, to the publications or any information, data, software or other intellectual propertycontained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use ofthe publications is detrimental to its interest or, as determined by IBM, the above instructions are notbeing properly followed.

You may not download, export or re-export this information except in full compliance with all applicablelaws and regulations, including all United States export laws and regulations.

Notices 35

Page 42: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THEPUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OFMERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

IBM Online Privacy StatementIBM Software products, including software as a service solutions, (“Software Offerings”) may use cookiesor other technologies to collect product usage information, to help improve the end user experience, totailor interactions with the end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offerings can help enable you tocollect personally identifiable information. If this Software Offering uses cookies to collect personallyidentifiable information, specific information about this offering's use of cookies is set forth in thefollowing paragraphs.

Depending upon the configurations deployed, this Software Offering may use session cookies that collecteach user's user name for purposes of session management, authentication, and single sign-onconfiguration. These cookies can be disabled, but disabling them will also likely eliminate thefunctionality they enable.

If the configurations deployed for this Software Offering provide you as customer the ability to collectpersonally identifiable information from end users via cookies and other technologies, you should seekyour own legal advice about any laws applicable to such data collection, including any requirements fornotice and consent.

For more information about the use of various technologies, including cookies, for these purposes, SeeIBM's Privacy Policy at http://www.ibm.com/privacy and IBM's Online Privacy Statement athttp://www.ibm.com/privacy/details the section entitled “Cookies, Web Beacons and OtherTechnologies” and the “IBM Software Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.

36 RabbitMQ Agent Reference

Page 43: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

Index

Aaccessibility features 31Acknowledgements Uncommitted attribute 17additional information

attributes 15attributes

Acknowledgements Uncommitted 17Available Disk Space 19Average Collection Duration 22Cache Hit Percent 22Cache Hits 22Cache Misses 22Channel Details 17Channel Name 17Channels Not Running 26Cluster Config Info 18Cluster Name 18Connection Name 17Consumer Count 17, 24Disk Free Status 19Disk Space Threshold 19Erlang Processes Threshold 19Erlang Processes Used(%) 19Erlang Version 18Error Code 22Host Name 18Intervals Skipped 23IP Address 20Last Collection Duration 23Last Collection Finished 23Last Collection Start 23Memory in Use 20Memory Usage Threshold 20Memory Used(%) 20Messages Delivered 26Messages Delivered in last collection interval 25Messages Published 26Messages Published in last collection interval 25Messages Ready 26Messages Returned 26Messages Unacknowledged 27Mode 17Node 17, 18, 20, 23, 25, 27Node Health 20Node Information 19Node Name 17, 20, 25Number of Collections 23Object Name 24Object Status 24Object Type 24overview 15Performance Object Status 22Policy 25Port Number 21Query Name 24Queue Details 24Queue Name 25Queues Not Running 27RabbitMQ Cluster Status 26RabbitMQ Version 19Ready Messages 25

attributes (continued)Refresh Interval 24Returned Messages 25Sockets Descriptors Used 21Sockets Descriptors Used(%) 21Sockets Used Threshold 21State 17, 25Status 21Thread Pool Active Threads 27Thread Pool Avg Active Threads 27Thread Pool Avg Job Wait 27Thread Pool Avg Queue Length 28Thread Pool Max Active Threads 28Thread Pool Max Queue Length 28Thread Pool Max Size 28Thread Pool Min Active Threads 28Thread Pool Min Queue Length 28Thread Pool Queue Length 29Thread Pool Size 29Thread Pool Status 27Thread Pool Total Jobs 29Timestamp 17, 19, 21, 24, 25, 27, 29Unacknowledged Messages 17Uncommitted Messages 18Unconfirmed Messages 18Used Erlang Process 21Vhost 18, 26

Available Disk Space attribute 19Average Collection Duration attribute 22

CCache Hit Percent attribute 22Cache Hits attribute 22Cache Misses attribute 22Channel Details data set 17Channel Name attribute 17Channels Not Running attribute 26Cluster Config Info data set 18Cluster Name attribute 18Connection Name attribute 17Consumer Count attribute 17, 24

Ddashboards 3data set

attributes 16data sets

Channel Details 17Cluster Config Info 18list of all 16Node Information 19overview 15Performance Object Status 22Queue Details 24RabbitMQ Cluster Status 26Thread Pool Status 27

Disk Free Status attribute 19Disk Space Threshold attribute 19

© Copyright IBM Corp. 2017, 2019 37

Page 44: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

EErlang Processes Threshold attribute 19Erlang Processes Used(%) attribute 19Erlang Version attribute 18Error Code attribute 22

HHost Name attribute 18

IIntervals Skipped attribute 23Introduction 1IP Address attribute 20

KKPIs 3

LLast Collection Duration attribute 23Last Collection Finished attribute 23Last Collection Start attribute 23

MMemory in Use attribute 20Memory Usage Threshold attribute 20Memory Used(%) attribute 20Messages Delivered attribute 26Messages Delivered in last collection interval attribute 25Messages Published attribute 26Messages Published in last collection interval attribute 25Messages Ready attribute 26Messages Returned attribute 26Messages Unacknowledged attribute 27Mode attribute 17

NNode attribute 17, 18, 20, 23, 25, 27Node Health attribute 20Node Information data set 19Node Name attribute 17, 20, 25Number of Collections attribute 23

OObject Name attribute 24Object Status attribute 24Object Type attribute 24

PPerformance Object Status data set 22Policy attribute 25Port Number attribute 21

QQuery Name attribute 24Queue Details data set 24Queue Name attribute 25Queues Not Running attribute 27

RRabbitMQ Cluster Status data set 26RabbitMQ Version attribute 19Ready Messages attribute 25Refresh Interval attribute 24Returned Messages attribute 25

SSockets Descriptors Used attribute 21Sockets Descriptors Used(%) attribute 21Sockets Used Threshold attribute 21State attribute 17, 25Status attribute 21

TThread Pool Active Threads attribute 27Thread Pool Avg Active Threads attribute 27Thread Pool Avg Job Wait attribute 27Thread Pool Avg Queue Length attribute 28Thread Pool Max Active Threads attribute 28Thread Pool Max Queue Length attribute 28Thread Pool Max Size attribute 28Thread Pool Min Active Threads attribute 28Thread Pool Min Queue Length attribute 28Thread Pool Queue Length attribute 29Thread Pool Size attribute 29Thread Pool Status data set 27Thread Pool Total Jobs attribute 29thresholds 13thresholds, using attributes 15Timestamp attribute 17, 19, 21, 24, 25, 27, 29

UUnacknowledged Messages attribute 17Uncommitted Messages attribute 18Unconfirmed Messages attribute 18Used Erlang Process attribute 21

VVhost attribute 18, 26

Wwidgets 3

38 RabbitMQ Agent Reference

Page 45: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical
Page 46: RabbitMQ Agent Reference - IBM · v The historical tr end of memory usage of the node in the cluster v The historical tr end of Erlang pr ocesses usage by the node v The historical

IBM®

Printed in USA