Skip to content

AIX WebSphere

AIX WebSphere input collects server status through serverStatus.sh and supports metrics_command output for JVM, thread pool, HTTP session, and other metrics.

Configuration¶

[inputs]
# Global switch for middleware inputs.
enabled = true

[[inputs.websphere]]
# Instance name, reported as the `instance` tag.
name = "AppSrv01"
# Whether to enable this WebSphere instance collection.
enabled = true
# Collection interval.
interval = "60s"
# Optional file loaded before collection to set instance environment variables.
env_file = ""
# WebSphere profile path.
profile_path = "/opt/IBM/WebSphere/AppServer/profiles/AppSrv01"
server_status = "/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/bin/serverStatus.sh"
server_name = "server1"
# Optional custom command that outputs JVM, thread pool, and session metrics.
metrics_command = ""
# Optional custom metric command. Each output line should be `key=value`.
deep_metrics_command = ""

Command Dependencies¶

Command	Description
`serverStatus.sh -all`	Collect WebSphere server start/stop status.
`metrics_command`	Custom command that outputs JVM, thread pool, and session metrics.
`deep_metrics_command`	Custom command that outputs `key=value` lines for custom metrics.

Metrics¶

All metrics append host, input=websphere, and instance=<name> tags.

`websphere`¶

Tags & Fields	Description
server (`tag`)	Server name.
up	Whether a started server exists. Type: int \| (gauge)
started_servers	STARTED server count. Type: int \| (gauge) Unit: count
stopped_servers	STOPPED server count. Type: int \| (gauge) Unit: count
Other fields	`metrics_command` Numeric `key=value` fields output by Type: int/float \| (gauge)

`websphere_jvm`¶

Tags & Fields	Description
server (`tag`)	Server name.
jvm (`tag`)	JVM name.
heap_used_mb	Used heap. Type: int/float \| (gauge) Unit: MB
heap_committed_mb	committed heap. Type: int/float \| (gauge) Unit: MB
heap_max_mb	Maximum heap. Type: int/float \| (gauge) Unit: MB
threads	Thread count. Type: int/float \| (gauge) Unit: count
gc_count	GC count. Type: int/float \| (count) Unit: count
gc_time_ms	GC time. Type: int/float \| (count) Unit: ms

`websphere_thread_pool`¶

Tags & Fields	Description
thread_pool (`tag`)	Thread pool name.
active	Active thread count. Type: int/float \| (gauge) Unit: count
pool_size	Thread pool size. Type: int/float \| (gauge) Unit: count
hung	Hung thread count. Type: int/float \| (gauge) Unit: count
declared_thread_hung	Declared hung count. Type: int/float \| (count) Unit: count
cleared_thread_hung	Cleared hung count. Type: int/float \| (count) Unit: count

`websphere_http_session`¶

Tags & Fields	Description
application (`tag`)	Application name.
live	Current live session count. Type: int/float \| (gauge) Unit: count
created	Created session count. Type: int/float \| (count) Unit: count
invalidated	Invalidated session count. Type: int/float \| (count) Unit: count
timeout_invalidated	Timeout-invalidated session count. Type: int/float \| (count) Unit: count

Custom Metrics¶

Custom metric fields are determined by deep_metrics_command output. Fields listed in the table are used as tags; numeric values in other key=value pairs are reported as int/float | (gauge) fields, and non-numeric values are reported as tags. If no numeric field exists, count=1 is added with unit count.

Measurement	Tags	Description
`websphere_pmi`	`metric`, `module`, `unit`	Custom PMI metrics.
`websphere_jmx`	`mbean`, `attribute`, `unit`	Custom JMX metrics.
`websphere_application`	`application`, `module`, `status`	Custom application metrics.
`websphere_deep_metric`	`metric`, `unit`	Generic WebSphere custom metrics.