master
yaml 886 lines 30.1 KB
Raw
1 # Generated metadata.yaml for db2 module
2 plugin_name: ibm.d.plugin
3 modules:
4 - meta:
5 plugin_name: ibm.d.plugin
6 module_name: db2
7 monitored_instance:
8 name: IBM DB2
9 link: https://www.ibm.com/products/db2
10 categories:
11 - data-collection.databases
12 icon_filename: "ibm.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - db2
20 overview:
21 data_collection:
22 metrics_description: |
23 Monitors IBM DB2 databases using system catalog views and MON_GET_* table
24 functions to expose connections, locking, buffer pool efficiency, tablespace
25 capacity, and workload performance metrics.
26
27 Detailed charts are opt-in per object family through include/exclude lists.
28 Defaults focus on engine activity (system connections, core buffer pools,
29 catalog tablespaces). Matching uses glob patterns that can target schema or
30 application names, with include rules taking precedence over excludes.
31
32 When the number of matching objects exceeds the configured `max_*` limits,
33 the collector publishes deterministic top-N per-instance charts, aggregates
34 the remainder under `group="__other__"`, and logs a throttled warning so you
35 can refine selectors before cardinality runs away. Group charts (by schema,
36 application prefix, or buffer pool family) are always emitted so high-level
37 visibility is preserved even when individual instances are trimmed.
38
39 method_description: |
40 The collector connects to IBM DB2 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 DB2 monitoring interface is accessible.
60 configuration:
61 file:
62 name: ibm.d/db2.conf
63 options:
64 description: |
65 Configuration options for the db2 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: bufferpool
101 description: These metrics refer to bufferpool instances.
102 labels:
103 - name: bufferpool
104 description: Bufferpool identifier
105 - name: page_size
106 description: Page_size identifier
107 metrics:
108 - name: db2.bufferpool_instance_hit_ratio
109 description: Buffer Pool Hit Ratio
110 unit: percentage
111 chart_type: line
112 dimensions:
113 - name: overall
114 - name: db2.bufferpool_instance_detailed_hit_ratio
115 description: Buffer Pool Detailed Hit Ratios
116 unit: percentage
117 chart_type: line
118 dimensions:
119 - name: data
120 - name: index
121 - name: xda
122 - name: column
123 - name: db2.bufferpool_instance_reads
124 description: Buffer Pool Reads
125 unit: reads/s
126 chart_type: stacked
127 dimensions:
128 - name: logical
129 - name: physical
130 - name: db2.bufferpool_instance_data_reads
131 description: Buffer Pool Data Page Reads
132 unit: reads/s
133 chart_type: stacked
134 dimensions:
135 - name: logical
136 - name: physical
137 - name: db2.bufferpool_instance_index_reads
138 description: Buffer Pool Index Page Reads
139 unit: reads/s
140 chart_type: stacked
141 dimensions:
142 - name: logical
143 - name: physical
144 - name: db2.bufferpool_instance_pages
145 description: Buffer Pool Pages
146 unit: pages
147 chart_type: stacked
148 dimensions:
149 - name: used
150 - name: total
151 - name: db2.bufferpool_instance_writes
152 description: Buffer Pool Writes
153 unit: writes/s
154 chart_type: line
155 dimensions:
156 - name: writes
157 - name: bufferpoolgroup
158 description: These metrics refer to bufferpoolgroup instances.
159 labels:
160 - name: group
161 description: Group identifier
162 metrics:
163 - name: db2.bufferpool_group_hit_ratio
164 description: Buffer Pool Group Hit Ratio
165 unit: percentage
166 chart_type: line
167 dimensions:
168 - name: overall
169 - name: db2.bufferpool_group_detailed_hit_ratio
170 description: Buffer Pool Group Detailed Hit Ratios
171 unit: percentage
172 chart_type: line
173 dimensions:
174 - name: data
175 - name: index
176 - name: xda
177 - name: column
178 - name: db2.bufferpool_group_reads
179 description: Buffer Pool Group Reads
180 unit: reads/s
181 chart_type: stacked
182 dimensions:
183 - name: logical
184 - name: physical
185 - name: db2.bufferpool_group_data_reads
186 description: Buffer Pool Group Data Reads
187 unit: reads/s
188 chart_type: stacked
189 dimensions:
190 - name: logical
191 - name: physical
192 - name: db2.bufferpool_group_index_reads
193 description: Buffer Pool Group Index Reads
194 unit: reads/s
195 chart_type: stacked
196 dimensions:
197 - name: logical
198 - name: physical
199 - name: db2.bufferpool_group_pages
200 description: Buffer Pool Group Pages
201 unit: pages
202 chart_type: stacked
203 dimensions:
204 - name: used
205 - name: total
206 - name: db2.bufferpool_group_writes
207 description: Buffer Pool Group Writes
208 unit: writes/s
209 chart_type: line
210 dimensions:
211 - name: writes
212 - name: connection
213 description: These metrics refer to connection instances.
214 labels:
215 - name: application_id
216 description: Application_id identifier
217 - name: application_name
218 description: Application_name identifier
219 - name: client_hostname
220 description: Client_hostname identifier
221 - name: client_ip
222 description: Client_ip identifier
223 - name: client_user
224 description: Client_user identifier
225 - name: state
226 description: State identifier
227 metrics:
228 - name: db2.connection_state
229 description: Connection State
230 unit: state
231 chart_type: line
232 dimensions:
233 - name: state
234 - name: db2.connection_activity
235 description: Connection Row Activity
236 unit: rows/s
237 chart_type: area
238 dimensions:
239 - name: read
240 - name: written
241 - name: db2.connection_wait_time
242 description: Connection Wait Time
243 unit: milliseconds
244 chart_type: stacked
245 dimensions:
246 - name: lock
247 - name: log_disk
248 - name: log_buffer
249 - name: pool_read
250 - name: pool_write
251 - name: direct_read
252 - name: direct_write
253 - name: fcm_recv
254 - name: fcm_send
255 - name: db2.connection_processing_time
256 description: Connection Processing Time
257 unit: milliseconds
258 chart_type: stacked
259 dimensions:
260 - name: routine
261 - name: compile
262 - name: section
263 - name: commit
264 - name: rollback
265 - name: connectiongroup
266 description: These metrics refer to connectiongroup instances.
267 labels:
268 - name: group
269 description: Group identifier
270 metrics:
271 - name: db2.connection_group.count
272 description: Connection Group Count
273 unit: connections
274 chart_type: line
275 dimensions:
276 - name: count
277 - name: db2.connection_group.state
278 description: Connection Group State Sum
279 unit: state
280 chart_type: line
281 dimensions:
282 - name: state
283 - name: db2.connection_group.activity
284 description: Connection Group Row Activity
285 unit: rows/s
286 chart_type: area
287 dimensions:
288 - name: read
289 - name: written
290 - name: db2.connection_group.wait_time
291 description: Connection Group Wait Time
292 unit: milliseconds
293 chart_type: stacked
294 dimensions:
295 - name: lock
296 - name: log_disk
297 - name: log_buffer
298 - name: pool_read
299 - name: pool_write
300 - name: direct_read
301 - name: direct_write
302 - name: fcm_recv
303 - name: fcm_send
304 - name: db2.connection_group.processing_time
305 description: Connection Group Processing Time
306 unit: milliseconds
307 chart_type: stacked
308 dimensions:
309 - name: routine
310 - name: compile
311 - name: section
312 - name: commit
313 - name: rollback
314 - name: database
315 description: These metrics refer to database instances.
316 labels:
317 - name: database
318 description: Database identifier
319 - name: status
320 description: Status identifier
321 metrics:
322 - name: db2.database_instance_status
323 description: Database Status
324 unit: status
325 chart_type: line
326 dimensions:
327 - name: status
328 - name: db2.database_applications
329 description: Database Applications
330 unit: applications
331 chart_type: line
332 dimensions:
333 - name: applications
334 - name: index
335 description: These metrics refer to index instances.
336 labels:
337 - name: index
338 description: Index identifier
339 metrics:
340 - name: db2.index_usage
341 description: Index Usage
342 unit: scans/s
343 chart_type: area
344 dimensions:
345 - name: index
346 - name: full
347 - name: indexgroup
348 description: These metrics refer to indexgroup instances.
349 labels:
350 - name: group
351 description: Group identifier
352 metrics:
353 - name: db2.index_group_usage
354 description: Index Group Usage
355 unit: scans/s
356 chart_type: area
357 dimensions:
358 - name: index
359 - name: full
360 - name: memorypool
361 description: These metrics refer to memorypool instances.
362 labels:
363 - name: pool_type
364 description: Pool_type identifier
365 metrics:
366 - name: db2.memory_pool_usage
367 description: Memory Pool Usage
368 unit: bytes
369 chart_type: line
370 dimensions:
371 - name: used
372 - name: db2.memory_pool_hwm
373 description: Memory Pool High Water Mark
374 unit: bytes
375 chart_type: line
376 dimensions:
377 - name: hwm
378 - name: memoryset
379 description: These metrics refer to memoryset instances.
380 labels:
381 - name: host
382 description: Host identifier
383 - name: database
384 description: Database identifier
385 - name: set_type
386 description: Set_type identifier
387 - name: member
388 description: Member identifier
389 metrics:
390 - name: db2.memory_set_usage
391 description: Memory Set Usage
392 unit: bytes
393 chart_type: line
394 dimensions:
395 - name: used
396 - name: db2.memory_set_committed
397 description: Memory Set Committed
398 unit: bytes
399 chart_type: line
400 dimensions:
401 - name: committed
402 - name: db2.memory_set_high_water_mark
403 description: Memory Set High Water Mark
404 unit: bytes
405 chart_type: line
406 dimensions:
407 - name: hwm
408 - name: db2.memory_set_additional_committed
409 description: Memory Set Additional Committed
410 unit: bytes
411 chart_type: line
412 dimensions:
413 - name: additional
414 - name: db2.memory_set_percent_used_hwm
415 description: Memory Set Percent Used vs HWM
416 unit: percentage
417 chart_type: line
418 dimensions:
419 - name: used_hwm
420 - name: prefetcher
421 description: These metrics refer to prefetcher instances.
422 labels:
423 - name: bufferpool
424 description: Bufferpool identifier
425 metrics:
426 - name: db2.prefetcher_prefetch_ratio
427 description: Prefetcher Prefetch Ratio
428 unit: percentage
429 chart_type: line
430 dimensions:
431 - name: ratio
432 - name: db2.prefetcher_cleaner_ratio
433 description: Prefetcher Cleaner Ratio
434 unit: percentage
435 chart_type: line
436 dimensions:
437 - name: ratio
438 - name: db2.prefetcher_physical_reads
439 description: Prefetcher Physical Reads
440 unit: reads/s
441 chart_type: line
442 dimensions:
443 - name: reads
444 - name: db2.prefetcher_async_reads
445 description: Prefetcher Asynchronous Reads
446 unit: reads/s
447 chart_type: line
448 dimensions:
449 - name: reads
450 - name: db2.prefetcher_wait_time
451 description: Prefetcher Wait Time
452 unit: milliseconds
453 chart_type: line
454 dimensions:
455 - name: wait_time
456 - name: db2.prefetcher_unread_pages
457 description: Prefetcher Unread Pages
458 unit: pages/s
459 chart_type: line
460 dimensions:
461 - name: unread
462 - name: global
463 description: These metrics refer to the entire monitored instance.
464 labels: []
465 metrics:
466 - name: db2.service_health
467 description: Service Health Status
468 unit: status
469 chart_type: line
470 dimensions:
471 - name: connection
472 - name: database
473 - name: db2.connections
474 description: Database Connections
475 unit: connections
476 chart_type: line
477 dimensions:
478 - name: total
479 - name: active
480 - name: executing
481 - name: idle
482 - name: max_allowed
483 - name: db2.locking
484 description: Database Locking
485 unit: events/s
486 chart_type: line
487 dimensions:
488 - name: waits
489 - name: timeouts
490 - name: escalations
491 - name: db2.deadlocks
492 description: Database Deadlocks
493 unit: deadlocks/s
494 chart_type: line
495 dimensions:
496 - name: deadlocks
497 - name: db2.lock_details
498 description: Lock Details
499 unit: locks
500 chart_type: line
501 dimensions:
502 - name: active
503 - name: waiting_agents
504 - name: memory_pages
505 - name: db2.lock_wait_time
506 description: Average Lock Wait Time
507 unit: milliseconds
508 chart_type: line
509 dimensions:
510 - name: wait_time
511 - name: db2.sorting
512 description: Database Sorting
513 unit: sorts/s
514 chart_type: stacked
515 dimensions:
516 - name: sorts
517 - name: overflows
518 - name: db2.row_activity
519 description: Row Activity
520 unit: rows/s
521 chart_type: area
522 dimensions:
523 - name: read
524 - name: returned
525 - name: modified
526 - name: db2.bufferpool_hit_ratio
527 description: Buffer Pool Hit Ratio
528 unit: percentage
529 chart_type: line
530 dimensions:
531 - name: hits
532 - name: misses
533 - name: db2.bufferpool_data_hit_ratio
534 description: Buffer Pool Data Page Hit Ratio
535 unit: percentage
536 chart_type: line
537 dimensions:
538 - name: hits
539 - name: misses
540 - name: db2.bufferpool_index_hit_ratio
541 description: Buffer Pool Index Page Hit Ratio
542 unit: percentage
543 chart_type: line
544 dimensions:
545 - name: hits
546 - name: misses
547 - name: db2.bufferpool_xda_hit_ratio
548 description: Buffer Pool XDA Page Hit Ratio
549 unit: percentage
550 chart_type: line
551 dimensions:
552 - name: hits
553 - name: misses
554 - name: db2.bufferpool_column_hit_ratio
555 description: Buffer Pool Column Page Hit Ratio
556 unit: percentage
557 chart_type: line
558 dimensions:
559 - name: hits
560 - name: misses
561 - name: db2.bufferpool_reads
562 description: Buffer Pool Reads
563 unit: reads/s
564 chart_type: stacked
565 dimensions:
566 - name: logical
567 - name: physical
568 - name: db2.bufferpool_data_reads
569 description: Buffer Pool Data Page Reads
570 unit: reads/s
571 chart_type: stacked
572 dimensions:
573 - name: logical
574 - name: physical
575 - name: db2.bufferpool_index_reads
576 description: Buffer Pool Index Page Reads
577 unit: reads/s
578 chart_type: stacked
579 dimensions:
580 - name: logical
581 - name: physical
582 - name: db2.bufferpool_xda_reads
583 description: Buffer Pool XDA Page Reads
584 unit: reads/s
585 chart_type: stacked
586 dimensions:
587 - name: logical
588 - name: physical
589 - name: db2.bufferpool_column_reads
590 description: Buffer Pool Column Page Reads
591 unit: reads/s
592 chart_type: stacked
593 dimensions:
594 - name: logical
595 - name: physical
596 - name: db2.bufferpool_writes
597 description: Buffer Pool Writes
598 unit: writes/s
599 chart_type: line
600 dimensions:
601 - name: writes
602 - name: db2.log_space
603 description: Log Space Usage
604 unit: bytes
605 chart_type: stacked
606 dimensions:
607 - name: used
608 - name: available
609 - name: db2.log_utilization
610 description: Log Space Utilization
611 unit: percentage
612 chart_type: line
613 dimensions:
614 - name: utilization
615 - name: db2.log_io
616 description: Log I/O Operations
617 unit: operations/s
618 chart_type: area
619 dimensions:
620 - name: reads
621 - name: writes
622 - name: db2.log_operations
623 description: Log Operations
624 unit: operations/s
625 chart_type: line
626 dimensions:
627 - name: commits
628 - name: rollbacks
629 - name: reads
630 - name: writes
631 - name: db2.log_timing
632 description: Log Operation Times
633 unit: milliseconds
634 chart_type: line
635 dimensions:
636 - name: avg_commit
637 - name: avg_read
638 - name: avg_write
639 - name: db2.log_buffer_events
640 description: Log Buffer Full Events
641 unit: events/s
642 chart_type: line
643 dimensions:
644 - name: buffer_full
645 - name: db2.long_running_queries
646 description: Long Running Queries
647 unit: queries
648 chart_type: stacked
649 dimensions:
650 - name: total
651 - name: warning
652 - name: critical
653 - name: db2.backup_status
654 description: Last Backup Status
655 unit: status
656 chart_type: line
657 dimensions:
658 - name: status
659 - name: db2.backup_age
660 description: Time Since Last Backup
661 unit: hours
662 chart_type: line
663 dimensions:
664 - name: full
665 - name: incremental
666 - name: db2.federation_connections
667 description: Federated Connections
668 unit: connections
669 chart_type: line
670 dimensions:
671 - name: active
672 - name: idle
673 - name: db2.federation_operations
674 description: Federated Operations
675 unit: operations/s
676 chart_type: line
677 dimensions:
678 - name: rows_read
679 - name: selects
680 - name: waits
681 - name: db2.database_status
682 description: Current Database Status
683 unit: status
684 chart_type: line
685 dimensions:
686 - name: active
687 - name: inactive
688 - name: db2.database_count
689 description: Database Count
690 unit: databases
691 chart_type: line
692 dimensions:
693 - name: active
694 - name: inactive
695 - name: db2.cpu_usage
696 description: CPU Usage (100% = 1 CPU core)
697 unit: percentage
698 chart_type: stacked
699 dimensions:
700 - name: user
701 - name: system
702 - name: idle
703 - name: iowait
704 - name: db2.active_connections
705 description: Active Connections
706 unit: connections
707 chart_type: line
708 dimensions:
709 - name: active
710 - name: total
711 - name: db2.memory_usage
712 description: Memory Usage
713 unit: MiB
714 chart_type: stacked
715 dimensions:
716 - name: database
717 - name: instance
718 - name: bufferpool
719 - name: shared_sort
720 - name: db2.sql_statements
721 description: SQL Statements
722 unit: statements/s
723 chart_type: stacked
724 dimensions:
725 - name: selects
726 - name: modifications
727 - name: db2.transaction_activity
728 description: Transaction Activity
729 unit: transactions/s
730 chart_type: stacked
731 dimensions:
732 - name: committed
733 - name: aborted
734 - name: db2.time_spent
735 description: Average Operation Times
736 unit: milliseconds
737 chart_type: line
738 dimensions:
739 - name: direct_read
740 - name: direct_write
741 - name: pool_read
742 - name: pool_write
743 - name: table
744 description: These metrics refer to table instances.
745 labels:
746 - name: table
747 description: Table identifier
748 metrics:
749 - name: db2.table_size
750 description: Table Size
751 unit: bytes
752 chart_type: stacked
753 dimensions:
754 - name: data
755 - name: index
756 - name: long_obj
757 - name: db2.table_activity
758 description: Table Activity
759 unit: rows/s
760 chart_type: area
761 dimensions:
762 - name: read
763 - name: written
764 - name: tablegroup
765 description: These metrics refer to tablegroup instances.
766 labels:
767 - name: group
768 description: Group identifier
769 metrics:
770 - name: db2.table_group_size
771 description: Table Group Size
772 unit: bytes
773 chart_type: stacked
774 dimensions:
775 - name: data
776 - name: index
777 - name: long_obj
778 - name: db2.table_group_activity
779 description: Table Group Activity
780 unit: rows/s
781 chart_type: area
782 dimensions:
783 - name: read
784 - name: written
785 - name: tableio
786 description: These metrics refer to tableio instances.
787 labels:
788 - name: table
789 description: Table identifier
790 metrics:
791 - name: db2.table_io_scans
792 description: Table Scans
793 unit: scans/s
794 chart_type: line
795 dimensions:
796 - name: scans
797 - name: db2.table_io_rows
798 description: Table Row Operations
799 unit: rows/s
800 chart_type: line
801 dimensions:
802 - name: read
803 - name: db2.table_io_activity
804 description: Table DML Activity
805 unit: operations/s
806 chart_type: stacked
807 dimensions:
808 - name: inserts
809 - name: updates
810 - name: deletes
811 - name: db2.table_io_overflow
812 description: Table Overflow Accesses
813 unit: accesses/s
814 chart_type: line
815 dimensions:
816 - name: overflow
817 - name: tablespace
818 description: These metrics refer to tablespace instances.
819 labels:
820 - name: tablespace
821 description: Tablespace identifier
822 - name: type
823 description: Type identifier
824 - name: content_type
825 description: Content_type identifier
826 - name: state
827 description: State identifier
828 metrics:
829 - name: db2.tablespace_usage
830 description: Tablespace Usage
831 unit: percentage
832 chart_type: line
833 dimensions:
834 - name: used
835 - name: db2.tablespace_size
836 description: Tablespace Size
837 unit: bytes
838 chart_type: stacked
839 dimensions:
840 - name: used
841 - name: free
842 - name: db2.tablespace_usable_size
843 description: Tablespace Usable Size
844 unit: bytes
845 chart_type: line
846 dimensions:
847 - name: total
848 - name: usable
849 - name: db2.tablespace_state
850 description: Tablespace State
851 unit: state
852 chart_type: line
853 dimensions:
854 - name: state
855 - name: tablespacegroup
856 description: These metrics refer to tablespacegroup instances.
857 labels:
858 - name: group
859 description: Group identifier
860 metrics:
861 - name: db2.tablespace_group_usage
862 description: Tablespace Group Usage
863 unit: percentage
864 chart_type: line
865 dimensions:
866 - name: used
867 - name: db2.tablespace_group_size
868 description: Tablespace Group Size
869 unit: bytes
870 chart_type: stacked
871 dimensions:
872 - name: used
873 - name: free
874 - name: db2.tablespace_group_usable_size
875 description: Tablespace Group Usable Size
876 unit: bytes
877 chart_type: line
878 dimensions:
879 - name: total
880 - name: usable
881 - name: db2.tablespace_group_state
882 description: Tablespace Group State
883 unit: state
884 chart_type: line
885 dimensions:
886 - name: state