README
¶
ActiveMQ collector
Overview
ActiveMQ is an open source message broker written in Java together with a full Java Message Service client.
This plugin collects queues and topics metrics using ActiveMQ Console API.
Collected metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
global
The metrics apply to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| activemq.messages | enqueued, dequeued | messages/s |
| activemq.unprocessed_messages | unprocessed | messages |
| activemq.consumers | consumers | consumers |
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name is go.d/activemq.conf.
The file format is YAML. Generally the format is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name1
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/activemq.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
Config options
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | |
| autodetection_retry | Re-check interval in seconds. Zero means not to schedule re-check. | 0 | |
| url | Server URL. | http://localhost:8161 | yes |
| webadmin | Webadmin root path. | admin | yes |
| max_queues | Maximum number of concurrently collected queues. | 50 | |
| max_topics | Maximum number of concurrently collected topics. | 50 | |
| queues_filter | Queues filter. Syntax is simple patterns. | ||
| topics_filter | Topics filter. Syntax is simple patterns. | ||
| username | Username for basic HTTP authentication. | ||
| password | Password for basic HTTP authentication. | ||
| proxy_username | Username for proxy basic HTTP authentication. | ||
| proxy_password | Password for proxy basic HTTP authentication. | ||
| method | HTTP request method. | GET | |
| timeout | HTTP request timeout. | 1 | |
| body | HTTP request body. | ||
| headers | HTTP request headers. | ||
| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | |
| tls_ca | Certification authority that the client uses when verifying the server's certificates. | ||
| tls_cert | Client TLS certificate. | ||
| tls_key | Client TLS key. |
Examples
A basic example configuration.
Config
jobs:
- name: local
url: http://127.0.0.1:8161
webadmin: admin
Basic HTTP authentication.
Config
jobs:
- name: local
url: http://127.0.0.1:8161
webadmin: admin
username: foo
password: bar
Using filters and limits for queues and topics.
Config
jobs:
- name: local
url: http://127.0.0.1:8161
webadmin: admin
max_queues: 100
max_topics: 100
queues_filter: '!sandr* *'
topics_filter: '!sandr* *'
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
Config
jobs:
- name: local
url: http://127.0.0.1:8161
webadmin: admin
- name: remote
url: http://192.0.2.1:8161
webadmin: admin
Troubleshooting
Debug mode
To troubleshoot issues with the activemq collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn't working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that's not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m activemq
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActiveMQ ¶ added in v0.5.0
type ActiveMQ struct {
module.Base
Config `yaml:",inline"`
// contains filtered or unexported fields
}
ActiveMQ ActiveMQ module.
type Config ¶ added in v0.5.0
type Config struct {
web.HTTP `yaml:",inline"`
Webadmin string `yaml:"webadmin"`
MaxQueues int `yaml:"max_queues"`
MaxTopics int `yaml:"max_topics"`
QueuesFilter string `yaml:"queues_filter"`
TopicsFilter string `yaml:"topics_filter"`
}
Config is the ActiveMQ module configuration.
Source Files