master
yaml 276 lines 9.38 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-activemq
5 module_name: activemq
6 plugin_name: go.d.plugin
7 monitored_instance:
8 categories:
9 - data-collection.databases
10 icon_filename: activemq.png
11 name: ActiveMQ
12 link: https://activemq.apache.org/
13 alternative_monitored_instances: []
14 keywords:
15 - message broker
16 info_provided_to_referring_integrations:
17 description: ""
18 related_resources:
19 integrations:
20 list:
21 - plugin_name: go.d.plugin
22 module_name: httpcheck
23 - plugin_name: apps.plugin
24 module_name: apps
25 overview:
26 data_collection:
27 metrics_description: This collector monitors ActiveMQ queues and topics.
28 method_description: It collects metrics by sending HTTP requests to the Web Console API.
29 additional_permissions:
30 description: ""
31 default_behavior:
32 auto_detection:
33 description: |
34 This collector discovers instances running on the local host that provide metrics on port 8161.
35 On startup, it tries to collect metrics from:
36
37 - http://localhost:8161
38 limits:
39 description: ""
40 performance_impact:
41 description: ""
42 multi_instance: true
43 supported_platforms:
44 include: []
45 exclude: []
46 setup:
47 prerequisites:
48 list: []
49 configuration:
50 file:
51 name: go.d/activemq.conf
52 options:
53 description: |
54 The following options can be defined globally: update_every, autodetection_retry.
55 folding:
56 title: Config options
57 enabled: true
58 list:
59 - name: update_every
60 description: Data collection interval (seconds).
61 default_value: 1
62 required: false
63 group: Collection
64 - name: autodetection_retry
65 description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 group: Collection
69
70 - name: url
71 description: Target endpoint URL.
72 default_value: http://127.0.0.1:8161
73 required: true
74 group: Target
75 - name: timeout
76 description: HTTP request timeout (seconds).
77 default_value: 1
78 required: false
79 group: Target
80 - name: webadmin
81 description: Webadmin root path.
82 default_value: admin
83 required: true
84 group: Target
85
86 - name: max_queues
87 description: Maximum number of queues to collect concurrently.
88 default_value: 50
89 required: false
90 group: Limits
91 - name: max_topics
92 description: Maximum number of topics to collect concurrently.
93 default_value: 50
94 required: false
95 group: Limits
96
97 - name: queues_filter
98 description: Queue selector. Uses [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
99 default_value: ""
100 required: false
101 group: Filters
102 - name: topics_filter
103 description: Topic selector. Uses [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
104 default_value: ""
105 required: false
106 group: Filters
107
108 - name: username
109 description: Username for Basic HTTP authentication.
110 default_value: ""
111 required: false
112 group: HTTP Auth
113 - name: password
114 description: Password for Basic HTTP authentication.
115 default_value: ""
116 required: false
117 group: HTTP Auth
118 - name: bearer_token_file
119 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
120 default_value: ""
121 required: false
122 group: HTTP Auth
123
124 - name: tls_skip_verify
125 description: Skip TLS certificate and hostname verification (insecure).
126 default_value: no
127 required: false
128 group: TLS
129 - name: tls_ca
130 description: Path to CA bundle used to validate the server certificate.
131 default_value: ""
132 required: false
133 group: TLS
134 - name: tls_cert
135 description: Path to client TLS certificate (for mTLS).
136 default_value: ""
137 required: false
138 group: TLS
139 - name: tls_key
140 description: Path to client TLS private key (for mTLS).
141 default_value: ""
142 required: false
143 group: TLS
144
145 - name: proxy_url
146 description: HTTP proxy URL.
147 default_value: ""
148 required: false
149 group: Proxy
150 - name: proxy_username
151 description: Username for proxy Basic HTTP authentication.
152 default_value: ""
153 required: false
154 group: Proxy
155 - name: proxy_password
156 description: Password for proxy Basic HTTP authentication.
157 default_value: ""
158 required: false
159 group: Proxy
160
161 - name: method
162 description: HTTP method to use.
163 default_value: "GET"
164 required: false
165 group: Request
166 - name: body
167 description: Request body (e.g., for POST/PUT).
168 default_value: ""
169 required: false
170 group: Request
171 - name: headers
172 description: "Additional HTTP headers (one per line as key: value)."
173 default_value: ""
174 required: false
175 group: Request
176 - name: not_follow_redirects
177 description: Do not follow HTTP redirects.
178 default_value: no
179 required: false
180 group: Request
181 - name: force_http2
182 description: Force HTTP/2 (including h2c over TCP).
183 default_value: no
184 required: false
185 group: Request
186
187 - name: vnode
188 description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).
189 default_value: ""
190 required: false
191 group: Virtual Node
192 examples:
193 folding:
194 title: Config
195 enabled: true
196 list:
197 - name: Basic
198 folding:
199 enabled: false
200 description: A basic example configuration.
201 config: |
202 jobs:
203 - name: local
204 url: http://127.0.0.1:8161
205 webadmin: admin
206 - name: HTTP authentication
207 description: Basic HTTP authentication.
208 config: |
209 jobs:
210 - name: local
211 url: http://127.0.0.1:8161
212 webadmin: admin
213 username: foo
214 password: bar
215 - name: Filters and limits
216 description: Using filters and limits for queues and topics.
217 config: |
218 jobs:
219 - name: local
220 url: http://127.0.0.1:8161
221 webadmin: admin
222 max_queues: 100
223 max_topics: 100
224 queues_filter: '!sandr* *'
225 topics_filter: '!sandr* *'
226 - name: Multi-instance
227 description: |
228 > **Note**: When you define multiple jobs, their names must be unique.
229
230 Collecting metrics from local and remote instances.
231 config: |
232 jobs:
233 - name: local
234 url: http://127.0.0.1:8161
235 webadmin: admin
236
237 - name: remote
238 url: http://192.0.2.1:8161
239 webadmin: admin
240 troubleshooting:
241 problems:
242 list: []
243 alerts: []
244 metrics:
245 folding:
246 title: Metrics
247 enabled: false
248 description: ""
249 availability: []
250 scopes:
251 - name: global
252 description: These metrics refer to the entire monitored application.
253 labels: []
254 metrics:
255 - name: activemq.messages
256 availability: []
257 description: Messaged
258 unit: messages/s
259 chart_type: line
260 dimensions:
261 - name: enqueued
262 - name: dequeued
263 - name: activemq.unprocessed_messages
264 availability: []
265 description: Unprocessed Messages
266 unit: messages
267 chart_type: line
268 dimensions:
269 - name: unprocessed
270 - name: activemq.consumers
271 availability: []
272 description: Consumers
273 unit: consumers
274 chart_type: line
275 dimensions:
276 - name: consumers