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

Table 4.1. Connection Properties

NameRequiredDescriptionInternal Name
Broker VersionnoThe version of the brokerBrokerVersion
Object Nameyes objectName
Name Templateyes nameTemplate
Description Templateyes descriptionTemplate
Broker NameyesThe name of the brokerbrokerName
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 4.2. Metrics

NameTypeDescriptionInternal Name
Total Consumer CountmeasurementNumber of message consumers subscribed to destinations on the broker.TotalConsumerCount
Total Enqueue CountmeasurementNumber of messages that have been sent to the broker.TotalEnqueueCount
Total Enqueue Count per MinutemeasurementNumber of messages per minute that have been sent to the broker.TotalEnqueueCount
Total Dequeue CountmeasurementNumber of messages that have been acknowledged on the broker.TotalDequeueCount
Total Dequeue Count per MinutemeasurementNumber of messages per minute that have been acknowledged on the broker.TotalDequeueCount
Total Message CountmeasurementNumber of unacknowledged messages on the broker.TotalMessageCount
Total Message Count per MinutemeasurementNumber of unacknowledged messages on the broker per minute.TotalMessageCount
Total Forward CountmeasurementNumber of messages forwarded from the destination to a networked broker.TotalForwardCount
Total Forward Count per MinutemeasurementNumber of messages forwarded per minute from the destination to a networked broker.TotalForwardCount
Memory Percent UsagemeasurementPercent of memory limit used.MemoryPercentUsage
Memory LimitmeasurementMemory 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

Table 4.3. Operations

NameDescription
StartStarts the Broker
StopStops the Broker and all its components
GcFlushes Broker caches so that the garbage collector can reclaim more memory
Add ConnectorAdds a Connector to the broker.
Remove ConnectorRemoves a Connector from the broker.
Reset StatisticsReset all broker statistics.
Enable StatisticsEnable broker statistics.
Disable StatisticsDisable broker statistics.
Add Network ConnectorAdds a Network Connector to the broker.
Remove Network ConnectorRemoves a Network Connector from the broker.
Stop GracefullyPolls queues matching queueName for empty state before stopping
Terminate JVMShuts down the JVM.
Add TopicAdds a Topic destination to the broker.
Add QueueAdds a Queue destination to the broker.
Remove TopicRemoves a Topic destination from the Broker
Remove QueueRemoves a Queue destination from the Broker
Reload Log 4j PropertiesReloads log4j.properties from the classpath.
Get Transport Connector By TypeThe url of transport connector by it's type; e.g. tcp, stomp, ssl, etc.

Package Types

none