Docs » Integrations Guide » Integrations Reference » ActiveMQ

../../_images/integrations_activemq.png ActiveMQ πŸ”—

DESCRIPTION πŸ”—

This integration primarily consists of the Smart Agent monitor collectd/activemq. Below is an overview of that monitor.

Smart Agent Monitor πŸ”—

SignalFx’s integration with ActiveMQ wraps the Collectd GenericJMX monitor to monitor ActiveMQ.

Use this monitor to gather the following types of information from ActiveMQ:

  • Broker (Totals per broker)
  • Queue (Queue status)
  • Topic (Topic status)

To monitor the age of messages inside ActiveMQ queues, see ActiveMQ message age listener.

REQUIREMENTS AND DEPENDENCIES πŸ”—

Software Version
Smart Agent *
ActiveMQ 5.8.0 or later

INSTALLATION πŸ”—

This integration is part of the SignalFx Smart Agent as the collectd/activemq monitor. You should first deploy the Smart Agent to the same host as the service you want to monitor, and then continue with the configuration instructions below.

CONFIGURATION πŸ”—

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: collectd/activemq
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
host yes string Host to connect to -- JMX must be configured for remote access and accessible from the agent
port yes integer JMX connection port (NOT the RMI port) on the application. This correponds to the com.sun.management.jmxremote.port Java property that should be set on the JVM when running the application.
name no string
serviceName no string This is how the service type is identified in the SignalFx UI so that you can get built-in content for it. For custom JMX integrations, it can be set to whatever you like and metrics will get the special property sf_hostHasService set to this value.
serviceURL no string The JMX connection string. This is rendered as a Go template and has access to the other values in this config. NOTE: under normal circumstances it is not advised to set this string directly - setting the host and port as specified above is preferred. (default: service:jmx:rmi:///jndi/rmi://{{.Host}}:{{.Port}}/jmxrmi)
instancePrefix no string Prefixes the generated plugin instance with prefix. If a second instancePrefix is specified in a referenced MBean block, the prefix specified in the Connection block will appear at the beginning of the plugin instance, and the prefix specified in the MBean block will be appended to it
username no string Username to authenticate to the server
password no string User password to authenticate to the server
customDimensions no map of strings Takes in key-values pairs of custom dimensions at the connection level.
mBeansToCollect no list of strings A list of the MBeans defined in mBeanDefinitions to actually collect. If not provided, then all defined MBeans will be collected.
mBeansToOmit no list of strings A list of the MBeans to omit. This will come handy in cases where only a few MBeans need to omitted from the default list
mBeanDefinitions no map of objects (see below) Specifies how to map JMX MBean values to metrics. If using a specific service monitor such as cassandra, kafka, or activemq, they come pre-loaded with a set of mappings, and any that you add in this option will be merged with those. See collectd GenericJMX for more details.

The nested mBeanDefinitions config object has the following fields:

Config option Required Type Description
objectName no string Sets the pattern which is used to retrieve MBeans from the MBeanServer. If more than one MBean is returned you should use the instanceFrom option to make the identifiers unique
instancePrefix no string Prefixes the generated plugin instance with prefix
instanceFrom no list of strings The object names used by JMX to identify MBeans include so called "properties" which are basically key-value-pairs. If the given object name is not unique and multiple MBeans are returned, the values of those properties usually differ. You can use this option to build the plugin instance from the appropriate property values. This option is optional and may be repeated to generate the plugin instance from multiple property values
values no list of objects (see below) The value blocks map one or more attributes of an MBean to a value list in collectd. There must be at least one value block within each MBean block
dimensions no list of strings

The nested values config object has the following fields:

Config option Required Type Description
type no string Sets the data set used within collectd to handle the values of the MBean attribute
table no bool Set this to true if the returned attribute is a composite type. If set to true, the keys within the composite type is appended to the type instance. (default: false)
instancePrefix no string Works like the option of the same name directly beneath the MBean block, but sets the type instance instead
instanceFrom no list of strings Works like the option of the same name directly beneath the MBean block, but sets the type instance instead
attribute no string Sets the name of the attribute from which to read the value. You can access the keys of composite types by using a dot to concatenate the key name to the attribute name. For example: β€œattrib0.key42”. If table is set to true, path must point to a composite type, otherwise it must point to a numeric type.
attributes no list of strings The plural form of the attribute config above. Used to derive multiple metrics from a single MBean.

USAGE πŸ”—

Sample of built-in dashboard in SignalFx:

../../_images/dashboard_activemq.png

METRICS πŸ”—

Metric Name Description Type
counter.amq.TotalConnectionsCount Total connections count per broker counter
gauge.amq.TotalConsumerCount Total number of consumers subscribed to destinations on the broker gauge
gauge.amq.TotalDequeueCount Total number of messages that have been acknowledged from the broker gauge
gauge.amq.TotalEnqueueCount Total number of messages that have been sent to the broker gauge
gauge.amq.TotalMessageCount Total number of unacknowledged messages on the broker gauge
gauge.amq.TotalProducerCount Total number of message producers active on destinations on the broker gauge
gauge.amq.queue.AverageBlockedTime Average time (ms) that messages have spent blocked by Flow Control gauge
gauge.amq.queue.AverageEnqueueTime Average time (ms) that messages have been held at this destination gauge
gauge.amq.queue.AverageMessageSize Average size of messages in this queue, in bytes gauge
gauge.amq.queue.BlockedSends Number of messages blocked by Flow Control gauge
gauge.amq.queue.ConsumerCount Number of consumers subscribed to this queue gauge
gauge.amq.queue.DequeueCount Number of messages that have been acknowledged and removed from the queue gauge
gauge.amq.queue.EnqueueCount Number of messages that have been sent to the queue gauge
gauge.amq.queue.ExpiredCount Number of messages that have expired from the queue gauge
gauge.amq.queue.ForwardCount Number of messages that have been forwarded from this queue to a networked broker gauge
gauge.amq.queue.InFlightCount The number of messages that have been dispatched to consumers, but not acknowledged gauge
gauge.amq.queue.ProducerCount Number of producers publishing to this queue gauge
gauge.amq.queue.QueueSize The number of messages in the queue that have yet to be consumed gauge
gauge.amq.queue.TotalBlockedTime The total time (ms) that messages have spent blocked by Flow Control gauge
gauge.amq.topic.AverageBlockedTime Average time (ms) that messages have been blocked by Flow Control gauge
gauge.amq.topic.AverageEnqueueTime Average time (ms) that messages have been held at this destination gauge
gauge.amq.topic.AverageMessageSize Average size of messages on this topic, in bytes gauge
gauge.amq.topic.BlockedSends Number of messages blocked by Flow Control gauge
gauge.amq.topic.ConsumerCount The number of consumers subscribed to this topic gauge
gauge.amq.topic.DequeueCount Number of messages that have been acknowledged and removed from the topic gauge
gauge.amq.topic.EnqueueCount The number of messages that have been sent to the topic gauge
gauge.amq.topic.ExpiredCount The number of messages that have expired from this topic gauge
gauge.amq.topic.ForwardCount The number of messages that have been forwarded from this topic to a networked broker gauge
gauge.amq.topic.InFlightCount The number of messages that have been dispatched to consumers, but have not yet been acknowledged gauge
gauge.amq.topic.ProducerCount Number of producers publishing to this topic gauge
gauge.amq.topic.QueueSize Number of messages in the topic that have yet to be consumed gauge
gauge.amq.topic.TotalBlockedTime The total time (ms) that messages have spent blocked by Flow Control gauge
gauge.jvm.threads.count Number of JVM threads gauge
gauge.loaded_classes Number of classes loaded in the JVM gauge
invocations Total number of garbage collection events cumulative
jmx_memory.committed Amount of memory guaranteed to be available in bytes gauge
jmx_memory.init Amount of initial memory at startup in bytes gauge
jmx_memory.max Maximum amount of memory that can be used in bytes gauge
jmx_memory.used Current memory usage in bytes gauge
total_time_in_ms.collection_time Amount of time spent garbage collecting in milliseconds cumulative

counter.amq.TotalConnectionsCount πŸ”—

counter

Total connections count per broker

gauge.amq.TotalConsumerCount πŸ”—

gauge

Total number of consumers subscribed to destinations on the broker

gauge.amq.TotalDequeueCount πŸ”—

gauge

Total number of messages that have been acknowledged from the broker.

gauge.amq.TotalEnqueueCount πŸ”—

gauge

Total number of messages that have been sent to the broker.

gauge.amq.TotalMessageCount πŸ”—

gauge

Total number of unacknowledged messages on the broker

gauge.amq.TotalProducerCount πŸ”—

gauge

Total number of message producers active on destinations on the broker

gauge.amq.queue.AverageBlockedTime πŸ”—

gauge

Average time (ms) that messages have spent blocked by Flow Control.

gauge.amq.queue.AverageEnqueueTime πŸ”—

gauge

Average time (ms) that messages have been held at this destination

gauge.amq.queue.AverageMessageSize πŸ”—

gauge

Average size of messages in this queue, in bytes.

gauge.amq.queue.BlockedSends πŸ”—

gauge

Number of messages blocked by Flow Control.

gauge.amq.queue.ConsumerCount πŸ”—

gauge

Number of consumers subscribed to this queue.

gauge.amq.queue.DequeueCount πŸ”—

gauge

Number of messages that have been acknowledged and removed from the queue.

gauge.amq.queue.EnqueueCount πŸ”—

gauge

Number of messages that have been sent to the queue.

gauge.amq.queue.ExpiredCount πŸ”—

gauge

Number of messages that have expired from the queue.

gauge.amq.queue.ForwardCount πŸ”—

gauge

Number of messages that have been forwarded from this queue to a networked broker.

gauge.amq.queue.InFlightCount πŸ”—

gauge

The number of messages that have been dispatched to consumers, but not acknowledged.

gauge.amq.queue.ProducerCount πŸ”—

gauge

Number of producers publishing to this queue

gauge.amq.queue.QueueSize πŸ”—

gauge

The number of messages in the queue that have yet to be consumed.

gauge.amq.queue.TotalBlockedTime πŸ”—

gauge

The total time (ms) that messages have spent blocked by Flow Control.

gauge.amq.topic.AverageBlockedTime πŸ”—

gauge

Average time (ms) that messages have been blocked by Flow Control.

gauge.amq.topic.AverageEnqueueTime πŸ”—

gauge

Average time (ms) that messages have been held at this destination.

gauge.amq.topic.AverageMessageSize πŸ”—

gauge

Average size of messages on this topic, in bytes.

gauge.amq.topic.BlockedSends πŸ”—

gauge

Number of messages blocked by Flow Control

gauge.amq.topic.ConsumerCount πŸ”—

gauge

The number of consumers subscribed to this topic

gauge.amq.topic.DequeueCount πŸ”—

gauge

Number of messages that have been acknowledged and removed from the topic.

gauge.amq.topic.EnqueueCount πŸ”—

gauge

The number of messages that have been sent to the topic.

gauge.amq.topic.ExpiredCount πŸ”—

gauge

The number of messages that have expired from this topic.

gauge.amq.topic.ForwardCount πŸ”—

gauge

The number of messages that have been forwarded from this topic to a networked broker.

gauge.amq.topic.InFlightCount πŸ”—

gauge

The number of messages that have been dispatched to consumers, but have not yet been acknowledged.

gauge.amq.topic.ProducerCount πŸ”—

gauge

Number of producers publishing to this topic.

gauge.amq.topic.QueueSize πŸ”—

gauge

Number of messages in the topic that have yet to be consumed.

gauge.amq.topic.TotalBlockedTime πŸ”—

gauge

The total time (ms) that messages have spent blocked by Flow Control

gauge.jvm.threads.count πŸ”—

gauge

Number of JVM threads

gauge.loaded_classes πŸ”—

gauge

Number of classes loaded in the JVM

invocations πŸ”—

cumulative

Total number of garbage collection events

jmx_memory.committed πŸ”—

gauge

Amount of memory guaranteed to be available in bytes

jmx_memory.init πŸ”—

gauge

Amount of initial memory at startup in bytes

jmx_memory.max πŸ”—

gauge

Maximum amount of memory that can be used in bytes

jmx_memory.used πŸ”—

gauge

Current memory usage in bytes

total_time_in_ms.collection_time πŸ”—

cumulative

Amount of time spent garbage collecting in milliseconds

Metrics that are categorized as container/host (default) are in bold and italics in the list below.

These are the metrics available for this integration.

  • counter.amq.TotalConnectionsCount (counter)
    Total connections count per broker
  • gauge.amq.TotalConsumerCount (gauge)
    Total number of consumers subscribed to destinations on the broker
  • gauge.amq.TotalDequeueCount (gauge)
    Total number of messages that have been acknowledged from the broker.
  • gauge.amq.TotalEnqueueCount (gauge)
    Total number of messages that have been sent to the broker.
  • gauge.amq.TotalMessageCount (gauge)
    Total number of unacknowledged messages on the broker
  • gauge.amq.TotalProducerCount (gauge)
    Total number of message producers active on destinations on the broker
  • gauge.amq.queue.AverageBlockedTime (gauge)
    Average time (ms) that messages have spent blocked by Flow Control.
  • gauge.amq.queue.AverageEnqueueTime (gauge)
    Average time (ms) that messages have been held at this destination
  • gauge.amq.queue.AverageMessageSize (gauge)
    Average size of messages in this queue, in bytes.
  • gauge.amq.queue.BlockedSends (gauge)
    Number of messages blocked by Flow Control.
  • gauge.amq.queue.ConsumerCount (gauge)
    Number of consumers subscribed to this queue.
  • gauge.amq.queue.DequeueCount (gauge)
    Number of messages that have been acknowledged and removed from the queue.
  • gauge.amq.queue.EnqueueCount (gauge)
    Number of messages that have been sent to the queue.
  • gauge.amq.queue.ExpiredCount (gauge)
    Number of messages that have expired from the queue.
  • gauge.amq.queue.ForwardCount (gauge)
    Number of messages that have been forwarded from this queue to a networked broker.
  • gauge.amq.queue.InFlightCount (gauge)
    The number of messages that have been dispatched to consumers, but not acknowledged.
  • gauge.amq.queue.ProducerCount (gauge)
    Number of producers publishing to this queue
  • gauge.amq.queue.QueueSize (gauge)
    The number of messages in the queue that have yet to be consumed.
  • gauge.amq.queue.TotalBlockedTime (gauge)
    The total time (ms) that messages have spent blocked by Flow Control.
  • gauge.amq.topic.AverageBlockedTime (gauge)
    Average time (ms) that messages have been blocked by Flow Control.
  • gauge.amq.topic.AverageEnqueueTime (gauge)
    Average time (ms) that messages have been held at this destination.
  • gauge.amq.topic.AverageMessageSize (gauge)
    Average size of messages on this topic, in bytes.
  • gauge.amq.topic.BlockedSends (gauge)
    Number of messages blocked by Flow Control
  • gauge.amq.topic.ConsumerCount (gauge)
    The number of consumers subscribed to this topic
  • gauge.amq.topic.DequeueCount (gauge)
    Number of messages that have been acknowledged and removed from the topic.
  • gauge.amq.topic.EnqueueCount (gauge)
    The number of messages that have been sent to the topic.
  • gauge.amq.topic.ExpiredCount (gauge)
    The number of messages that have expired from this topic.
  • gauge.amq.topic.ForwardCount (gauge)
    The number of messages that have been forwarded from this topic to a networked broker.
  • gauge.amq.topic.InFlightCount (gauge)
    The number of messages that have been dispatched to consumers, but have not yet been acknowledged.
  • gauge.amq.topic.ProducerCount (gauge)
    Number of producers publishing to this topic.
  • gauge.amq.topic.QueueSize (gauge)
    Number of messages in the topic that have yet to be consumed.
  • gauge.amq.topic.TotalBlockedTime (gauge)
    The total time (ms) that messages have spent blocked by Flow Control

Group jvm πŸ”—

All of the following metrics are part of the jvm metric group. All of the non-default metrics below can be turned on by adding jvm to the monitor config option extraGroups:

  • gauge.jvm.threads.count (gauge)
    Number of JVM threads
  • gauge.loaded_classes (gauge)
    Number of classes loaded in the JVM
  • invocations (cumulative)
    Total number of garbage collection events
  • jmx_memory.committed (gauge)
    Amount of memory guaranteed to be available in bytes
  • jmx_memory.init (gauge)
    Amount of initial memory at startup in bytes
  • jmx_memory.max (gauge)
    Maximum amount of memory that can be used in bytes
  • jmx_memory.used (gauge)
    Current memory usage in bytes
  • total_time_in_ms.collection_time (cumulative)
    Amount of time spent garbage collecting in milliseconds

Non-default metrics (version 4.7.0+) πŸ”—

The following information applies to the agent version 4.7.0+ that has enableBuiltInFiltering: true set on the top level of the agent config.

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Legacy non-default metrics (version < 4.7.0) πŸ”—

The following information only applies to agent versions prior to 4.7.0. If you have a newer agent and have set enableBuiltInFiltering: true at the top level of your agent config, see the section above. See upgrade instructions in Old-style inclusion list filtering.

If you have a reference to the whitelist.json in your agent’s top-level metricsToExclude config option, and you want to emit metrics that are not in that allow list, then you need to add an item to the top-level metricsToInclude config option to override that allow list (see Inclusion filtering. Or you can just copy the whitelist.json, modify it, and reference that in metricsToExclude.