Red Hat SummitPerformance Metrics Reference
Red Hat JBoss A-MQ
Monitoring the broker's performance
Version 6.0
Copyright © 2013 Red Hat, Inc. and/or its affiliates.
13 Oct 2017
Abstract
Red Hat JBoss A-MQ provides a number of metrics that can be used to monitor a broker's performance.
Chapter 1. ActiveMQ Server
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Server Process |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
- Managed Platforms
Child Resource Types
Copy linkLink copied to clipboard!
- ActiveMQ Server JVM Server
Autodiscovery Process Scans
Copy linkLink copied to clipboard!
| Name | Query |
|---|---|
${processScan.name} | process|basename|match=^java.*,arg|-Dactivemq.home|match=.* |
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Log Event Sources | yes | The list of log files that can be tracked | logEventSources |
| ActiveMQ Home | yes | The home directory of the Server | activemq.home |
| Server Resource Key | yes | Java system property that uniquely identifies this Server | resourceKey |
| Version File Pattern | yes | File name with Server version | versionFile |
| Home Directory | yes | System property for home directory | homeProperty |
| Log File | yes | Name of the log file to track | logFile |
| Connector Address | no | JMX Service URL | connectorAddress |
| Principal | no | JMX login principal/username | principal |
| Credentials | no | JMX login credentials/password | credentials |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
none
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
none
Package Types
Copy linkLink copied to clipboard!
none
Chapter 2. Broker Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Broker |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
- ActiveMQ Server Platform
- JMX Server Platform
- Servicemix 3 Server Platform
- Servicemix 4 Server Platform
- Fabric Container Platform
- JBoss Fuse Container Platform
- JBossAS Server Platform
Child Resource Types
Copy linkLink copied to clipboard!
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Broker Version | yes | The version of the broker | BrokerVersion |
| Object Name | yes | objectName | |
| Object Name 1 | yes | objectName1 | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Broker Name | yes | The name of the broker | brokerName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Consumer Count | measurement | Number of message consumers subscribed to destinations on the broker. | TotalConsumerCount |
| Total Enqueue Count | measurement | Number of messages that have been sent to the broker. | TotalEnqueueCount |
| Total Enqueue Count per Minute | measurement | Number of messages that have been sent to the broker. | TotalEnqueueCount |
| Total Dequeue Count | measurement | Number of messages that have been acknowledged on the broker. | TotalDequeueCount |
| Total Dequeue Count per Minute | measurement | Number of messages that have been acknowledged on the broker. | TotalDequeueCount |
| Total Message Count | measurement | Number of unacknowledged messages on the broker. | TotalMessageCount |
| Total Message Count per Minute | measurement | Number of unacknowledged messages on the broker. | TotalMessageCount |
| Memory Percent Usage | measurement | Percent of memory limit used. | MemoryPercentUsage |
| Memory Limit | measurement | Memory limit, in bytes, used for holding undelivered messages before paging to temporary storage. | MemoryLimit |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Start | Starts the Broker |
| Stop | Stops the Broker and all its components |
| Gc | Flushes Broker caches so that the garbage collector can reclaim more memory |
| Add Connector | Adds a Connector to the broker. |
| Remove Connector | Removes a Connector from the broker. |
| Reset Statistics | Reset all broker statistics. |
| Enable Statistics | Enable broker statistics. |
| Disable Statistics | Disable broker statistics. |
| Add Network Connector | Adds a Network Connector to the broker. |
| Remove Network Connector | Removes a Network Connector from the broker. |
| Stop Gracefully | Poll for queues matching queueName are empty before stopping |
| Terminate JVM | Shuts down the JVM. |
| Add Topic | Adds a Topic destination to the broker. |
| Add Queue | Adds a Queue destination to the broker. |
| Remove Topic | Removes a Topic destination from the Broker |
| Remove Queue | Removes a Queue destination from the Broker |
| Reload Log 4j Properties | Reloads log4j.properties from the classpath. |
| Get Transport Connector By Type | The url of transport connector by it's type; e.g. tcp, stomp, ssl, etc. |
Package Types
Copy linkLink copied to clipboard!
none
Chapter 3. Client Connector Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Connector |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
Child Resource Types
Copy linkLink copied to clipboard!
none
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Connector Name | yes | The name of the connector | connectorName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
none
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Connection Count | Returns the connection count |
| Reset Statistics | Resets the statistics |
| Enable Statistics | Enables statistics gathering |
| Disable Statistics | Disables statistics gathering |
| Start | Starts the Connector |
| Stop | Stops the Connector |
Package Types
Copy linkLink copied to clipboard!
none
Chapter 4. Connector Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Connector |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
Child Resource Types
Copy linkLink copied to clipboard!
none
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Connector Name | yes | The name of the connector | connectorName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
none
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Connection Count | Returns the connection count |
| Reset Statistics | Resets the statistics |
| Enable Statistics | Enables statistics gathering |
| Disable Statistics | Disables statistics gathering |
| Start | Starts the Connector |
| Stop | Stops the Connector |
Package Types
Copy linkLink copied to clipboard!
none
Chapter 5. Network Connector Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Connector |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
Child Resource Types
Copy linkLink copied to clipboard!
none
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Object Name 1 | yes | objectName1 | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Connector Name | yes | The name of the connector | connectorName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
none
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Start | Starts the Connector |
| Stop | Stops the Connector |
Package Types
Copy linkLink copied to clipboard!
none
Chapter 6. Queue Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Queue |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
Child Resource Types
Copy linkLink copied to clipboard!
none
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Object Name 1 | yes | objectName1 | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Destination | yes | destination |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Enqueue Count | measurement | Number of messages that have been sent to the destination | EnqueueCount |
| Enqueue Count per Minute | measurement | Number of messages that have been sent to the destination | EnqueueCount |
| Dequeue Count | measurement | Number of messages that have been acknowledged (and removed from) from the destination. | DequeueCount |
| Dequeue Count per Minute | measurement | Number of messages that have been acknowledged (and removed from) from the destination. | DequeueCount |
| Consumer Count | measurement | Number of consumers subscribed to this destination | ConsumerCount |
| Queue Size | measurement | Number of messages in the destination which are yet to be consumed. Potentially dispatched but unacknowledged. | QueueSize |
| Memory Percent Usage | measurement | The percentage of the memory limit used | MemoryPercentUsage |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Purge | Removes all of the messages in the queue |
| Remove Message | Remove a message from the destination by JMS message ID. If the message has been dispatched, it cannot be deleted and false is returned. |
| Remove Matching Messages | Removes up to a specified number of messages from the destination based on an SQL-92 selection on the message headers or XPATH on the body. |
| Copy Message To | Copies a message with the given JMS message ID into the specified destination. |
| Copy Matching Messages To | Copies up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination. |
| Move Message To | Moves a message with the given JMS message ID into the specified destination. |
| Move Matching Messages To | Moves up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination. |
| Retry Message | Moves a message with the given JMS message back to its original destination |
| Does Cursor Have Space | Message cursor has memory space available |
| Does Cursor Have Messages Buffered | Message cursor has buffered messages to deliver |
| Cursor Size | Number of messages available to be paged in by the cursor. |
| Reset Statistics | Resets statistics |
| Send Text Message | Sends a text message to this destination |
Package Types
Copy linkLink copied to clipboard!
none
Chapter 7. Topic Service
Copy linkLink copied to clipboard!
Overview
Copy linkLink copied to clipboard!
| Description: | ActiveMQ Topic |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
Copy linkLink copied to clipboard!
Child Resource Types
Copy linkLink copied to clipboard!
none
Connection Properties
Copy linkLink copied to clipboard!
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Object Name 1 | yes | objectName1 | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Destination | yes | destination |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Copy linkLink copied to clipboard!
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Enqueue Count | measurement | Number of messages that have been sent to the destination | EnqueueCount |
| Enqueue Count per Minute | measurement | Number of messages that have been sent to the destination | EnqueueCount |
| Dequeue Count | measurement | Number of messages that have been acknowledged (and removed from) from the destination. | DequeueCount |
| Dequeue Count per Minute | measurement | Number of messages that have been acknowledged (and removed from) from the destination. | DequeueCount |
| Consumer Count | measurement | Number of consumers subscribed to this destination | ConsumerCount |
| Queue Size | measurement | Number of messages in the destination which are yet to be consumed. Potentially dispatched but unacknowledged. | QueueSize |
| Memory Percent Usage | measurement | The percentage of the memory limit used | MemoryPercentUsage |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Copy linkLink copied to clipboard!
none
Operations
Copy linkLink copied to clipboard!
| Name | Description |
|---|---|
| Reset Statistics | Resets statistics |
| Send Text Message | Sends a text message to this destination |
Package Types
Copy linkLink copied to clipboard!
none
Legal Notice
Copy linkLink copied to clipboard!
Trademark Disclaimer
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.
Legal Notice
Copy linkLink copied to clipboard!
Third Party Acknowledgements
One or more products in the Red Hat JBoss A-MQ release includes third party components covered by licenses that require that the following documentation notices be provided:
- JLine (http://jline.sourceforge.net) jline:jline:jar:1.0License: BSD (LICENSE.txt) - Copyright (c) 2002-2006, Marc Prud'hommeaux
mwp1@cornell.eduAll rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JLine nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - Stax2 API (http://woodstox.codehaus.org/StAX2) org.codehaus.woodstox:stax2-api:jar:3.1.1License: The BSD License (http://www.opensource.org/licenses/bsd-license.php)Copyright (c) <YEAR>, <OWNER> All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - jibx-run - JiBX runtime (http://www.jibx.org/main-reactor/jibx-run) org.jibx:jibx-run:bundle:1.2.3License: BSD (http://jibx.sourceforge.net/jibx-license.html) Copyright (c) 2003-2010, Dennis M. Sosnoski.All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - JavaAssist (http://www.jboss.org/javassist) org.jboss.javassist:com.springsource.javassist:jar:3.9.0.GA:compileLicense: MPL (http://www.mozilla.org/MPL/MPL-1.1.html)
- HAPI-OSGI-Base Module (http://hl7api.sourceforge.net/hapi-osgi-base/) ca.uhn.hapi:hapi-osgi-base:bundle:1.2License: Mozilla Public License 1.1 (http://www.mozilla.org/MPL/MPL-1.1.txt)
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}