master
yaml 899 lines 31.2 KB
Raw
1 # Generated metadata.yaml for websphere_pmi module
2 plugin_name: ibm.d.plugin
3 modules:
4 - meta:
5 plugin_name: ibm.d.plugin
6 module_name: websphere_pmi
7 monitored_instance:
8 name: IBM WebSphere PMI
9 link: https://www.ibm.com/docs/en/was
10 categories:
11 - data-collection.applications
12 icon_filename: "ibm.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - websphere_pmi
20 overview:
21 data_collection:
22 metrics_description: |
23 Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface,
24 covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information.
25
26 method_description: |
27 The collector connects to IBM WebSphere PMI and collects metrics via its monitoring interface.
28 supported_platforms:
29 include: []
30 exclude: []
31 multi_instance: true
32 additional_permissions:
33 description: ""
34 default_behavior:
35 auto_detection:
36 description: ""
37 limits:
38 description: ""
39 performance_impact:
40 description: ""
41 setup:
42 prerequisites:
43 list:
44 - title: Enable monitoring interface
45 description: |
46 Ensure the IBM WebSphere PMI monitoring interface is accessible.
47 configuration:
48 file:
49 name: ibm.d/websphere_pmi.conf
50 options:
51 description: |
52 Configuration options for the websphere_pmi collector.
53 folding:
54 title: Config options
55 enabled: true
56 list:
57 - name: update_every
58 description: Data collection frequency.
59 default_value: 1
60 required: false
61 - name: endpoint
62 description: Connection endpoint.
63 default_value: "dummy://localhost"
64 required: false
65 examples:
66 folding:
67 enabled: true
68 title: Config
69 list:
70 - name: Basic
71 description: Basic configuration example.
72 config: |
73 jobs:
74 - name: local
75 endpoint: dummy://localhost
76 troubleshooting:
77 problems:
78 list: []
79 alerts: []
80 metrics:
81 folding:
82 title: Metrics
83 enabled: false
84 description: ""
85 availability: []
86 scopes:
87 - name: alarmmanager
88 description: These metrics refer to alarmmanager instances.
89 labels:
90 - name: node
91 description: Node identifier
92 - name: server
93 description: Server identifier
94 - name: manager
95 description: Manager identifier
96 metrics:
97 - name: websphere_pmi.alarm_manager_events
98 description: Alarm Manager Events
99 unit: events/s
100 chart_type: line
101 dimensions:
102 - name: created
103 - name: cancelled
104 - name: fired
105 - name: dynamiccache
106 description: These metrics refer to dynamiccache instances.
107 labels:
108 - name: node
109 description: Node identifier
110 - name: server
111 description: Server identifier
112 - name: cache
113 description: Cache identifier
114 metrics:
115 - name: websphere_pmi.dynamic_cache_in_memory
116 description: Dynamic Cache Entries
117 unit: entries
118 chart_type: line
119 dimensions:
120 - name: entries
121 - name: websphere_pmi.dynamic_cache_capacity
122 description: Dynamic Cache Capacity
123 unit: entries
124 chart_type: line
125 dimensions:
126 - name: max_entries
127 - name: enterprisebeans
128 description: These metrics refer to enterprisebeans instances.
129 labels:
130 - name: node
131 description: Node identifier
132 - name: server
133 description: Server identifier
134 - name: bean
135 description: Bean identifier
136 metrics:
137 - name: websphere_pmi.ejb_operations
138 description: EJB Operations
139 unit: operations/s
140 chart_type: line
141 dimensions:
142 - name: create
143 - name: remove
144 - name: activate
145 - name: passivate
146 - name: instantiate
147 - name: store
148 - name: load
149 - name: websphere_pmi.ejb_messages
150 description: EJB Message Activity
151 unit: messages/s
152 chart_type: line
153 dimensions:
154 - name: received
155 - name: backout
156 - name: websphere_pmi.ejb_pool
157 description: EJB Pool Usage
158 unit: beans
159 chart_type: line
160 dimensions:
161 - name: ready
162 - name: live
163 - name: pooled
164 - name: active_method
165 - name: passive
166 - name: server_session_pool
167 - name: method_ready
168 - name: async_queue
169 - name: websphere_pmi.ejb_time
170 description: EJB Operation Time
171 unit: milliseconds
172 chart_type: line
173 dimensions:
174 - name: activation
175 - name: passivation
176 - name: create
177 - name: remove
178 - name: load
179 - name: store
180 - name: method_response
181 - name: wait
182 - name: async_wait
183 - name: read_lock
184 - name: write_lock
185 - name: extensionregistry
186 description: These metrics refer to extensionregistry instances.
187 labels:
188 - name: node
189 description: Node identifier
190 - name: server
191 description: Server identifier
192 metrics:
193 - name: websphere_pmi.extension_registry_requests
194 description: Extension Registry Requests
195 unit: events/s
196 chart_type: line
197 dimensions:
198 - name: requests
199 - name: hits
200 - name: displacements
201 - name: websphere_pmi.extension_registry_hit_rate
202 description: Extension Registry Hit Rate
203 unit: percentage
204 chart_type: line
205 dimensions:
206 - name: hit_rate
207 - name: hamanager
208 description: These metrics refer to hamanager instances.
209 labels:
210 - name: node
211 description: Node identifier
212 - name: server
213 description: Server identifier
214 metrics:
215 - name: websphere_pmi.ha_manager_groups
216 description: HA Manager Groups
217 unit: groups
218 chart_type: line
219 dimensions:
220 - name: local
221 - name: websphere_pmi.ha_manager_bulletin_board
222 description: HA Manager Bulletin Board
223 unit: items
224 chart_type: line
225 dimensions:
226 - name: subjects
227 - name: subscriptions
228 - name: local_subjects
229 - name: local_subscriptions
230 - name: websphere_pmi.ha_manager_rebuild_time
231 description: HA Manager Rebuild Time
232 unit: milliseconds
233 chart_type: line
234 dimensions:
235 - name: group_state
236 - name: bulletin_board
237 - name: jcapool
238 description: These metrics refer to jcapool instances.
239 labels:
240 - name: node
241 description: Node identifier
242 - name: server
243 description: Server identifier
244 - name: provider
245 description: Provider identifier
246 - name: pool
247 description: Pool identifier
248 metrics:
249 - name: websphere_pmi.jca_pool_operations
250 description: JCA Pool Operations
251 unit: operations/s
252 chart_type: line
253 dimensions:
254 - name: create
255 - name: close
256 - name: allocate
257 - name: freed
258 - name: faults
259 - name: websphere_pmi.jca_pool_managed
260 description: JCA Pool Managed Resources
261 unit: resources
262 chart_type: line
263 dimensions:
264 - name: managed_connections
265 - name: connection_handles
266 - name: websphere_pmi.jca_pool_utilization
267 description: JCA Pool Utilization
268 unit: percentage
269 chart_type: line
270 dimensions:
271 - name: percent_used
272 - name: percent_maxed
273 - name: websphere_pmi.jca_pool_waiting
274 description: JCA Pool Waiting Threads
275 unit: threads
276 chart_type: line
277 dimensions:
278 - name: waiting_threads
279 - name: jdbcpool
280 description: These metrics refer to jdbcpool instances.
281 labels:
282 - name: node
283 description: Node identifier
284 - name: server
285 description: Server identifier
286 - name: pool
287 description: Pool identifier
288 metrics:
289 - name: websphere_pmi.jdbc_pool_usage
290 description: JDBC Pool Utilization
291 unit: percentage
292 chart_type: line
293 dimensions:
294 - name: percent_used
295 - name: percent_maxed
296 - name: websphere_pmi.jdbc_pool_waiting
297 description: JDBC Pool Waiting Threads
298 unit: threads
299 chart_type: line
300 dimensions:
301 - name: waiting_threads
302 - name: websphere_pmi.jdbc_pool_connections
303 description: JDBC Pool Connections
304 unit: connections
305 chart_type: line
306 dimensions:
307 - name: managed
308 - name: handles
309 - name: websphere_pmi.jdbc_pool_operations
310 description: JDBC Pool Operations
311 unit: operations/s
312 chart_type: line
313 dimensions:
314 - name: created
315 - name: closed
316 - name: allocated
317 - name: returned
318 - name: faults
319 - name: prep_stmt_cache_discard
320 - name: websphere_pmi.jdbc_pool_time
321 description: JDBC Pool Time
322 unit: milliseconds
323 chart_type: line
324 dimensions:
325 - name: use
326 - name: wait
327 - name: jdbc
328 - name: jmsqueue
329 description: These metrics refer to jmsqueue instances.
330 labels:
331 - name: node
332 description: Node identifier
333 - name: server
334 description: Server identifier
335 - name: engine
336 description: Engine identifier
337 - name: destination
338 description: Destination identifier
339 metrics:
340 - name: websphere_pmi.jms_queue_messages_produced
341 description: JMS Queue Messages Produced
342 unit: messages/s
343 chart_type: line
344 dimensions:
345 - name: total
346 - name: best_effort
347 - name: express
348 - name: reliable_nonpersistent
349 - name: reliable_persistent
350 - name: assured_persistent
351 - name: websphere_pmi.jms_queue_messages_consumed
352 description: JMS Queue Messages Consumed
353 unit: messages/s
354 chart_type: line
355 dimensions:
356 - name: total
357 - name: best_effort
358 - name: express
359 - name: reliable_nonpersistent
360 - name: reliable_persistent
361 - name: assured_persistent
362 - name: expired
363 - name: websphere_pmi.jms_queue_clients
364 description: JMS Queue Clients
365 unit: clients
366 chart_type: line
367 dimensions:
368 - name: local_producers
369 - name: local_producer_attaches
370 - name: local_consumers
371 - name: local_consumer_attaches
372 - name: websphere_pmi.jms_queue_storage
373 description: JMS Queue Storage
374 unit: messages
375 chart_type: line
376 dimensions:
377 - name: available
378 - name: unavailable
379 - name: oldest_age
380 - name: websphere_pmi.jms_queue_wait_time
381 description: JMS Queue Wait Time
382 unit: milliseconds
383 chart_type: line
384 dimensions:
385 - name: aggregate
386 - name: local
387 - name: jmsstore
388 description: These metrics refer to jmsstore instances.
389 labels:
390 - name: node
391 description: Node identifier
392 - name: server
393 description: Server identifier
394 - name: engine
395 description: Engine identifier
396 - name: section
397 description: Section identifier
398 metrics:
399 - name: websphere_pmi.jms_store_cache
400 description: JMS Store Cache
401 unit: events
402 chart_type: line
403 dimensions:
404 - name: add_stored
405 - name: add_not_stored
406 - name: stored_current
407 - name: stored_bytes
408 - name: not_stored_current
409 - name: not_stored_bytes
410 - name: discard_count
411 - name: discard_bytes
412 - name: websphere_pmi.jms_store_datastore
413 description: JMS Store Datastore Operations
414 unit: events/s
415 chart_type: line
416 dimensions:
417 - name: insert_batches
418 - name: update_batches
419 - name: delete_batches
420 - name: insert_count
421 - name: update_count
422 - name: delete_count
423 - name: open_count
424 - name: abort_count
425 - name: transaction_ms
426 - name: websphere_pmi.jms_store_transactions
427 description: JMS Store Transactions
428 unit: transactions/s
429 chart_type: line
430 dimensions:
431 - name: global_start
432 - name: global_commit
433 - name: global_abort
434 - name: global_indoubt
435 - name: local_start
436 - name: local_commit
437 - name: local_abort
438 - name: websphere_pmi.jms_store_expiry
439 description: JMS Store Expiry Index
440 unit: items
441 chart_type: line
442 dimensions:
443 - name: index_items
444 - name: jmstopic
445 description: These metrics refer to jmstopic instances.
446 labels:
447 - name: node
448 description: Node identifier
449 - name: server
450 description: Server identifier
451 - name: engine
452 description: Engine identifier
453 - name: destination
454 description: Destination identifier
455 metrics:
456 - name: websphere_pmi.jms_topic_publications
457 description: JMS Topic Publications
458 unit: messages/s
459 chart_type: line
460 dimensions:
461 - name: assured
462 - name: best_effort
463 - name: express
464 - name: websphere_pmi.jms_topic_subscription_hits
465 description: JMS Topic Subscription Hits
466 unit: events/s
467 chart_type: line
468 dimensions:
469 - name: assured
470 - name: best_effort
471 - name: express
472 - name: websphere_pmi.jms_topic_subscriptions
473 description: JMS Topic Subscriptions
474 unit: subscriptions
475 chart_type: line
476 dimensions:
477 - name: durable_local
478 - name: websphere_pmi.jms_topic_events
479 description: JMS Topic Events
480 unit: events/s
481 chart_type: line
482 dimensions:
483 - name: incomplete_publications
484 - name: publisher_attaches
485 - name: subscriber_attaches
486 - name: websphere_pmi.jms_topic_age
487 description: JMS Topic Oldest Publication Age
488 unit: milliseconds
489 chart_type: line
490 dimensions:
491 - name: local_oldest
492 - name: global
493 description: These metrics refer to the entire monitored instance.
494 labels: []
495 metrics:
496 - name: websphere_pmi.jvm_heap_usage
497 description: JVM Heap Memory Usage
498 unit: bytes
499 chart_type: stacked
500 dimensions:
501 - name: used
502 - name: free
503 - name: websphere_pmi.jvm_heap_committed
504 description: JVM Heap Committed
505 unit: bytes
506 chart_type: line
507 dimensions:
508 - name: committed
509 - name: websphere_pmi.jvm_heap_max
510 description: JVM Heap Maximum
511 unit: bytes
512 chart_type: line
513 dimensions:
514 - name: limit
515 - name: websphere_pmi.jvm_uptime
516 description: JVM Uptime
517 unit: seconds
518 chart_type: line
519 dimensions:
520 - name: uptime
521 - name: websphere_pmi.jvm_cpu
522 description: JVM CPU Usage
523 unit: percentage
524 chart_type: line
525 dimensions:
526 - name: usage
527 - name: websphere_pmi.jvm_gc_collections
528 description: JVM GC Collections
529 unit: collections/s
530 chart_type: line
531 dimensions:
532 - name: collections
533 - name: websphere_pmi.jvm_gc_time
534 description: JVM GC Time
535 unit: milliseconds
536 chart_type: line
537 dimensions:
538 - name: total
539 - name: websphere_pmi.jvm_threads
540 description: JVM Threads
541 unit: threads
542 chart_type: stacked
543 dimensions:
544 - name: daemon
545 - name: other
546 - name: websphere_pmi.jvm_threads_peak
547 description: JVM Peak Threads
548 unit: threads
549 chart_type: line
550 dimensions:
551 - name: peak
552 - name: orb
553 description: These metrics refer to orb instances.
554 labels:
555 - name: node
556 description: Node identifier
557 - name: server
558 description: Server identifier
559 metrics:
560 - name: websphere_pmi.orb_concurrent
561 description: ORB Concurrent Requests
562 unit: requests
563 chart_type: line
564 dimensions:
565 - name: concurrent_requests
566 - name: websphere_pmi.orb_requests
567 description: ORB Requests
568 unit: requests/s
569 chart_type: line
570 dimensions:
571 - name: requests
572 - name: objectpool
573 description: These metrics refer to objectpool instances.
574 labels:
575 - name: node
576 description: Node identifier
577 - name: server
578 description: Server identifier
579 - name: pool
580 description: Pool identifier
581 metrics:
582 - name: websphere_pmi.object_pool_operations
583 description: Object Pool Operations
584 unit: operations/s
585 chart_type: line
586 dimensions:
587 - name: created
588 - name: websphere_pmi.object_pool_size
589 description: Object Pool Size
590 unit: objects
591 chart_type: line
592 dimensions:
593 - name: allocated
594 - name: returned
595 - name: idle
596 - name: pmiwebservicemodule
597 description: These metrics refer to pmiwebservicemodule instances.
598 labels:
599 - name: node
600 description: Node identifier
601 - name: server
602 description: Server identifier
603 - name: module
604 description: Module identifier
605 metrics:
606 - name: websphere_pmi.pmi_web_service_module_services
607 description: PMI Web Service Module Services
608 unit: services
609 chart_type: line
610 dimensions:
611 - name: loaded
612 - name: portlet
613 description: These metrics refer to portlet instances.
614 labels:
615 - name: node
616 description: Node identifier
617 - name: server
618 description: Server identifier
619 - name: portlet
620 description: Portlet identifier
621 metrics:
622 - name: websphere_pmi.portlet_requests
623 description: Portlet Requests
624 unit: requests/s
625 chart_type: line
626 dimensions:
627 - name: requests
628 - name: websphere_pmi.portlet_concurrent
629 description: Portlet Concurrent Requests
630 unit: requests
631 chart_type: line
632 dimensions:
633 - name: concurrent
634 - name: websphere_pmi.portlet_errors
635 description: Portlet Errors
636 unit: errors/s
637 chart_type: line
638 dimensions:
639 - name: errors
640 - name: websphere_pmi.portlet_response_time
641 description: Portlet Response Time
642 unit: milliseconds
643 chart_type: line
644 dimensions:
645 - name: render
646 - name: action
647 - name: process_event
648 - name: serve_resource
649 - name: portletapplication
650 description: These metrics refer to portletapplication instances.
651 labels:
652 - name: node
653 description: Node identifier
654 - name: server
655 description: Server identifier
656 metrics:
657 - name: websphere_pmi.portlet_application_loaded
658 description: Loaded Portlets
659 unit: portlets
660 chart_type: line
661 dimensions:
662 - name: loaded
663 - name: schedulers
664 description: These metrics refer to schedulers instances.
665 labels:
666 - name: node
667 description: Node identifier
668 - name: server
669 description: Server identifier
670 - name: scheduler
671 description: Scheduler identifier
672 metrics:
673 - name: websphere_pmi.scheduler_activity
674 description: Scheduler Activity
675 unit: events/s
676 chart_type: line
677 dimensions:
678 - name: finished
679 - name: failures
680 - name: polls
681 - name: securityauth
682 description: These metrics refer to securityauth instances.
683 labels:
684 - name: node
685 description: Node identifier
686 - name: server
687 description: Server identifier
688 metrics:
689 - name: websphere_pmi.security_auth_counts
690 description: Security Authentication Counts
691 unit: events/s
692 chart_type: line
693 dimensions:
694 - name: web
695 - name: tai
696 - name: identity
697 - name: basic
698 - name: token
699 - name: jaas_identity
700 - name: jaas_basic
701 - name: jaas_token
702 - name: rmi
703 - name: securityauthz
704 description: These metrics refer to securityauthz instances.
705 labels:
706 - name: node
707 description: Node identifier
708 - name: server
709 description: Server identifier
710 metrics:
711 - name: websphere_pmi.security_authz_time
712 description: Security Authorization Time
713 unit: milliseconds
714 chart_type: line
715 dimensions:
716 - name: web
717 - name: ejb
718 - name: admin
719 - name: cwwja
720 - name: sessionmanager
721 description: These metrics refer to sessionmanager instances.
722 labels:
723 - name: node
724 description: Node identifier
725 - name: server
726 description: Server identifier
727 - name: app
728 description: App identifier
729 metrics:
730 - name: websphere_pmi.session_manager_active
731 description: Session Manager Active Sessions
732 unit: sessions
733 chart_type: line
734 dimensions:
735 - name: active
736 - name: live
737 - name: websphere_pmi.session_manager_events
738 description: Session Manager Events
739 unit: events/s
740 chart_type: line
741 dimensions:
742 - name: created
743 - name: invalidated
744 - name: timeout_invalidations
745 - name: affinity_breaks
746 - name: cache_discards
747 - name: no_room
748 - name: activate_non_exist
749 - name: global
750 description: These metrics refer to the entire monitored instance.
751 labels: []
752 metrics:
753 - name: websphere_pmi.cpu_utilization
754 description: CPU Utilization
755 unit: percentage
756 chart_type: line
757 dimensions:
758 - name: utilization
759 - name: global
760 description: These metrics refer to the entire monitored instance.
761 labels: []
762 metrics:
763 - name: websphere_pmi.system_data_usage
764 description: System Data Snapshot
765 unit: value
766 chart_type: line
767 dimensions:
768 - name: cpu_since_last
769 - name: free_memory
770 - name: threadpool
771 description: These metrics refer to threadpool instances.
772 labels:
773 - name: name
774 description: Name identifier
775 metrics:
776 - name: websphere_pmi.threadpool_usage
777 description: Thread Pool Usage
778 unit: threads
779 chart_type: stacked
780 dimensions:
781 - name: active
782 - name: size
783 - name: transactionmanager
784 description: These metrics refer to transactionmanager instances.
785 labels:
786 - name: node
787 description: Node identifier
788 - name: server
789 description: Server identifier
790 metrics:
791 - name: websphere_pmi.transaction_counts
792 description: Transaction Counts
793 unit: transactions/s
794 chart_type: line
795 dimensions:
796 - name: global_begun
797 - name: global_committed
798 - name: global_rolled_back
799 - name: global_timeout
800 - name: global_involved
801 - name: optimizations
802 - name: local_begun
803 - name: local_committed
804 - name: local_rolled_back
805 - name: local_timeout
806 - name: websphere_pmi.transaction_active
807 description: Active Transactions
808 unit: transactions
809 chart_type: line
810 dimensions:
811 - name: global
812 - name: local
813 - name: websphere_pmi.transaction_time
814 description: Transaction Durations
815 unit: milliseconds
816 chart_type: line
817 dimensions:
818 - name: global_total
819 - name: global_prepare
820 - name: global_commit
821 - name: global_before_completion
822 - name: local_total
823 - name: local_commit
824 - name: local_before_completion
825 - name: url
826 description: These metrics refer to url instances.
827 labels:
828 - name: node
829 description: Node identifier
830 - name: server
831 description: Server identifier
832 - name: url
833 description: Url identifier
834 metrics:
835 - name: websphere_pmi.url_requests
836 description: URL Requests
837 unit: requests/s
838 chart_type: line
839 dimensions:
840 - name: requests
841 - name: websphere_pmi.url_time
842 description: URL Service Time
843 unit: milliseconds
844 chart_type: line
845 dimensions:
846 - name: service
847 - name: async
848 - name: webapp
849 description: These metrics refer to webapp instances.
850 labels:
851 - name: node
852 description: Node identifier
853 - name: server
854 description: Server identifier
855 - name: app
856 description: App identifier
857 metrics:
858 - name: websphere_pmi.webapp_load
859 description: Web Application Load
860 unit: events
861 chart_type: line
862 dimensions:
863 - name: loaded_servlets
864 - name: reloads
865 - name: webservices
866 description: These metrics refer to webservices instances.
867 labels:
868 - name: node
869 description: Node identifier
870 - name: server
871 description: Server identifier
872 - name: service
873 description: Service identifier
874 metrics:
875 - name: websphere_pmi.web_services_loaded
876 description: Web Services Loaded
877 unit: services
878 chart_type: line
879 dimensions:
880 - name: loaded
881 - name: webservicesgateway
882 description: These metrics refer to webservicesgateway instances.
883 labels:
884 - name: node
885 description: Node identifier
886 - name: server
887 description: Server identifier
888 - name: gateway
889 description: Gateway identifier
890 metrics:
891 - name: websphere_pmi.web_services_gateway_requests
892 description: Web Services Gateway Requests
893 unit: requests/s
894 chart_type: line
895 dimensions:
896 - name: synchronous
897 - name: synchronous_responses
898 - name: asynchronous
899 - name: asynchronous_responses