Chapter 4. Broker Service
Overview
| Description: | ActiveMQ Broker |
|---|---|
| Singleton: | no |
| Plugin: | ActiveMQ |
Parent Resource Types
- 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
Connection Properties
| Name | Required | Description | Internal Name |
|---|---|---|---|
| Broker Version | no | The version of the broker | BrokerVersion |
| Object Name | yes | objectName | |
| 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
| 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 per minute 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 per minute 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 per minute. | TotalMessageCount |
| Total Forward Count | measurement | Number of messages forwarded from the destination to a networked broker. | TotalForwardCount |
| Total Forward Count per Minute | measurement | Number of messages forwarded per minute from the destination to a networked broker. | TotalForwardCount |
| 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
none
Operations
| 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 | Polls queues matching queueName for empty state 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
none
