blob: 2ec25fb771812bf4d6db1b013163472a7bfdbdf2 (
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-vernemq
plugin_name: go.d.plugin
module_name: vernemq
monitored_instance:
name: VerneMQ
link: https://vernemq.com
icon_filename: vernemq.svg
categories:
- data-collection.message-brokers
keywords:
- vernemq
- message brokers
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors VerneMQ instances.
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: []
configuration:
file:
name: go.d/vernemq.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://127.0.0.1:8888/metrics
required: true
- 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:8888/metrics
- name: HTTP authentication
description: Local instance with basic HTTP authentication.
config: |
jobs:
- name: local
url: http://127.0.0.1:8888/metrics
username: username
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:8888/metrics
- name: remote
url: http://203.0.113.10:8888/metrics
troubleshooting:
problems:
list: []
alerts:
- name: vernemq_socket_errors
metric: vernemq.socket_errors
info: number of socket errors in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_queue_message_drop
metric: vernemq.queue_undelivered_messages
info: number of dropped messaged due to full queues in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_queue_message_expired
metric: vernemq.queue_undelivered_messages
info: number of messages which expired before delivery in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_queue_message_unhandled
metric: vernemq.queue_undelivered_messages
info: "number of unhandled messages (connections with clean session=true) in the last minute"
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_average_scheduler_utilization
metric: vernemq.average_scheduler_utilization
info: average scheduler utilization over the last 10 minutes
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_cluster_dropped
metric: vernemq.cluster_dropped
info: amount of traffic dropped during communication with the cluster nodes in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_netsplits
metric: vvernemq.netsplits
info: "number of detected netsplits (split brain situation) in the last minute"
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_connack_sent_reason_unsuccessful
metric: vernemq.mqtt_connack_sent_reason
info: number of sent unsuccessful v3/v5 CONNACK packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_disconnect_received_reason_not_normal
metric: vernemq.mqtt_disconnect_received_reason
info: number of received not normal v5 DISCONNECT packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_disconnect_sent_reason_not_normal
metric: vernemq.mqtt_disconnect_sent_reason
info: number of sent not normal v5 DISCONNECT packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_subscribe_error
metric: vernemq.mqtt_subscribe_error
info: number of failed v3/v5 SUBSCRIBE operations in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_subscribe_auth_error
metric: vernemq.mqtt_subscribe_auth_error
info: number of unauthorized v3/v5 SUBSCRIBE attempts in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_unsubscribe_error
metric: vernemq.mqtt_unsubscribe_error
info: number of failed v3/v5 UNSUBSCRIBE operations in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_publish_errors
metric: vernemq.mqtt_publish_errors
info: number of failed v3/v5 PUBLISH operations in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_publish_auth_errors
metric: vernemq.mqtt_publish_auth_errors
info: number of unauthorized v3/v5 PUBLISH attempts in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_puback_received_reason_unsuccessful
metric: vernemq.mqtt_puback_received_reason
info: number of received unsuccessful v5 PUBACK packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_puback_sent_reason_unsuccessful
metric: vernemq.mqtt_puback_sent_reason
info: number of sent unsuccessful v5 PUBACK packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_puback_unexpected
metric: vernemq.mqtt_puback_invalid_error
info: number of received unexpected v3/v5 PUBACK packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubrec_received_reason_unsuccessful
metric: vernemq.mqtt_pubrec_received_reason
info: number of received unsuccessful v5 PUBREC packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubrec_sent_reason_unsuccessful
metric: vernemq.mqtt_pubrec_sent_reason
info: number of sent unsuccessful v5 PUBREC packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubrec_invalid_error
metric: vernemq.mqtt_pubrec_invalid_error
info: number of received unexpected v3 PUBREC packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubrel_received_reason_unsuccessful
metric: vernemq.mqtt_pubrel_received_reason
info: number of received unsuccessful v5 PUBREL packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubrel_sent_reason_unsuccessful
metric: vernemq.mqtt_pubrel_sent_reason
info: number of sent unsuccessful v5 PUBREL packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubcomp_received_reason_unsuccessful
metric: vernemq.mqtt_pubcomp_received_reason
info: number of received unsuccessful v5 PUBCOMP packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubcomp_sent_reason_unsuccessful
metric: vernemq.mqtt_pubcomp_sent_reason
info: number of sent unsuccessful v5 PUBCOMP packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
- name: vernemq_mqtt_pubcomp_unexpected
metric: vernemq.mqtt_pubcomp_invalid_error
info: number of received unexpected v3/v5 PUBCOMP packets in the last minute
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vernemq.conf
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: These metrics refer to the entire monitored application.
labels: []
metrics:
- name: vernemq.sockets
description: Open Sockets
unit: sockets
chart_type: line
dimensions:
- name: open
- name: vernemq.socket_operations
description: Socket Open and Close Events
unit: sockets/s
chart_type: line
dimensions:
- name: open
- name: close
- name: vernemq.client_keepalive_expired
description: Closed Sockets due to Keepalive Time Expired
unit: sockets/s
chart_type: line
dimensions:
- name: closed
- name: vernemq.socket_close_timeout
description: Closed Sockets due to no CONNECT Frame On Time
unit: sockets/s
chart_type: line
dimensions:
- name: closed
- name: vernemq.socket_errors
description: Socket Errors
unit: errors/s
chart_type: line
dimensions:
- name: errors
- name: vernemq.queue_processes
description: Living Queues in an Online or an Offline State
unit: queue processes
chart_type: line
dimensions:
- name: queue_processes
- name: vernemq.queue_processes_operations
description: Queue Processes Setup and Teardown Events
unit: events/s
chart_type: line
dimensions:
- name: setup
- name: teardown
- name: vernemq.queue_process_init_from_storage
description: Queue Processes Initialized from Offline Storage
unit: queue processes/s
chart_type: line
dimensions:
- name: queue_processes
- name: vernemq.queue_messages
description: Received and Sent PUBLISH Messages
unit: messages/s
chart_type: area
dimensions:
- name: received
- name: sent
- name: vernemq.queue_undelivered_messages
description: Undelivered PUBLISH Messages
unit: messages/s
chart_type: stacked
dimensions:
- name: dropped
- name: expired
- name: unhandled
- name: vernemq.router_subscriptions
description: Subscriptions in the Routing Table
unit: subscriptions
chart_type: line
dimensions:
- name: subscriptions
- name: vernemq.router_matched_subscriptions
description: Matched Subscriptions
unit: subscriptions/s
chart_type: line
dimensions:
- name: local
- name: remote
- name: vernemq.router_memory
description: Routing Table Memory Usage
unit: KiB
chart_type: area
dimensions:
- name: used
- name: vernemq.average_scheduler_utilization
description: Average Scheduler Utilization
unit: percentage
chart_type: area
dimensions:
- name: utilization
- name: vernemq.system_utilization_scheduler
description: Scheduler Utilization
unit: percentage
chart_type: stacked
dimensions:
- name: a dimension per scheduler
- name: vernemq.system_processes
description: Erlang Processes
unit: processes
chart_type: line
dimensions:
- name: processes
- name: vernemq.system_reductions
description: Reductions
unit: ops/s
chart_type: line
dimensions:
- name: reductions
- name: vernemq.system_context_switches
description: Context Switches
unit: ops/s
chart_type: line
dimensions:
- name: context_switches
- name: vernemq.system_io
description: Received and Sent Traffic through Ports
unit: kilobits/s
chart_type: area
dimensions:
- name: received
- name: sent
- name: vernemq.system_run_queue
description: Processes that are Ready to Run on All Run-Queues
unit: processes
chart_type: line
dimensions:
- name: ready
- name: vernemq.system_gc_count
description: GC Count
unit: ops/s
chart_type: line
dimensions:
- name: gc
- name: vernemq.system_gc_words_reclaimed
description: GC Words Reclaimed
unit: ops/s
chart_type: line
dimensions:
- name: words_reclaimed
- name: vernemq.system_allocated_memory
description: Memory Allocated by the Erlang Processes and by the Emulator
unit: KiB
chart_type: stacked
dimensions:
- name: processes
- name: system
- name: vernemq.bandwidth
description: Bandwidth
unit: kilobits/s
chart_type: area
dimensions:
- name: received
- name: sent
- name: vernemq.retain_messages
description: Stored Retained Messages
unit: messages
chart_type: line
dimensions:
- name: messages
- name: vernemq.retain_memory
description: Stored Retained Messages Memory Usage
unit: KiB
chart_type: area
dimensions:
- name: used
- name: vernemq.cluster_bandwidth
description: Communication with Other Cluster Nodes
unit: kilobits/s
chart_type: area
dimensions:
- name: received
- name: sent
- name: vernemq.cluster_dropped
description: Traffic Dropped During Communication with Other Cluster Nodes
unit: kilobits/s
chart_type: area
dimensions:
- name: dropped
- name: vernemq.netsplit_unresolved
description: Unresolved Netsplits
unit: netsplits
chart_type: line
dimensions:
- name: unresolved
- name: vernemq.netsplits
description: Netsplits
unit: netsplits/s
chart_type: stacked
dimensions:
- name: resolved
- name: detected
- name: vernemq.mqtt_auth
description: v5 AUTH
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_auth_received_reason
description: v5 AUTH Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_auth_sent_reason
description: v5 AUTH Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_connect
description: v3/v5 CONNECT and CONNACK
unit: packets/s
chart_type: line
dimensions:
- name: connect
- name: connack
- name: vernemq.mqtt_connack_sent_reason
description: v3/v5 CONNACK Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_disconnect
description: v3/v5 DISCONNECT
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_disconnect_received_reason
description: v5 DISCONNECT Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_disconnect_sent_reason
description: v5 DISCONNECT Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_subscribe
description: v3/v5 SUBSCRIBE and SUBACK
unit: packets/s
chart_type: line
dimensions:
- name: subscribe
- name: suback
- name: vernemq.mqtt_subscribe_error
description: v3/v5 Failed SUBSCRIBE Operations due to a Netsplit
unit: ops/s
chart_type: line
dimensions:
- name: failed
- name: vernemq.mqtt_subscribe_auth_error
description: v3/v5 Unauthorized SUBSCRIBE Attempts
unit: attempts/s
chart_type: line
dimensions:
- name: unauth
- name: vernemq.mqtt_unsubscribe
description: v3/v5 UNSUBSCRIBE and UNSUBACK
unit: packets/s
chart_type: line
dimensions:
- name: unsubscribe
- name: unsuback
- name: vernemq.mqtt_unsubscribe_error
description: v3/v5 Failed UNSUBSCRIBE Operations due to a Netsplit
unit: ops/s
chart_type: line
dimensions:
- name: mqtt_unsubscribe_error
- name: vernemq.mqtt_publish
description: v3/v5 QoS 0,1,2 PUBLISH
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_publish_errors
description: v3/v5 Failed PUBLISH Operations due to a Netsplit
unit: ops/s
chart_type: line
dimensions:
- name: failed
- name: vernemq.mqtt_publish_auth_errors
description: v3/v5 Unauthorized PUBLISH Attempts
unit: attempts/s
chart_type: area
dimensions:
- name: unauth
- name: vernemq.mqtt_puback
description: v3/v5 QoS 1 PUBACK
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_puback_received_reason
description: v5 PUBACK QoS 1 Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_puback_sent_reason
description: v5 PUBACK QoS 1 Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_puback_invalid_error
description: v3/v5 PUBACK QoS 1 Received Unexpected Messages
unit: messages/s
chart_type: line
dimensions:
- name: unexpected
- name: vernemq.mqtt_pubrec
description: v3/v5 PUBREC QoS 2
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_pubrec_received_reason
description: v5 PUBREC QoS 2 Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubrec_sent_reason
description: v5 PUBREC QoS 2 Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubrec_invalid_error
description: v3 PUBREC QoS 2 Received Unexpected Messages
unit: messages/s
chart_type: line
dimensions:
- name: unexpected
- name: vernemq.mqtt_pubrel
description: v3/v5 PUBREL QoS 2
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_pubrel_received_reason
description: v5 PUBREL QoS 2 Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubrel_sent_reason
description: v5 PUBREL QoS 2 Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubcom
description: v3/v5 PUBCOMP QoS 2
unit: packets/s
chart_type: line
dimensions:
- name: received
- name: sent
- name: vernemq.mqtt_pubcomp_received_reason
description: v5 PUBCOMP QoS 2 Received by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubcomp_sent_reason
description: v5 PUBCOMP QoS 2 Sent by Reason
unit: packets/s
chart_type: stacked
dimensions:
- name: a dimensions per reason
- name: vernemq.mqtt_pubcomp_invalid_error
description: v3/v5 PUBCOMP QoS 2 Received Unexpected Messages
unit: messages/s
chart_type: line
dimensions:
- name: unexpected
- name: vernemq.mqtt_ping
description: v3/v5 PING
unit: packets/s
chart_type: line
dimensions:
- name: pingreq
- name: pingresp
- name: vernemq.node_uptime
description: Node Uptime
unit: seconds
chart_type: line
dimensions:
- name: time
|