master
yaml 767 lines 26.8 KB
Raw
1 # Generated metadata.yaml for mq module
2 plugin_name: ibm.d.plugin
3 modules:
4 - meta:
5 plugin_name: ibm.d.plugin
6 module_name: mq
7 monitored_instance:
8 name: IBM MQ
9 link: https://www.ibm.com/products/mq
10 categories:
11 - data-collection.applications
12 icon_filename: "ibm-mq.png"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - mq
20 overview:
21 data_collection:
22 metrics_description: |
23 Monitors IBM MQ queue managers, queues, channels, and topics
24 using the PCF (Programmable Command Format) protocol.
25
26 By default the collector tracks the critical system queues `SYSTEM.DEAD.LETTER.QUEUE`,
27 `SYSTEM.ADMIN.COMMAND.QUEUE`, and `SYSTEM.ADMIN.STATISTICS.QUEUE`. All other queues are
28 opt-in via the `include_queues` list, with `exclude_queues` removing noisy patterns such as
29 `SYSTEM.*` or `AMQ.*`. Include patterns take precedence over excludes so you can safely
30 monitor individual system queues while dropping the broader wildcard.
31
32 Per-queue charts are bounded by `max_queues` (default 50). When more queues are discovered,
33 the collector exports the busiest ones individually, rolls the remainder into an
34 aggregated `__other__` dimension, and logs a throttled warning listing the overflowed
35 groups. Parallel queue-group charts summarise depth, traffic, and backlog per naming
36 prefix (first two dot-separated segments, collapsing all `SYSTEM.*` queues together), so
37 high-level visibility is never lost even when detailed charts are trimmed.
38
39 method_description: |
40 The collector connects to IBM MQ and collects metrics via its monitoring interface.
41 supported_platforms:
42 include: []
43 exclude: []
44 multi_instance: true
45 additional_permissions:
46 description: ""
47 default_behavior:
48 auto_detection:
49 description: ""
50 limits:
51 description: ""
52 performance_impact:
53 description: ""
54 setup:
55 prerequisites:
56 list:
57 - title: Enable monitoring interface
58 description: |
59 Ensure the IBM MQ monitoring interface is accessible.
60 configuration:
61 file:
62 name: ibm.d/mq.conf
63 options:
64 description: |
65 Configuration options for the mq collector.
66 folding:
67 title: Config options
68 enabled: true
69 list:
70 - name: update_every
71 description: Data collection frequency.
72 default_value: 1
73 required: false
74 - name: endpoint
75 description: Connection endpoint.
76 default_value: "dummy://localhost"
77 required: false
78 examples:
79 folding:
80 enabled: true
81 title: Config
82 list:
83 - name: Basic
84 description: Basic configuration example.
85 config: |
86 jobs:
87 - name: local
88 endpoint: dummy://localhost
89 troubleshooting:
90 problems:
91 list: []
92 alerts: []
93 metrics:
94 folding:
95 title: Metrics
96 enabled: false
97 description: ""
98 availability: []
99 scopes:
100 - name: channel
101 description: These metrics refer to channel instances.
102 labels:
103 - name: channel
104 description: Channel identifier
105 - name: type
106 description: Type identifier
107 metrics:
108 - name: mq.channel.status
109 description: Channel Status
110 unit: status
111 chart_type: stacked
112 dimensions:
113 - name: inactive
114 - name: binding
115 - name: starting
116 - name: running
117 - name: stopping
118 - name: retrying
119 - name: stopped
120 - name: requesting
121 - name: paused
122 - name: disconnected
123 - name: initializing
124 - name: switching
125 - name: mq.channel.messages
126 description: Channel Message Rate
127 unit: messages/s
128 chart_type: line
129 dimensions:
130 - name: messages
131 - name: mq.channel.bytes
132 description: Channel Data Transfer Rate
133 unit: bytes/s
134 chart_type: line
135 dimensions:
136 - name: bytes
137 - name: mq.channel.batches
138 description: Channel Batch Rate
139 unit: batches/s
140 chart_type: line
141 dimensions:
142 - name: batches
143 - name: mq.channel.batch_size
144 description: Channel Batch Size
145 unit: messages
146 chart_type: line
147 dimensions:
148 - name: batch_size
149 - name: mq.channel.batch_interval
150 description: Channel Batch Interval
151 unit: milliseconds
152 chart_type: line
153 dimensions:
154 - name: batch_interval
155 - name: mq.channel.intervals
156 description: Channel Intervals
157 unit: seconds
158 chart_type: line
159 dimensions:
160 - name: disc_interval
161 - name: hb_interval
162 - name: keep_alive_interval
163 - name: mq.channel.short_retry_count
164 description: Channel Short Retry Count
165 unit: retries
166 chart_type: line
167 dimensions:
168 - name: short_retry
169 - name: mq.channel.long_retry_interval
170 description: Channel Long Retry Interval
171 unit: seconds
172 chart_type: line
173 dimensions:
174 - name: long_retry
175 - name: mq.channel.max_msg_length
176 description: Channel Max Message Length
177 unit: bytes
178 chart_type: line
179 dimensions:
180 - name: max_msg_length
181 - name: mq.channel.sharing_conversations
182 description: Channel Sharing Conversations
183 unit: conversations
184 chart_type: line
185 dimensions:
186 - name: sharing_conversations
187 - name: mq.channel.network_priority
188 description: Channel Network Priority
189 unit: priority
190 chart_type: line
191 dimensions:
192 - name: network_priority
193 - name: mq.channel.buffer_counts
194 description: Channel Buffer Counts
195 unit: buffers
196 chart_type: line
197 dimensions:
198 - name: sent
199 - name: received
200 - name: mq.channel.current_messages
201 description: Channel Current Messages
202 unit: messages
203 chart_type: line
204 dimensions:
205 - name: current
206 - name: mq.channel.xmitq_time
207 description: Channel Transmission Queue Time
208 unit: milliseconds
209 chart_type: line
210 dimensions:
211 - name: xmitq_time
212 - name: mq.channel.mca_status
213 description: Channel MCA Status
214 unit: status
215 chart_type: line
216 dimensions:
217 - name: mca_status
218 - name: mq.channel.indoubt_status
219 description: Channel In-Doubt Status
220 unit: status
221 chart_type: line
222 dimensions:
223 - name: indoubt_status
224 - name: mq.channel.ssl_key_resets
225 description: Channel SSL Key Resets
226 unit: resets
227 chart_type: line
228 dimensions:
229 - name: ssl_key_resets
230 - name: mq.channel.npm_speed
231 description: Channel Non-Persistent Message Speed
232 unit: speed
233 chart_type: line
234 dimensions:
235 - name: npm_speed
236 - name: mq.channel.current_sharing_convs
237 description: Channel Current Sharing Conversations
238 unit: conversations
239 chart_type: line
240 dimensions:
241 - name: current_sharing
242 - name: channelstatistics
243 description: These metrics refer to channelstatistics instances.
244 labels:
245 - name: channel
246 description: Channel identifier
247 - name: type
248 description: Type identifier
249 metrics:
250 - name: mq.channel_stats.messages
251 description: Channel Messages (Statistics)
252 unit: messages/s
253 chart_type: line
254 dimensions:
255 - name: messages
256 - name: mq.channel_stats.bytes
257 description: Channel Bytes (Statistics)
258 unit: bytes/s
259 chart_type: line
260 dimensions:
261 - name: bytes
262 - name: mq.channel_stats.batches
263 description: Channel Batches (Statistics)
264 unit: batches/s
265 chart_type: line
266 dimensions:
267 - name: full_batches
268 - name: incomplete_batches
269 - name: mq.channel_stats.batch_size
270 description: Channel Average Batch Size (Statistics)
271 unit: messages
272 chart_type: line
273 dimensions:
274 - name: avg_batch_size
275 - name: mq.channel_stats.put_retries
276 description: Channel Put Retries (Statistics)
277 unit: retries/s
278 chart_type: line
279 dimensions:
280 - name: put_retries
281 - name: listener
282 description: These metrics refer to listener instances.
283 labels:
284 - name: listener
285 description: Listener identifier
286 - name: port
287 description: Port identifier
288 - name: ip_address
289 description: Ip_address identifier
290 metrics:
291 - name: mq.listener.status
292 description: Listener Status
293 unit: status
294 chart_type: line
295 dimensions:
296 - name: stopped
297 - name: starting
298 - name: running
299 - name: stopping
300 - name: retrying
301 - name: mq.listener.backlog
302 description: Listener Connection Backlog
303 unit: connections
304 chart_type: line
305 dimensions:
306 - name: backlog
307 - name: mq.listener.uptime
308 description: Listener Uptime
309 unit: seconds
310 chart_type: line
311 dimensions:
312 - name: uptime
313 - name: mqistatistics
314 description: These metrics refer to mqistatistics instances.
315 labels:
316 - name: queue_manager
317 description: Queue_manager identifier
318 metrics:
319 - name: mq.mqi_stats.opens
320 description: MQOPEN Operations (Statistics)
321 unit: operations/s
322 chart_type: line
323 dimensions:
324 - name: opens_total
325 - name: opens_failed
326 - name: mq.mqi_stats.closes
327 description: MQCLOSE Operations (Statistics)
328 unit: operations/s
329 chart_type: line
330 dimensions:
331 - name: closes_total
332 - name: closes_failed
333 - name: mq.mqi_stats.inqs
334 description: MQINQ Operations (Statistics)
335 unit: operations/s
336 chart_type: line
337 dimensions:
338 - name: inqs_total
339 - name: inqs_failed
340 - name: mq.mqi_stats.sets
341 description: MQSET Operations (Statistics)
342 unit: operations/s
343 chart_type: line
344 dimensions:
345 - name: sets_total
346 - name: sets_failed
347 - name: queue
348 description: These metrics refer to queue instances.
349 labels:
350 - name: queue
351 description: Queue identifier
352 - name: type
353 description: Type identifier
354 metrics:
355 - name: mq.queue.depth
356 description: Queue Depth
357 unit: messages
358 chart_type: line
359 dimensions:
360 - name: current
361 - name: max
362 - name: mq.queue.depth_percentage
363 description: Queue Depth Percentage
364 unit: percentage
365 chart_type: line
366 dimensions:
367 - name: percentage
368 - name: mq.queue.messages
369 description: Queue Messages
370 unit: messages/s
371 chart_type: line
372 dimensions:
373 - name: enqueued
374 - name: dequeued
375 - name: mq.queue.connections
376 description: Queue Connections
377 unit: connections
378 chart_type: line
379 dimensions:
380 - name: input
381 - name: output
382 - name: mq.queue.high_depth
383 description: Queue Peak Depth
384 unit: messages
385 chart_type: line
386 dimensions:
387 - name: high_depth
388 - name: mq.queue.uncommitted_msgs
389 description: Queue Uncommitted Messages
390 unit: messages
391 chart_type: line
392 dimensions:
393 - name: uncommitted
394 - name: mq.queue.file_size
395 description: Queue File Size
396 unit: bytes
397 chart_type: line
398 dimensions:
399 - name: current
400 - name: max
401 - name: mq.queue.last_activity
402 description: Time Since Last Queue Activity
403 unit: seconds
404 chart_type: line
405 dimensions:
406 - name: since_last_get
407 - name: since_last_put
408 - name: mq.queue.oldest_msg_age
409 description: Queue Oldest Message Age
410 unit: seconds
411 chart_type: line
412 dimensions:
413 - name: oldest_msg_age
414 - name: mq.queue.time_indicators
415 description: Queue Time Indicators
416 unit: microseconds
417 chart_type: line
418 dimensions:
419 - name: short_period
420 - name: long_period
421 - name: mq.queue.service_interval
422 description: Queue Service Interval
423 unit: milliseconds
424 chart_type: line
425 dimensions:
426 - name: service_interval
427 - name: mq.queue.inhibit_status
428 description: Queue Inhibit Status
429 unit: status
430 chart_type: line
431 dimensions:
432 - name: inhibit_get
433 - name: inhibit_put
434 - name: mq.queue.priority
435 description: Queue Priority Configuration
436 unit: priority
437 chart_type: line
438 dimensions:
439 - name: def_priority
440 - name: mq.queue.message_persistence
441 description: Queue Default Message Persistence
442 unit: boolean
443 chart_type: line
444 dimensions:
445 - name: persistent
446 - name: non_persistent
447 - name: mq.queue.retention_interval
448 description: Queue Retention Interval
449 unit: hours
450 chart_type: line
451 dimensions:
452 - name: retention_interval
453 - name: mq.queue.triggers
454 description: Queue Trigger Configuration
455 unit: messages
456 chart_type: line
457 dimensions:
458 - name: trigger_depth
459 - name: trigger_type
460 - name: mq.queue.backout_threshold
461 description: Queue Error Handling
462 unit: retries
463 chart_type: line
464 dimensions:
465 - name: backout_threshold
466 - name: mq.queue.max_msg_length
467 description: Queue Max Message Length
468 unit: bytes
469 chart_type: line
470 dimensions:
471 - name: max_msg_length
472 - name: mq.queue.scope
473 description: Queue Scope
474 unit: boolean
475 chart_type: line
476 dimensions:
477 - name: queue_manager
478 - name: cell
479 - name: mq.queue.usage
480 description: Queue Usage Type
481 unit: boolean
482 chart_type: line
483 dimensions:
484 - name: normal
485 - name: transmission
486 - name: mq.queue.msg_delivery_sequence
487 description: Message Delivery Sequence
488 unit: boolean
489 chart_type: line
490 dimensions:
491 - name: priority
492 - name: fifo
493 - name: mq.queue.harden_get_backout
494 description: Harden Get Backout
495 unit: boolean
496 chart_type: line
497 dimensions:
498 - name: enabled
499 - name: disabled
500 - name: queuegroup
501 description: These metrics refer to queuegroup instances.
502 labels:
503 - name: group
504 description: Group identifier
505 metrics:
506 - name: mq.queue_group.depth
507 description: Queue Group Depth
508 unit: messages
509 chart_type: line
510 dimensions:
511 - name: current
512 - name: max
513 - name: mq.queue_group.depth_percentage
514 description: Queue Group Depth Percentage
515 unit: percentage
516 chart_type: line
517 dimensions:
518 - name: percentage
519 - name: mq.queue_group.messages
520 description: Queue Group Messages
521 unit: messages/s
522 chart_type: line
523 dimensions:
524 - name: enqueued
525 - name: dequeued
526 - name: mq.queue_group.connections
527 description: Queue Group Connections
528 unit: connections
529 chart_type: line
530 dimensions:
531 - name: input
532 - name: output
533 - name: mq.queue_group.uncommitted_msgs
534 description: Queue Group Uncommitted Messages
535 unit: messages
536 chart_type: line
537 dimensions:
538 - name: uncommitted
539 - name: mq.queue_group.file_size
540 description: Queue Group File Size
541 unit: bytes
542 chart_type: line
543 dimensions:
544 - name: current
545 - name: max
546 - name: mq.queue_group.oldest_msg_age
547 description: Queue Group Oldest Message Age
548 unit: seconds
549 chart_type: line
550 dimensions:
551 - name: oldest_msg_age
552 - name: global
553 description: These metrics refer to the entire monitored instance.
554 labels: []
555 metrics:
556 - name: mq.qmgr.status
557 description: Queue Manager Status
558 unit: status
559 chart_type: line
560 dimensions:
561 - name: status
562 - name: mq.qmgr.connection_count
563 description: Queue Manager Connections
564 unit: connections
565 chart_type: line
566 dimensions:
567 - name: connections
568 - name: mq.qmgr.uptime
569 description: Queue Manager Uptime
570 unit: seconds
571 chart_type: line
572 dimensions:
573 - name: uptime
574 - name: mq.queues.overview
575 description: Queues Monitoring Status
576 unit: queues
577 chart_type: stacked
578 dimensions:
579 - name: monitored
580 - name: excluded
581 - name: invisible
582 - name: failed
583 - name: mq.channels.overview
584 description: Channels Monitoring Status
585 unit: channels
586 chart_type: stacked
587 dimensions:
588 - name: monitored
589 - name: excluded
590 - name: invisible
591 - name: failed
592 - name: mq.topics.overview
593 description: Topics Monitoring Status
594 unit: topics
595 chart_type: stacked
596 dimensions:
597 - name: monitored
598 - name: excluded
599 - name: invisible
600 - name: failed
601 - name: mq.listeners.overview
602 description: Listeners Monitoring Status
603 unit: listeners
604 chart_type: stacked
605 dimensions:
606 - name: monitored
607 - name: excluded
608 - name: invisible
609 - name: failed
610 - name: global
611 description: These metrics refer to the entire monitored instance.
612 labels: []
613 metrics:
614 - name: mq.qmgr.cpu_usage
615 description: Queue Manager CPU Usage
616 unit: percentage
617 chart_type: stacked
618 dimensions:
619 - name: user
620 - name: system
621 - name: mq.qmgr.memory_usage
622 description: Queue Manager Memory Usage
623 unit: bytes
624 chart_type: line
625 dimensions:
626 - name: total
627 - name: mq.qmgr.ram_usage
628 description: Queue Manager RAM Usage
629 unit: bytes
630 chart_type: line
631 dimensions:
632 - name: total
633 - name: mq.qmgr.log_utilization
634 description: Queue Manager Log Utilization
635 unit: percentage
636 chart_type: line
637 dimensions:
638 - name: used
639 - name: mq.qmgr.log_file_size
640 description: Queue Manager Log File Size
641 unit: bytes
642 chart_type: line
643 dimensions:
644 - name: size
645 - name: mq.qmgr.log_write_rate
646 description: Queue Manager Log Write Rate
647 unit: bytes/s
648 chart_type: line
649 dimensions:
650 - name: rate
651 - name: queuestatistics
652 description: These metrics refer to queuestatistics instances.
653 labels:
654 - name: queue
655 description: Queue identifier
656 - name: type
657 description: Type identifier
658 metrics:
659 - name: mq.queue_stats.depth_min_max
660 description: Queue Depth Min/Max (Statistics)
661 unit: messages
662 chart_type: line
663 dimensions:
664 - name: min_depth
665 - name: max_depth
666 - name: mq.queue_stats.avg_queue_time
667 description: Queue Average Time (Statistics)
668 unit: microseconds
669 chart_type: line
670 dimensions:
671 - name: non_persistent
672 - name: persistent
673 - name: mq.queue_stats.time_indicators
674 description: Queue Time Indicators (Statistics)
675 unit: microseconds
676 chart_type: line
677 dimensions:
678 - name: short_period
679 - name: long_period
680 - name: mq.queue_stats.operations
681 description: Queue Operations (Statistics)
682 unit: operations/s
683 chart_type: line
684 dimensions:
685 - name: puts_non_persistent
686 - name: puts_persistent
687 - name: gets_non_persistent
688 - name: gets_persistent
689 - name: put1s
690 - name: browses
691 - name: mq.queue_stats.bytes
692 description: Queue Bytes (Statistics)
693 unit: bytes/s
694 chart_type: line
695 dimensions:
696 - name: put_bytes_non_persistent
697 - name: put_bytes_persistent
698 - name: get_bytes_non_persistent
699 - name: get_bytes_persistent
700 - name: browse_bytes
701 - name: mq.queue_stats.failures
702 description: Queue Operation Failures (Statistics)
703 unit: failures/s
704 chart_type: line
705 dimensions:
706 - name: puts_failed
707 - name: put1s_failed
708 - name: gets_failed
709 - name: browses_failed
710 - name: mq.queue_stats.message_lifecycle
711 description: Queue Message Lifecycle (Statistics)
712 unit: messages/s
713 chart_type: line
714 dimensions:
715 - name: expired
716 - name: purged
717 - name: not_queued
718 - name: subscription
719 description: These metrics refer to subscription instances.
720 labels:
721 - name: subscription
722 description: Subscription identifier
723 - name: topic
724 description: Topic identifier
725 metrics:
726 - name: mq.subscription.messages
727 description: IBM MQ Subscription Messages
728 unit: messages
729 chart_type: line
730 dimensions:
731 - name: pending
732 - name: mq.subscription.last_message_age
733 description: IBM MQ Subscription Last Message Age
734 unit: seconds
735 chart_type: line
736 dimensions:
737 - name: age
738 - name: topic
739 description: These metrics refer to topic instances.
740 labels:
741 - name: topic
742 description: Topic identifier
743 metrics:
744 - name: mq.topic.publishers
745 description: Topic Publishers
746 unit: publishers
747 chart_type: line
748 dimensions:
749 - name: publishers
750 - name: mq.topic.subscribers
751 description: Topic Subscribers
752 unit: subscribers
753 chart_type: line
754 dimensions:
755 - name: subscribers
756 - name: mq.topic.messages
757 description: Topic Message Rate
758 unit: messages/s
759 chart_type: line
760 dimensions:
761 - name: messages
762 - name: mq.topic.time_since_last_message
763 description: Time Since Last Message
764 unit: seconds
765 chart_type: line
766 dimensions:
767 - name: time_since_last_msg