IBM WebSphere PMI

Plugin: ibm.d.plugin Module: websphere_pmi

Overview

Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface, covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information.

The collector connects to IBM WebSphere PMI and collects metrics via its monitoring interface.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

Enable monitoring interface

Ensure the IBM WebSphere PMI monitoring interface is accessible.

Configuration

Options

Configuration options for the websphere_pmi collector.

<details open><summary>Config options</summary>

Option	Description	Default	Required
update_every	Data collection frequency.	1	no
endpoint	Connection endpoint.	dummy://localhost	no

</details>

via File

The configuration file name for this integration is ibm.d/websphere_pmi.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config ibm.d/websphere_pmi.conf

Examples

Basic

Basic configuration example.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    endpoint: dummy://localhost

</details>

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per alarmmanager

These metrics refer to alarmmanager instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
manager	Manager identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.alarm_manager_events	Alarm Manager Events	created, cancelled, fired	events/s

Per dynamiccache

These metrics refer to dynamiccache instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
cache	Cache identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.dynamic_cache_in_memory	Dynamic Cache Entries	entries	entries
websphere_pmi.dynamic_cache_capacity	Dynamic Cache Capacity	max_entries	entries

Per enterprisebeans

These metrics refer to enterprisebeans instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
bean	Bean identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.ejb_operations	EJB Operations	create, remove, activate, passivate, instantiate, store, load	operations/s
websphere_pmi.ejb_messages	EJB Message Activity	received, backout	messages/s
websphere_pmi.ejb_pool	EJB Pool Usage	ready, live, pooled, active_method, passive, server_session_pool, method_ready, async_queue	beans
websphere_pmi.ejb_time	EJB Operation Time	activation, passivation, create, remove, load, store, method_response, wait, async_wait, read_lock, write_lock	milliseconds

Per extensionregistry

These metrics refer to extensionregistry instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.extension_registry_requests	Extension Registry Requests	requests, hits, displacements	events/s
websphere_pmi.extension_registry_hit_rate	Extension Registry Hit Rate	hit_rate	percentage

Per hamanager

These metrics refer to hamanager instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.ha_manager_groups	HA Manager Groups	local	groups
websphere_pmi.ha_manager_bulletin_board	HA Manager Bulletin Board	subjects, subscriptions, local_subjects, local_subscriptions	items
websphere_pmi.ha_manager_rebuild_time	HA Manager Rebuild Time	group_state, bulletin_board	milliseconds

Per jcapool

These metrics refer to jcapool instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
provider	Provider identifier
pool	Pool identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jca_pool_operations	JCA Pool Operations	create, close, allocate, freed, faults	operations/s
websphere_pmi.jca_pool_managed	JCA Pool Managed Resources	managed_connections, connection_handles	resources
websphere_pmi.jca_pool_utilization	JCA Pool Utilization	percent_used, percent_maxed	percentage
websphere_pmi.jca_pool_waiting	JCA Pool Waiting Threads	waiting_threads	threads

Per jdbcpool

These metrics refer to jdbcpool instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
pool	Pool identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jdbc_pool_usage	JDBC Pool Utilization	percent_used, percent_maxed	percentage
websphere_pmi.jdbc_pool_waiting	JDBC Pool Waiting Threads	waiting_threads	threads
websphere_pmi.jdbc_pool_connections	JDBC Pool Connections	managed, handles	connections
websphere_pmi.jdbc_pool_operations	JDBC Pool Operations	created, closed, allocated, returned, faults, prep_stmt_cache_discard	operations/s
websphere_pmi.jdbc_pool_time	JDBC Pool Time	use, wait, jdbc	milliseconds

Per jmsqueue

These metrics refer to jmsqueue instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
engine	Engine identifier
destination	Destination identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jms_queue_messages_produced	JMS Queue Messages Produced	total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent	messages/s
websphere_pmi.jms_queue_messages_consumed	JMS Queue Messages Consumed	total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent, expired	messages/s
websphere_pmi.jms_queue_clients	JMS Queue Clients	local_producers, local_producer_attaches, local_consumers, local_consumer_attaches	clients
websphere_pmi.jms_queue_storage	JMS Queue Storage	available, unavailable, oldest_age	messages
websphere_pmi.jms_queue_wait_time	JMS Queue Wait Time	aggregate, local	milliseconds

Per jmsstore

These metrics refer to jmsstore instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
engine	Engine identifier
section	Section identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jms_store_cache	JMS Store Cache	add_stored, add_not_stored, stored_current, stored_bytes, not_stored_current, not_stored_bytes, discard_count, discard_bytes	events
websphere_pmi.jms_store_datastore	JMS Store Datastore Operations	insert_batches, update_batches, delete_batches, insert_count, update_count, delete_count, open_count, abort_count, transaction_ms	events/s
websphere_pmi.jms_store_transactions	JMS Store Transactions	global_start, global_commit, global_abort, global_indoubt, local_start, local_commit, local_abort	transactions/s
websphere_pmi.jms_store_expiry	JMS Store Expiry Index	index_items	items

Per jmstopic

These metrics refer to jmstopic instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
engine	Engine identifier
destination	Destination identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jms_topic_publications	JMS Topic Publications	assured, best_effort, express	messages/s
websphere_pmi.jms_topic_subscription_hits	JMS Topic Subscription Hits	assured, best_effort, express	events/s
websphere_pmi.jms_topic_subscriptions	JMS Topic Subscriptions	durable_local	subscriptions
websphere_pmi.jms_topic_events	JMS Topic Events	incomplete_publications, publisher_attaches, subscriber_attaches	events/s
websphere_pmi.jms_topic_age	JMS Topic Oldest Publication Age	local_oldest	milliseconds

Per IBM WebSphere PMI instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.jvm_heap_usage	JVM Heap Memory Usage	used, free	bytes
websphere_pmi.jvm_heap_committed	JVM Heap Committed	committed	bytes
websphere_pmi.jvm_heap_max	JVM Heap Maximum	limit	bytes
websphere_pmi.jvm_uptime	JVM Uptime	uptime	seconds
websphere_pmi.jvm_cpu	JVM CPU Usage	usage	percentage
websphere_pmi.jvm_gc_collections	JVM GC Collections	collections	collections/s
websphere_pmi.jvm_gc_time	JVM GC Time	total	milliseconds
websphere_pmi.jvm_threads	JVM Threads	daemon, other	threads
websphere_pmi.jvm_threads_peak	JVM Peak Threads	peak	threads

Per orb

These metrics refer to orb instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.orb_concurrent	ORB Concurrent Requests	concurrent_requests	requests
websphere_pmi.orb_requests	ORB Requests	requests	requests/s

Per objectpool

These metrics refer to objectpool instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
pool	Pool identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.object_pool_operations	Object Pool Operations	created	operations/s
websphere_pmi.object_pool_size	Object Pool Size	allocated, returned, idle	objects

Per pmiwebservicemodule

These metrics refer to pmiwebservicemodule instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
module	Module identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.pmi_web_service_module_services	PMI Web Service Module Services	loaded	services

Per portlet

These metrics refer to portlet instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
portlet	Portlet identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.portlet_requests	Portlet Requests	requests	requests/s
websphere_pmi.portlet_concurrent	Portlet Concurrent Requests	concurrent	requests
websphere_pmi.portlet_errors	Portlet Errors	errors	errors/s
websphere_pmi.portlet_response_time	Portlet Response Time	render, action, process_event, serve_resource	milliseconds

Per portletapplication

These metrics refer to portletapplication instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.portlet_application_loaded	Loaded Portlets	loaded	portlets

Per schedulers

These metrics refer to schedulers instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
scheduler	Scheduler identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.scheduler_activity	Scheduler Activity	finished, failures, polls	events/s

Per securityauth

These metrics refer to securityauth instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.security_auth_counts	Security Authentication Counts	web, tai, identity, basic, token, jaas_identity, jaas_basic, jaas_token, rmi	events/s

Per securityauthz

These metrics refer to securityauthz instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.security_authz_time	Security Authorization Time	web, ejb, admin, cwwja	milliseconds

Per sessionmanager

These metrics refer to sessionmanager instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
app	App identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.session_manager_active	Session Manager Active Sessions	active, live	sessions
websphere_pmi.session_manager_events	Session Manager Events	created, invalidated, timeout_invalidations, affinity_breaks, cache_discards, no_room, activate_non_exist	events/s

Per IBM WebSphere PMI instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.cpu_utilization	CPU Utilization	utilization	percentage

Per IBM WebSphere PMI instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.system_data_usage	System Data Snapshot	cpu_since_last, free_memory	value

Per threadpool

These metrics refer to threadpool instances.

Labels:

Label	Description
name	Name identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.threadpool_usage	Thread Pool Usage	active, size	threads

Per transactionmanager

These metrics refer to transactionmanager instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.transaction_counts	Transaction Counts	global_begun, global_committed, global_rolled_back, global_timeout, global_involved, optimizations, local_begun, local_committed, local_rolled_back, local_timeout	transactions/s
websphere_pmi.transaction_active	Active Transactions	global, local	transactions
websphere_pmi.transaction_time	Transaction Durations	global_total, global_prepare, global_commit, global_before_completion, local_total, local_commit, local_before_completion	milliseconds

Per url

These metrics refer to url instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
url	Url identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.url_requests	URL Requests	requests	requests/s
websphere_pmi.url_time	URL Service Time	service, async	milliseconds

Per webapp

These metrics refer to webapp instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
app	App identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.webapp_load	Web Application Load	loaded_servlets, reloads	events

Per webservices

These metrics refer to webservices instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
service	Service identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.web_services_loaded	Web Services Loaded	loaded	services

Per webservicesgateway

These metrics refer to webservicesgateway instances.

Labels:

Label	Description
node	Node identifier
server	Server identifier
gateway	Gateway identifier

Metrics:

Metric	Description	Dimensions	Unit
websphere_pmi.web_services_gateway_requests	Web Services Gateway Requests	synchronous, synchronous_responses, asynchronous, asynchronous_responses	requests/s