summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/rabbitmq/metadata.yaml
blob: f0a17b9e7fbcc8c9bc1d97db944a67ffdbc9465a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-rabbitmq
      plugin_name: go.d.plugin
      module_name: rabbitmq
      monitored_instance:
        name: RabbitMQ
        link: https://www.rabbitmq.com/
        icon_filename: rabbitmq.svg
        categories:
          - data-collection.message-brokers
      keywords:
        - rabbitmq
        - message brokers
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors RabbitMQ instances.
          
          It collects data using an HTTP-based API provided by the [management plugin](https://www.rabbitmq.com/management.html).
          The following endpoints are used:
          
          - `/api/overview`
          - `/api/node/{node_name}`
          - `/api/vhosts`
          - `/api/queues` (disabled by default)
        method_description: ""
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: ""
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: Enable management plugin.
            description: |
              The management plugin is included in the RabbitMQ distribution, but disabled.
              To enable see [Management Plugin](https://www.rabbitmq.com/management.html#getting-started) documentation.
      configuration:
        file:
          name: go.d/rabbitmq.conf
        options:
          description: |
            The following options can be defined globally: update_every, autodetection_retry.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 1
              required: false
            - name: autodetection_retry
              description: Recheck interval in seconds. Zero means no recheck will be scheduled.
              default_value: 0
              required: false
            - name: url
              description: Server URL.
              default_value: http://localhost:15672
              required: true
            - name: collect_queues_metrics
              description: Collect stats per vhost per queues. Enabling this can introduce serious overhead on both Netdata and RabbitMQ if many queues are configured and used.
              default_value: false
              required: false
            - name: timeout
              description: HTTP request timeout.
              default_value: 1
              required: false
            - name: username
              description: Username for basic HTTP authentication.
              default_value: ""
              required: false
            - name: password
              description: Password for basic HTTP authentication.
              default_value: ""
              required: false
            - name: proxy_url
              description: Proxy URL.
              default_value: ""
              required: false
            - name: proxy_username
              description: Username for proxy basic HTTP authentication.
              default_value: ""
              required: false
            - name: proxy_password
              description: Password for proxy basic HTTP authentication.
              default_value: ""
              required: false
            - name: method
              description: HTTP request method.
              default_value: GET
              required: false
            - name: body
              description: HTTP request body.
              default_value: ""
              required: false
            - name: headers
              description: HTTP request headers.
              default_value: ""
              required: false
            - name: not_follow_redirects
              description: Redirect handling policy. Controls whether the client follows redirects.
              default_value: false
              required: false
            - name: tls_skip_verify
              description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
              default_value: false
              required: false
            - name: tls_ca
              description: Certification authority that the client uses when verifying the server's certificates.
              default_value: ""
              required: false
            - name: tls_cert
              description: Client TLS certificate.
              default_value: ""
              required: false
            - name: tls_key
              description: Client TLS key.
              default_value: ""
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Basic
              description: An example configuration.
              config: |
                jobs:
                  - name: local
                    url: http://127.0.0.1:15672
            - name: Basic HTTP auth
              description: Local server with basic HTTP authentication.
              config: |
                jobs:
                  - name: local
                    url: http://127.0.0.1:15672
                    username: admin
                    password: password
            - name: Multi-instance
              description: |
                > **Note**: When you define multiple jobs, their names must be unique.
                
                Local and remote instances.
              config: |
                jobs:
                  - name: local
                    url: http://127.0.0.1:15672
                
                  - name: remote
                    url: http://192.0.2.0:15672
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: These metrics refer to the entire monitored application.
          labels: []
          metrics:
            - name: rabbitmq.messages_count
              description: Messages
              unit: messages
              chart_type: stacked
              dimensions:
                - name: ready
                - name: unacknowledged
            - name: rabbitmq.messages_rate
              description: Messages
              unit: messages/s
              chart_type: line
              dimensions:
                - name: ack
                - name: publish
                - name: publish_in
                - name: publish_out
                - name: confirm
                - name: deliver
                - name: deliver_no_ack
                - name: get
                - name: get_no_ack
                - name: deliver_get
                - name: redeliver
                - name: return_unroutable
            - name: rabbitmq.objects_count
              description: Objects
              unit: messages
              chart_type: line
              dimensions:
                - name: channels
                - name: consumers
                - name: connections
                - name: queues
                - name: exchanges
            - name: rabbitmq.connection_churn_rate
              description: Connection churn
              unit: operations/s
              chart_type: line
              dimensions:
                - name: created
                - name: closed
            - name: rabbitmq.channel_churn_rate
              description: Channel churn
              unit: operations/s
              chart_type: line
              dimensions:
                - name: created
                - name: closed
            - name: rabbitmq.queue_churn_rate
              description: Queue churn
              unit: operations/s
              chart_type: line
              dimensions:
                - name: created
                - name: deleted
                - name: declared
            - name: rabbitmq.file_descriptors_count
              description: File descriptors
              unit: fd
              chart_type: stacked
              dimensions:
                - name: available
                - name: used
            - name: rabbitmq.sockets_count
              description: Used sockets
              unit: sockets
              chart_type: stacked
              dimensions:
                - name: available
                - name: used
            - name: rabbitmq.erlang_processes_count
              description: Erlang processes
              unit: processes
              chart_type: stacked
              dimensions:
                - name: available
                - name: used
            - name: rabbitmq.erlang_run_queue_processes_count
              description: Erlang run queue
              unit: processes
              chart_type: line
              dimensions:
                - name: length
            - name: rabbitmq.memory_usage
              description: Memory
              unit: bytes
              chart_type: line
              dimensions:
                - name: used
            - name: rabbitmq.disk_space_free_size
              description: Free disk space
              unit: bytes
              chart_type: line
              dimensions:
                - name: free
        - name: vhost
          description: These metrics refer to the virtual host.
          labels:
            - name: vhost
              description: virtual host name
          metrics:
            - name: rabbitmq.vhost_messages_count
              description: Vhost messages
              unit: messages
              chart_type: line
              dimensions:
                - name: ready
                - name: unacknowledged
            - name: rabbitmq.vhost_messages_rate
              description: Vhost messages rate
              unit: messages/s
              chart_type: line
              dimensions:
                - name: ack
                - name: publish
                - name: publish_in
                - name: publish_out
                - name: confirm
                - name: deliver
                - name: deliver_no_ack
                - name: get
                - name: get_no_ack
                - name: deliver_get
                - name: redeliver
                - name: return_unroutable
        - name: queue
          description: These metrics refer to the virtual host queue.
          labels:
            - name: vhost
              description: virtual host name
            - name: queue
              description: queue name
          metrics:
            - name: rabbitmq.queue_messages_count
              description: Queue messages
              unit: messages
              chart_type: line
              dimensions:
                - name: ready
                - name: unacknowledged
                - name: paged_out
                - name: persistent
            - name: rabbitmq.queue_messages_rate
              description: Queue messages rate
              unit: messages/s
              chart_type: line
              dimensions:
                - name: ack
                - name: publish
                - name: publish_in
                - name: publish_out
                - name: confirm
                - name: deliver
                - name: deliver_no_ack
                - name: get
                - name: get_no_ack
                - name: deliver_get
                - name: redeliver
                - name: return_unroutable