////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: activemq

[[metricbeat-module-activemq]]
[role="xpack"]
== ActiveMQ module

This module periodically fetches JMX metrics from Apache ActiveMQ.

[float]
=== Compatibility
The module has been tested with ActiveMQ 5.13.0 and 5.15.9. Other versions are expected to work.

[float]
=== Usage
The ActiveMQ module requires <<metricbeat-module-jolokia,Jolokia>>to fetch JMX metrics. Refer to the link for instructions about how to use Jolokia.


[float]
=== Example configuration

The ActiveMQ module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: activemq
  metricsets: ['broker', 'queue', 'topic']
  period: 10s
  hosts: ['localhost:8161']
  path: '/api/jolokia/?ignoreErrors=true&canonicalNaming=false'
  username: admin # default username
  password: admin # default password
----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-activemq-broker,broker>>

* <<metricbeat-metricset-activemq-queue,queue>>

* <<metricbeat-metricset-activemq-topic,topic>>

include::activemq/broker.asciidoc[]

include::activemq/queue.asciidoc[]

include::activemq/topic.asciidoc[]

