@cryptotaxi247 / netdata-1 / commits / 2accbea02

Regenerate integrations docs (#21757)

Co-authored-by: ktsaou <2662304+ktsaou@users.noreply.github.com>

Netdata bot committed Feb 13, 2026 at 07:43 UTC 2accbea0273823f06c3973966f20454fb8afd1db
25 files changed +2794 -2627
src/collectors/COLLECTORS.md
+8
@@ -66,6 +66,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
66 | [CouchDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/couchdb/integrations/couchdb.md) | This collector monitors CouchDB servers. |
67 | [Elasticsearch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md) | This collector monitors the performance and health of the Elasticsearch cluster. |
68 | [HANA](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hana.md) | Track SAP HANA database metrics for efficient data storage and query performance. |
69 +| [IBM DB2](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/db2/integrations/ibm_db2.md) | Monitors IBM DB2 databases using system catalog views and MON_GET_* table functions to expose connections, locking, buffer pool efficiency, tablespace capacity, and workload performance metrics. |
70 | [IBM MQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_mq.md) | Keep tabs on IBM MQ message queue metrics for efficient message transport and performance. |
71 | [InfluxDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/influxdb.md) | Monitor InfluxDB time-series database metrics for efficient data storage and query performance. |
72 | [Kafka](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka.md) | Keep an eye on Kafka message queue metrics for optimized data streaming and performance. |
@@ -192,6 +193,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
193 | [Entropy](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/entropy.md) | Entropy, a measure of the randomness or unpredictability of data. |
194 | [FreeBSD RCTL-RACCT](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/freebsd_rctl-racct.md) | Keep an eye on FreeBSD Resource Container metrics for optimized resource management and performance. |
195 | [hw.intrcnt](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/hw.intrcnt.md) | Get total number of interrupts |
196 +| [IBM i (AS/400)](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/as400/integrations/ibm_i_as-400.md) | Monitors IBM i (AS/400) systems using SQL services and CL commands to expose CPU, memory, storage, job, and subsystem activity. |
197 | [Inter Process Communication](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/inter_process_communication.md) | IPC stands for Inter-Process Communication. |
198 | [Interrupts](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/interrupts.md) | Monitors `/proc/interrupts`, a file organized by CPU and then by the type of interrupt. |
199 | [kern.cp_time](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/kern.cp_time.md) | Total CPU utilization |
@@ -274,6 +276,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
276 | [net.inet6.ip6.stats](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/net.inet6.ip6.stats.md) | Collect information abou IPv6 stats. |
277 | [net.isr](https://github.com/netdata/netdata/blob/master/src/collectors/freebsd.plugin/integrations/net.isr.md) | Collect information about system softnet stat. |
278 | [Netfilter](https://github.com/netdata/netdata/blob/master/src/collectors/nfacct.plugin/integrations/netfilter.md) | Monitor Netfilter metrics for optimal packet filtering and manipulation. |
279 +| [Network Connections](https://github.com/netdata/netdata/blob/master/src/collectors/network-viewer.plugin/integrations/network_connections.md) | This plugin reads the system's socket tables to enumerate all active network connections, including TCP and UDP sockets in all states, for both IPv4 and IPv6. |
280 | [Network interfaces](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/network_interfaces.md) | Monitor network interface metrics about bandwidth, state, errors and more. |
281 | [Network statistics](https://github.com/netdata/netdata/blob/master/src/collectors/proc.plugin/integrations/network_statistics.md) | This integration provides metrics from the `netstat`, `snmp` and `snmp6` modules. |
282 | [Network Subsystem](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/network_subsystem.md) | Monitor network interface metrics about bandwidth, state, errors and more. |
@@ -325,6 +328,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
328 | [Hubble](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hubble.md) | Monitor Hubble network observability metrics for efficient network visibility and management. |
329 | [Jenkins](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jenkins.md) | Track Jenkins continuous integration server metrics for efficient development and build management. |
330 | [Linode](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/linode.md) | Monitor Linode cloud hosting metrics for efficient virtual server management and performance. |
331 +| [OpenTelemetry](https://github.com/netdata/netdata/blob/master/src/crates/netdata-otel/otel-plugin/integrations/opentelemetry.md) | This plugin ingests OpenTelemetry metrics and logs via the OTLP/gRPC protocol. |
332 | [Puppet](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/puppet/integrations/puppet.md) | This collector monitors Puppet metrics, including JVM heap and non-heap memory, CPU usage, and file descriptors. |
333 | [Spacelift](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/spacelift.md) | Track Spacelift infrastructure-as-code (IaC) platform metrics for efficient infrastructure automation and management. |
334 | [Zerto](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/zerto.md) | Monitor Zerto disaster recovery and data protection metrics for efficient backup and recovery management. |
@@ -425,6 +429,10 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
429 | [Homey](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/homey.md) | Track Homey smart home controller metrics for efficient home automation and performance. |
430 | [Honeypot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/honeypot.md) | Monitor honeypot metrics for efficient threat detection and management. |
431 | [IBM AIX systems Njmon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ibm_aix_systems_njmon.md) | Keep an eye on NJmon system performance monitoring metrics for efficient IT infrastructure management and performance. |
432 +| [IBM MQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/mq/integrations/ibm_mq.md) | Monitors IBM MQ queue managers, queues, channels, and topics using the PCF (Programmable Command Format) protocol. |
433 +| [IBM WebSphere JMX](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/websphere/jmx/integrations/ibm_websphere_jmx.md) | Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application Server via the embedded JMX bridge helper. |
434 +| [IBM WebSphere MicroProfile](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/websphere/mp/integrations/ibm_websphere_microprofile.md) | Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Liberty servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint. |
435 +| [IBM WebSphere PMI](https://github.com/netdata/netdata/blob/master/src/go/plugin/ibm.d/modules/websphere/pmi/integrations/ibm_websphere_pmi.md) | Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface, covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information. |
436 | [Icecast](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/icecast/integrations/icecast.md) | This collector monitors Icecast listener counts. |
437 | [JMX](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/jmx.md) | Track Java Management Extensions (JMX) metrics for efficient Java application management and performance. |
438 | [journald](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/journald.md) | Keep an eye on systemd-journald metrics for efficient log management and analysis. |
src/collectors/network-viewer.plugin/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/network_connections.md
\ No newline at end of file
src/collectors/network-viewer.plugin/integrations/network_connections.md new
+128
@@ -0,0 +1,128 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/network-viewer.plugin/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/network-viewer.plugin/metadata.yaml"
4 +sidebar_label: "Network Connections"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Networking"
7 +most_popular: False
8 +keywords: ['network', 'connections', 'sockets', 'tcp', 'udp', 'ports']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# Network Connections
13 +
14 +
15 +<img src="https://netdata.cloud/img/network.svg" width="150"/>
16 +
17 +
18 +Plugin: network-viewer.plugin
19 +Module: network-viewer.plugin
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +
26 +
27 +This plugin reads the system's socket tables to enumerate all active network connections,
28 +including TCP and UDP sockets in all states, for both IPv4 and IPv6.
29 +
30 +
31 +This collector is only supported on the following platforms:
32 +
33 +- Linux
34 +
35 +This collector only supports collecting metrics from a single instance of this integration.
36 +
37 +
38 +### Default Behavior
39 +
40 +#### Auto-Detection
41 +
42 +The plugin automatically detects all active network connections on the system.
43 +
44 +
45 +#### Limits
46 +
47 +The default configuration for this integration does not impose any limits on data collection.
48 +
49 +#### Performance Impact
50 +
51 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
52 +
53 +## Metrics
54 +
55 +
56 +
57 +
58 +## Functions
59 +
60 +This plugin exposes a real-time function for viewing active network connections.
61 +
62 +
63 +### Network Connections
64 +
65 +Shows active network connections with protocol details, states, addresses, ports, and performance metrics.
66 +
67 +Provides both aggregated and detailed views of TCP and UDP connections for IPv4 and IPv6,
68 +including connection direction (listen, inbound, outbound, local), process information,
69 +and TCP performance metrics (RTT, retransmissions).
70 +
71 +Connections are classified as system or container based on network namespace.
72 +
73 +
74 +| Aspect | Description |
75 +|:-------|:------------|
76 +| Name | `Network-viewer.plugin:network-connections` |
77 +| Require Cloud | no |
78 +| Performance | |
79 +| Security | |
80 +| Availability | |
81 +
82 +#### Prerequisites
83 +
84 +No additional configuration is required.
85 +
86 +#### Parameters
87 +
88 +This function has no parameters.
89 +
90 +#### Returns
91 +
92 +
93 +
94 +| Column | Type | Unit | Visibility | Description |
95 +|:-------|:-----|:-----|:-----------|:------------|
96 +
97 +
98 +
99 +## Alerts
100 +
101 +There are no alerts configured by default for this integration.
102 +
103 +
104 +## Setup
105 +
106 +
107 +### Prerequisites
108 +
109 +No action required.
110 +
111 +### Configuration
112 +
113 +#### Options
114 +
115 +
116 +
117 +There are no configuration options.
118 +
119 +
120 +
121 +#### via File
122 +
123 +There is no configuration file.
124 +
125 +##### Examples
126 +There are no configuration examples.
127 +
128 +
src/crates/netdata-otel/otel-plugin/README.md deleted
-111
@@ -1,111 +0,0 @@
1 -# OpenTelemetry Metrics (otel.plugin)
2 -
3 -`otel.plugin` is a [Netdata](https://github.com/netdata/netdata) external plugin,
4 -enabling users to ingest, store and visualize OpenTelemetry metrics in charts.
5 -
6 -## Configuration
7 -
8 -Edit the [otel.yaml](https://github.com/netdata/netdata/blob/master/src/crates/netdata-otel/otel-plugin/configs/otel.yaml)
9 -configuration file using `edit-config` from the Netdata
10 -[config directory](/docs/netdata-agent/configuration/README.md#locate-your-config-directory),
11 -which is typically located under `/etc/netdata`.
12 -
13 -```bash
14 -cd /etc/netdata # Replace this path with your Netdata config directory
15 -sudo ./edit-config otel.yaml
16 -```
17 -
18 -### gRPC Endpoint
19 -
20 -By default `otel.plugin` listens for incoming OTLP-formatted metrics on
21 -`localhost:4317` via gRPC. Users can set up a secure TLS connection by
22 -updating the TLS configuration in the `endpoint` section:
23 -
24 -```yaml
25 -endpoint:
26 - # gRPC endpoint to listen on for OpenTelemetry data
27 - path: "127.0.0.1:4317"
28 -
29 - # Path to TLS certificate file (enables TLS when provided)
30 - tls_cert_path: null
31 -
32 - # Path to TLS private key file (required when TLS certificate is provided)
33 - tls_key_path: null
34 -
35 - # Path to TLS CA certificate file for client authentication (optional)
36 - tls_ca_cert_path: null
37 -```
38 -
39 -## Metrics
40 -
41 -The `metrics` section allows users to specify the directory containing
42 -configuration files for mapping OpenTelemetry metrics to Netdata chart
43 -instances, and the number of metric samples the `otel.plugin` will use for
44 -detecting their collection interval:
45 -
46 -```yaml
47 -metrics:
48 - # Directory with configuration files for mapping OTEL metrics to Netdata charts
49 - # (relative paths are resolved based on Netdata's user configuration directory)
50 - chart_configs_dir: otel.d/v1/metrics/
51 -
52 - # Number of samples to buffer for collection interval detection
53 - buffer_samples: 10
54 -```
55 -
56 -### Mapping OpenTelemetry metrics to Netdata chart instances
57 -
58 -Without an explicit mapping, the `otel.plugin` defaults to creating distinct
59 -chart instances based on the attributes of each data point in a metric. Users
60 -can place their YAML chart configuration files under `otel.d/v1/metrics` to
61 -override, or fine-tune, the default mapping.
62 -
63 -For each instrumentation scope and metric name, the configuration defines
64 -the attributes that the `otel.plugin` will use when creating new chart
65 -instances and dimension names.
66 -
67 -For example, the following bit from the
68 -[otel.d/v1/metrics/hostmetrics.yaml](https://github.com/netdata/netdata/blob/master/src/crates/netdata-otel/otel-plugin/configs/otel.d/v1/metrics/hostmetrics-receiver.yaml)
69 - configuration file for the [hostmetrics](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md) receiver:
70 -```yaml
71 -select:
72 - instrumentation_scope_name: hostmetricsreceiver.*networkscraper
73 - metric_name: system.network.connections
74 -extract:
75 - chart_instance_pattern: metric.attributes.protocol
76 - dimension_name: metric.attributes.state
77 -```
78 -will apply to metrics whose instrumentation scope and metric names match the
79 -corresponding regular expressions specified in the values of the
80 -`instrumentation_scope_name` and `metric_name` keys. Similarly, the values of
81 -the `protocol` and `state` attributes of each data point in the matched metric
82 -will be used to create a new chart instance with the proper dimension names.
83 -
84 -## Logs
85 -
86 -The `logs` section configures how `otel.plugin` receives, stores, and manages
87 -OpenTelemetry logs. Logs are stored in `systemd`-compatible journal files that
88 -support rotation and retention policies for efficient storage management.
89 -
90 -### Rotation
91 -
92 -Rotation controls when a new journal file is created. A new file is created
93 -when **any** of the following limits is exceeded:
94 -
95 -| Option | Default | Description |
96 -|------------------------------|-----------|----------------------------------------------|
97 -| `size_of_journal_file` | `100MB` | Maximum file size before rotating |
98 -| `entries_of_journal_file` | `50000` | Maximum log entries per file |
99 -| `duration_of_journal_file` | `2 hours` | Maximum time span within a single file |
100 -
101 -### Retention
102 -
103 -Retention controls when old journal files are deleted, allowing you to limit
104 -the overall size of the logs directory. Files are removed (starting with the
105 -oldest) to satisfy **all** of the following limits:
106 -
107 -| Option | Default | Description |
108 -|------------------------------|----------|-----------------------------------|
109 -| `number_of_journal_files` | `10` | Maximum number of files to keep |
110 -| `size_of_journal_files` | `1GB` | Maximum total size of all files |
111 -| `duration_of_journal_files` | `7 days` | Maximum age of files |
src/crates/netdata-otel/otel-plugin/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/opentelemetry.md
\ No newline at end of file
src/crates/netdata-otel/otel-plugin/integrations/opentelemetry.md new
+166
@@ -0,0 +1,166 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/crates/netdata-otel/otel-plugin/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/crates/netdata-otel/otel-plugin/metadata.yaml"
4 +sidebar_label: "OpenTelemetry"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Cloud and DevOps"
7 +most_popular: True
8 +keywords: ['opentelemetry', 'otel', 'otlp', 'grpc', 'metrics', 'logs', 'observability']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# OpenTelemetry
13 +
14 +
15 +<img src="https://netdata.cloud/img/opentelemetry.svg" width="150"/>
16 +
17 +
18 +Plugin: otel.plugin
19 +Module: otel
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +This plugin ingests OpenTelemetry metrics and logs via the OTLP/gRPC protocol.
26 +
27 +It receives OTLP-formatted data from any OpenTelemetry-compatible source (collectors, SDKs, instrumented applications)
28 +and automatically creates Netdata charts for visualization and alerting.
29 +
30 +For logs, it stores them in systemd-compatible journal files with configurable rotation and retention policies.
31 +
32 +
33 +The plugin listens on a gRPC endpoint (default `127.0.0.1:4317`) for incoming OTLP data.
34 +It supports both metrics and logs signals. Metrics are mapped to Netdata charts using configurable
35 +mapping rules. Logs are stored in journal files for querying via the Netdata Logs tab.
36 +
37 +
38 +This collector is only supported on the following platforms:
39 +
40 +- Linux
41 +
42 +This collector only supports collecting metrics from a single instance of this integration.
43 +
44 +
45 +### Default Behavior
46 +
47 +#### Auto-Detection
48 +
49 +The plugin starts automatically and listens on `127.0.0.1:4317` for incoming OTLP/gRPC connections.
50 +
51 +
52 +#### Limits
53 +
54 +The default configuration for this integration does not impose any limits on data collection.
55 +
56 +#### Performance Impact
57 +
58 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
59 +
60 +## Metrics
61 +
62 +Metrics are dynamically created based on the OpenTelemetry data received.
63 +The specific metrics depend on the OTLP sources sending data to the plugin.
64 +
65 +
66 +
67 +## Alerts
68 +
69 +There are no alerts configured by default for this integration.
70 +
71 +
72 +## Setup
73 +
74 +
75 +### Prerequisites
76 +
77 +#### OpenTelemetry data source
78 +
79 +An OpenTelemetry Collector, SDK, or instrumented application configured to send OTLP data
80 +to the Netdata agent's gRPC endpoint.
81 +
82 +
83 +
84 +### Configuration
85 +
86 +#### Options
87 +
88 +The plugin is configured via `otel.yaml` in the Netdata configuration directory.
89 +
90 +
91 +<details open><summary>Config options</summary>
92 +
93 +
94 +
95 +| Option | Description | Default | Required |
96 +|:-----|:------------|:--------|:---------:|
97 +| endpoint.path | gRPC endpoint to listen on for incoming OTLP data. | 127.0.0.1:4317 | no |
98 +| endpoint.tls_cert_path | Path to TLS certificate file. Enables TLS when provided. | | no |
99 +| endpoint.tls_key_path | Path to TLS private key file. Required when TLS certificate is provided. | | no |
100 +| endpoint.tls_ca_cert_path | Path to TLS CA certificate file for client authentication. | | no |
101 +| metrics.chart_configs_dir | Directory with YAML files for mapping OTLP metrics to Netdata charts. | otel.d/v1/metrics/ | no |
102 +| metrics.buffer_samples | Number of samples to buffer for collection interval detection. | 10 | no |
103 +| metrics.throttle_charts | Maximum number of new charts to create per collection interval. | 100 | no |
104 +| logs.journal_dir | Directory to store journal files for ingested logs. | | yes |
105 +| logs.size_of_journal_file | Maximum file size before rotating to a new journal file. | 100MB | no |
106 +| logs.entries_of_journal_file | Maximum log entries per journal file. | 50000 | no |
107 +| logs.duration_of_journal_file | Maximum time span within a single journal file. | 2 hours | no |
108 +| logs.number_of_journal_files | Maximum number of journal files to keep. | 10 | no |
109 +| logs.size_of_journal_files | Maximum total size of all journal files. | 1GB | no |
110 +| logs.duration_of_journal_files | Maximum age of journal files. | 7 days | no |
111 +
112 +
113 +</details>
114 +
115 +
116 +
117 +#### via File
118 +
119 +The configuration file name for this integration is `otel.yaml`.
120 +
121 +
122 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
123 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
124 +
125 +```bash
126 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
127 +sudo ./edit-config otel.yaml
128 +```
129 +
130 +##### Examples
131 +
132 +###### Basic configuration
133 +
134 +Listen on default endpoint with default settings.
135 +
136 +```yaml
137 +endpoint:
138 + path: "127.0.0.1:4317"
139 +metrics:
140 + chart_configs_dir: otel.d/v1/metrics/
141 + buffer_samples: 10
142 +logs:
143 + journal_dir: /var/log/netdata/otel-journals
144 +
145 +```
146 +###### TLS-enabled configuration
147 +
148 +Listen with TLS enabled for secure connections.
149 +
150 +<details open><summary>Config</summary>
151 +
152 +```yaml
153 +endpoint:
154 + path: "0.0.0.0:4317"
155 + tls_cert_path: /etc/netdata/ssl/cert.pem
156 + tls_key_path: /etc/netdata/ssl/key.pem
157 +metrics:
158 + chart_configs_dir: otel.d/v1/metrics/
159 + buffer_samples: 10
160 +logs:
161 + journal_dir: /var/log/netdata/otel-journals
162 +
163 +```
164 +</details>
165 +
166 +
src/go/plugin/go.d/collector/dcgm/integrations/nvidia_dcgm_exporter.md
src/go/plugin/ibm.d/modules/as400/README.md deleted
-529
@@ -1,529 +0,0 @@
1 -# IBM i (AS/400) collector
2 -
3 -## Overview
4 -
5 -Monitors IBM i (AS/400) systems using SQL services and CL commands to
6 -expose CPU, memory, storage, job, and subsystem activity.
7 -
8 -**Dependencies:**
9 -- unixODBC 2.3+ with IBM i Access ODBC driver
10 -- IBM i 7.2 or later with SQL services enabled
11 -
12 -**Required Libraries:**
13 -- libodbc.so (provided by unixODBC)
14 -- IBM i Access Client Solutions
15 -
16 -**Collection paths**
17 -
18 -The collector executes queries in multiple tracks:
19 -
20 -- **Fast path (5s)**: lightweight system status queries remain sequential on the main plugin thread.
21 -- **Slow path (10s beat)**: heavier queries (per-queue metrics, subsystems, plan cache, etc.) run in a background worker with bounded concurrency.
22 -- **Batch path (≥60s beat)**: optional long-period worker used for expensive aggregate queries such as queue totals. Disabled by default unless queue totals are explicitly enabled.
23 -
24 -**CPU Collection Methods:**
25 -
26 -The collector uses a hybrid approach for CPU utilization metrics to handle IBM i 7.4+ where
27 -`AVERAGE_CPU_*` columns were deprecated:
28 -
29 -1. **Primary Method - TOTAL_CPU_TIME**: Uses the monotonic `TOTAL_CPU_TIME` counter from
30 - `QSYS2.SYSTEM_STATUS()` to calculate CPU utilization via delta-based calculation. This is
31 - the most accurate method but requires `*JOBCTL` special authority. TOTAL_CPU_TIME is a
32 - cumulative counter in nanoseconds representing CPU-seconds consumed, naturally in per-core
33 - scale.
34 -
35 -2. **Fallback Method - ELAPSED_CPU_USED**: If `*JOBCTL` authority is not available, falls back
36 - to `ELAPSED_CPU_USED` with automatic reset detection. This method tracks when IBM i statistics
37 - are reset (either manually or via `reset_statistics` configuration) and re-establishes a
38 - baseline after detecting resets. The values are already in per-core scale.
39 -
40 -3. **Legacy Method - AVERAGE_CPU_UTILIZATION**: For IBM i versions before 7.4, uses the now-
41 - deprecated `AVERAGE_CPU_UTILIZATION` column, which IBM reports in the same per-core scale.
42 -
43 -The collector automatically selects the appropriate method based on available permissions and
44 -logs which method is being used.
45 -
46 -**CPU Metric Scale:**
47 -
48 -CPU utilization is reported using the "100% = 1 CPU core" semantic. This means:
49 -- 100% indicates one CPU core is fully utilized
50 -- 400% indicates four CPU cores are fully utilized
51 -- Values are limited to 100% × ConfiguredCPUs, matching the partition's configured capacity
52 -
53 -For shared LPARs, the metrics show absolute CPU consumption in per-core scale, not relative to
54 -entitled capacity. For example, a shared LPAR entitled to 0.20 cores can show 150% utilization
55 -when bursting above entitlement.
56 -
57 -**Statistics Reset Behavior:**
58 -
59 -The `reset_statistics` configuration option controls whether the collector resets IBM i system
60 -statistics on each query via `SYSTEM_STATUS(RESET_STATISTICS=>'YES')`. When enabled:
61 -
62 -- System-level statistics (CPU, memory pools, etc.) are reset after each collection cycle
63 -- Matches legacy behavior but clears global statistics that other tools may rely on
64 -- The ELAPSED_CPU_USED fallback method will detect and handle these resets automatically
65 -- **Caution**: Enabling this affects all users and applications on the IBM i system
66 -
67 -Default: `false` (statistics are not reset, using `RESET_STATISTICS=>'NO'`)
68 -
69 -**Chart Gaps During Baseline Resets:**
70 -
71 -The `as400.system_activity_cpu_rate` and `as400.system_activity_cpu_utilization` charts rely on
72 -delta calculations. When the collector detects that IBM i reset these statistics—or when it is
73 -still establishing the initial baseline—it intentionally skips a sample instead of emitting a zero
74 -or spike. Netdata renders those skipped samples as small gaps, which is expected behaviour.
75 -
76 -**Cardinality Management:**
77 -
78 -To prevent performance issues from excessive metric creation, the collector enforces cardinality
79 -limits on per-instance metrics (disks, subsystems, job queues, message queues, output queues,
80 -active jobs, network interfaces, HTTP servers).
81 -
82 -**How Limits Work:**
83 -- The collector counts instances before collecting metrics
84 -- If count exceeds the configured `max_*` limit, **collection is skipped entirely** for that category
85 -- The collector logs a warning: `"[category] count (X) exceeds limit (Y), skipping collection"`
86 -- No metrics are collected for that category until you adjust the configuration
87 -
88 -**Configuration Options:**
89 -
90 -Use **both** limit and selector options together to manage high-cardinality environments:
91 -
92 -| Option | Purpose | Default |
93 -|--------|---------|---------|
94 -| `max_disks` | Maximum disk units to monitor | 100 |
95 -| `max_subsystems` | Maximum subsystems to monitor | 100 |
96 -| `max_job_queues` | Maximum job queues to monitor | 100 |
97 -| `max_message_queues` | Maximum message queues to monitor | 100 |
98 -| `max_output_queues` | Maximum output queues to monitor | 100 |
99 -| `active_jobs` | Fully qualified active jobs to monitor (`JOB_NUMBER/USER/JOB_NAME`) | `[]` |
100 -| `collect_disks_matching` | Glob pattern to filter disks (e.g., `"001* 002*"`) | `""` (match all) |
101 -| `collect_subsystems_matching` | Glob pattern to filter subsystems (e.g., `"QINTER QBATCH"`) | `""` (match all) |
102 -| `collect_job_queues_matching` | Glob pattern to filter job queues (e.g., `"QSYS/*"`) | `""` (match all) |
103 -
104 -Optional batch-path controls:
105 -
106 -| Option | Purpose | Default |
107 -|--------|---------|---------|
108 -| `batch_path` | Enables the long-period batch worker for aggregate queries | `false` |
109 -| `batch_path_update_every` | Batch worker cadence (minimum 60s, recommend ≥600s in production) | `60s` |
110 -| `batch_path_max_connections` | Maximum concurrent connections for batch queries | `1` |
111 -| `collect_message_queue_totals` | Enables full-scan counting of all message queues and messages | `auto` (off) |
112 -| `collect_job_queue_totals` | Enables aggregate counting of job queues and queued jobs | `auto` (off) |
113 -| `collect_output_queue_totals` | Enables aggregate counting of output queues and spooled files | `auto` (off) |
114 -
115 -> **Warning:** queue totals require scanning IBM i catalog views and can be very expensive on large systems. Leave these options disabled unless aggregate counts are absolutely necessary.
116 -
117 -
118 -**Example Workflow:**
119 -
120 -1. System has 500 disks, collector skips disk metrics (exceeds default limit of 100)
121 -2. Check logs: `"disk count (500) exceeds limit (100), skipping per-disk metrics"`
122 -3. Two options:
123 - - **Option A**: Increase limit: `max_disks: 500` (collects all 500 disks)
124 - - **Option B**: Use selector: `collect_disks_matching: "00[1-5]*"` (cherry-pick specific disks)
125 -
126 -**Best Practices:**
127 -- Use selectors to monitor only business-critical objects in large environments
128 -- Set limits based on your Netdata server's capacity (each instance = multiple charts)
129 -- Start with defaults and adjust based on actual usage patterns
130 -
131 -**IBM i 7.2–7.3 Behavior Note (Message Queues):**
132 -
133 -IBM i 7.4 introduced a message-queue table function that returns only the live backlog. On
134 -7.2–7.3 systems we fall back to the `QSYS2.MESSAGE_QUEUE_INFO` view, which includes *all*
135 -recorded messages (even those already processed/cleared from the queue). Aggregations—especially
136 -`MAX(SEVERITY)`—therefore reflect the historical log, not just the outstanding backlog. This
137 -behaviour is inherent to the IBM SQL service and can lead to higher-than-expected max severity
138 -values on pre-7.4 systems.
139 -
140 -Network interface metrics have a fixed internal limit of 50 instances, and HTTP server metrics are capped at 200 instances; these limits are currently not configurable.
141 -
142 -
143 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
144 -
145 -## Collected metrics
146 -
147 -Metrics grouped by scope.
148 -
149 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
150 -
151 -### Per IBM i (AS/400) instance
152 -
153 -
154 -These metrics refer to the entire monitored IBM i (AS/400) instance.
155 -
156 -This scope has no labels.
157 -
158 -Metrics:
159 -
160 -| Metric | Dimensions | Unit |
161 -|:-------|:-----------|:-----|
162 -| netdata.plugin_ibm.as400_query_latency_fast | count_disks, count_http_servers, count_network_interfaces, detect_ibmi_version_primary, detect_ibmi_version_fallback, disk_instances, disk_instances_enhanced, disk_status, http_server_info, job_info, memory_pools, network_connections, network_interfaces, serial_number, system_name, system_activity, system_model, system_status, temp_storage_named, temp_storage_total, technology_refresh_level, active_job | ms |
163 -| netdata.plugin_ibm.as400_query_latency_slow | analyze_plan_cache, count_subsystems, subsystems, message_queue_aggregates, job_queues, output_queue_info, plan_cache_summary | ms |
164 -| netdata.plugin_ibm.as400_query_latency_batch | message_queue_totals, job_queue_totals, output_queue_totals | ms |
165 -
166 -These metrics refer to the entire monitored IBM i (AS/400) instance.
167 -
168 -This scope has no labels.
169 -
170 -Metrics:
171 -
172 -| Metric | Dimensions | Unit |
173 -|:-------|:-----------|:-----|
174 -| as400.cpu_utilization | utilization | percentage |
175 -| as400.cpu_utilization_entitled | utilization | percentage |
176 -| as400.cpu_configuration | configured | cpus |
177 -| as400.cpu_capacity | capacity | percentage |
178 -| as400.total_jobs | total | jobs |
179 -| as400.active_jobs_by_type | batch, interactive, active | jobs |
180 -| as400.job_queue_length | waiting | jobs |
181 -| as400.main_storage_size | total | bytes |
182 -| as400.temporary_storage | current, maximum | MiB |
183 -| as400.memory_pool_usage | machine, base, interactive, spool | bytes |
184 -| as400.memory_pool_defined | machine, base | bytes |
185 -| as400.memory_pool_reserved | machine, base | bytes |
186 -| as400.memory_pool_threads | machine, base | threads |
187 -| as400.memory_pool_max_threads | machine, base | threads |
188 -| as400.disk_busy_average | busy | percentage |
189 -| as400.system_asp_usage | used | percentage |
190 -| as400.system_asp_storage | total | MiB |
191 -| as400.total_auxiliary_storage | total | MiB |
192 -| as400.system_threads | active, per_processor | threads |
193 -| as400.network_connections | remote, total | connections |
194 -| as400.network_connection_states | listen, close_wait | connections |
195 -| as400.temp_storage_total | current, peak | bytes |
196 -| as400.system_activity_cpu_rate | average | percentage |
197 -| as400.system_activity_cpu_utilization | average, minimum, maximum | percentage |
198 -
199 -
200 -
201 -### Per activejob
202 -
203 -These metrics refer to individual activejob instances.
204 -
205 -Labels:
206 -
207 -| Label | Description |
208 -|:------|:------------|
209 -| job_name | Job_name identifier |
210 -| job_status | Job_status identifier |
211 -| subsystem | Subsystem identifier |
212 -| job_type | Job_type identifier |
213 -
214 -Metrics:
215 -
216 -| Metric | Dimensions | Unit |
217 -|:-------|:-----------|:-----|
218 -| as400.activejob_cpu | cpu | percentage |
219 -| as400.activejob_resources | temp_storage | MiB |
220 -| as400.activejob_time | cpu_time, total_time | seconds |
221 -| as400.activejob_activity | disk_io, interactive_transactions | operations/s |
222 -| as400.activejob_threads | threads | threads |
223 -
224 -### Per disk
225 -
226 -These metrics refer to individual disk instances.
227 -
228 -Labels:
229 -
230 -| Label | Description |
231 -|:------|:------------|
232 -| disk_unit | Disk_unit identifier |
233 -| disk_type | Disk_type identifier |
234 -| disk_model | Disk_model identifier |
235 -| hardware_status | Hardware_status identifier |
236 -| disk_serial_number | Disk_serial_number identifier |
237 -
238 -Metrics:
239 -
240 -| Metric | Dimensions | Unit |
241 -|:-------|:-----------|:-----|
242 -| as400.disk_busy | busy | percentage |
243 -| as400.disk_io_requests | read, write | requests/s |
244 -| as400.disk_space_usage | used | percentage |
245 -| as400.disk_capacity | available, used | gigabytes |
246 -| as400.disk_blocks | read, write | blocks/s |
247 -| as400.disk_ssd_health | life_remaining | percentage |
248 -| as400.disk_ssd_age | power_on_days | days |
249 -
250 -### Per httpserver
251 -
252 -These metrics refer to individual httpserver instances.
253 -
254 -Labels:
255 -
256 -| Label | Description |
257 -|:------|:------------|
258 -| server | Server identifier |
259 -| function | Function identifier |
260 -
261 -Metrics:
262 -
263 -| Metric | Dimensions | Unit |
264 -|:-------|:-----------|:-----|
265 -| as400.http_server_connections | normal, ssl | connections |
266 -| as400.http_server_threads | active, idle | threads |
267 -| as400.http_server_requests | requests, responses, rejected | requests/s |
268 -| as400.http_server_bytes | received, sent | bytes/s |
269 -
270 -### Per jobqueue
271 -
272 -These metrics refer to individual jobqueue instances.
273 -
274 -Labels:
275 -
276 -| Label | Description |
277 -|:------|:------------|
278 -| job_queue | Job_queue identifier |
279 -| library | Library identifier |
280 -| status | Status identifier |
281 -
282 -Metrics:
283 -
284 -| Metric | Dimensions | Unit |
285 -|:-------|:-----------|:-----|
286 -| as400.jobqueue_length | jobs | jobs |
287 -
288 -### Per messagequeue
289 -
290 -These metrics refer to individual messagequeue instances.
291 -
292 -Labels:
293 -
294 -| Label | Description |
295 -|:------|:------------|
296 -| library | Library identifier |
297 -| queue | Queue identifier |
298 -
299 -Metrics:
300 -
301 -| Metric | Dimensions | Unit |
302 -|:-------|:-----------|:-----|
303 -| as400.message_queue_messages | total, informational, inquiry, diagnostic, escape, notify, sender_copy | messages |
304 -| as400.message_queue_severity | max | severity |
305 -
306 -### Per networkinterface
307 -
308 -These metrics refer to individual networkinterface instances.
309 -
310 -Labels:
311 -
312 -| Label | Description |
313 -|:------|:------------|
314 -| interface | Interface identifier |
315 -| interface_type | Interface_type identifier |
316 -| connection_type | Connection_type identifier |
317 -| internet_address | Internet_address identifier |
318 -| network_address | Network_address identifier |
319 -| subnet_mask | Subnet_mask identifier |
320 -
321 -Metrics:
322 -
323 -| Metric | Dimensions | Unit |
324 -|:-------|:-----------|:-----|
325 -| as400.network_interface_status | active | status |
326 -| as400.network_interface_mtu | mtu | bytes |
327 -
328 -### Per outputqueue
329 -
330 -These metrics refer to individual outputqueue instances.
331 -
332 -Labels:
333 -
334 -| Label | Description |
335 -|:------|:------------|
336 -| library | Library identifier |
337 -| queue | Queue identifier |
338 -| status | Status identifier |
339 -
340 -Metrics:
341 -
342 -| Metric | Dimensions | Unit |
343 -|:-------|:-----------|:-----|
344 -| as400.output_queue_files | files | files |
345 -| as400.output_queue_writers | writers | writers |
346 -| as400.output_queue_status | released | state |
347 -
348 -### Per plancache
349 -
350 -These metrics refer to individual plancache instances.
351 -
352 -Labels:
353 -
354 -| Label | Description |
355 -|:------|:------------|
356 -| metric | Metric identifier |
357 -
358 -Metrics:
359 -
360 -| Metric | Dimensions | Unit |
361 -|:-------|:-----------|:-----|
362 -| as400.plan_cache_summary | value | value |
363 -
364 -### Per queueoverview
365 -
366 -These metrics refer to individual queueoverview instances.
367 -
368 -Labels:
369 -
370 -| Label | Description |
371 -|:------|:------------|
372 -| queue_type | Queue_type identifier |
373 -| item_type | Item_type identifier |
374 -
375 -Metrics:
376 -
377 -| Metric | Dimensions | Unit |
378 -|:-------|:-----------|:-----|
379 -| as400.queues_count | queues | queues |
380 -| as400.queued_items | items | items |
381 -
382 -### Per subsystem
383 -
384 -These metrics refer to individual subsystem instances.
385 -
386 -Labels:
387 -
388 -| Label | Description |
389 -|:------|:------------|
390 -| subsystem | Subsystem identifier |
391 -| library | Library identifier |
392 -| status | Status identifier |
393 -
394 -Metrics:
395 -
396 -| Metric | Dimensions | Unit |
397 -|:-------|:-----------|:-----|
398 -| as400.subsystem_jobs | active, maximum | jobs |
399 -
400 -### Per tempstoragebucket
401 -
402 -These metrics refer to individual tempstoragebucket instances.
403 -
404 -Labels:
405 -
406 -| Label | Description |
407 -|:------|:------------|
408 -| bucket | Bucket identifier |
409 -
410 -Metrics:
411 -
412 -| Metric | Dimensions | Unit |
413 -|:-------|:-----------|:-----|
414 -| as400.temp_storage_bucket | current, peak | bytes |
415 -
416 -
417 -## Configuration
418 -
419 -### File
420 -
421 -The configuration file name for this integration is `ibm.d/as400.conf`.
422 -
423 -You can edit the configuration file using the `edit-config` script from the
424 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
425 -
426 -```bash
427 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
428 -sudo ./edit-config ibm.d/as400.conf
429 -```
430 -
431 -### Options
432 -
433 -The following options can be defined globally or per job.
434 -
435 -| Name | Description | Default | Required | Min | Max |
436 -|:-----|:------------|:--------|:---------|:----|:----|
437 -| update_every | Data collection frequency | `5` | no | 1 | - |
438 -| Vnode | Vnode allows binding the collector to a virtual node. | `` | no | - | - |
439 -| DSN | DSN provides a full IBM i ODBC connection string if manual override is needed. | `` | no | - | - |
440 -| Timeout | Timeout controls how long to wait for SQL statements and RPCs. | `2000000000` | no | - | - |
441 -| Hostname | Hostname is the remote IBM i host to monitor. | `` | no | - | - |
442 -| Port | Port is the TCP port for the IBM i Access ODBC server. | `8471` | no | 1 | 65535 |
443 -| Username | Username supplies the credentials used for authentication. | `` | no | - | - |
444 -| Password | Password supplies the password used for authentication. | `` | no | - | - |
445 -| Database | Database selects the IBM i database (library) to use when building the DSN. | `*SYSBAS` | no | - | - |
446 -| ConnectionType | ConnectionType selects how the collector connects (currently only "odbc"). | `odbc` | no | - | - |
447 -| ODBCDriver | ODBCDriver specifies the driver name registered on the host. | `IBM i Access ODBC Driver` | no | - | - |
448 -| UseSSL | UseSSL enables TLS for the ODBC connection when supported by the driver. | `false` | no | - | - |
449 -| ResetStatistics | ResetStatistics toggles destructive SQL services that reset system statistics on each query. | `false` | no | - | - |
450 -| CollectDiskMetrics | CollectDiskMetrics toggles collection of disk unit statistics. | `auto` | no | - | - |
451 -| CollectSubsystemMetrics | CollectSubsystemMetrics toggles collection of subsystem activity metrics. | `auto` | no | - | - |
452 -| CollectActiveJobs | CollectActiveJobs toggles collection of detailed per-job metrics. | `auto` | no | - | - |
453 -| CollectHTTPServerMetrics | CollectHTTPServerMetrics toggles collection of IBM HTTP Server statistics. | `auto` | no | - | - |
454 -| CollectPlanCacheMetrics | CollectPlanCacheMetrics toggles collection of plan cache analysis metrics. | `auto` | no | - | - |
455 -| CollectMessageQueueTotals | CollectMessageQueueTotals enables expensive aggregate counting across all message queues. | `auto` | no | - | - |
456 -| CollectJobQueueTotals | CollectJobQueueTotals enables expensive aggregate counting across all job queues. | `auto` | no | - | - |
457 -| CollectOutputQueueTotals | CollectOutputQueueTotals enables expensive aggregate counting across all output queues. | `auto` | no | - | - |
458 -| SlowPath | SlowPath enables the asynchronous slow-path worker for heavy queries. | `true` | no | - | - |
459 -| SlowPathUpdateEvery | SlowPathUpdateEvery controls the beat interval for the slow-path worker. | `10000000000` | no | - | - |
460 -| SlowPathMaxConnections | SlowPathMaxConnections caps the number of concurrent queries the slow-path worker may run. | `1` | no | - | - |
461 -| BatchPath | BatchPath enables the long-period batch worker for expensive queue aggregates. | `false` | no | - | - |
462 -| BatchPathUpdateEvery | BatchPathUpdateEvery controls the beat interval for the batch worker. | `60000000000` | no | - | - |
463 -| BatchPathMaxConnections | BatchPathMaxConnections caps concurrent queries for the batch worker. | `1` | no | - | - |
464 -| MaxDisks | MaxDisks caps how many disk units may be charted. | `100` | no | - | - |
465 -| MaxSubsystems | MaxSubsystems caps how many subsystems may be charted. | `100` | no | - | - |
466 -| DiskSelector | DiskSelector filters disk units by name using glob-style patterns. | `` | no | - | - |
467 -| SubsystemSelector | SubsystemSelector filters subsystems by name using glob-style patterns. | `` | no | - | - |
468 -| ActiveJobs | ActiveJobs lists active jobs to monitor, using fully-qualified job identifiers (JOB_NUMBER/USER/JOB_NAME). When empty, active job collection is disabled. | `nil` | no | - | - |
469 -| MessageQueues | MessageQueues lists message queues to collect, formatted as LIBRARY/QUEUE strings. When empty, message queue collection is disabled. The default configuration monitors QSYS/QSYSOPR, QSYS/QSYSMSG, and QSYS/QHST. | `[QSYS/QSYSOPR QSYS/QSYSMSG QSYS/QHST]` | no | - | - |
470 -| JobQueues | JobQueues lists job queues to collect, formatted as LIBRARY/QUEUE strings. When empty, job queue collection is disabled. | `nil` | no | - | - |
471 -| OutputQueues | OutputQueues lists output queues to collect, formatted as LIBRARY/QUEUE strings. When empty, output queue collection is disabled. | `nil` | no | - | - |
472 -
473 -### Examples
474 -
475 -#### Basic configuration
476 -
477 -IBM i (AS/400) monitoring with default settings.
478 -
479 -<details>
480 -<summary>Config</summary>
481 -
482 -```yaml
483 -jobs:
484 - - name: local
485 - endpoint: dummy://localhost
486 -```
487 -
488 -</details>
489 -
490 -## Troubleshooting
491 -
492 -### Debug Mode
493 -
494 -To troubleshoot issues with the `as400` collector, run the `ibm.d.plugin` with the debug option enabled.
495 -The output should give you clues as to why the collector isn't working.
496 -
497 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
498 -- Switch to the `netdata` user
499 -- Run the `ibm.d.plugin` to debug the collector:
500 -
501 -```bash
502 -sudo -u netdata ./ibm.d.plugin -d -m as400
503 -```
504 -
505 -## Getting Logs
506 -
507 -If you're encountering problems with the `as400` collector, follow these steps to retrieve logs and identify potential issues:
508 -
509 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
510 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
511 -
512 -### For systemd systems (most Linux distributions)
513 -
514 -```bash
515 -sudo journalctl -u netdata --reverse | grep as400
516 -```
517 -
518 -### For non-systemd systems
519 -
520 -```bash
521 -sudo grep as400 /var/log/netdata/error.log
522 -sudo grep as400 /var/log/netdata/collector.log
523 -```
524 -
525 -### For Docker containers
526 -
527 -```bash
528 -sudo docker logs netdata 2>&1 | grep as400
529 -```
src/go/plugin/ibm.d/modules/as400/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_i_as-400.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/as400/integrations/ibm_i_as-400.md new
+525
@@ -0,0 +1,525 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/as400/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/as400/metadata.yaml"
4 +sidebar_label: "IBM i (AS/400)"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Operating Systems"
7 +most_popular: False
8 +keywords: ['as400']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM i (AS/400)
13 +
14 +
15 +<img src="https://netdata.cloud/img/ibm-i.svg" width="150"/>
16 +
17 +
18 +Plugin: ibm.d.plugin
19 +Module: as400
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitors IBM i (AS/400) systems using SQL services and CL commands to
26 +expose CPU, memory, storage, job, and subsystem activity.
27 +
28 +**Dependencies:**
29 +- unixODBC 2.3+ with IBM i Access ODBC driver
30 +- IBM i 7.2 or later with SQL services enabled
31 +
32 +**Required Libraries:**
33 +- libodbc.so (provided by unixODBC)
34 +- IBM i Access Client Solutions
35 +
36 +**Collection paths**
37 +
38 +The collector executes queries in multiple tracks:
39 +
40 +- **Fast path (5s)**: lightweight system status queries remain sequential on the main plugin thread.
41 +- **Slow path (10s beat)**: heavier queries (per-queue metrics, subsystems, plan cache, etc.) run in a background worker with bounded concurrency.
42 +- **Batch path (≥60s beat)**: optional long-period worker used for expensive aggregate queries such as queue totals. Disabled by default unless queue totals are explicitly enabled.
43 +
44 +**CPU Collection Methods:**
45 +
46 +The collector uses a hybrid approach for CPU utilization metrics to handle IBM i 7.4+ where
47 +`AVERAGE_CPU_*` columns were deprecated:
48 +
49 +1. **Primary Method - TOTAL_CPU_TIME**: Uses the monotonic `TOTAL_CPU_TIME` counter from
50 + `QSYS2.SYSTEM_STATUS()` to calculate CPU utilization via delta-based calculation. This is
51 + the most accurate method but requires `*JOBCTL` special authority. TOTAL_CPU_TIME is a
52 + cumulative counter in nanoseconds representing CPU-seconds consumed, naturally in per-core
53 + scale.
54 +
55 +2. **Fallback Method - ELAPSED_CPU_USED**: If `*JOBCTL` authority is not available, falls back
56 + to `ELAPSED_CPU_USED` with automatic reset detection. This method tracks when IBM i statistics
57 + are reset (either manually or via `reset_statistics` configuration) and re-establishes a
58 + baseline after detecting resets. The values are already in per-core scale.
59 +
60 +3. **Legacy Method - AVERAGE_CPU_UTILIZATION**: For IBM i versions before 7.4, uses the now-
61 + deprecated `AVERAGE_CPU_UTILIZATION` column, which IBM reports in the same per-core scale.
62 +
63 +The collector automatically selects the appropriate method based on available permissions and
64 +logs which method is being used.
65 +
66 +**CPU Metric Scale:**
67 +
68 +CPU utilization is reported using the "100% = 1 CPU core" semantic. This means:
69 +- 100% indicates one CPU core is fully utilized
70 +- 400% indicates four CPU cores are fully utilized
71 +- Values are limited to 100% × ConfiguredCPUs, matching the partition's configured capacity
72 +
73 +For shared LPARs, the metrics show absolute CPU consumption in per-core scale, not relative to
74 +entitled capacity. For example, a shared LPAR entitled to 0.20 cores can show 150% utilization
75 +when bursting above entitlement.
76 +
77 +**Statistics Reset Behavior:**
78 +
79 +The `reset_statistics` configuration option controls whether the collector resets IBM i system
80 +statistics on each query via `SYSTEM_STATUS(RESET_STATISTICS=>'YES')`. When enabled:
81 +
82 +- System-level statistics (CPU, memory pools, etc.) are reset after each collection cycle
83 +- Matches legacy behavior but clears global statistics that other tools may rely on
84 +- The ELAPSED_CPU_USED fallback method will detect and handle these resets automatically
85 +- **Caution**: Enabling this affects all users and applications on the IBM i system
86 +
87 +Default: `false` (statistics are not reset, using `RESET_STATISTICS=>'NO'`)
88 +
89 +**Chart Gaps During Baseline Resets:**
90 +
91 +The `as400.system_activity_cpu_rate` and `as400.system_activity_cpu_utilization` charts rely on
92 +delta calculations. When the collector detects that IBM i reset these statistics—or when it is
93 +still establishing the initial baseline—it intentionally skips a sample instead of emitting a zero
94 +or spike. Netdata renders those skipped samples as small gaps, which is expected behaviour.
95 +
96 +**Cardinality Management:**
97 +
98 +To prevent performance issues from excessive metric creation, the collector enforces cardinality
99 +limits on per-instance metrics (disks, subsystems, job queues, message queues, output queues,
100 +active jobs, network interfaces, HTTP servers).
101 +
102 +**How Limits Work:**
103 +- The collector counts instances before collecting metrics
104 +- If count exceeds the configured `max_*` limit, **collection is skipped entirely** for that category
105 +- The collector logs a warning: `"[category] count (X) exceeds limit (Y), skipping collection"`
106 +- No metrics are collected for that category until you adjust the configuration
107 +
108 +**Configuration Options:**
109 +
110 +Use **both** limit and selector options together to manage high-cardinality environments:
111 +
112 +| Option | Purpose | Default |
113 +|--------|---------|---------|
114 +| `max_disks` | Maximum disk units to monitor | 100 |
115 +| `max_subsystems` | Maximum subsystems to monitor | 100 |
116 +| `max_job_queues` | Maximum job queues to monitor | 100 |
117 +| `max_message_queues` | Maximum message queues to monitor | 100 |
118 +| `max_output_queues` | Maximum output queues to monitor | 100 |
119 +| `active_jobs` | Fully qualified active jobs to monitor (`JOB_NUMBER/USER/JOB_NAME`) | `[]` |
120 +| `collect_disks_matching` | Glob pattern to filter disks (e.g., `"001* 002*"`) | `""` (match all) |
121 +| `collect_subsystems_matching` | Glob pattern to filter subsystems (e.g., `"QINTER QBATCH"`) | `""` (match all) |
122 +| `collect_job_queues_matching` | Glob pattern to filter job queues (e.g., `"QSYS/*"`) | `""` (match all) |
123 +
124 +Optional batch-path controls:
125 +
126 +| Option | Purpose | Default |
127 +|--------|---------|---------|
128 +| `batch_path` | Enables the long-period batch worker for aggregate queries | `false` |
129 +| `batch_path_update_every` | Batch worker cadence (minimum 60s, recommend ≥600s in production) | `60s` |
130 +| `batch_path_max_connections` | Maximum concurrent connections for batch queries | `1` |
131 +| `collect_message_queue_totals` | Enables full-scan counting of all message queues and messages | `auto` (off) |
132 +| `collect_job_queue_totals` | Enables aggregate counting of job queues and queued jobs | `auto` (off) |
133 +| `collect_output_queue_totals` | Enables aggregate counting of output queues and spooled files | `auto` (off) |
134 +
135 +> **Warning:** queue totals require scanning IBM i catalog views and can be very expensive on large systems. Leave these options disabled unless aggregate counts are absolutely necessary.
136 +
137 +
138 +**Example Workflow:**
139 +
140 +1. System has 500 disks, collector skips disk metrics (exceeds default limit of 100)
141 +2. Check logs: `"disk count (500) exceeds limit (100), skipping per-disk metrics"`
142 +3. Two options:
143 + - **Option A**: Increase limit: `max_disks: 500` (collects all 500 disks)
144 + - **Option B**: Use selector: `collect_disks_matching: "00[1-5]*"` (cherry-pick specific disks)
145 +
146 +**Best Practices:**
147 +- Use selectors to monitor only business-critical objects in large environments
148 +- Set limits based on your Netdata server's capacity (each instance = multiple charts)
149 +- Start with defaults and adjust based on actual usage patterns
150 +
151 +**IBM i 7.2–7.3 Behavior Note (Message Queues):**
152 +
153 +IBM i 7.4 introduced a message-queue table function that returns only the live backlog. On
154 +7.2–7.3 systems we fall back to the `QSYS2.MESSAGE_QUEUE_INFO` view, which includes *all*
155 +recorded messages (even those already processed/cleared from the queue). Aggregations—especially
156 +`MAX(SEVERITY)`—therefore reflect the historical log, not just the outstanding backlog. This
157 +behaviour is inherent to the IBM SQL service and can lead to higher-than-expected max severity
158 +values on pre-7.4 systems.
159 +
160 +Network interface metrics have a fixed internal limit of 50 instances, and HTTP server metrics are capped at 200 instances; these limits are currently not configurable.
161 +
162 +
163 +The collector connects to IBM i (AS/400) and collects metrics via its monitoring interface.
164 +
165 +
166 +This collector is supported on all platforms.
167 +
168 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
169 +
170 +
171 +### Default Behavior
172 +
173 +#### Auto-Detection
174 +
175 +This integration doesn't support auto-detection.
176 +
177 +#### Limits
178 +
179 +The default configuration for this integration does not impose any limits on data collection.
180 +
181 +#### Performance Impact
182 +
183 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
184 +
185 +## Metrics
186 +
187 +Metrics grouped by *scope*.
188 +
189 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
190 +
191 +
192 +
193 +### Per activejob
194 +
195 +These metrics refer to activejob instances.
196 +
197 +Labels:
198 +
199 +| Label | Description |
200 +|:-----------|:----------------|
201 +| job_name | Job_name identifier |
202 +| job_status | Job_status identifier |
203 +| subsystem | Subsystem identifier |
204 +| job_type | Job_type identifier |
205 +
206 +Metrics:
207 +
208 +| Metric | Dimensions | Unit |
209 +|:------|:----------|:----|
210 +| as400.activejob_cpu | cpu | percentage |
211 +| as400.activejob_resources | temp_storage | MiB |
212 +| as400.activejob_time | cpu_time, total_time | seconds |
213 +| as400.activejob_activity | disk_io, interactive_transactions | operations/s |
214 +| as400.activejob_threads | threads | threads |
215 +
216 +### Per disk
217 +
218 +These metrics refer to disk instances.
219 +
220 +Labels:
221 +
222 +| Label | Description |
223 +|:-----------|:----------------|
224 +| disk_unit | Disk_unit identifier |
225 +| disk_type | Disk_type identifier |
226 +| disk_model | Disk_model identifier |
227 +| hardware_status | Hardware_status identifier |
228 +| disk_serial_number | Disk_serial_number identifier |
229 +
230 +Metrics:
231 +
232 +| Metric | Dimensions | Unit |
233 +|:------|:----------|:----|
234 +| as400.disk_busy | busy | percentage |
235 +| as400.disk_io_requests | read, write | requests/s |
236 +| as400.disk_space_usage | used | percentage |
237 +| as400.disk_capacity | available, used | gigabytes |
238 +| as400.disk_blocks | read, write | blocks/s |
239 +| as400.disk_ssd_health | life_remaining | percentage |
240 +| as400.disk_ssd_age | power_on_days | days |
241 +
242 +### Per httpserver
243 +
244 +These metrics refer to httpserver instances.
245 +
246 +Labels:
247 +
248 +| Label | Description |
249 +|:-----------|:----------------|
250 +| server | Server identifier |
251 +| function | Function identifier |
252 +
253 +Metrics:
254 +
255 +| Metric | Dimensions | Unit |
256 +|:------|:----------|:----|
257 +| as400.http_server_connections | normal, ssl | connections |
258 +| as400.http_server_threads | active, idle | threads |
259 +| as400.http_server_requests | requests, responses, rejected | requests/s |
260 +| as400.http_server_bytes | received, sent | bytes/s |
261 +
262 +### Per jobqueue
263 +
264 +These metrics refer to jobqueue instances.
265 +
266 +Labels:
267 +
268 +| Label | Description |
269 +|:-----------|:----------------|
270 +| job_queue | Job_queue identifier |
271 +| library | Library identifier |
272 +| status | Status identifier |
273 +
274 +Metrics:
275 +
276 +| Metric | Dimensions | Unit |
277 +|:------|:----------|:----|
278 +| as400.jobqueue_length | jobs | jobs |
279 +
280 +### Per messagequeue
281 +
282 +These metrics refer to messagequeue instances.
283 +
284 +Labels:
285 +
286 +| Label | Description |
287 +|:-----------|:----------------|
288 +| library | Library identifier |
289 +| queue | Queue identifier |
290 +
291 +Metrics:
292 +
293 +| Metric | Dimensions | Unit |
294 +|:------|:----------|:----|
295 +| as400.message_queue_messages | total, informational, inquiry, diagnostic, escape, notify, sender_copy | messages |
296 +| as400.message_queue_severity | max | severity |
297 +
298 +### Per networkinterface
299 +
300 +These metrics refer to networkinterface instances.
301 +
302 +Labels:
303 +
304 +| Label | Description |
305 +|:-----------|:----------------|
306 +| interface | Interface identifier |
307 +| interface_type | Interface_type identifier |
308 +| connection_type | Connection_type identifier |
309 +| internet_address | Internet_address identifier |
310 +| network_address | Network_address identifier |
311 +| subnet_mask | Subnet_mask identifier |
312 +
313 +Metrics:
314 +
315 +| Metric | Dimensions | Unit |
316 +|:------|:----------|:----|
317 +| as400.network_interface_status | active | status |
318 +| as400.network_interface_mtu | mtu | bytes |
319 +
320 +### Per IBM i (AS/400) instance
321 +
322 +These metrics refer to the entire monitored instance.
323 +
324 +This scope has no labels.
325 +
326 +Metrics:
327 +
328 +| Metric | Dimensions | Unit |
329 +|:------|:----------|:----|
330 +| netdata.plugin_ibm.as400_query_latency_fast | count_disks, count_http_servers, count_network_interfaces, detect_ibmi_version_primary, detect_ibmi_version_fallback, disk_instances, disk_instances_enhanced, disk_status, http_server_info, job_info, memory_pools, network_connections, network_interfaces, serial_number, system_name, system_activity, system_model, system_status, temp_storage_named, temp_storage_total, technology_refresh_level, active_job | ms |
331 +| netdata.plugin_ibm.as400_query_latency_slow | analyze_plan_cache, count_subsystems, subsystems, message_queue_aggregates, job_queues, output_queue_info, plan_cache_summary | ms |
332 +| netdata.plugin_ibm.as400_query_latency_batch | message_queue_totals, job_queue_totals, output_queue_totals | ms |
333 +
334 +### Per outputqueue
335 +
336 +These metrics refer to outputqueue instances.
337 +
338 +Labels:
339 +
340 +| Label | Description |
341 +|:-----------|:----------------|
342 +| library | Library identifier |
343 +| queue | Queue identifier |
344 +| status | Status identifier |
345 +
346 +Metrics:
347 +
348 +| Metric | Dimensions | Unit |
349 +|:------|:----------|:----|
350 +| as400.output_queue_files | files | files |
351 +| as400.output_queue_writers | writers | writers |
352 +| as400.output_queue_status | released | state |
353 +
354 +### Per plancache
355 +
356 +These metrics refer to plancache instances.
357 +
358 +Labels:
359 +
360 +| Label | Description |
361 +|:-----------|:----------------|
362 +| metric | Metric identifier |
363 +
364 +Metrics:
365 +
366 +| Metric | Dimensions | Unit |
367 +|:------|:----------|:----|
368 +| as400.plan_cache_summary | value | value |
369 +
370 +### Per queueoverview
371 +
372 +These metrics refer to queueoverview instances.
373 +
374 +Labels:
375 +
376 +| Label | Description |
377 +|:-----------|:----------------|
378 +| queue_type | Queue_type identifier |
379 +| item_type | Item_type identifier |
380 +
381 +Metrics:
382 +
383 +| Metric | Dimensions | Unit |
384 +|:------|:----------|:----|
385 +| as400.queues_count | queues | queues |
386 +| as400.queued_items | items | items |
387 +
388 +### Per subsystem
389 +
390 +These metrics refer to subsystem instances.
391 +
392 +Labels:
393 +
394 +| Label | Description |
395 +|:-----------|:----------------|
396 +| subsystem | Subsystem identifier |
397 +| library | Library identifier |
398 +| status | Status identifier |
399 +
400 +Metrics:
401 +
402 +| Metric | Dimensions | Unit |
403 +|:------|:----------|:----|
404 +| as400.subsystem_jobs | active, maximum | jobs |
405 +
406 +### Per IBM i (AS/400) instance
407 +
408 +These metrics refer to the entire monitored instance.
409 +
410 +This scope has no labels.
411 +
412 +Metrics:
413 +
414 +| Metric | Dimensions | Unit |
415 +|:------|:----------|:----|
416 +| as400.cpu_utilization | utilization | percentage |
417 +| as400.cpu_utilization_entitled | utilization | percentage |
418 +| as400.cpu_configuration | configured | cpus |
419 +| as400.cpu_capacity | capacity | percentage |
420 +| as400.total_jobs | total | jobs |
421 +| as400.active_jobs_by_type | batch, interactive, active | jobs |
422 +| as400.job_queue_length | waiting | jobs |
423 +| as400.main_storage_size | total | bytes |
424 +| as400.temporary_storage | current, maximum | MiB |
425 +| as400.memory_pool_usage | machine, base, interactive, spool | bytes |
426 +| as400.memory_pool_defined | machine, base | bytes |
427 +| as400.memory_pool_reserved | machine, base | bytes |
428 +| as400.memory_pool_threads | machine, base | threads |
429 +| as400.memory_pool_max_threads | machine, base | threads |
430 +| as400.disk_busy_average | busy | percentage |
431 +| as400.system_asp_usage | used | percentage |
432 +| as400.system_asp_storage | total | MiB |
433 +| as400.total_auxiliary_storage | total | MiB |
434 +| as400.system_threads | active, per_processor | threads |
435 +| as400.network_connections | remote, total | connections |
436 +| as400.network_connection_states | listen, close_wait | connections |
437 +| as400.temp_storage_total | current, peak | bytes |
438 +| as400.system_activity_cpu_rate | average | percentage |
439 +| as400.system_activity_cpu_utilization | average, minimum, maximum | percentage |
440 +
441 +### Per tempstoragebucket
442 +
443 +These metrics refer to tempstoragebucket instances.
444 +
445 +Labels:
446 +
447 +| Label | Description |
448 +|:-----------|:----------------|
449 +| bucket | Bucket identifier |
450 +
451 +Metrics:
452 +
453 +| Metric | Dimensions | Unit |
454 +|:------|:----------|:----|
455 +| as400.temp_storage_bucket | current, peak | bytes |
456 +
457 +
458 +
459 +## Alerts
460 +
461 +There are no alerts configured by default for this integration.
462 +
463 +
464 +## Setup
465 +
466 +
467 +### Prerequisites
468 +
469 +#### Enable monitoring interface
470 +
471 +Ensure the IBM i (AS/400) monitoring interface is accessible.
472 +
473 +
474 +
475 +### Configuration
476 +
477 +#### Options
478 +
479 +Configuration options for the as400 collector.
480 +
481 +
482 +<details open><summary>Config options</summary>
483 +
484 +
485 +
486 +| Option | Description | Default | Required |
487 +|:-----|:------------|:--------|:---------:|
488 +| update_every | Data collection frequency. | 1 | no |
489 +| endpoint | Connection endpoint. | dummy://localhost | no |
490 +
491 +
492 +</details>
493 +
494 +
495 +
496 +#### via File
497 +
498 +The configuration file name for this integration is `ibm.d/as400.conf`.
499 +
500 +
501 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
502 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
503 +
504 +```bash
505 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
506 +sudo ./edit-config ibm.d/as400.conf
507 +```
508 +
509 +##### Examples
510 +
511 +###### Basic
512 +
513 +Basic configuration example.
514 +
515 +<details open><summary>Config</summary>
516 +
517 +```yaml
518 +jobs:
519 + - name: local
520 + endpoint: dummy://localhost
521 +
522 +```
523 +</details>
524 +
525 +
src/go/plugin/ibm.d/modules/db2/README.md deleted
-488
@@ -1,488 +0,0 @@
1 -# IBM DB2 collector
2 -
3 -## Overview
4 -
5 -Monitors IBM DB2 databases using system catalog views and MON_GET_* table
6 -functions to expose connections, locking, buffer pool efficiency, tablespace
7 -capacity, and workload performance metrics.
8 -
9 -Detailed charts are opt-in per object family through include/exclude lists.
10 -Defaults focus on engine activity (system connections, core buffer pools,
11 -catalog tablespaces). Matching uses glob patterns that can target schema or
12 -application names, with include rules taking precedence over excludes.
13 -
14 -When the number of matching objects exceeds the configured `max_*` limits,
15 -the collector publishes deterministic top-N per-instance charts, aggregates
16 -the remainder under `group="__other__"`, and logs a throttled warning so you
17 -can refine selectors before cardinality runs away. Group charts (by schema,
18 -application prefix, or buffer pool family) are always emitted so high-level
19 -visibility is preserved even when individual instances are trimmed.
20 -
21 -
22 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
23 -
24 -## Collected metrics
25 -
26 -Metrics grouped by scope.
27 -
28 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
29 -
30 -### Per IBM DB2 instance
31 -
32 -
33 -These metrics refer to the entire monitored IBM DB2 instance.
34 -
35 -This scope has no labels.
36 -
37 -Metrics:
38 -
39 -| Metric | Dimensions | Unit |
40 -|:-------|:-----------|:-----|
41 -| db2.service_health | connection, database | status |
42 -| db2.connections | total, active, executing, idle, max_allowed | connections |
43 -| db2.locking | waits, timeouts, escalations | events/s |
44 -| db2.deadlocks | deadlocks | deadlocks/s |
45 -| db2.lock_details | active, waiting_agents, memory_pages | locks |
46 -| db2.lock_wait_time | wait_time | milliseconds |
47 -| db2.sorting | sorts, overflows | sorts/s |
48 -| db2.row_activity | read, returned, modified | rows/s |
49 -| db2.bufferpool_hit_ratio | hits, misses | percentage |
50 -| db2.bufferpool_data_hit_ratio | hits, misses | percentage |
51 -| db2.bufferpool_index_hit_ratio | hits, misses | percentage |
52 -| db2.bufferpool_xda_hit_ratio | hits, misses | percentage |
53 -| db2.bufferpool_column_hit_ratio | hits, misses | percentage |
54 -| db2.bufferpool_reads | logical, physical | reads/s |
55 -| db2.bufferpool_data_reads | logical, physical | reads/s |
56 -| db2.bufferpool_index_reads | logical, physical | reads/s |
57 -| db2.bufferpool_xda_reads | logical, physical | reads/s |
58 -| db2.bufferpool_column_reads | logical, physical | reads/s |
59 -| db2.bufferpool_writes | writes | writes/s |
60 -| db2.log_space | used, available | bytes |
61 -| db2.log_utilization | utilization | percentage |
62 -| db2.log_io | reads, writes | operations/s |
63 -| db2.log_operations | commits, rollbacks, reads, writes | operations/s |
64 -| db2.log_timing | avg_commit, avg_read, avg_write | milliseconds |
65 -| db2.log_buffer_events | buffer_full | events/s |
66 -| db2.long_running_queries | total, warning, critical | queries |
67 -| db2.backup_status | status | status |
68 -| db2.backup_age | full, incremental | hours |
69 -| db2.federation_connections | active, idle | connections |
70 -| db2.federation_operations | rows_read, selects, waits | operations/s |
71 -| db2.database_status | active, inactive | status |
72 -| db2.database_count | active, inactive | databases |
73 -| db2.cpu_usage | user, system, idle, iowait | percentage |
74 -| db2.active_connections | active, total | connections |
75 -| db2.memory_usage | database, instance, bufferpool, shared_sort | MiB |
76 -| db2.sql_statements | selects, modifications | statements/s |
77 -| db2.transaction_activity | committed, aborted | transactions/s |
78 -| db2.time_spent | direct_read, direct_write, pool_read, pool_write | milliseconds |
79 -
80 -
81 -
82 -### Per bufferpool
83 -
84 -These metrics refer to individual bufferpool instances.
85 -
86 -Labels:
87 -
88 -| Label | Description |
89 -|:------|:------------|
90 -| bufferpool | Bufferpool identifier |
91 -| page_size | Page_size identifier |
92 -
93 -Metrics:
94 -
95 -| Metric | Dimensions | Unit |
96 -|:-------|:-----------|:-----|
97 -| db2.bufferpool_instance_hit_ratio | overall | percentage |
98 -| db2.bufferpool_instance_detailed_hit_ratio | data, index, xda, column | percentage |
99 -| db2.bufferpool_instance_reads | logical, physical | reads/s |
100 -| db2.bufferpool_instance_data_reads | logical, physical | reads/s |
101 -| db2.bufferpool_instance_index_reads | logical, physical | reads/s |
102 -| db2.bufferpool_instance_pages | used, total | pages |
103 -| db2.bufferpool_instance_writes | writes | writes/s |
104 -
105 -### Per bufferpoolgroup
106 -
107 -These metrics refer to individual bufferpoolgroup instances.
108 -
109 -Labels:
110 -
111 -| Label | Description |
112 -|:------|:------------|
113 -| group | Group identifier |
114 -
115 -Metrics:
116 -
117 -| Metric | Dimensions | Unit |
118 -|:-------|:-----------|:-----|
119 -| db2.bufferpool_group_hit_ratio | overall | percentage |
120 -| db2.bufferpool_group_detailed_hit_ratio | data, index, xda, column | percentage |
121 -| db2.bufferpool_group_reads | logical, physical | reads/s |
122 -| db2.bufferpool_group_data_reads | logical, physical | reads/s |
123 -| db2.bufferpool_group_index_reads | logical, physical | reads/s |
124 -| db2.bufferpool_group_pages | used, total | pages |
125 -| db2.bufferpool_group_writes | writes | writes/s |
126 -
127 -### Per connection
128 -
129 -These metrics refer to individual connection instances.
130 -
131 -Labels:
132 -
133 -| Label | Description |
134 -|:------|:------------|
135 -| application_id | Application_id identifier |
136 -| application_name | Application_name identifier |
137 -| client_hostname | Client_hostname identifier |
138 -| client_ip | Client_ip identifier |
139 -| client_user | Client_user identifier |
140 -| state | State identifier |
141 -
142 -Metrics:
143 -
144 -| Metric | Dimensions | Unit |
145 -|:-------|:-----------|:-----|
146 -| db2.connection_state | state | state |
147 -| db2.connection_activity | read, written | rows/s |
148 -| db2.connection_wait_time | lock, log_disk, log_buffer, pool_read, pool_write, direct_read, direct_write, fcm_recv, fcm_send | milliseconds |
149 -| db2.connection_processing_time | routine, compile, section, commit, rollback | milliseconds |
150 -
151 -### Per connectiongroup
152 -
153 -These metrics refer to individual connectiongroup instances.
154 -
155 -Labels:
156 -
157 -| Label | Description |
158 -|:------|:------------|
159 -| group | Group identifier |
160 -
161 -Metrics:
162 -
163 -| Metric | Dimensions | Unit |
164 -|:-------|:-----------|:-----|
165 -| db2.connection_group.count | count | connections |
166 -| db2.connection_group.state | state | state |
167 -| db2.connection_group.activity | read, written | rows/s |
168 -| db2.connection_group.wait_time | lock, log_disk, log_buffer, pool_read, pool_write, direct_read, direct_write, fcm_recv, fcm_send | milliseconds |
169 -| db2.connection_group.processing_time | routine, compile, section, commit, rollback | milliseconds |
170 -
171 -### Per database
172 -
173 -These metrics refer to individual database instances.
174 -
175 -Labels:
176 -
177 -| Label | Description |
178 -|:------|:------------|
179 -| database | Database identifier |
180 -| status | Status identifier |
181 -
182 -Metrics:
183 -
184 -| Metric | Dimensions | Unit |
185 -|:-------|:-----------|:-----|
186 -| db2.database_instance_status | status | status |
187 -| db2.database_applications | applications | applications |
188 -
189 -### Per index
190 -
191 -These metrics refer to individual index instances.
192 -
193 -Labels:
194 -
195 -| Label | Description |
196 -|:------|:------------|
197 -| index | Index identifier |
198 -
199 -Metrics:
200 -
201 -| Metric | Dimensions | Unit |
202 -|:-------|:-----------|:-----|
203 -| db2.index_usage | index, full | scans/s |
204 -
205 -### Per indexgroup
206 -
207 -These metrics refer to individual indexgroup instances.
208 -
209 -Labels:
210 -
211 -| Label | Description |
212 -|:------|:------------|
213 -| group | Group identifier |
214 -
215 -Metrics:
216 -
217 -| Metric | Dimensions | Unit |
218 -|:-------|:-----------|:-----|
219 -| db2.index_group_usage | index, full | scans/s |
220 -
221 -### Per memorypool
222 -
223 -These metrics refer to individual memorypool instances.
224 -
225 -Labels:
226 -
227 -| Label | Description |
228 -|:------|:------------|
229 -| pool_type | Pool_type identifier |
230 -
231 -Metrics:
232 -
233 -| Metric | Dimensions | Unit |
234 -|:-------|:-----------|:-----|
235 -| db2.memory_pool_usage | used | bytes |
236 -| db2.memory_pool_hwm | hwm | bytes |
237 -
238 -### Per memoryset
239 -
240 -These metrics refer to individual memoryset instances.
241 -
242 -Labels:
243 -
244 -| Label | Description |
245 -|:------|:------------|
246 -| host | Host identifier |
247 -| database | Database identifier |
248 -| set_type | Set_type identifier |
249 -| member | Member identifier |
250 -
251 -Metrics:
252 -
253 -| Metric | Dimensions | Unit |
254 -|:-------|:-----------|:-----|
255 -| db2.memory_set_usage | used | bytes |
256 -| db2.memory_set_committed | committed | bytes |
257 -| db2.memory_set_high_water_mark | hwm | bytes |
258 -| db2.memory_set_additional_committed | additional | bytes |
259 -| db2.memory_set_percent_used_hwm | used_hwm | percentage |
260 -
261 -### Per prefetcher
262 -
263 -These metrics refer to individual prefetcher instances.
264 -
265 -Labels:
266 -
267 -| Label | Description |
268 -|:------|:------------|
269 -| bufferpool | Bufferpool identifier |
270 -
271 -Metrics:
272 -
273 -| Metric | Dimensions | Unit |
274 -|:-------|:-----------|:-----|
275 -| db2.prefetcher_prefetch_ratio | ratio | percentage |
276 -| db2.prefetcher_cleaner_ratio | ratio | percentage |
277 -| db2.prefetcher_physical_reads | reads | reads/s |
278 -| db2.prefetcher_async_reads | reads | reads/s |
279 -| db2.prefetcher_wait_time | wait_time | milliseconds |
280 -| db2.prefetcher_unread_pages | unread | pages/s |
281 -
282 -### Per table
283 -
284 -These metrics refer to individual table instances.
285 -
286 -Labels:
287 -
288 -| Label | Description |
289 -|:------|:------------|
290 -| table | Table identifier |
291 -
292 -Metrics:
293 -
294 -| Metric | Dimensions | Unit |
295 -|:-------|:-----------|:-----|
296 -| db2.table_size | data, index, long_obj | bytes |
297 -| db2.table_activity | read, written | rows/s |
298 -
299 -### Per tablegroup
300 -
301 -These metrics refer to individual tablegroup instances.
302 -
303 -Labels:
304 -
305 -| Label | Description |
306 -|:------|:------------|
307 -| group | Group identifier |
308 -
309 -Metrics:
310 -
311 -| Metric | Dimensions | Unit |
312 -|:-------|:-----------|:-----|
313 -| db2.table_group_size | data, index, long_obj | bytes |
314 -| db2.table_group_activity | read, written | rows/s |
315 -
316 -### Per tableio
317 -
318 -These metrics refer to individual tableio instances.
319 -
320 -Labels:
321 -
322 -| Label | Description |
323 -|:------|:------------|
324 -| table | Table identifier |
325 -
326 -Metrics:
327 -
328 -| Metric | Dimensions | Unit |
329 -|:-------|:-----------|:-----|
330 -| db2.table_io_scans | scans | scans/s |
331 -| db2.table_io_rows | read | rows/s |
332 -| db2.table_io_activity | inserts, updates, deletes | operations/s |
333 -| db2.table_io_overflow | overflow | accesses/s |
334 -
335 -### Per tablespace
336 -
337 -These metrics refer to individual tablespace instances.
338 -
339 -Labels:
340 -
341 -| Label | Description |
342 -|:------|:------------|
343 -| tablespace | Tablespace identifier |
344 -| type | Type identifier |
345 -| content_type | Content_type identifier |
346 -| state | State identifier |
347 -
348 -Metrics:
349 -
350 -| Metric | Dimensions | Unit |
351 -|:-------|:-----------|:-----|
352 -| db2.tablespace_usage | used | percentage |
353 -| db2.tablespace_size | used, free | bytes |
354 -| db2.tablespace_usable_size | total, usable | bytes |
355 -| db2.tablespace_state | state | state |
356 -
357 -### Per tablespacegroup
358 -
359 -These metrics refer to individual tablespacegroup instances.
360 -
361 -Labels:
362 -
363 -| Label | Description |
364 -|:------|:------------|
365 -| group | Group identifier |
366 -
367 -Metrics:
368 -
369 -| Metric | Dimensions | Unit |
370 -|:-------|:-----------|:-----|
371 -| db2.tablespace_group_usage | used | percentage |
372 -| db2.tablespace_group_size | used, free | bytes |
373 -| db2.tablespace_group_usable_size | total, usable | bytes |
374 -| db2.tablespace_group_state | state | state |
375 -
376 -
377 -## Configuration
378 -
379 -### File
380 -
381 -The configuration file name for this integration is `ibm.d/db2.conf`.
382 -
383 -You can edit the configuration file using the `edit-config` script from the
384 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
385 -
386 -```bash
387 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
388 -sudo ./edit-config ibm.d/db2.conf
389 -```
390 -
391 -### Options
392 -
393 -The following options can be defined globally or per job.
394 -
395 -| Name | Description | Default | Required | Min | Max |
396 -|:-----|:------------|:--------|:---------|:----|:----|
397 -| update_every | Data collection frequency | `5` | no | 1 | - |
398 -| Vnode | Vnode allows binding the collector to a virtual node. | `` | no | - | - |
399 -| DSN | DSN provides a full DB2 connection string when manual control is required. | `` | no | - | - |
400 -| Timeout | Timeout controls how long DB2 RPCs may run before cancellation. | `2000000000` | no | - | - |
401 -| MaxDbConns | MaxDbConns limits the connection pool size. | `1` | no | - | - |
402 -| MaxDbLifeTime | MaxDbLifeTime forces pooled connections to be recycled after the specified duration. | `600000000000` | no | - | - |
403 -| CollectDatabaseMetrics | CollectDatabaseMetrics toggles high-level database status metrics. | `auto` | no | - | - |
404 -| CollectBufferpoolMetrics | CollectBufferpoolMetrics toggles buffer pool efficiency metrics. | `auto` | no | - | - |
405 -| CollectTablespaceMetrics | CollectTablespaceMetrics toggles tablespace capacity metrics. | `auto` | no | - | - |
406 -| CollectConnectionMetrics | CollectConnectionMetrics toggles per-connection activity metrics. | `auto` | no | - | - |
407 -| CollectLockMetrics | CollectLockMetrics toggles lock contention metrics. | `auto` | no | - | - |
408 -| CollectTableMetrics | CollectTableMetrics toggles table-level size and row metrics. | `auto` | no | - | - |
409 -| CollectIndexMetrics | CollectIndexMetrics toggles index usage metrics. | `auto` | no | - | - |
410 -| MaxDatabases | MaxDatabases caps the number of databases charted. | `10` | no | - | - |
411 -| MaxBufferpools | MaxBufferpools caps the number of buffer pools charted. | `20` | no | - | - |
412 -| MaxTablespaces | MaxTablespaces caps the number of tablespaces charted. | `50` | no | - | - |
413 -| MaxConnections | MaxConnections caps the number of connection instances charted. | `50` | no | - | - |
414 -| MaxTables | MaxTables caps the number of tables charted. | `25` | no | - | - |
415 -| MaxIndexes | MaxIndexes caps the number of indexes charted. | `50` | no | - | - |
416 -| BackupHistoryDays | BackupHistoryDays controls how many days of backup history are retrieved. | `30` | no | - | - |
417 -| CollectMemoryMetrics | CollectMemoryMetrics enables memory pool statistics. | `true` | no | - | - |
418 -| CollectWaitMetrics | CollectWaitMetrics enables wait time statistics (locks, logs, I/O). | `true` | no | - | - |
419 -| CollectTableIOMetrics | CollectTableIOMetrics enables table I/O statistics when available. | `true` | no | - | - |
420 -| CollectDatabasesMatching | CollectDatabasesMatching filters databases by name using glob patterns. | `` | no | - | - |
421 -| IncludeConnections | IncludeConnections filters monitored connections by application ID or application name (wildcards supported). | `[db2sysc* db2agent* db2hadr* db2acd* db2bmgr*]` | no | - | - |
422 -| ExcludeConnections | ExcludeConnections excludes connections after inclusion matching. | `[*TEMP*]` | no | - | - |
423 -| IncludeBufferpools | IncludeBufferpools filters buffer pools by name. | `[IBMDEFAULTBP IBMSYSTEMBP* IBMHADRBP*]` | no | - | - |
424 -| ExcludeBufferpools | ExcludeBufferpools excludes buffer pools after inclusion. | `nil` | no | - | - |
425 -| IncludeTablespaces | IncludeTablespaces filters tablespaces by name. | `[SYSCATSPACE TEMPSPACE* SYSTOOLSPACE]` | no | - | - |
426 -| ExcludeTablespaces | ExcludeTablespaces excludes tablespaces after inclusion. | `[TEMPSPACE2]` | no | - | - |
427 -| IncludeTables | IncludeTables filters tables by schema/name. | `nil` | no | - | - |
428 -| ExcludeTables | ExcludeTables excludes tables after inclusion. | `nil` | no | - | - |
429 -| IncludeIndexes | IncludeIndexes filters indexes by schema/name. | `nil` | no | - | - |
430 -| ExcludeIndexes | ExcludeIndexes excludes indexes after inclusion. | `nil` | no | - | - |
431 -
432 -### Examples
433 -
434 -#### Basic configuration
435 -
436 -IBM DB2 monitoring with default settings.
437 -
438 -<details>
439 -<summary>Config</summary>
440 -
441 -```yaml
442 -jobs:
443 - - name: local
444 - endpoint: dummy://localhost
445 -```
446 -
447 -</details>
448 -
449 -## Troubleshooting
450 -
451 -### Debug Mode
452 -
453 -To troubleshoot issues with the `db2` collector, run the `ibm.d.plugin` with the debug option enabled.
454 -The output should give you clues as to why the collector isn't working.
455 -
456 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
457 -- Switch to the `netdata` user
458 -- Run the `ibm.d.plugin` to debug the collector:
459 -
460 -```bash
461 -sudo -u netdata ./ibm.d.plugin -d -m db2
462 -```
463 -
464 -## Getting Logs
465 -
466 -If you're encountering problems with the `db2` collector, follow these steps to retrieve logs and identify potential issues:
467 -
468 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
469 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
470 -
471 -### For systemd systems (most Linux distributions)
472 -
473 -```bash
474 -sudo journalctl -u netdata --reverse | grep db2
475 -```
476 -
477 -### For non-systemd systems
478 -
479 -```bash
480 -sudo grep db2 /var/log/netdata/error.log
481 -sudo grep db2 /var/log/netdata/collector.log
482 -```
483 -
484 -### For Docker containers
485 -
486 -```bash
487 -sudo docker logs netdata 2>&1 | grep db2
488 -```
src/go/plugin/ibm.d/modules/db2/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_db2.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/db2/integrations/ibm_db2.md new
+483
@@ -0,0 +1,483 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/db2/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/db2/metadata.yaml"
4 +sidebar_label: "IBM DB2"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Databases"
7 +most_popular: False
8 +keywords: ['db2']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM DB2
13 +
14 +
15 +<img src="https://netdata.cloud/img/ibm.svg" width="150"/>
16 +
17 +
18 +Plugin: ibm.d.plugin
19 +Module: db2
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitors IBM DB2 databases using system catalog views and MON_GET_* table
26 +functions to expose connections, locking, buffer pool efficiency, tablespace
27 +capacity, and workload performance metrics.
28 +
29 +Detailed charts are opt-in per object family through include/exclude lists.
30 +Defaults focus on engine activity (system connections, core buffer pools,
31 +catalog tablespaces). Matching uses glob patterns that can target schema or
32 +application names, with include rules taking precedence over excludes.
33 +
34 +When the number of matching objects exceeds the configured `max_*` limits,
35 +the collector publishes deterministic top-N per-instance charts, aggregates
36 +the remainder under `group="__other__"`, and logs a throttled warning so you
37 +can refine selectors before cardinality runs away. Group charts (by schema,
38 +application prefix, or buffer pool family) are always emitted so high-level
39 +visibility is preserved even when individual instances are trimmed.
40 +
41 +
42 +The collector connects to IBM DB2 and collects metrics via its monitoring interface.
43 +
44 +
45 +This collector is supported on all platforms.
46 +
47 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
48 +
49 +
50 +### Default Behavior
51 +
52 +#### Auto-Detection
53 +
54 +This integration doesn't support auto-detection.
55 +
56 +#### Limits
57 +
58 +The default configuration for this integration does not impose any limits on data collection.
59 +
60 +#### Performance Impact
61 +
62 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
63 +
64 +## Metrics
65 +
66 +Metrics grouped by *scope*.
67 +
68 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
69 +
70 +
71 +
72 +### Per bufferpool
73 +
74 +These metrics refer to bufferpool instances.
75 +
76 +Labels:
77 +
78 +| Label | Description |
79 +|:-----------|:----------------|
80 +| bufferpool | Bufferpool identifier |
81 +| page_size | Page_size identifier |
82 +
83 +Metrics:
84 +
85 +| Metric | Dimensions | Unit |
86 +|:------|:----------|:----|
87 +| db2.bufferpool_instance_hit_ratio | overall | percentage |
88 +| db2.bufferpool_instance_detailed_hit_ratio | data, index, xda, column | percentage |
89 +| db2.bufferpool_instance_reads | logical, physical | reads/s |
90 +| db2.bufferpool_instance_data_reads | logical, physical | reads/s |
91 +| db2.bufferpool_instance_index_reads | logical, physical | reads/s |
92 +| db2.bufferpool_instance_pages | used, total | pages |
93 +| db2.bufferpool_instance_writes | writes | writes/s |
94 +
95 +### Per bufferpoolgroup
96 +
97 +These metrics refer to bufferpoolgroup instances.
98 +
99 +Labels:
100 +
101 +| Label | Description |
102 +|:-----------|:----------------|
103 +| group | Group identifier |
104 +
105 +Metrics:
106 +
107 +| Metric | Dimensions | Unit |
108 +|:------|:----------|:----|
109 +| db2.bufferpool_group_hit_ratio | overall | percentage |
110 +| db2.bufferpool_group_detailed_hit_ratio | data, index, xda, column | percentage |
111 +| db2.bufferpool_group_reads | logical, physical | reads/s |
112 +| db2.bufferpool_group_data_reads | logical, physical | reads/s |
113 +| db2.bufferpool_group_index_reads | logical, physical | reads/s |
114 +| db2.bufferpool_group_pages | used, total | pages |
115 +| db2.bufferpool_group_writes | writes | writes/s |
116 +
117 +### Per connection
118 +
119 +These metrics refer to connection instances.
120 +
121 +Labels:
122 +
123 +| Label | Description |
124 +|:-----------|:----------------|
125 +| application_id | Application_id identifier |
126 +| application_name | Application_name identifier |
127 +| client_hostname | Client_hostname identifier |
128 +| client_ip | Client_ip identifier |
129 +| client_user | Client_user identifier |
130 +| state | State identifier |
131 +
132 +Metrics:
133 +
134 +| Metric | Dimensions | Unit |
135 +|:------|:----------|:----|
136 +| db2.connection_state | state | state |
137 +| db2.connection_activity | read, written | rows/s |
138 +| db2.connection_wait_time | lock, log_disk, log_buffer, pool_read, pool_write, direct_read, direct_write, fcm_recv, fcm_send | milliseconds |
139 +| db2.connection_processing_time | routine, compile, section, commit, rollback | milliseconds |
140 +
141 +### Per connectiongroup
142 +
143 +These metrics refer to connectiongroup instances.
144 +
145 +Labels:
146 +
147 +| Label | Description |
148 +|:-----------|:----------------|
149 +| group | Group identifier |
150 +
151 +Metrics:
152 +
153 +| Metric | Dimensions | Unit |
154 +|:------|:----------|:----|
155 +| db2.connection_group.count | count | connections |
156 +| db2.connection_group.state | state | state |
157 +| db2.connection_group.activity | read, written | rows/s |
158 +| db2.connection_group.wait_time | lock, log_disk, log_buffer, pool_read, pool_write, direct_read, direct_write, fcm_recv, fcm_send | milliseconds |
159 +| db2.connection_group.processing_time | routine, compile, section, commit, rollback | milliseconds |
160 +
161 +### Per database
162 +
163 +These metrics refer to database instances.
164 +
165 +Labels:
166 +
167 +| Label | Description |
168 +|:-----------|:----------------|
169 +| database | Database identifier |
170 +| status | Status identifier |
171 +
172 +Metrics:
173 +
174 +| Metric | Dimensions | Unit |
175 +|:------|:----------|:----|
176 +| db2.database_instance_status | status | status |
177 +| db2.database_applications | applications | applications |
178 +
179 +### Per index
180 +
181 +These metrics refer to index instances.
182 +
183 +Labels:
184 +
185 +| Label | Description |
186 +|:-----------|:----------------|
187 +| index | Index identifier |
188 +
189 +Metrics:
190 +
191 +| Metric | Dimensions | Unit |
192 +|:------|:----------|:----|
193 +| db2.index_usage | index, full | scans/s |
194 +
195 +### Per indexgroup
196 +
197 +These metrics refer to indexgroup instances.
198 +
199 +Labels:
200 +
201 +| Label | Description |
202 +|:-----------|:----------------|
203 +| group | Group identifier |
204 +
205 +Metrics:
206 +
207 +| Metric | Dimensions | Unit |
208 +|:------|:----------|:----|
209 +| db2.index_group_usage | index, full | scans/s |
210 +
211 +### Per memorypool
212 +
213 +These metrics refer to memorypool instances.
214 +
215 +Labels:
216 +
217 +| Label | Description |
218 +|:-----------|:----------------|
219 +| pool_type | Pool_type identifier |
220 +
221 +Metrics:
222 +
223 +| Metric | Dimensions | Unit |
224 +|:------|:----------|:----|
225 +| db2.memory_pool_usage | used | bytes |
226 +| db2.memory_pool_hwm | hwm | bytes |
227 +
228 +### Per memoryset
229 +
230 +These metrics refer to memoryset instances.
231 +
232 +Labels:
233 +
234 +| Label | Description |
235 +|:-----------|:----------------|
236 +| host | Host identifier |
237 +| database | Database identifier |
238 +| set_type | Set_type identifier |
239 +| member | Member identifier |
240 +
241 +Metrics:
242 +
243 +| Metric | Dimensions | Unit |
244 +|:------|:----------|:----|
245 +| db2.memory_set_usage | used | bytes |
246 +| db2.memory_set_committed | committed | bytes |
247 +| db2.memory_set_high_water_mark | hwm | bytes |
248 +| db2.memory_set_additional_committed | additional | bytes |
249 +| db2.memory_set_percent_used_hwm | used_hwm | percentage |
250 +
251 +### Per prefetcher
252 +
253 +These metrics refer to prefetcher instances.
254 +
255 +Labels:
256 +
257 +| Label | Description |
258 +|:-----------|:----------------|
259 +| bufferpool | Bufferpool identifier |
260 +
261 +Metrics:
262 +
263 +| Metric | Dimensions | Unit |
264 +|:------|:----------|:----|
265 +| db2.prefetcher_prefetch_ratio | ratio | percentage |
266 +| db2.prefetcher_cleaner_ratio | ratio | percentage |
267 +| db2.prefetcher_physical_reads | reads | reads/s |
268 +| db2.prefetcher_async_reads | reads | reads/s |
269 +| db2.prefetcher_wait_time | wait_time | milliseconds |
270 +| db2.prefetcher_unread_pages | unread | pages/s |
271 +
272 +### Per IBM DB2 instance
273 +
274 +These metrics refer to the entire monitored instance.
275 +
276 +This scope has no labels.
277 +
278 +Metrics:
279 +
280 +| Metric | Dimensions | Unit |
281 +|:------|:----------|:----|
282 +| db2.service_health | connection, database | status |
283 +| db2.connections | total, active, executing, idle, max_allowed | connections |
284 +| db2.locking | waits, timeouts, escalations | events/s |
285 +| db2.deadlocks | deadlocks | deadlocks/s |
286 +| db2.lock_details | active, waiting_agents, memory_pages | locks |
287 +| db2.lock_wait_time | wait_time | milliseconds |
288 +| db2.sorting | sorts, overflows | sorts/s |
289 +| db2.row_activity | read, returned, modified | rows/s |
290 +| db2.bufferpool_hit_ratio | hits, misses | percentage |
291 +| db2.bufferpool_data_hit_ratio | hits, misses | percentage |
292 +| db2.bufferpool_index_hit_ratio | hits, misses | percentage |
293 +| db2.bufferpool_xda_hit_ratio | hits, misses | percentage |
294 +| db2.bufferpool_column_hit_ratio | hits, misses | percentage |
295 +| db2.bufferpool_reads | logical, physical | reads/s |
296 +| db2.bufferpool_data_reads | logical, physical | reads/s |
297 +| db2.bufferpool_index_reads | logical, physical | reads/s |
298 +| db2.bufferpool_xda_reads | logical, physical | reads/s |
299 +| db2.bufferpool_column_reads | logical, physical | reads/s |
300 +| db2.bufferpool_writes | writes | writes/s |
301 +| db2.log_space | used, available | bytes |
302 +| db2.log_utilization | utilization | percentage |
303 +| db2.log_io | reads, writes | operations/s |
304 +| db2.log_operations | commits, rollbacks, reads, writes | operations/s |
305 +| db2.log_timing | avg_commit, avg_read, avg_write | milliseconds |
306 +| db2.log_buffer_events | buffer_full | events/s |
307 +| db2.long_running_queries | total, warning, critical | queries |
308 +| db2.backup_status | status | status |
309 +| db2.backup_age | full, incremental | hours |
310 +| db2.federation_connections | active, idle | connections |
311 +| db2.federation_operations | rows_read, selects, waits | operations/s |
312 +| db2.database_status | active, inactive | status |
313 +| db2.database_count | active, inactive | databases |
314 +| db2.cpu_usage | user, system, idle, iowait | percentage |
315 +| db2.active_connections | active, total | connections |
316 +| db2.memory_usage | database, instance, bufferpool, shared_sort | MiB |
317 +| db2.sql_statements | selects, modifications | statements/s |
318 +| db2.transaction_activity | committed, aborted | transactions/s |
319 +| db2.time_spent | direct_read, direct_write, pool_read, pool_write | milliseconds |
320 +
321 +### Per table
322 +
323 +These metrics refer to table instances.
324 +
325 +Labels:
326 +
327 +| Label | Description |
328 +|:-----------|:----------------|
329 +| table | Table identifier |
330 +
331 +Metrics:
332 +
333 +| Metric | Dimensions | Unit |
334 +|:------|:----------|:----|
335 +| db2.table_size | data, index, long_obj | bytes |
336 +| db2.table_activity | read, written | rows/s |
337 +
338 +### Per tablegroup
339 +
340 +These metrics refer to tablegroup instances.
341 +
342 +Labels:
343 +
344 +| Label | Description |
345 +|:-----------|:----------------|
346 +| group | Group identifier |
347 +
348 +Metrics:
349 +
350 +| Metric | Dimensions | Unit |
351 +|:------|:----------|:----|
352 +| db2.table_group_size | data, index, long_obj | bytes |
353 +| db2.table_group_activity | read, written | rows/s |
354 +
355 +### Per tableio
356 +
357 +These metrics refer to tableio instances.
358 +
359 +Labels:
360 +
361 +| Label | Description |
362 +|:-----------|:----------------|
363 +| table | Table identifier |
364 +
365 +Metrics:
366 +
367 +| Metric | Dimensions | Unit |
368 +|:------|:----------|:----|
369 +| db2.table_io_scans | scans | scans/s |
370 +| db2.table_io_rows | read | rows/s |
371 +| db2.table_io_activity | inserts, updates, deletes | operations/s |
372 +| db2.table_io_overflow | overflow | accesses/s |
373 +
374 +### Per tablespace
375 +
376 +These metrics refer to tablespace instances.
377 +
378 +Labels:
379 +
380 +| Label | Description |
381 +|:-----------|:----------------|
382 +| tablespace | Tablespace identifier |
383 +| type | Type identifier |
384 +| content_type | Content_type identifier |
385 +| state | State identifier |
386 +
387 +Metrics:
388 +
389 +| Metric | Dimensions | Unit |
390 +|:------|:----------|:----|
391 +| db2.tablespace_usage | used | percentage |
392 +| db2.tablespace_size | used, free | bytes |
393 +| db2.tablespace_usable_size | total, usable | bytes |
394 +| db2.tablespace_state | state | state |
395 +
396 +### Per tablespacegroup
397 +
398 +These metrics refer to tablespacegroup instances.
399 +
400 +Labels:
401 +
402 +| Label | Description |
403 +|:-----------|:----------------|
404 +| group | Group identifier |
405 +
406 +Metrics:
407 +
408 +| Metric | Dimensions | Unit |
409 +|:------|:----------|:----|
410 +| db2.tablespace_group_usage | used | percentage |
411 +| db2.tablespace_group_size | used, free | bytes |
412 +| db2.tablespace_group_usable_size | total, usable | bytes |
413 +| db2.tablespace_group_state | state | state |
414 +
415 +
416 +
417 +## Alerts
418 +
419 +There are no alerts configured by default for this integration.
420 +
421 +
422 +## Setup
423 +
424 +
425 +### Prerequisites
426 +
427 +#### Enable monitoring interface
428 +
429 +Ensure the IBM DB2 monitoring interface is accessible.
430 +
431 +
432 +
433 +### Configuration
434 +
435 +#### Options
436 +
437 +Configuration options for the db2 collector.
438 +
439 +
440 +<details open><summary>Config options</summary>
441 +
442 +
443 +
444 +| Option | Description | Default | Required |
445 +|:-----|:------------|:--------|:---------:|
446 +| update_every | Data collection frequency. | 1 | no |
447 +| endpoint | Connection endpoint. | dummy://localhost | no |
448 +
449 +
450 +</details>
451 +
452 +
453 +
454 +#### via File
455 +
456 +The configuration file name for this integration is `ibm.d/db2.conf`.
457 +
458 +
459 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
460 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
461 +
462 +```bash
463 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
464 +sudo ./edit-config ibm.d/db2.conf
465 +```
466 +
467 +##### Examples
468 +
469 +###### Basic
470 +
471 +Basic configuration example.
472 +
473 +<details open><summary>Config</summary>
474 +
475 +```yaml
476 +jobs:
477 + - name: local
478 + endpoint: dummy://localhost
479 +
480 +```
481 +</details>
482 +
483 +
src/go/plugin/ibm.d/modules/mq/README.md deleted
-393
@@ -1,393 +0,0 @@
1 -# IBM MQ collector
2 -
3 -## Overview
4 -
5 -Monitors IBM MQ queue managers, queues, channels, and topics
6 -using the PCF (Programmable Command Format) protocol.
7 -
8 -By default the collector tracks the critical system queues `SYSTEM.DEAD.LETTER.QUEUE`,
9 -`SYSTEM.ADMIN.COMMAND.QUEUE`, and `SYSTEM.ADMIN.STATISTICS.QUEUE`. All other queues are
10 -opt-in via the `include_queues` list, with `exclude_queues` removing noisy patterns such as
11 -`SYSTEM.*` or `AMQ.*`. Include patterns take precedence over excludes so you can safely
12 -monitor individual system queues while dropping the broader wildcard.
13 -
14 -Per-queue charts are bounded by `max_queues` (default 50). When more queues are discovered,
15 -the collector exports the busiest ones individually, rolls the remainder into an
16 -aggregated `__other__` dimension, and logs a throttled warning listing the overflowed
17 -groups. Parallel queue-group charts summarise depth, traffic, and backlog per naming
18 -prefix (first two dot-separated segments, collapsing all `SYSTEM.*` queues together), so
19 -high-level visibility is never lost even when detailed charts are trimmed.
20 -
21 -
22 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
23 -
24 -## Collected metrics
25 -
26 -Metrics grouped by scope.
27 -
28 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
29 -
30 -### Per IBM MQ instance
31 -
32 -
33 -These metrics refer to the entire monitored IBM MQ instance.
34 -
35 -This scope has no labels.
36 -
37 -Metrics:
38 -
39 -| Metric | Dimensions | Unit |
40 -|:-------|:-----------|:-----|
41 -| mq.qmgr.status | status | status |
42 -| mq.qmgr.connection_count | connections | connections |
43 -| mq.qmgr.uptime | uptime | seconds |
44 -| mq.queues.overview | monitored, excluded, invisible, failed | queues |
45 -| mq.channels.overview | monitored, excluded, invisible, failed | channels |
46 -| mq.topics.overview | monitored, excluded, invisible, failed | topics |
47 -| mq.listeners.overview | monitored, excluded, invisible, failed | listeners |
48 -
49 -These metrics refer to the entire monitored IBM MQ instance.
50 -
51 -This scope has no labels.
52 -
53 -Metrics:
54 -
55 -| Metric | Dimensions | Unit |
56 -|:-------|:-----------|:-----|
57 -| mq.qmgr.cpu_usage | user, system | percentage |
58 -| mq.qmgr.memory_usage | total | bytes |
59 -| mq.qmgr.ram_usage | total | bytes |
60 -| mq.qmgr.log_utilization | used | percentage |
61 -| mq.qmgr.log_file_size | size | bytes |
62 -| mq.qmgr.log_write_rate | rate | bytes/s |
63 -
64 -
65 -
66 -### Per channel
67 -
68 -These metrics refer to individual channel instances.
69 -
70 -Labels:
71 -
72 -| Label | Description |
73 -|:------|:------------|
74 -| channel | Channel identifier |
75 -| type | Type identifier |
76 -
77 -Metrics:
78 -
79 -| Metric | Dimensions | Unit |
80 -|:-------|:-----------|:-----|
81 -| mq.channel.status | inactive, binding, starting, running, stopping, retrying, stopped, requesting, paused, disconnected, initializing, switching | status |
82 -| mq.channel.messages | messages | messages/s |
83 -| mq.channel.bytes | bytes | bytes/s |
84 -| mq.channel.batches | batches | batches/s |
85 -| mq.channel.batch_size | batch_size | messages |
86 -| mq.channel.batch_interval | batch_interval | milliseconds |
87 -| mq.channel.intervals | disc_interval, hb_interval, keep_alive_interval | seconds |
88 -| mq.channel.short_retry_count | short_retry | retries |
89 -| mq.channel.long_retry_interval | long_retry | seconds |
90 -| mq.channel.max_msg_length | max_msg_length | bytes |
91 -| mq.channel.sharing_conversations | sharing_conversations | conversations |
92 -| mq.channel.network_priority | network_priority | priority |
93 -| mq.channel.buffer_counts | sent, received | buffers |
94 -| mq.channel.current_messages | current | messages |
95 -| mq.channel.xmitq_time | xmitq_time | milliseconds |
96 -| mq.channel.mca_status | mca_status | status |
97 -| mq.channel.indoubt_status | indoubt_status | status |
98 -| mq.channel.ssl_key_resets | ssl_key_resets | resets |
99 -| mq.channel.npm_speed | npm_speed | speed |
100 -| mq.channel.current_sharing_convs | current_sharing | conversations |
101 -
102 -### Per channelstatistics
103 -
104 -These metrics refer to individual channelstatistics instances.
105 -
106 -Labels:
107 -
108 -| Label | Description |
109 -|:------|:------------|
110 -| channel | Channel identifier |
111 -| type | Type identifier |
112 -
113 -Metrics:
114 -
115 -| Metric | Dimensions | Unit |
116 -|:-------|:-----------|:-----|
117 -| mq.channel_stats.messages | messages | messages/s |
118 -| mq.channel_stats.bytes | bytes | bytes/s |
119 -| mq.channel_stats.batches | full_batches, incomplete_batches | batches/s |
120 -| mq.channel_stats.batch_size | avg_batch_size | messages |
121 -| mq.channel_stats.put_retries | put_retries | retries/s |
122 -
123 -### Per listener
124 -
125 -These metrics refer to individual listener instances.
126 -
127 -Labels:
128 -
129 -| Label | Description |
130 -|:------|:------------|
131 -| listener | Listener identifier |
132 -| port | Port identifier |
133 -| ip_address | Ip_address identifier |
134 -
135 -Metrics:
136 -
137 -| Metric | Dimensions | Unit |
138 -|:-------|:-----------|:-----|
139 -| mq.listener.status | stopped, starting, running, stopping, retrying | status |
140 -| mq.listener.backlog | backlog | connections |
141 -| mq.listener.uptime | uptime | seconds |
142 -
143 -### Per mqistatistics
144 -
145 -These metrics refer to individual mqistatistics instances.
146 -
147 -Labels:
148 -
149 -| Label | Description |
150 -|:------|:------------|
151 -| queue_manager | Queue_manager identifier |
152 -
153 -Metrics:
154 -
155 -| Metric | Dimensions | Unit |
156 -|:-------|:-----------|:-----|
157 -| mq.mqi_stats.opens | opens_total, opens_failed | operations/s |
158 -| mq.mqi_stats.closes | closes_total, closes_failed | operations/s |
159 -| mq.mqi_stats.inqs | inqs_total, inqs_failed | operations/s |
160 -| mq.mqi_stats.sets | sets_total, sets_failed | operations/s |
161 -
162 -### Per queue
163 -
164 -These metrics refer to individual queue instances.
165 -
166 -Labels:
167 -
168 -| Label | Description |
169 -|:------|:------------|
170 -| queue | Queue identifier |
171 -| type | Type identifier |
172 -
173 -Metrics:
174 -
175 -| Metric | Dimensions | Unit |
176 -|:-------|:-----------|:-----|
177 -| mq.queue.depth | current, max | messages |
178 -| mq.queue.depth_percentage | percentage | percentage |
179 -| mq.queue.messages | enqueued, dequeued | messages/s |
180 -| mq.queue.connections | input, output | connections |
181 -| mq.queue.high_depth | high_depth | messages |
182 -| mq.queue.uncommitted_msgs | uncommitted | messages |
183 -| mq.queue.file_size | current, max | bytes |
184 -| mq.queue.last_activity | since_last_get, since_last_put | seconds |
185 -| mq.queue.oldest_msg_age | oldest_msg_age | seconds |
186 -| mq.queue.time_indicators | short_period, long_period | microseconds |
187 -| mq.queue.service_interval | service_interval | milliseconds |
188 -| mq.queue.inhibit_status | inhibit_get, inhibit_put | status |
189 -| mq.queue.priority | def_priority | priority |
190 -| mq.queue.message_persistence | persistent, non_persistent | boolean |
191 -| mq.queue.retention_interval | retention_interval | hours |
192 -| mq.queue.triggers | trigger_depth, trigger_type | messages |
193 -| mq.queue.backout_threshold | backout_threshold | retries |
194 -| mq.queue.max_msg_length | max_msg_length | bytes |
195 -| mq.queue.scope | queue_manager, cell | boolean |
196 -| mq.queue.usage | normal, transmission | boolean |
197 -| mq.queue.msg_delivery_sequence | priority, fifo | boolean |
198 -| mq.queue.harden_get_backout | enabled, disabled | boolean |
199 -
200 -### Per queuegroup
201 -
202 -These metrics refer to individual queuegroup instances.
203 -
204 -Labels:
205 -
206 -| Label | Description |
207 -|:------|:------------|
208 -| group | Group identifier |
209 -
210 -Metrics:
211 -
212 -| Metric | Dimensions | Unit |
213 -|:-------|:-----------|:-----|
214 -| mq.queue_group.depth | current, max | messages |
215 -| mq.queue_group.depth_percentage | percentage | percentage |
216 -| mq.queue_group.messages | enqueued, dequeued | messages/s |
217 -| mq.queue_group.connections | input, output | connections |
218 -| mq.queue_group.uncommitted_msgs | uncommitted | messages |
219 -| mq.queue_group.file_size | current, max | bytes |
220 -| mq.queue_group.oldest_msg_age | oldest_msg_age | seconds |
221 -
222 -### Per queuestatistics
223 -
224 -These metrics refer to individual queuestatistics instances.
225 -
226 -Labels:
227 -
228 -| Label | Description |
229 -|:------|:------------|
230 -| queue | Queue identifier |
231 -| type | Type identifier |
232 -
233 -Metrics:
234 -
235 -| Metric | Dimensions | Unit |
236 -|:-------|:-----------|:-----|
237 -| mq.queue_stats.depth_min_max | min_depth, max_depth | messages |
238 -| mq.queue_stats.avg_queue_time | non_persistent, persistent | microseconds |
239 -| mq.queue_stats.time_indicators | short_period, long_period | microseconds |
240 -| mq.queue_stats.operations | puts_non_persistent, puts_persistent, gets_non_persistent, gets_persistent, put1s, browses | operations/s |
241 -| mq.queue_stats.bytes | put_bytes_non_persistent, put_bytes_persistent, get_bytes_non_persistent, get_bytes_persistent, browse_bytes | bytes/s |
242 -| mq.queue_stats.failures | puts_failed, put1s_failed, gets_failed, browses_failed | failures/s |
243 -| mq.queue_stats.message_lifecycle | expired, purged, not_queued | messages/s |
244 -
245 -### Per subscription
246 -
247 -These metrics refer to individual subscription instances.
248 -
249 -Labels:
250 -
251 -| Label | Description |
252 -|:------|:------------|
253 -| subscription | Subscription identifier |
254 -| topic | Topic identifier |
255 -
256 -Metrics:
257 -
258 -| Metric | Dimensions | Unit |
259 -|:-------|:-----------|:-----|
260 -| mq.subscription.messages | pending | messages |
261 -| mq.subscription.last_message_age | age | seconds |
262 -
263 -### Per topic
264 -
265 -These metrics refer to individual topic instances.
266 -
267 -Labels:
268 -
269 -| Label | Description |
270 -|:------|:------------|
271 -| topic | Topic identifier |
272 -
273 -Metrics:
274 -
275 -| Metric | Dimensions | Unit |
276 -|:-------|:-----------|:-----|
277 -| mq.topic.publishers | publishers | publishers |
278 -| mq.topic.subscribers | subscribers | subscribers |
279 -| mq.topic.messages | messages | messages/s |
280 -| mq.topic.time_since_last_message | time_since_last_msg | seconds |
281 -
282 -
283 -## Configuration
284 -
285 -### File
286 -
287 -The configuration file name for this integration is `ibm.d/mq.conf`.
288 -
289 -You can edit the configuration file using the `edit-config` script from the
290 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
291 -
292 -```bash
293 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
294 -sudo ./edit-config ibm.d/mq.conf
295 -```
296 -
297 -### Options
298 -
299 -The following options can be defined globally or per job.
300 -
301 -| Name | Description | Default | Required | Min | Max |
302 -|:-----|:------------|:--------|:---------|:----|:----|
303 -| update_every | Data collection frequency | `10` | no | 1 | - |
304 -| QueueManager | IBM MQ Queue Manager name to connect to | `QM1` | no | - | - |
305 -| Channel | IBM MQ channel name for connection | `SYSTEM.DEF.SVRCONN` | no | - | - |
306 -| Host | IBM MQ server hostname or IP address | `localhost` | no | - | - |
307 -| Port | IBM MQ server port number | `1414` | no | 1 | 65535 |
308 -| User | Username for IBM MQ authentication | `` | no | - | - |
309 -| Password | Password for IBM MQ authentication | `` | no | - | - |
310 -| CollectQueues | Enable collection of queue metrics | `true` | no | - | - |
311 -| CollectChannels | Enable collection of channel metrics | `true` | no | - | - |
312 -| CollectTopics | Enable collection of topic metrics | `true` | no | - | - |
313 -| CollectListeners | Enable collection of listener metrics | `true` | no | - | - |
314 -| CollectSubscriptions | Enable collection of subscription metrics | `true` | no | - | - |
315 -| CollectSystemQueues | Enable collection of system queue metrics (SYSTEM.* queues provide critical infrastructure visibility) | `true` | no | - | - |
316 -| CollectSystemChannels | Enable collection of system channel metrics (SYSTEM.* channels show clustering and administrative health) | `true` | no | - | - |
317 -| CollectSystemTopics | Enable collection of system topic metrics (SYSTEM.* topics show internal messaging patterns) | `true` | no | - | - |
318 -| CollectSystemListeners | Enable collection of system listener metrics (SYSTEM.* listeners show internal connectivity) | `true` | no | - | - |
319 -| CollectChannelConfig | Enable collection of channel configuration metrics | `true` | no | - | - |
320 -| CollectQueueConfig | Enable collection of queue configuration metrics | `true` | no | - | - |
321 -| IncludeQueues | Patterns to include queues (wildcards supported). Empty means include everything. | `[SYSTEM.DEAD.LETTER.QUEUE SYSTEM.ADMIN.COMMAND.QUEUE SYSTEM.ADMIN.STATISTICS.QUEUE]` | no | - | - |
322 -| ExcludeQueues | Patterns to exclude queues after inclusion (wildcards supported). | `[SYSTEM.* AMQ.*]` | no | - | - |
323 -| ChannelSelector | Pattern to filter channels (wildcards supported) | `` | no | - | - |
324 -| TopicSelector | Pattern to filter topics (wildcards supported) | `` | no | - | - |
325 -| ListenerSelector | Pattern to filter listeners (wildcards supported) | `` | no | - | - |
326 -| SubscriptionSelector | Pattern to filter subscriptions (wildcards supported) | `` | no | - | - |
327 -| MaxQueues | Maximum number of queues to collect (0 = no limit) | `50` | no | - | - |
328 -| MaxChannels | Maximum number of channels to collect (0 = no limit) | `100` | no | - | - |
329 -| MaxTopics | Maximum number of topics to collect (0 = no limit) | `100` | no | - | - |
330 -| MaxListeners | Maximum number of listeners to collect (0 = no limit) | `100` | no | - | - |
331 -| CollectResetQueueStats | Enable collection of queue statistics (destructive operation) | `false` | no | - | - |
332 -| CollectStatisticsQueue | Enable collection of statistics queue metrics (SYSTEM.ADMIN.STATISTICS.QUEUE provides advanced metrics like min/max depth) | `false` | no | - | - |
333 -| CollectSysTopics | Enable collection of $SYS topic metrics (provides Queue Manager CPU, memory, and log utilization) | `false` | no | - | - |
334 -| StatisticsInterval | Statistics collection interval in seconds (auto-detected STATINT overwrites this value) | `60` | no | - | - |
335 -| SysTopicInterval | $SYS topic collection interval in seconds (user override for customized MQ configurations) | `10` | no | - | - |
336 -
337 -### Examples
338 -
339 -#### Basic configuration
340 -
341 -IBM MQ monitoring with default settings.
342 -
343 -<details>
344 -<summary>Config</summary>
345 -
346 -```yaml
347 -jobs:
348 - - name: local
349 - endpoint: dummy://localhost
350 -```
351 -
352 -</details>
353 -
354 -## Troubleshooting
355 -
356 -### Debug Mode
357 -
358 -To troubleshoot issues with the `mq` collector, run the `ibm.d.plugin` with the debug option enabled.
359 -The output should give you clues as to why the collector isn't working.
360 -
361 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
362 -- Switch to the `netdata` user
363 -- Run the `ibm.d.plugin` to debug the collector:
364 -
365 -```bash
366 -sudo -u netdata ./ibm.d.plugin -d -m mq
367 -```
368 -
369 -## Getting Logs
370 -
371 -If you're encountering problems with the `mq` collector, follow these steps to retrieve logs and identify potential issues:
372 -
373 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
374 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
375 -
376 -### For systemd systems (most Linux distributions)
377 -
378 -```bash
379 -sudo journalctl -u netdata --reverse | grep mq
380 -```
381 -
382 -### For non-systemd systems
383 -
384 -```bash
385 -sudo grep mq /var/log/netdata/error.log
386 -sudo grep mq /var/log/netdata/collector.log
387 -```
388 -
389 -### For Docker containers
390 -
391 -```bash
392 -sudo docker logs netdata 2>&1 | grep mq
393 -```
src/go/plugin/ibm.d/modules/mq/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_mq.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/mq/integrations/ibm_mq.md new
+391
@@ -0,0 +1,391 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/mq/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/mq/metadata.yaml"
4 +sidebar_label: "IBM MQ"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Applications"
7 +most_popular: False
8 +keywords: ['mq']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM MQ
13 +
14 +
15 +<img src="https://netdata.cloud/img/ibm-mq.svg" width="150"/>
16 +
17 +
18 +Plugin: ibm.d.plugin
19 +Module: mq
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Monitors IBM MQ queue managers, queues, channels, and topics
26 +using the PCF (Programmable Command Format) protocol.
27 +
28 +By default the collector tracks the critical system queues `SYSTEM.DEAD.LETTER.QUEUE`,
29 +`SYSTEM.ADMIN.COMMAND.QUEUE`, and `SYSTEM.ADMIN.STATISTICS.QUEUE`. All other queues are
30 +opt-in via the `include_queues` list, with `exclude_queues` removing noisy patterns such as
31 +`SYSTEM.*` or `AMQ.*`. Include patterns take precedence over excludes so you can safely
32 +monitor individual system queues while dropping the broader wildcard.
33 +
34 +Per-queue charts are bounded by `max_queues` (default 50). When more queues are discovered,
35 +the collector exports the busiest ones individually, rolls the remainder into an
36 +aggregated `__other__` dimension, and logs a throttled warning listing the overflowed
37 +groups. Parallel queue-group charts summarise depth, traffic, and backlog per naming
38 +prefix (first two dot-separated segments, collapsing all `SYSTEM.*` queues together), so
39 +high-level visibility is never lost even when detailed charts are trimmed.
40 +
41 +
42 +The collector connects to IBM MQ and collects metrics via its monitoring interface.
43 +
44 +
45 +This collector is supported on all platforms.
46 +
47 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
48 +
49 +
50 +### Default Behavior
51 +
52 +#### Auto-Detection
53 +
54 +This integration doesn't support auto-detection.
55 +
56 +#### Limits
57 +
58 +The default configuration for this integration does not impose any limits on data collection.
59 +
60 +#### Performance Impact
61 +
62 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
63 +
64 +## Metrics
65 +
66 +Metrics grouped by *scope*.
67 +
68 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
69 +
70 +
71 +
72 +### Per channel
73 +
74 +These metrics refer to channel instances.
75 +
76 +Labels:
77 +
78 +| Label | Description |
79 +|:-----------|:----------------|
80 +| channel | Channel identifier |
81 +| type | Type identifier |
82 +
83 +Metrics:
84 +
85 +| Metric | Dimensions | Unit |
86 +|:------|:----------|:----|
87 +| mq.channel.status | inactive, binding, starting, running, stopping, retrying, stopped, requesting, paused, disconnected, initializing, switching | status |
88 +| mq.channel.messages | messages | messages/s |
89 +| mq.channel.bytes | bytes | bytes/s |
90 +| mq.channel.batches | batches | batches/s |
91 +| mq.channel.batch_size | batch_size | messages |
92 +| mq.channel.batch_interval | batch_interval | milliseconds |
93 +| mq.channel.intervals | disc_interval, hb_interval, keep_alive_interval | seconds |
94 +| mq.channel.short_retry_count | short_retry | retries |
95 +| mq.channel.long_retry_interval | long_retry | seconds |
96 +| mq.channel.max_msg_length | max_msg_length | bytes |
97 +| mq.channel.sharing_conversations | sharing_conversations | conversations |
98 +| mq.channel.network_priority | network_priority | priority |
99 +| mq.channel.buffer_counts | sent, received | buffers |
100 +| mq.channel.current_messages | current | messages |
101 +| mq.channel.xmitq_time | xmitq_time | milliseconds |
102 +| mq.channel.mca_status | mca_status | status |
103 +| mq.channel.indoubt_status | indoubt_status | status |
104 +| mq.channel.ssl_key_resets | ssl_key_resets | resets |
105 +| mq.channel.npm_speed | npm_speed | speed |
106 +| mq.channel.current_sharing_convs | current_sharing | conversations |
107 +
108 +### Per channelstatistics
109 +
110 +These metrics refer to channelstatistics instances.
111 +
112 +Labels:
113 +
114 +| Label | Description |
115 +|:-----------|:----------------|
116 +| channel | Channel identifier |
117 +| type | Type identifier |
118 +
119 +Metrics:
120 +
121 +| Metric | Dimensions | Unit |
122 +|:------|:----------|:----|
123 +| mq.channel_stats.messages | messages | messages/s |
124 +| mq.channel_stats.bytes | bytes | bytes/s |
125 +| mq.channel_stats.batches | full_batches, incomplete_batches | batches/s |
126 +| mq.channel_stats.batch_size | avg_batch_size | messages |
127 +| mq.channel_stats.put_retries | put_retries | retries/s |
128 +
129 +### Per listener
130 +
131 +These metrics refer to listener instances.
132 +
133 +Labels:
134 +
135 +| Label | Description |
136 +|:-----------|:----------------|
137 +| listener | Listener identifier |
138 +| port | Port identifier |
139 +| ip_address | Ip_address identifier |
140 +
141 +Metrics:
142 +
143 +| Metric | Dimensions | Unit |
144 +|:------|:----------|:----|
145 +| mq.listener.status | stopped, starting, running, stopping, retrying | status |
146 +| mq.listener.backlog | backlog | connections |
147 +| mq.listener.uptime | uptime | seconds |
148 +
149 +### Per mqistatistics
150 +
151 +These metrics refer to mqistatistics instances.
152 +
153 +Labels:
154 +
155 +| Label | Description |
156 +|:-----------|:----------------|
157 +| queue_manager | Queue_manager identifier |
158 +
159 +Metrics:
160 +
161 +| Metric | Dimensions | Unit |
162 +|:------|:----------|:----|
163 +| mq.mqi_stats.opens | opens_total, opens_failed | operations/s |
164 +| mq.mqi_stats.closes | closes_total, closes_failed | operations/s |
165 +| mq.mqi_stats.inqs | inqs_total, inqs_failed | operations/s |
166 +| mq.mqi_stats.sets | sets_total, sets_failed | operations/s |
167 +
168 +### Per queue
169 +
170 +These metrics refer to queue instances.
171 +
172 +Labels:
173 +
174 +| Label | Description |
175 +|:-----------|:----------------|
176 +| queue | Queue identifier |
177 +| type | Type identifier |
178 +
179 +Metrics:
180 +
181 +| Metric | Dimensions | Unit |
182 +|:------|:----------|:----|
183 +| mq.queue.depth | current, max | messages |
184 +| mq.queue.depth_percentage | percentage | percentage |
185 +| mq.queue.messages | enqueued, dequeued | messages/s |
186 +| mq.queue.connections | input, output | connections |
187 +| mq.queue.high_depth | high_depth | messages |
188 +| mq.queue.uncommitted_msgs | uncommitted | messages |
189 +| mq.queue.file_size | current, max | bytes |
190 +| mq.queue.last_activity | since_last_get, since_last_put | seconds |
191 +| mq.queue.oldest_msg_age | oldest_msg_age | seconds |
192 +| mq.queue.time_indicators | short_period, long_period | microseconds |
193 +| mq.queue.service_interval | service_interval | milliseconds |
194 +| mq.queue.inhibit_status | inhibit_get, inhibit_put | status |
195 +| mq.queue.priority | def_priority | priority |
196 +| mq.queue.message_persistence | persistent, non_persistent | boolean |
197 +| mq.queue.retention_interval | retention_interval | hours |
198 +| mq.queue.triggers | trigger_depth, trigger_type | messages |
199 +| mq.queue.backout_threshold | backout_threshold | retries |
200 +| mq.queue.max_msg_length | max_msg_length | bytes |
201 +| mq.queue.scope | queue_manager, cell | boolean |
202 +| mq.queue.usage | normal, transmission | boolean |
203 +| mq.queue.msg_delivery_sequence | priority, fifo | boolean |
204 +| mq.queue.harden_get_backout | enabled, disabled | boolean |
205 +
206 +### Per queuegroup
207 +
208 +These metrics refer to queuegroup instances.
209 +
210 +Labels:
211 +
212 +| Label | Description |
213 +|:-----------|:----------------|
214 +| group | Group identifier |
215 +
216 +Metrics:
217 +
218 +| Metric | Dimensions | Unit |
219 +|:------|:----------|:----|
220 +| mq.queue_group.depth | current, max | messages |
221 +| mq.queue_group.depth_percentage | percentage | percentage |
222 +| mq.queue_group.messages | enqueued, dequeued | messages/s |
223 +| mq.queue_group.connections | input, output | connections |
224 +| mq.queue_group.uncommitted_msgs | uncommitted | messages |
225 +| mq.queue_group.file_size | current, max | bytes |
226 +| mq.queue_group.oldest_msg_age | oldest_msg_age | seconds |
227 +
228 +### Per IBM MQ instance
229 +
230 +These metrics refer to the entire monitored instance.
231 +
232 +This scope has no labels.
233 +
234 +Metrics:
235 +
236 +| Metric | Dimensions | Unit |
237 +|:------|:----------|:----|
238 +| mq.qmgr.status | status | status |
239 +| mq.qmgr.connection_count | connections | connections |
240 +| mq.qmgr.uptime | uptime | seconds |
241 +| mq.queues.overview | monitored, excluded, invisible, failed | queues |
242 +| mq.channels.overview | monitored, excluded, invisible, failed | channels |
243 +| mq.topics.overview | monitored, excluded, invisible, failed | topics |
244 +| mq.listeners.overview | monitored, excluded, invisible, failed | listeners |
245 +
246 +### Per IBM MQ instance
247 +
248 +These metrics refer to the entire monitored instance.
249 +
250 +This scope has no labels.
251 +
252 +Metrics:
253 +
254 +| Metric | Dimensions | Unit |
255 +|:------|:----------|:----|
256 +| mq.qmgr.cpu_usage | user, system | percentage |
257 +| mq.qmgr.memory_usage | total | bytes |
258 +| mq.qmgr.ram_usage | total | bytes |
259 +| mq.qmgr.log_utilization | used | percentage |
260 +| mq.qmgr.log_file_size | size | bytes |
261 +| mq.qmgr.log_write_rate | rate | bytes/s |
262 +
263 +### Per queuestatistics
264 +
265 +These metrics refer to queuestatistics instances.
266 +
267 +Labels:
268 +
269 +| Label | Description |
270 +|:-----------|:----------------|
271 +| queue | Queue identifier |
272 +| type | Type identifier |
273 +
274 +Metrics:
275 +
276 +| Metric | Dimensions | Unit |
277 +|:------|:----------|:----|
278 +| mq.queue_stats.depth_min_max | min_depth, max_depth | messages |
279 +| mq.queue_stats.avg_queue_time | non_persistent, persistent | microseconds |
280 +| mq.queue_stats.time_indicators | short_period, long_period | microseconds |
281 +| mq.queue_stats.operations | puts_non_persistent, puts_persistent, gets_non_persistent, gets_persistent, put1s, browses | operations/s |
282 +| mq.queue_stats.bytes | put_bytes_non_persistent, put_bytes_persistent, get_bytes_non_persistent, get_bytes_persistent, browse_bytes | bytes/s |
283 +| mq.queue_stats.failures | puts_failed, put1s_failed, gets_failed, browses_failed | failures/s |
284 +| mq.queue_stats.message_lifecycle | expired, purged, not_queued | messages/s |
285 +
286 +### Per subscription
287 +
288 +These metrics refer to subscription instances.
289 +
290 +Labels:
291 +
292 +| Label | Description |
293 +|:-----------|:----------------|
294 +| subscription | Subscription identifier |
295 +| topic | Topic identifier |
296 +
297 +Metrics:
298 +
299 +| Metric | Dimensions | Unit |
300 +|:------|:----------|:----|
301 +| mq.subscription.messages | pending | messages |
302 +| mq.subscription.last_message_age | age | seconds |
303 +
304 +### Per topic
305 +
306 +These metrics refer to topic instances.
307 +
308 +Labels:
309 +
310 +| Label | Description |
311 +|:-----------|:----------------|
312 +| topic | Topic identifier |
313 +
314 +Metrics:
315 +
316 +| Metric | Dimensions | Unit |
317 +|:------|:----------|:----|
318 +| mq.topic.publishers | publishers | publishers |
319 +| mq.topic.subscribers | subscribers | subscribers |
320 +| mq.topic.messages | messages | messages/s |
321 +| mq.topic.time_since_last_message | time_since_last_msg | seconds |
322 +
323 +
324 +
325 +## Alerts
326 +
327 +There are no alerts configured by default for this integration.
328 +
329 +
330 +## Setup
331 +
332 +
333 +### Prerequisites
334 +
335 +#### Enable monitoring interface
336 +
337 +Ensure the IBM MQ monitoring interface is accessible.
338 +
339 +
340 +
341 +### Configuration
342 +
343 +#### Options
344 +
345 +Configuration options for the mq collector.
346 +
347 +
348 +<details open><summary>Config options</summary>
349 +
350 +
351 +
352 +| Option | Description | Default | Required |
353 +|:-----|:------------|:--------|:---------:|
354 +| update_every | Data collection frequency. | 1 | no |
355 +| endpoint | Connection endpoint. | dummy://localhost | no |
356 +
357 +
358 +</details>
359 +
360 +
361 +
362 +#### via File
363 +
364 +The configuration file name for this integration is `ibm.d/mq.conf`.
365 +
366 +
367 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
368 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
369 +
370 +```bash
371 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
372 +sudo ./edit-config ibm.d/mq.conf
373 +```
374 +
375 +##### Examples
376 +
377 +###### Basic
378 +
379 +Basic configuration example.
380 +
381 +<details open><summary>Config</summary>
382 +
383 +```yaml
384 +jobs:
385 + - name: local
386 + endpoint: dummy://localhost
387 +
388 +```
389 +</details>
390 +
391 +
src/go/plugin/ibm.d/modules/websphere/jmx/README.md deleted
-263
@@ -1,263 +0,0 @@
1 -# IBM WebSphere JMX collector
2 -
3 -## Overview
4 -
5 -Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application Server
6 -via the embedded JMX bridge helper.
7 -
8 -
9 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
10 -
11 -## Collected metrics
12 -
13 -Metrics grouped by scope.
14 -
15 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
16 -
17 -### Per IBM WebSphere JMX instance
18 -
19 -
20 -These metrics refer to the entire monitored IBM WebSphere JMX instance.
21 -
22 -This scope has no labels.
23 -
24 -Metrics:
25 -
26 -| Metric | Dimensions | Unit |
27 -|:-------|:-----------|:-----|
28 -| websphere_jmx.jvm_heap_memory | used, committed, max | bytes |
29 -| websphere_jmx.jvm_heap_usage | usage | percentage |
30 -| websphere_jmx.jvm_nonheap_memory | used, committed | bytes |
31 -| websphere_jmx.jvm_gc_count | collections | collections |
32 -| websphere_jmx.jvm_gc_time | time | milliseconds |
33 -| websphere_jmx.jvm_threads | total, daemon | threads |
34 -| websphere_jmx.jvm_thread_states | peak, started | threads |
35 -| websphere_jmx.jvm_classes | loaded, unloaded | classes |
36 -| websphere_jmx.jvm_process_cpu_usage | cpu | percentage |
37 -| websphere_jmx.jvm_uptime | uptime | seconds |
38 -
39 -
40 -
41 -### Per applications
42 -
43 -These metrics refer to individual applications instances.
44 -
45 -Labels:
46 -
47 -| Label | Description |
48 -|:------|:------------|
49 -| application | Application identifier |
50 -| module | Module identifier |
51 -
52 -Metrics:
53 -
54 -| Metric | Dimensions | Unit |
55 -|:-------|:-----------|:-----|
56 -| websphere_jmx.app_requests | requests | requests |
57 -| websphere_jmx.app_response_time | response_time | milliseconds |
58 -| websphere_jmx.app_sessions_active | active | sessions |
59 -| websphere_jmx.app_sessions_live | live | sessions |
60 -| websphere_jmx.app_session_events | creates, invalidates | sessions |
61 -| websphere_jmx.app_transactions | committed, rolledback | transactions |
62 -
63 -### Per jca
64 -
65 -These metrics refer to individual jca instances.
66 -
67 -Labels:
68 -
69 -| Label | Description |
70 -|:------|:------------|
71 -| pool | Pool identifier |
72 -
73 -Metrics:
74 -
75 -| Metric | Dimensions | Unit |
76 -|:-------|:-----------|:-----|
77 -| websphere_jmx.jca_pool_size | size | connections |
78 -| websphere_jmx.jca_pool_usage | active, free | connections |
79 -| websphere_jmx.jca_pool_wait_time | wait | milliseconds |
80 -| websphere_jmx.jca_pool_use_time | use | milliseconds |
81 -| websphere_jmx.jca_pool_connections | created, destroyed | connections |
82 -| websphere_jmx.jca_pool_waiting_threads | waiting | threads |
83 -
84 -### Per jdbc
85 -
86 -These metrics refer to individual jdbc instances.
87 -
88 -Labels:
89 -
90 -| Label | Description |
91 -|:------|:------------|
92 -| pool | Pool identifier |
93 -
94 -Metrics:
95 -
96 -| Metric | Dimensions | Unit |
97 -|:-------|:-----------|:-----|
98 -| websphere_jmx.jdbc_pool_size | size | connections |
99 -| websphere_jmx.jdbc_pool_usage | active, free | connections |
100 -| websphere_jmx.jdbc_pool_wait_time | wait | milliseconds |
101 -| websphere_jmx.jdbc_pool_use_time | use | milliseconds |
102 -| websphere_jmx.jdbc_pool_connections | created, destroyed | connections |
103 -| websphere_jmx.jdbc_pool_waiting_threads | waiting | threads |
104 -
105 -### Per jms
106 -
107 -These metrics refer to individual jms instances.
108 -
109 -Labels:
110 -
111 -| Label | Description |
112 -|:------|:------------|
113 -| destination | Destination identifier |
114 -| destination_type | Destination_type identifier |
115 -
116 -Metrics:
117 -
118 -| Metric | Dimensions | Unit |
119 -|:-------|:-----------|:-----|
120 -| websphere_jmx.jms_messages_current | current | messages |
121 -| websphere_jmx.jms_messages_pending | pending | messages |
122 -| websphere_jmx.jms_messages_total | total | messages |
123 -| websphere_jmx.jms_consumers | consumers | consumers |
124 -
125 -### Per threadpools
126 -
127 -These metrics refer to individual threadpools instances.
128 -
129 -Labels:
130 -
131 -| Label | Description |
132 -|:------|:------------|
133 -| pool | Pool identifier |
134 -
135 -Metrics:
136 -
137 -| Metric | Dimensions | Unit |
138 -|:-------|:-----------|:-----|
139 -| websphere_jmx.threadpool_size | size, max | threads |
140 -| websphere_jmx.threadpool_active | active | threads |
141 -
142 -
143 -## Configuration
144 -
145 -### File
146 -
147 -The configuration file name for this integration is `ibm.d/websphere_jmx.conf`.
148 -
149 -You can edit the configuration file using the `edit-config` script from the
150 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
151 -
152 -```bash
153 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
154 -sudo ./edit-config ibm.d/websphere_jmx.conf
155 -```
156 -
157 -### Options
158 -
159 -The following options can be defined globally or per job.
160 -
161 -| Name | Description | Default | Required | Min | Max |
162 -|:-----|:------------|:--------|:---------|:----|:----|
163 -| update_every | Data collection frequency | `5` | no | 1 | - |
164 -| Vnode | Vnode | `` | no | - | - |
165 -| JMXURL | Connection settings | `` | no | - | - |
166 -| JMXUsername | Username | `` | no | - | - |
167 -| JMXPassword | Password | `` | no | - | - |
168 -| JMXClasspath | J m x classpath | `` | no | - | - |
169 -| JavaExecPath | Java exec path | `` | no | - | - |
170 -| JMXTimeout | Timeout | `5000000000` | no | - | - |
171 -| InitTimeout | Timeout | `30000000000` | no | - | - |
172 -| ShutdownDelay | Shutdown delay | `100000000` | no | - | - |
173 -| ClusterName | Identity labels | `` | no | - | - |
174 -| CellName | Cell name | `` | no | - | - |
175 -| NodeName | Node name | `` | no | - | - |
176 -| ServerName | Server name | `` | no | - | - |
177 -| ServerType | Server type | `` | no | - | - |
178 -| CollectJVMMetrics | Metric toggles | `enabled` | no | - | - |
179 -| CollectThreadPoolMetrics | Collect Thread pool metrics | `enabled` | no | - | - |
180 -| CollectJDBCMetrics | Collect J d b c metrics | `enabled` | no | - | - |
181 -| CollectJCAMetrics | Collect J c a metrics | `enabled` | no | - | - |
182 -| CollectJMSMetrics | Collect J m s metrics | `enabled` | no | - | - |
183 -| CollectWebAppMetrics | Collect Web app metrics | `enabled` | no | - | - |
184 -| CollectSessionMetrics | Collect Session metrics | `enabled` | no | - | - |
185 -| CollectTransactionMetrics | Collect Transaction metrics | `enabled` | no | - | - |
186 -| CollectClusterMetrics | Collect Cluster metrics | `enabled` | no | - | - |
187 -| CollectServletMetrics | Collect Servlet metrics | `enabled` | no | - | - |
188 -| CollectEJBMetrics | Collect E j b metrics | `enabled` | no | - | - |
189 -| CollectJDBCAdvanced | Collect J d b c advanced | `disabled` | no | - | - |
190 -| MaxThreadPools | Cardinality guards | `50` | no | - | - |
191 -| MaxJDBCPools | Max J d b c pools | `50` | no | - | - |
192 -| MaxJCAPools | Max J c a pools | `50` | no | - | - |
193 -| MaxJMSDestinations | Max J m s destinations | `50` | no | - | - |
194 -| MaxApplications | Max Applications | `100` | no | - | - |
195 -| MaxServlets | Max Servlets | `50` | no | - | - |
196 -| MaxEJBs | Max E j bs | `50` | no | - | - |
197 -| CollectPoolsMatching | Filters | `` | no | - | - |
198 -| CollectJMSMatching | Collect J m s matching | `` | no | - | - |
199 -| CollectAppsMatching | Collect Apps matching | `` | no | - | - |
200 -| CollectServletsMatching | Collect Servlets matching | `` | no | - | - |
201 -| CollectEJBsMatching | Collect E j bs matching | `` | no | - | - |
202 -| MaxRetries | Resilience tuning | `3` | no | - | - |
203 -| RetryBackoffMultiplier | Retry backoff multiplier | `2` | no | - | - |
204 -| CircuitBreakerThreshold | Circuit breaker threshold | `5` | no | - | - |
205 -| HelperRestartMax | Helper restart max | `3` | no | - | - |
206 -
207 -### Examples
208 -
209 -#### Basic configuration
210 -
211 -IBM WebSphere JMX monitoring with default settings.
212 -
213 -<details>
214 -<summary>Config</summary>
215 -
216 -```yaml
217 -jobs:
218 - - name: local
219 - endpoint: dummy://localhost
220 -```
221 -
222 -</details>
223 -
224 -## Troubleshooting
225 -
226 -### Debug Mode
227 -
228 -To troubleshoot issues with the `websphere_jmx` collector, run the `ibm.d.plugin` with the debug option enabled.
229 -The output should give you clues as to why the collector isn't working.
230 -
231 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
232 -- Switch to the `netdata` user
233 -- Run the `ibm.d.plugin` to debug the collector:
234 -
235 -```bash
236 -sudo -u netdata ./ibm.d.plugin -d -m websphere_jmx
237 -```
238 -
239 -## Getting Logs
240 -
241 -If you're encountering problems with the `websphere_jmx` collector, follow these steps to retrieve logs and identify potential issues:
242 -
243 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
244 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
245 -
246 -### For systemd systems (most Linux distributions)
247 -
248 -```bash
249 -sudo journalctl -u netdata --reverse | grep websphere_jmx
250 -```
251 -
252 -### For non-systemd systems
253 -
254 -```bash
255 -sudo grep websphere_jmx /var/log/netdata/error.log
256 -sudo grep websphere_jmx /var/log/netdata/collector.log
257 -```
258 -
259 -### For Docker containers
260 -
261 -```bash
262 -sudo docker logs netdata 2>&1 | grep websphere_jmx
263 -```
src/go/plugin/ibm.d/modules/websphere/jmx/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_websphere_jmx.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/websphere/jmx/integrations/ibm_websphere_jmx.md new
+245
@@ -0,0 +1,245 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/jmx/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/jmx/metadata.yaml"
4 +sidebar_label: "IBM WebSphere JMX"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Applications"
7 +most_popular: False
8 +keywords: ['websphere_jmx']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM WebSphere JMX
13 +
14 +Plugin: ibm.d.plugin
15 +Module: websphere_jmx
16 +
17 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
18 +
19 +## Overview
20 +
21 +Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application Server
22 +via the embedded JMX bridge helper.
23 +
24 +
25 +The collector connects to IBM WebSphere JMX and collects metrics via its monitoring interface.
26 +
27 +
28 +This collector is supported on all platforms.
29 +
30 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
31 +
32 +
33 +### Default Behavior
34 +
35 +#### Auto-Detection
36 +
37 +This integration doesn't support auto-detection.
38 +
39 +#### Limits
40 +
41 +The default configuration for this integration does not impose any limits on data collection.
42 +
43 +#### Performance Impact
44 +
45 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
46 +
47 +## Metrics
48 +
49 +Metrics grouped by *scope*.
50 +
51 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
52 +
53 +
54 +
55 +### Per applications
56 +
57 +These metrics refer to applications instances.
58 +
59 +Labels:
60 +
61 +| Label | Description |
62 +|:-----------|:----------------|
63 +| application | Application identifier |
64 +| module | Module identifier |
65 +
66 +Metrics:
67 +
68 +| Metric | Dimensions | Unit |
69 +|:------|:----------|:----|
70 +| websphere_jmx.app_requests | requests | requests |
71 +| websphere_jmx.app_response_time | response_time | milliseconds |
72 +| websphere_jmx.app_sessions_active | active | sessions |
73 +| websphere_jmx.app_sessions_live | live | sessions |
74 +| websphere_jmx.app_session_events | creates, invalidates | sessions |
75 +| websphere_jmx.app_transactions | committed, rolledback | transactions |
76 +
77 +### Per jca
78 +
79 +These metrics refer to jca instances.
80 +
81 +Labels:
82 +
83 +| Label | Description |
84 +|:-----------|:----------------|
85 +| pool | Pool identifier |
86 +
87 +Metrics:
88 +
89 +| Metric | Dimensions | Unit |
90 +|:------|:----------|:----|
91 +| websphere_jmx.jca_pool_size | size | connections |
92 +| websphere_jmx.jca_pool_usage | active, free | connections |
93 +| websphere_jmx.jca_pool_wait_time | wait | milliseconds |
94 +| websphere_jmx.jca_pool_use_time | use | milliseconds |
95 +| websphere_jmx.jca_pool_connections | created, destroyed | connections |
96 +| websphere_jmx.jca_pool_waiting_threads | waiting | threads |
97 +
98 +### Per jdbc
99 +
100 +These metrics refer to jdbc instances.
101 +
102 +Labels:
103 +
104 +| Label | Description |
105 +|:-----------|:----------------|
106 +| pool | Pool identifier |
107 +
108 +Metrics:
109 +
110 +| Metric | Dimensions | Unit |
111 +|:------|:----------|:----|
112 +| websphere_jmx.jdbc_pool_size | size | connections |
113 +| websphere_jmx.jdbc_pool_usage | active, free | connections |
114 +| websphere_jmx.jdbc_pool_wait_time | wait | milliseconds |
115 +| websphere_jmx.jdbc_pool_use_time | use | milliseconds |
116 +| websphere_jmx.jdbc_pool_connections | created, destroyed | connections |
117 +| websphere_jmx.jdbc_pool_waiting_threads | waiting | threads |
118 +
119 +### Per jms
120 +
121 +These metrics refer to jms instances.
122 +
123 +Labels:
124 +
125 +| Label | Description |
126 +|:-----------|:----------------|
127 +| destination | Destination identifier |
128 +| destination_type | Destination_type identifier |
129 +
130 +Metrics:
131 +
132 +| Metric | Dimensions | Unit |
133 +|:------|:----------|:----|
134 +| websphere_jmx.jms_messages_current | current | messages |
135 +| websphere_jmx.jms_messages_pending | pending | messages |
136 +| websphere_jmx.jms_messages_total | total | messages |
137 +| websphere_jmx.jms_consumers | consumers | consumers |
138 +
139 +### Per IBM WebSphere JMX instance
140 +
141 +These metrics refer to the entire monitored instance.
142 +
143 +This scope has no labels.
144 +
145 +Metrics:
146 +
147 +| Metric | Dimensions | Unit |
148 +|:------|:----------|:----|
149 +| websphere_jmx.jvm_heap_memory | used, committed, max | bytes |
150 +| websphere_jmx.jvm_heap_usage | usage | percentage |
151 +| websphere_jmx.jvm_nonheap_memory | used, committed | bytes |
152 +| websphere_jmx.jvm_gc_count | collections | collections |
153 +| websphere_jmx.jvm_gc_time | time | milliseconds |
154 +| websphere_jmx.jvm_threads | total, daemon | threads |
155 +| websphere_jmx.jvm_thread_states | peak, started | threads |
156 +| websphere_jmx.jvm_classes | loaded, unloaded | classes |
157 +| websphere_jmx.jvm_process_cpu_usage | cpu | percentage |
158 +| websphere_jmx.jvm_uptime | uptime | seconds |
159 +
160 +### Per threadpools
161 +
162 +These metrics refer to threadpools instances.
163 +
164 +Labels:
165 +
166 +| Label | Description |
167 +|:-----------|:----------------|
168 +| pool | Pool identifier |
169 +
170 +Metrics:
171 +
172 +| Metric | Dimensions | Unit |
173 +|:------|:----------|:----|
174 +| websphere_jmx.threadpool_size | size, max | threads |
175 +| websphere_jmx.threadpool_active | active | threads |
176 +
177 +
178 +
179 +## Alerts
180 +
181 +There are no alerts configured by default for this integration.
182 +
183 +
184 +## Setup
185 +
186 +
187 +### Prerequisites
188 +
189 +#### Enable monitoring interface
190 +
191 +Ensure the IBM WebSphere JMX monitoring interface is accessible.
192 +
193 +
194 +
195 +### Configuration
196 +
197 +#### Options
198 +
199 +Configuration options for the websphere_jmx collector.
200 +
201 +
202 +<details open><summary>Config options</summary>
203 +
204 +
205 +
206 +| Option | Description | Default | Required |
207 +|:-----|:------------|:--------|:---------:|
208 +| update_every | Data collection frequency. | 1 | no |
209 +| endpoint | Connection endpoint. | dummy://localhost | no |
210 +
211 +
212 +</details>
213 +
214 +
215 +
216 +#### via File
217 +
218 +The configuration file name for this integration is `ibm.d/websphere_jmx.conf`.
219 +
220 +
221 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
222 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
223 +
224 +```bash
225 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
226 +sudo ./edit-config ibm.d/websphere_jmx.conf
227 +```
228 +
229 +##### Examples
230 +
231 +###### Basic
232 +
233 +Basic configuration example.
234 +
235 +<details open><summary>Config</summary>
236 +
237 +```yaml
238 +jobs:
239 + - name: local
240 + endpoint: dummy://localhost
241 +
242 +```
243 +</details>
244 +
245 +
src/go/plugin/ibm.d/modules/websphere/mp/README.md deleted
-180
@@ -1,180 +0,0 @@
1 -# IBM WebSphere MicroProfile collector
2 -
3 -## Overview
4 -
5 -Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Liberty
6 -servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint.
7 -
8 -
9 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
10 -
11 -## Collected metrics
12 -
13 -Metrics grouped by scope.
14 -
15 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
16 -
17 -### Per IBM WebSphere MicroProfile instance
18 -
19 -
20 -These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
21 -
22 -This scope has no labels.
23 -
24 -Metrics:
25 -
26 -| Metric | Dimensions | Unit |
27 -|:-------|:-----------|:-----|
28 -| websphere_mp.cpu_usage | process, utilization | percentage |
29 -| websphere_mp.cpu_time | total | seconds |
30 -
31 -These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
32 -
33 -This scope has no labels.
34 -
35 -Metrics:
36 -
37 -| Metric | Dimensions | Unit |
38 -|:-------|:-----------|:-----|
39 -| websphere_mp.jvm_memory_heap_usage | used, free | bytes |
40 -| websphere_mp.jvm_memory_heap_committed | committed | bytes |
41 -| websphere_mp.jvm_memory_heap_max | limit | bytes |
42 -| websphere_mp.jvm_heap_utilization | utilization | percentage |
43 -| websphere_mp.jvm_gc_collections | rate | collections/s |
44 -| websphere_mp.jvm_gc_time | total, per_cycle | milliseconds |
45 -| websphere_mp.jvm_threads_current | daemon, other | threads |
46 -| websphere_mp.jvm_threads_peak | peak | threads |
47 -
48 -These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
49 -
50 -This scope has no labels.
51 -
52 -Metrics:
53 -
54 -| Metric | Dimensions | Unit |
55 -|:-------|:-----------|:-----|
56 -| websphere_mp.threadpool_usage | active, idle | threads |
57 -| websphere_mp.threadpool_size | size | threads |
58 -
59 -
60 -
61 -### Per restendpoint
62 -
63 -These metrics refer to individual restendpoint instances.
64 -
65 -Labels:
66 -
67 -| Label | Description |
68 -|:------|:------------|
69 -| method | Method identifier |
70 -| endpoint | Endpoint identifier |
71 -
72 -Metrics:
73 -
74 -| Metric | Dimensions | Unit |
75 -|:-------|:-----------|:-----|
76 -| websphere_mp.rest_requests | requests | requests/s |
77 -| websphere_mp.rest_response_time | average | milliseconds |
78 -
79 -
80 -## Configuration
81 -
82 -### File
83 -
84 -The configuration file name for this integration is `ibm.d/websphere_mp.conf`.
85 -
86 -You can edit the configuration file using the `edit-config` script from the
87 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
88 -
89 -```bash
90 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
91 -sudo ./edit-config ibm.d/websphere_mp.conf
92 -```
93 -
94 -### Options
95 -
96 -The following options can be defined globally or per job.
97 -
98 -| Name | Description | Default | Required | Min | Max |
99 -|:-----|:------------|:--------|:---------|:----|:----|
100 -| tls_key | Client key path | `` | no | - | - |
101 -| tls_cert | Client certificate path | `` | no | - | - |
102 -| tls_ca | Custom CA bundle path | `` | no | - | - |
103 -| tls_skip_verify | Skip TLS certificate verification | `false` | no | - | - |
104 -| headers | Custom headers | `<no value>` | no | - | - |
105 -| proxy_password | Proxy password | `` | no | - | - |
106 -| proxy_username | Proxy username | `` | no | - | - |
107 -| proxy_url | Proxy URL | `` | no | - | - |
108 -| not_follow_redirects | Disable HTTP redirects | `false` | no | - | - |
109 -| timeout | Request timeout in seconds | `10000000000` | no | - | - |
110 -| password | Password for authentication | `` | no | - | - |
111 -| username | Username for authentication | `` | no | - | - |
112 -| url | Target URL | `` | no | - | - |
113 -| update_every | Data collection frequency | `1` | no | 1 | - |
114 -| Vnode | Vnode | `` | no | - | - |
115 -| CellName | CellName appends the Liberty cell label to every exported time-series. | `` | no | - | - |
116 -| NodeName | NodeName appends the Liberty node label to every exported time-series. | `` | no | - | - |
117 -| ServerName | ServerName appends the Liberty server label to every exported time-series. | `` | no | - | - |
118 -| MetricsEndpoint | MetricsEndpoint overrides the metrics path relative to the base URL (accepts absolute URLs as well). | `/metrics` | no | - | - |
119 -| CollectJVMMetrics | CollectJVMMetrics toggles JVM/base scope metrics scraped from the MicroProfile endpoint. | `enabled` | no | - | - |
120 -| CollectRESTMetrics | CollectRESTMetrics toggles per-endpoint REST/JAX-RS metrics (may introduce cardinality). | `enabled` | no | - | - |
121 -| MaxRESTEndpoints | MaxRESTEndpoints limits how many REST endpoints are exported when REST metrics are enabled (0 disables the limit). | `50` | no | - | - |
122 -| CollectRESTMatching | CollectRESTMatching filters REST endpoints using glob-style patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
123 -
124 -### Examples
125 -
126 -#### Basic configuration
127 -
128 -IBM WebSphere MicroProfile monitoring with default settings.
129 -
130 -<details>
131 -<summary>Config</summary>
132 -
133 -```yaml
134 -jobs:
135 - - name: local
136 - endpoint: dummy://localhost
137 -```
138 -
139 -</details>
140 -
141 -## Troubleshooting
142 -
143 -### Debug Mode
144 -
145 -To troubleshoot issues with the `websphere_mp` collector, run the `ibm.d.plugin` with the debug option enabled.
146 -The output should give you clues as to why the collector isn't working.
147 -
148 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
149 -- Switch to the `netdata` user
150 -- Run the `ibm.d.plugin` to debug the collector:
151 -
152 -```bash
153 -sudo -u netdata ./ibm.d.plugin -d -m websphere_mp
154 -```
155 -
156 -## Getting Logs
157 -
158 -If you're encountering problems with the `websphere_mp` collector, follow these steps to retrieve logs and identify potential issues:
159 -
160 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
161 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
162 -
163 -### For systemd systems (most Linux distributions)
164 -
165 -```bash
166 -sudo journalctl -u netdata --reverse | grep websphere_mp
167 -```
168 -
169 -### For non-systemd systems
170 -
171 -```bash
172 -sudo grep websphere_mp /var/log/netdata/error.log
173 -sudo grep websphere_mp /var/log/netdata/collector.log
174 -```
175 -
176 -### For Docker containers
177 -
178 -```bash
179 -sudo docker logs netdata 2>&1 | grep websphere_mp
180 -```
src/go/plugin/ibm.d/modules/websphere/mp/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_websphere_microprofile.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/websphere/mp/integrations/ibm_websphere_microprofile.md new
+190
@@ -0,0 +1,190 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/mp/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/mp/metadata.yaml"
4 +sidebar_label: "IBM WebSphere MicroProfile"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Applications"
7 +most_popular: False
8 +keywords: ['websphere_mp']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM WebSphere MicroProfile
13 +
14 +
15 +<img src="https://netdata.cloud/img/ibm.svg" width="150"/>
16 +
17 +
18 +Plugin: ibm.d.plugin
19 +Module: websphere_mp
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Liberty
26 +servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint.
27 +
28 +
29 +The collector connects to IBM WebSphere MicroProfile and collects metrics via its monitoring interface.
30 +
31 +
32 +This collector is supported on all platforms.
33 +
34 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
35 +
36 +
37 +### Default Behavior
38 +
39 +#### Auto-Detection
40 +
41 +This integration doesn't support auto-detection.
42 +
43 +#### Limits
44 +
45 +The default configuration for this integration does not impose any limits on data collection.
46 +
47 +#### Performance Impact
48 +
49 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
50 +
51 +## Metrics
52 +
53 +Metrics grouped by *scope*.
54 +
55 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
56 +
57 +
58 +
59 +### Per IBM WebSphere MicroProfile instance
60 +
61 +These metrics refer to the entire monitored instance.
62 +
63 +This scope has no labels.
64 +
65 +Metrics:
66 +
67 +| Metric | Dimensions | Unit |
68 +|:------|:----------|:----|
69 +| websphere_mp.cpu_usage | process, utilization | percentage |
70 +| websphere_mp.cpu_time | total | seconds |
71 +
72 +### Per IBM WebSphere MicroProfile instance
73 +
74 +These metrics refer to the entire monitored instance.
75 +
76 +This scope has no labels.
77 +
78 +Metrics:
79 +
80 +| Metric | Dimensions | Unit |
81 +|:------|:----------|:----|
82 +| websphere_mp.jvm_memory_heap_usage | used, free | bytes |
83 +| websphere_mp.jvm_memory_heap_committed | committed | bytes |
84 +| websphere_mp.jvm_memory_heap_max | limit | bytes |
85 +| websphere_mp.jvm_heap_utilization | utilization | percentage |
86 +| websphere_mp.jvm_gc_collections | rate | collections/s |
87 +| websphere_mp.jvm_gc_time | total, per_cycle | milliseconds |
88 +| websphere_mp.jvm_threads_current | daemon, other | threads |
89 +| websphere_mp.jvm_threads_peak | peak | threads |
90 +
91 +### Per restendpoint
92 +
93 +These metrics refer to restendpoint instances.
94 +
95 +Labels:
96 +
97 +| Label | Description |
98 +|:-----------|:----------------|
99 +| method | Method identifier |
100 +| endpoint | Endpoint identifier |
101 +
102 +Metrics:
103 +
104 +| Metric | Dimensions | Unit |
105 +|:------|:----------|:----|
106 +| websphere_mp.rest_requests | requests | requests/s |
107 +| websphere_mp.rest_response_time | average | milliseconds |
108 +
109 +### Per IBM WebSphere MicroProfile instance
110 +
111 +These metrics refer to the entire monitored instance.
112 +
113 +This scope has no labels.
114 +
115 +Metrics:
116 +
117 +| Metric | Dimensions | Unit |
118 +|:------|:----------|:----|
119 +| websphere_mp.threadpool_usage | active, idle | threads |
120 +| websphere_mp.threadpool_size | size | threads |
121 +
122 +
123 +
124 +## Alerts
125 +
126 +There are no alerts configured by default for this integration.
127 +
128 +
129 +## Setup
130 +
131 +
132 +### Prerequisites
133 +
134 +#### Enable monitoring interface
135 +
136 +Ensure the IBM WebSphere MicroProfile monitoring interface is accessible.
137 +
138 +
139 +
140 +### Configuration
141 +
142 +#### Options
143 +
144 +Configuration options for the websphere_mp collector.
145 +
146 +
147 +<details open><summary>Config options</summary>
148 +
149 +
150 +
151 +| Option | Description | Default | Required |
152 +|:-----|:------------|:--------|:---------:|
153 +| update_every | Data collection frequency. | 1 | no |
154 +| endpoint | Connection endpoint. | dummy://localhost | no |
155 +
156 +
157 +</details>
158 +
159 +
160 +
161 +#### via File
162 +
163 +The configuration file name for this integration is `ibm.d/websphere_mp.conf`.
164 +
165 +
166 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
167 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
168 +
169 +```bash
170 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
171 +sudo ./edit-config ibm.d/websphere_mp.conf
172 +```
173 +
174 +##### Examples
175 +
176 +###### Basic
177 +
178 +Basic configuration example.
179 +
180 +<details open><summary>Config</summary>
181 +
182 +```yaml
183 +jobs:
184 + - name: local
185 + endpoint: dummy://localhost
186 +
187 +```
188 +</details>
189 +
190 +
src/go/plugin/ibm.d/modules/websphere/pmi/README.md deleted
-663
@@ -1,663 +0,0 @@
1 -# IBM WebSphere PMI collector
2 -
3 -## Overview
4 -
5 -Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface,
6 -covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information.
7 -
8 -
9 -This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
10 -
11 -## Collected metrics
12 -
13 -Metrics grouped by scope.
14 -
15 -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
16 -
17 -### Per IBM WebSphere PMI instance
18 -
19 -
20 -These metrics refer to the entire monitored IBM WebSphere PMI instance.
21 -
22 -This scope has no labels.
23 -
24 -Metrics:
25 -
26 -| Metric | Dimensions | Unit |
27 -|:-------|:-----------|:-----|
28 -| websphere_pmi.jvm_heap_usage | used, free | bytes |
29 -| websphere_pmi.jvm_heap_committed | committed | bytes |
30 -| websphere_pmi.jvm_heap_max | limit | bytes |
31 -| websphere_pmi.jvm_uptime | uptime | seconds |
32 -| websphere_pmi.jvm_cpu | usage | percentage |
33 -| websphere_pmi.jvm_gc_collections | collections | collections/s |
34 -| websphere_pmi.jvm_gc_time | total | milliseconds |
35 -| websphere_pmi.jvm_threads | daemon, other | threads |
36 -| websphere_pmi.jvm_threads_peak | peak | threads |
37 -
38 -These metrics refer to the entire monitored IBM WebSphere PMI instance.
39 -
40 -This scope has no labels.
41 -
42 -Metrics:
43 -
44 -| Metric | Dimensions | Unit |
45 -|:-------|:-----------|:-----|
46 -| websphere_pmi.cpu_utilization | utilization | percentage |
47 -
48 -These metrics refer to the entire monitored IBM WebSphere PMI instance.
49 -
50 -This scope has no labels.
51 -
52 -Metrics:
53 -
54 -| Metric | Dimensions | Unit |
55 -|:-------|:-----------|:-----|
56 -| websphere_pmi.system_data_usage | cpu_since_last, free_memory | value |
57 -
58 -
59 -
60 -### Per alarmmanager
61 -
62 -These metrics refer to individual alarmmanager instances.
63 -
64 -Labels:
65 -
66 -| Label | Description |
67 -|:------|:------------|
68 -| node | Node identifier |
69 -| server | Server identifier |
70 -| manager | Manager identifier |
71 -
72 -Metrics:
73 -
74 -| Metric | Dimensions | Unit |
75 -|:-------|:-----------|:-----|
76 -| websphere_pmi.alarm_manager_events | created, cancelled, fired | events/s |
77 -
78 -### Per dynamiccache
79 -
80 -These metrics refer to individual dynamiccache instances.
81 -
82 -Labels:
83 -
84 -| Label | Description |
85 -|:------|:------------|
86 -| node | Node identifier |
87 -| server | Server identifier |
88 -| cache | Cache identifier |
89 -
90 -Metrics:
91 -
92 -| Metric | Dimensions | Unit |
93 -|:-------|:-----------|:-----|
94 -| websphere_pmi.dynamic_cache_in_memory | entries | entries |
95 -| websphere_pmi.dynamic_cache_capacity | max_entries | entries |
96 -
97 -### Per enterprisebeans
98 -
99 -These metrics refer to individual enterprisebeans instances.
100 -
101 -Labels:
102 -
103 -| Label | Description |
104 -|:------|:------------|
105 -| node | Node identifier |
106 -| server | Server identifier |
107 -| bean | Bean identifier |
108 -
109 -Metrics:
110 -
111 -| Metric | Dimensions | Unit |
112 -|:-------|:-----------|:-----|
113 -| websphere_pmi.ejb_operations | create, remove, activate, passivate, instantiate, store, load | operations/s |
114 -| websphere_pmi.ejb_messages | received, backout | messages/s |
115 -| websphere_pmi.ejb_pool | ready, live, pooled, active_method, passive, server_session_pool, method_ready, async_queue | beans |
116 -| websphere_pmi.ejb_time | activation, passivation, create, remove, load, store, method_response, wait, async_wait, read_lock, write_lock | milliseconds |
117 -
118 -### Per extensionregistry
119 -
120 -These metrics refer to individual extensionregistry instances.
121 -
122 -Labels:
123 -
124 -| Label | Description |
125 -|:------|:------------|
126 -| node | Node identifier |
127 -| server | Server identifier |
128 -
129 -Metrics:
130 -
131 -| Metric | Dimensions | Unit |
132 -|:-------|:-----------|:-----|
133 -| websphere_pmi.extension_registry_requests | requests, hits, displacements | events/s |
134 -| websphere_pmi.extension_registry_hit_rate | hit_rate | percentage |
135 -
136 -### Per hamanager
137 -
138 -These metrics refer to individual hamanager instances.
139 -
140 -Labels:
141 -
142 -| Label | Description |
143 -|:------|:------------|
144 -| node | Node identifier |
145 -| server | Server identifier |
146 -
147 -Metrics:
148 -
149 -| Metric | Dimensions | Unit |
150 -|:-------|:-----------|:-----|
151 -| websphere_pmi.ha_manager_groups | local | groups |
152 -| websphere_pmi.ha_manager_bulletin_board | subjects, subscriptions, local_subjects, local_subscriptions | items |
153 -| websphere_pmi.ha_manager_rebuild_time | group_state, bulletin_board | milliseconds |
154 -
155 -### Per jcapool
156 -
157 -These metrics refer to individual jcapool instances.
158 -
159 -Labels:
160 -
161 -| Label | Description |
162 -|:------|:------------|
163 -| node | Node identifier |
164 -| server | Server identifier |
165 -| provider | Provider identifier |
166 -| pool | Pool identifier |
167 -
168 -Metrics:
169 -
170 -| Metric | Dimensions | Unit |
171 -|:-------|:-----------|:-----|
172 -| websphere_pmi.jca_pool_operations | create, close, allocate, freed, faults | operations/s |
173 -| websphere_pmi.jca_pool_managed | managed_connections, connection_handles | resources |
174 -| websphere_pmi.jca_pool_utilization | percent_used, percent_maxed | percentage |
175 -| websphere_pmi.jca_pool_waiting | waiting_threads | threads |
176 -
177 -### Per jdbcpool
178 -
179 -These metrics refer to individual jdbcpool instances.
180 -
181 -Labels:
182 -
183 -| Label | Description |
184 -|:------|:------------|
185 -| node | Node identifier |
186 -| server | Server identifier |
187 -| pool | Pool identifier |
188 -
189 -Metrics:
190 -
191 -| Metric | Dimensions | Unit |
192 -|:-------|:-----------|:-----|
193 -| websphere_pmi.jdbc_pool_usage | percent_used, percent_maxed | percentage |
194 -| websphere_pmi.jdbc_pool_waiting | waiting_threads | threads |
195 -| websphere_pmi.jdbc_pool_connections | managed, handles | connections |
196 -| websphere_pmi.jdbc_pool_operations | created, closed, allocated, returned, faults, prep_stmt_cache_discard | operations/s |
197 -| websphere_pmi.jdbc_pool_time | use, wait, jdbc | milliseconds |
198 -
199 -### Per jmsqueue
200 -
201 -These metrics refer to individual jmsqueue instances.
202 -
203 -Labels:
204 -
205 -| Label | Description |
206 -|:------|:------------|
207 -| node | Node identifier |
208 -| server | Server identifier |
209 -| engine | Engine identifier |
210 -| destination | Destination identifier |
211 -
212 -Metrics:
213 -
214 -| Metric | Dimensions | Unit |
215 -|:-------|:-----------|:-----|
216 -| websphere_pmi.jms_queue_messages_produced | total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent | messages/s |
217 -| websphere_pmi.jms_queue_messages_consumed | total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent, expired | messages/s |
218 -| websphere_pmi.jms_queue_clients | local_producers, local_producer_attaches, local_consumers, local_consumer_attaches | clients |
219 -| websphere_pmi.jms_queue_storage | available, unavailable, oldest_age | messages |
220 -| websphere_pmi.jms_queue_wait_time | aggregate, local | milliseconds |
221 -
222 -### Per jmsstore
223 -
224 -These metrics refer to individual jmsstore instances.
225 -
226 -Labels:
227 -
228 -| Label | Description |
229 -|:------|:------------|
230 -| node | Node identifier |
231 -| server | Server identifier |
232 -| engine | Engine identifier |
233 -| section | Section identifier |
234 -
235 -Metrics:
236 -
237 -| Metric | Dimensions | Unit |
238 -|:-------|:-----------|:-----|
239 -| websphere_pmi.jms_store_cache | add_stored, add_not_stored, stored_current, stored_bytes, not_stored_current, not_stored_bytes, discard_count, discard_bytes | events |
240 -| websphere_pmi.jms_store_datastore | insert_batches, update_batches, delete_batches, insert_count, update_count, delete_count, open_count, abort_count, transaction_ms | events/s |
241 -| websphere_pmi.jms_store_transactions | global_start, global_commit, global_abort, global_indoubt, local_start, local_commit, local_abort | transactions/s |
242 -| websphere_pmi.jms_store_expiry | index_items | items |
243 -
244 -### Per jmstopic
245 -
246 -These metrics refer to individual jmstopic instances.
247 -
248 -Labels:
249 -
250 -| Label | Description |
251 -|:------|:------------|
252 -| node | Node identifier |
253 -| server | Server identifier |
254 -| engine | Engine identifier |
255 -| destination | Destination identifier |
256 -
257 -Metrics:
258 -
259 -| Metric | Dimensions | Unit |
260 -|:-------|:-----------|:-----|
261 -| websphere_pmi.jms_topic_publications | assured, best_effort, express | messages/s |
262 -| websphere_pmi.jms_topic_subscription_hits | assured, best_effort, express | events/s |
263 -| websphere_pmi.jms_topic_subscriptions | durable_local | subscriptions |
264 -| websphere_pmi.jms_topic_events | incomplete_publications, publisher_attaches, subscriber_attaches | events/s |
265 -| websphere_pmi.jms_topic_age | local_oldest | milliseconds |
266 -
267 -### Per orb
268 -
269 -These metrics refer to individual orb instances.
270 -
271 -Labels:
272 -
273 -| Label | Description |
274 -|:------|:------------|
275 -| node | Node identifier |
276 -| server | Server identifier |
277 -
278 -Metrics:
279 -
280 -| Metric | Dimensions | Unit |
281 -|:-------|:-----------|:-----|
282 -| websphere_pmi.orb_concurrent | concurrent_requests | requests |
283 -| websphere_pmi.orb_requests | requests | requests/s |
284 -
285 -### Per objectpool
286 -
287 -These metrics refer to individual objectpool instances.
288 -
289 -Labels:
290 -
291 -| Label | Description |
292 -|:------|:------------|
293 -| node | Node identifier |
294 -| server | Server identifier |
295 -| pool | Pool identifier |
296 -
297 -Metrics:
298 -
299 -| Metric | Dimensions | Unit |
300 -|:-------|:-----------|:-----|
301 -| websphere_pmi.object_pool_operations | created | operations/s |
302 -| websphere_pmi.object_pool_size | allocated, returned, idle | objects |
303 -
304 -### Per pmiwebservicemodule
305 -
306 -These metrics refer to individual pmiwebservicemodule instances.
307 -
308 -Labels:
309 -
310 -| Label | Description |
311 -|:------|:------------|
312 -| node | Node identifier |
313 -| server | Server identifier |
314 -| module | Module identifier |
315 -
316 -Metrics:
317 -
318 -| Metric | Dimensions | Unit |
319 -|:-------|:-----------|:-----|
320 -| websphere_pmi.pmi_web_service_module_services | loaded | services |
321 -
322 -### Per portlet
323 -
324 -These metrics refer to individual portlet instances.
325 -
326 -Labels:
327 -
328 -| Label | Description |
329 -|:------|:------------|
330 -| node | Node identifier |
331 -| server | Server identifier |
332 -| portlet | Portlet identifier |
333 -
334 -Metrics:
335 -
336 -| Metric | Dimensions | Unit |
337 -|:-------|:-----------|:-----|
338 -| websphere_pmi.portlet_requests | requests | requests/s |
339 -| websphere_pmi.portlet_concurrent | concurrent | requests |
340 -| websphere_pmi.portlet_errors | errors | errors/s |
341 -| websphere_pmi.portlet_response_time | render, action, process_event, serve_resource | milliseconds |
342 -
343 -### Per portletapplication
344 -
345 -These metrics refer to individual portletapplication instances.
346 -
347 -Labels:
348 -
349 -| Label | Description |
350 -|:------|:------------|
351 -| node | Node identifier |
352 -| server | Server identifier |
353 -
354 -Metrics:
355 -
356 -| Metric | Dimensions | Unit |
357 -|:-------|:-----------|:-----|
358 -| websphere_pmi.portlet_application_loaded | loaded | portlets |
359 -
360 -### Per schedulers
361 -
362 -These metrics refer to individual schedulers instances.
363 -
364 -Labels:
365 -
366 -| Label | Description |
367 -|:------|:------------|
368 -| node | Node identifier |
369 -| server | Server identifier |
370 -| scheduler | Scheduler identifier |
371 -
372 -Metrics:
373 -
374 -| Metric | Dimensions | Unit |
375 -|:-------|:-----------|:-----|
376 -| websphere_pmi.scheduler_activity | finished, failures, polls | events/s |
377 -
378 -### Per securityauth
379 -
380 -These metrics refer to individual securityauth instances.
381 -
382 -Labels:
383 -
384 -| Label | Description |
385 -|:------|:------------|
386 -| node | Node identifier |
387 -| server | Server identifier |
388 -
389 -Metrics:
390 -
391 -| Metric | Dimensions | Unit |
392 -|:-------|:-----------|:-----|
393 -| websphere_pmi.security_auth_counts | web, tai, identity, basic, token, jaas_identity, jaas_basic, jaas_token, rmi | events/s |
394 -
395 -### Per securityauthz
396 -
397 -These metrics refer to individual securityauthz instances.
398 -
399 -Labels:
400 -
401 -| Label | Description |
402 -|:------|:------------|
403 -| node | Node identifier |
404 -| server | Server identifier |
405 -
406 -Metrics:
407 -
408 -| Metric | Dimensions | Unit |
409 -|:-------|:-----------|:-----|
410 -| websphere_pmi.security_authz_time | web, ejb, admin, cwwja | milliseconds |
411 -
412 -### Per sessionmanager
413 -
414 -These metrics refer to individual sessionmanager instances.
415 -
416 -Labels:
417 -
418 -| Label | Description |
419 -|:------|:------------|
420 -| node | Node identifier |
421 -| server | Server identifier |
422 -| app | App identifier |
423 -
424 -Metrics:
425 -
426 -| Metric | Dimensions | Unit |
427 -|:-------|:-----------|:-----|
428 -| websphere_pmi.session_manager_active | active, live | sessions |
429 -| websphere_pmi.session_manager_events | created, invalidated, timeout_invalidations, affinity_breaks, cache_discards, no_room, activate_non_exist | events/s |
430 -
431 -### Per threadpool
432 -
433 -These metrics refer to individual threadpool instances.
434 -
435 -Labels:
436 -
437 -| Label | Description |
438 -|:------|:------------|
439 -| name | Name identifier |
440 -
441 -Metrics:
442 -
443 -| Metric | Dimensions | Unit |
444 -|:-------|:-----------|:-----|
445 -| websphere_pmi.threadpool_usage | active, size | threads |
446 -
447 -### Per transactionmanager
448 -
449 -These metrics refer to individual transactionmanager instances.
450 -
451 -Labels:
452 -
453 -| Label | Description |
454 -|:------|:------------|
455 -| node | Node identifier |
456 -| server | Server identifier |
457 -
458 -Metrics:
459 -
460 -| Metric | Dimensions | Unit |
461 -|:-------|:-----------|:-----|
462 -| websphere_pmi.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 |
463 -| websphere_pmi.transaction_active | global, local | transactions |
464 -| websphere_pmi.transaction_time | global_total, global_prepare, global_commit, global_before_completion, local_total, local_commit, local_before_completion | milliseconds |
465 -
466 -### Per url
467 -
468 -These metrics refer to individual url instances.
469 -
470 -Labels:
471 -
472 -| Label | Description |
473 -|:------|:------------|
474 -| node | Node identifier |
475 -| server | Server identifier |
476 -| url | Url identifier |
477 -
478 -Metrics:
479 -
480 -| Metric | Dimensions | Unit |
481 -|:-------|:-----------|:-----|
482 -| websphere_pmi.url_requests | requests | requests/s |
483 -| websphere_pmi.url_time | service, async | milliseconds |
484 -
485 -### Per webapp
486 -
487 -These metrics refer to individual webapp instances.
488 -
489 -Labels:
490 -
491 -| Label | Description |
492 -|:------|:------------|
493 -| node | Node identifier |
494 -| server | Server identifier |
495 -| app | App identifier |
496 -
497 -Metrics:
498 -
499 -| Metric | Dimensions | Unit |
500 -|:-------|:-----------|:-----|
501 -| websphere_pmi.webapp_load | loaded_servlets, reloads | events |
502 -
503 -### Per webservices
504 -
505 -These metrics refer to individual webservices instances.
506 -
507 -Labels:
508 -
509 -| Label | Description |
510 -|:------|:------------|
511 -| node | Node identifier |
512 -| server | Server identifier |
513 -| service | Service identifier |
514 -
515 -Metrics:
516 -
517 -| Metric | Dimensions | Unit |
518 -|:-------|:-----------|:-----|
519 -| websphere_pmi.web_services_loaded | loaded | services |
520 -
521 -### Per webservicesgateway
522 -
523 -These metrics refer to individual webservicesgateway instances.
524 -
525 -Labels:
526 -
527 -| Label | Description |
528 -|:------|:------------|
529 -| node | Node identifier |
530 -| server | Server identifier |
531 -| gateway | Gateway identifier |
532 -
533 -Metrics:
534 -
535 -| Metric | Dimensions | Unit |
536 -|:-------|:-----------|:-----|
537 -| websphere_pmi.web_services_gateway_requests | synchronous, synchronous_responses, asynchronous, asynchronous_responses | requests/s |
538 -
539 -
540 -## Configuration
541 -
542 -### File
543 -
544 -The configuration file name for this integration is `ibm.d/websphere_pmi.conf`.
545 -
546 -You can edit the configuration file using the `edit-config` script from the
547 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
548 -
549 -```bash
550 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
551 -sudo ./edit-config ibm.d/websphere_pmi.conf
552 -```
553 -
554 -### Options
555 -
556 -The following options can be defined globally or per job.
557 -
558 -| Name | Description | Default | Required | Min | Max |
559 -|:-----|:------------|:--------|:---------|:----|:----|
560 -| tls_key | Client key path | `` | no | - | - |
561 -| tls_cert | Client certificate path | `` | no | - | - |
562 -| tls_ca | Custom CA bundle path | `` | no | - | - |
563 -| tls_skip_verify | Skip TLS certificate verification | `false` | no | - | - |
564 -| headers | Custom headers | `<no value>` | no | - | - |
565 -| proxy_password | Proxy password | `` | no | - | - |
566 -| proxy_username | Proxy username | `` | no | - | - |
567 -| proxy_url | Proxy URL | `` | no | - | - |
568 -| not_follow_redirects | Disable HTTP redirects | `false` | no | - | - |
569 -| timeout | Request timeout in seconds | `5000000000` | no | - | - |
570 -| password | Password for authentication | `` | no | - | - |
571 -| username | Username for authentication | `` | no | - | - |
572 -| url | Target URL | `` | no | - | - |
573 -| update_every | Data collection frequency | `5` | no | 1 | - |
574 -| Vnode | Vnode allows binding the collector to a virtual node. | `` | no | - | - |
575 -| PMIStatsType | PMIStatsType selects which PMI statistics tier to request (`basic`, `extended`, `all`, or `custom`). | `extended` | no | - | - |
576 -| PMIRefreshRate | PMIRefreshRate overrides the global PMI servlet refresh interval in seconds when a value >0 is provided. | `60` | no | - | - |
577 -| PMICustomStatsPaths | PMICustomStatsPaths adds extra PMI XML paths when `pmi_stats_type` is set to `custom`. | `nil` | no | - | - |
578 -| ClusterName | ClusterName appends the WebSphere cluster identifier label to every exported time-series. | `` | no | - | - |
579 -| CellName | CellName appends the WebSphere cell identifier label to every exported time-series. | `` | no | - | - |
580 -| NodeName | NodeName appends the WebSphere node identifier label to every exported time-series. | `` | no | - | - |
581 -| ServerType | ServerType records the WebSphere server type label (for example `app_server`, `dmgr`, `nodeagent`). | `` | no | - | - |
582 -| CollectJVMMetrics | CollectJVMMetrics toggles JVM runtime metrics; defaults to enabled when unset. | `auto` | no | - | - |
583 -| CollectThreadPoolMetrics | CollectThreadPoolMetrics toggles thread-pool metrics; defaults to enabled when unset. | `auto` | no | - | - |
584 -| CollectJDBCMetrics | CollectJDBCMetrics toggles JDBC connection-pool metrics; defaults to enabled when unset. | `auto` | no | - | - |
585 -| CollectJCAMetrics | CollectJCAMetrics toggles JCA resource-adapter metrics; defaults to enabled when unset. | `auto` | no | - | - |
586 -| CollectJMSMetrics | CollectJMSMetrics toggles JMS destination metrics; defaults to enabled when unset. | `auto` | no | - | - |
587 -| CollectWebAppMetrics | CollectWebAppMetrics toggles Web application metrics (includes servlet/session data); defaults to enabled when unset. | `auto` | no | - | - |
588 -| CollectSessionMetrics | CollectSessionMetrics toggles HTTP session manager metrics; defaults to enabled when unset. | `auto` | no | - | - |
589 -| CollectTransactionMetrics | CollectTransactionMetrics toggles transaction manager metrics; defaults to enabled when unset. | `auto` | no | - | - |
590 -| CollectClusterMetrics | CollectClusterMetrics toggles cluster-level health metrics; defaults to enabled when unset. | `auto` | no | - | - |
591 -| CollectServletMetrics | CollectServletMetrics enables servlet response-time metrics; defaults to enabled when unset (may add high-cardinality charts). | `auto` | no | - | - |
592 -| CollectEJBMetrics | CollectEJBMetrics enables Enterprise Java Bean workload metrics; defaults to enabled when unset. | `auto` | no | - | - |
593 -| CollectJDBCAdvanced | CollectJDBCAdvanced enables additional JDBC latency/timing statistics; defaults to disabled when unset. | `auto` | no | - | - |
594 -| MaxThreadPools | MaxThreadPools caps the number of thread pools charted per server (0 disables the limit). | `50` | no | - | - |
595 -| MaxJDBCPools | MaxJDBCPools caps the number of JDBC connection pools charted (0 disables the limit). | `50` | no | - | - |
596 -| MaxJCAPools | MaxJCAPools caps the number of JCA resource adapters charted (0 disables the limit). | `50` | no | - | - |
597 -| MaxJMSDestinations | MaxJMSDestinations caps the number of JMS destinations charted (0 disables the limit). | `50` | no | - | - |
598 -| MaxApplications | MaxApplications caps the number of web applications charted (0 disables the limit). | `100` | no | - | - |
599 -| MaxServlets | MaxServlets caps the number of servlet contexts charted when servlet collection is enabled (0 disables the limit). | `50` | no | - | - |
600 -| MaxEJBs | MaxEJBs caps the number of Enterprise Java Beans charted (0 disables the limit). | `50` | no | - | - |
601 -| CollectAppsMatching | CollectAppsMatching filters Web applications by name using glob patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
602 -| CollectPoolsMatching | CollectPoolsMatching filters JDBC and JCA pools by name using glob patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
603 -| CollectJMSMatching | CollectJMSMatching filters JMS destinations by name using glob patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
604 -| CollectServletsMatching | CollectServletsMatching filters servlet contexts by name using glob patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
605 -| CollectEJBsMatching | CollectEJBsMatching filters Enterprise Java Beans by name using glob patterns (supports `*`, `?`, `!` prefixes). | `` | no | - | - |
606 -
607 -### Examples
608 -
609 -#### Basic configuration
610 -
611 -IBM WebSphere PMI monitoring with default settings.
612 -
613 -<details>
614 -<summary>Config</summary>
615 -
616 -```yaml
617 -jobs:
618 - - name: local
619 - endpoint: dummy://localhost
620 -```
621 -
622 -</details>
623 -
624 -## Troubleshooting
625 -
626 -### Debug Mode
627 -
628 -To troubleshoot issues with the `websphere_pmi` collector, run the `ibm.d.plugin` with the debug option enabled.
629 -The output should give you clues as to why the collector isn't working.
630 -
631 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`
632 -- Switch to the `netdata` user
633 -- Run the `ibm.d.plugin` to debug the collector:
634 -
635 -```bash
636 -sudo -u netdata ./ibm.d.plugin -d -m websphere_pmi
637 -```
638 -
639 -## Getting Logs
640 -
641 -If you're encountering problems with the `websphere_pmi` collector, follow these steps to retrieve logs and identify potential issues:
642 -
643 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
644 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages will typically provide clues about the root cause of the problem.
645 -
646 -### For systemd systems (most Linux distributions)
647 -
648 -```bash
649 -sudo journalctl -u netdata --reverse | grep websphere_pmi
650 -```
651 -
652 -### For non-systemd systems
653 -
654 -```bash
655 -sudo grep websphere_pmi /var/log/netdata/error.log
656 -sudo grep websphere_pmi /var/log/netdata/collector.log
657 -```
658 -
659 -### For Docker containers
660 -
661 -```bash
662 -sudo docker logs netdata 2>&1 | grep websphere_pmi
663 -```
src/go/plugin/ibm.d/modules/websphere/pmi/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/ibm_websphere_pmi.md
\ No newline at end of file
src/go/plugin/ibm.d/modules/websphere/pmi/integrations/ibm_websphere_pmi.md new
+650
@@ -0,0 +1,650 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/pmi/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/pmi/metadata.yaml"
4 +sidebar_label: "IBM WebSphere PMI"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Applications"
7 +most_popular: False
8 +keywords: ['websphere_pmi']
9 +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10 +endmeta-->
11 +
12 +# IBM WebSphere PMI
13 +
14 +
15 +<img src="https://netdata.cloud/img/ibm.svg" width="150"/>
16 +
17 +
18 +Plugin: ibm.d.plugin
19 +Module: websphere_pmi
20 +
21 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22 +
23 +## Overview
24 +
25 +Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface,
26 +covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information.
27 +
28 +
29 +The collector connects to IBM WebSphere PMI and collects metrics via its monitoring interface.
30 +
31 +
32 +This collector is supported on all platforms.
33 +
34 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
35 +
36 +
37 +### Default Behavior
38 +
39 +#### Auto-Detection
40 +
41 +This integration doesn't support auto-detection.
42 +
43 +#### Limits
44 +
45 +The default configuration for this integration does not impose any limits on data collection.
46 +
47 +#### Performance Impact
48 +
49 +The default configuration for this integration is not expected to impose a significant performance impact on the system.
50 +
51 +## Metrics
52 +
53 +Metrics grouped by *scope*.
54 +
55 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
56 +
57 +
58 +
59 +### Per alarmmanager
60 +
61 +These metrics refer to alarmmanager instances.
62 +
63 +Labels:
64 +
65 +| Label | Description |
66 +|:-----------|:----------------|
67 +| node | Node identifier |
68 +| server | Server identifier |
69 +| manager | Manager identifier |
70 +
71 +Metrics:
72 +
73 +| Metric | Dimensions | Unit |
74 +|:------|:----------|:----|
75 +| websphere_pmi.alarm_manager_events | created, cancelled, fired | events/s |
76 +
77 +### Per dynamiccache
78 +
79 +These metrics refer to dynamiccache instances.
80 +
81 +Labels:
82 +
83 +| Label | Description |
84 +|:-----------|:----------------|
85 +| node | Node identifier |
86 +| server | Server identifier |
87 +| cache | Cache identifier |
88 +
89 +Metrics:
90 +
91 +| Metric | Dimensions | Unit |
92 +|:------|:----------|:----|
93 +| websphere_pmi.dynamic_cache_in_memory | entries | entries |
94 +| websphere_pmi.dynamic_cache_capacity | max_entries | entries |
95 +
96 +### Per enterprisebeans
97 +
98 +These metrics refer to enterprisebeans instances.
99 +
100 +Labels:
101 +
102 +| Label | Description |
103 +|:-----------|:----------------|
104 +| node | Node identifier |
105 +| server | Server identifier |
106 +| bean | Bean identifier |
107 +
108 +Metrics:
109 +
110 +| Metric | Dimensions | Unit |
111 +|:------|:----------|:----|
112 +| websphere_pmi.ejb_operations | create, remove, activate, passivate, instantiate, store, load | operations/s |
113 +| websphere_pmi.ejb_messages | received, backout | messages/s |
114 +| websphere_pmi.ejb_pool | ready, live, pooled, active_method, passive, server_session_pool, method_ready, async_queue | beans |
115 +| websphere_pmi.ejb_time | activation, passivation, create, remove, load, store, method_response, wait, async_wait, read_lock, write_lock | milliseconds |
116 +
117 +### Per extensionregistry
118 +
119 +These metrics refer to extensionregistry instances.
120 +
121 +Labels:
122 +
123 +| Label | Description |
124 +|:-----------|:----------------|
125 +| node | Node identifier |
126 +| server | Server identifier |
127 +
128 +Metrics:
129 +
130 +| Metric | Dimensions | Unit |
131 +|:------|:----------|:----|
132 +| websphere_pmi.extension_registry_requests | requests, hits, displacements | events/s |
133 +| websphere_pmi.extension_registry_hit_rate | hit_rate | percentage |
134 +
135 +### Per hamanager
136 +
137 +These metrics refer to hamanager instances.
138 +
139 +Labels:
140 +
141 +| Label | Description |
142 +|:-----------|:----------------|
143 +| node | Node identifier |
144 +| server | Server identifier |
145 +
146 +Metrics:
147 +
148 +| Metric | Dimensions | Unit |
149 +|:------|:----------|:----|
150 +| websphere_pmi.ha_manager_groups | local | groups |
151 +| websphere_pmi.ha_manager_bulletin_board | subjects, subscriptions, local_subjects, local_subscriptions | items |
152 +| websphere_pmi.ha_manager_rebuild_time | group_state, bulletin_board | milliseconds |
153 +
154 +### Per jcapool
155 +
156 +These metrics refer to jcapool instances.
157 +
158 +Labels:
159 +
160 +| Label | Description |
161 +|:-----------|:----------------|
162 +| node | Node identifier |
163 +| server | Server identifier |
164 +| provider | Provider identifier |
165 +| pool | Pool identifier |
166 +
167 +Metrics:
168 +
169 +| Metric | Dimensions | Unit |
170 +|:------|:----------|:----|
171 +| websphere_pmi.jca_pool_operations | create, close, allocate, freed, faults | operations/s |
172 +| websphere_pmi.jca_pool_managed | managed_connections, connection_handles | resources |
173 +| websphere_pmi.jca_pool_utilization | percent_used, percent_maxed | percentage |
174 +| websphere_pmi.jca_pool_waiting | waiting_threads | threads |
175 +
176 +### Per jdbcpool
177 +
178 +These metrics refer to jdbcpool instances.
179 +
180 +Labels:
181 +
182 +| Label | Description |
183 +|:-----------|:----------------|
184 +| node | Node identifier |
185 +| server | Server identifier |
186 +| pool | Pool identifier |
187 +
188 +Metrics:
189 +
190 +| Metric | Dimensions | Unit |
191 +|:------|:----------|:----|
192 +| websphere_pmi.jdbc_pool_usage | percent_used, percent_maxed | percentage |
193 +| websphere_pmi.jdbc_pool_waiting | waiting_threads | threads |
194 +| websphere_pmi.jdbc_pool_connections | managed, handles | connections |
195 +| websphere_pmi.jdbc_pool_operations | created, closed, allocated, returned, faults, prep_stmt_cache_discard | operations/s |
196 +| websphere_pmi.jdbc_pool_time | use, wait, jdbc | milliseconds |
197 +
198 +### Per jmsqueue
199 +
200 +These metrics refer to jmsqueue instances.
201 +
202 +Labels:
203 +
204 +| Label | Description |
205 +|:-----------|:----------------|
206 +| node | Node identifier |
207 +| server | Server identifier |
208 +| engine | Engine identifier |
209 +| destination | Destination identifier |
210 +
211 +Metrics:
212 +
213 +| Metric | Dimensions | Unit |
214 +|:------|:----------|:----|
215 +| websphere_pmi.jms_queue_messages_produced | total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent | messages/s |
216 +| websphere_pmi.jms_queue_messages_consumed | total, best_effort, express, reliable_nonpersistent, reliable_persistent, assured_persistent, expired | messages/s |
217 +| websphere_pmi.jms_queue_clients | local_producers, local_producer_attaches, local_consumers, local_consumer_attaches | clients |
218 +| websphere_pmi.jms_queue_storage | available, unavailable, oldest_age | messages |
219 +| websphere_pmi.jms_queue_wait_time | aggregate, local | milliseconds |
220 +
221 +### Per jmsstore
222 +
223 +These metrics refer to jmsstore instances.
224 +
225 +Labels:
226 +
227 +| Label | Description |
228 +|:-----------|:----------------|
229 +| node | Node identifier |
230 +| server | Server identifier |
231 +| engine | Engine identifier |
232 +| section | Section identifier |
233 +
234 +Metrics:
235 +
236 +| Metric | Dimensions | Unit |
237 +|:------|:----------|:----|
238 +| websphere_pmi.jms_store_cache | add_stored, add_not_stored, stored_current, stored_bytes, not_stored_current, not_stored_bytes, discard_count, discard_bytes | events |
239 +| websphere_pmi.jms_store_datastore | insert_batches, update_batches, delete_batches, insert_count, update_count, delete_count, open_count, abort_count, transaction_ms | events/s |
240 +| websphere_pmi.jms_store_transactions | global_start, global_commit, global_abort, global_indoubt, local_start, local_commit, local_abort | transactions/s |
241 +| websphere_pmi.jms_store_expiry | index_items | items |
242 +
243 +### Per jmstopic
244 +
245 +These metrics refer to jmstopic instances.
246 +
247 +Labels:
248 +
249 +| Label | Description |
250 +|:-----------|:----------------|
251 +| node | Node identifier |
252 +| server | Server identifier |
253 +| engine | Engine identifier |
254 +| destination | Destination identifier |
255 +
256 +Metrics:
257 +
258 +| Metric | Dimensions | Unit |
259 +|:------|:----------|:----|
260 +| websphere_pmi.jms_topic_publications | assured, best_effort, express | messages/s |
261 +| websphere_pmi.jms_topic_subscription_hits | assured, best_effort, express | events/s |
262 +| websphere_pmi.jms_topic_subscriptions | durable_local | subscriptions |
263 +| websphere_pmi.jms_topic_events | incomplete_publications, publisher_attaches, subscriber_attaches | events/s |
264 +| websphere_pmi.jms_topic_age | local_oldest | milliseconds |
265 +
266 +### Per IBM WebSphere PMI instance
267 +
268 +These metrics refer to the entire monitored instance.
269 +
270 +This scope has no labels.
271 +
272 +Metrics:
273 +
274 +| Metric | Dimensions | Unit |
275 +|:------|:----------|:----|
276 +| websphere_pmi.jvm_heap_usage | used, free | bytes |
277 +| websphere_pmi.jvm_heap_committed | committed | bytes |
278 +| websphere_pmi.jvm_heap_max | limit | bytes |
279 +| websphere_pmi.jvm_uptime | uptime | seconds |
280 +| websphere_pmi.jvm_cpu | usage | percentage |
281 +| websphere_pmi.jvm_gc_collections | collections | collections/s |
282 +| websphere_pmi.jvm_gc_time | total | milliseconds |
283 +| websphere_pmi.jvm_threads | daemon, other | threads |
284 +| websphere_pmi.jvm_threads_peak | peak | threads |
285 +
286 +### Per orb
287 +
288 +These metrics refer to orb instances.
289 +
290 +Labels:
291 +
292 +| Label | Description |
293 +|:-----------|:----------------|
294 +| node | Node identifier |
295 +| server | Server identifier |
296 +
297 +Metrics:
298 +
299 +| Metric | Dimensions | Unit |
300 +|:------|:----------|:----|
301 +| websphere_pmi.orb_concurrent | concurrent_requests | requests |
302 +| websphere_pmi.orb_requests | requests | requests/s |
303 +
304 +### Per objectpool
305 +
306 +These metrics refer to objectpool instances.
307 +
308 +Labels:
309 +
310 +| Label | Description |
311 +|:-----------|:----------------|
312 +| node | Node identifier |
313 +| server | Server identifier |
314 +| pool | Pool identifier |
315 +
316 +Metrics:
317 +
318 +| Metric | Dimensions | Unit |
319 +|:------|:----------|:----|
320 +| websphere_pmi.object_pool_operations | created | operations/s |
321 +| websphere_pmi.object_pool_size | allocated, returned, idle | objects |
322 +
323 +### Per pmiwebservicemodule
324 +
325 +These metrics refer to pmiwebservicemodule instances.
326 +
327 +Labels:
328 +
329 +| Label | Description |
330 +|:-----------|:----------------|
331 +| node | Node identifier |
332 +| server | Server identifier |
333 +| module | Module identifier |
334 +
335 +Metrics:
336 +
337 +| Metric | Dimensions | Unit |
338 +|:------|:----------|:----|
339 +| websphere_pmi.pmi_web_service_module_services | loaded | services |
340 +
341 +### Per portlet
342 +
343 +These metrics refer to portlet instances.
344 +
345 +Labels:
346 +
347 +| Label | Description |
348 +|:-----------|:----------------|
349 +| node | Node identifier |
350 +| server | Server identifier |
351 +| portlet | Portlet identifier |
352 +
353 +Metrics:
354 +
355 +| Metric | Dimensions | Unit |
356 +|:------|:----------|:----|
357 +| websphere_pmi.portlet_requests | requests | requests/s |
358 +| websphere_pmi.portlet_concurrent | concurrent | requests |
359 +| websphere_pmi.portlet_errors | errors | errors/s |
360 +| websphere_pmi.portlet_response_time | render, action, process_event, serve_resource | milliseconds |
361 +
362 +### Per portletapplication
363 +
364 +These metrics refer to portletapplication instances.
365 +
366 +Labels:
367 +
368 +| Label | Description |
369 +|:-----------|:----------------|
370 +| node | Node identifier |
371 +| server | Server identifier |
372 +
373 +Metrics:
374 +
375 +| Metric | Dimensions | Unit |
376 +|:------|:----------|:----|
377 +| websphere_pmi.portlet_application_loaded | loaded | portlets |
378 +
379 +### Per schedulers
380 +
381 +These metrics refer to schedulers instances.
382 +
383 +Labels:
384 +
385 +| Label | Description |
386 +|:-----------|:----------------|
387 +| node | Node identifier |
388 +| server | Server identifier |
389 +| scheduler | Scheduler identifier |
390 +
391 +Metrics:
392 +
393 +| Metric | Dimensions | Unit |
394 +|:------|:----------|:----|
395 +| websphere_pmi.scheduler_activity | finished, failures, polls | events/s |
396 +
397 +### Per securityauth
398 +
399 +These metrics refer to securityauth instances.
400 +
401 +Labels:
402 +
403 +| Label | Description |
404 +|:-----------|:----------------|
405 +| node | Node identifier |
406 +| server | Server identifier |
407 +
408 +Metrics:
409 +
410 +| Metric | Dimensions | Unit |
411 +|:------|:----------|:----|
412 +| websphere_pmi.security_auth_counts | web, tai, identity, basic, token, jaas_identity, jaas_basic, jaas_token, rmi | events/s |
413 +
414 +### Per securityauthz
415 +
416 +These metrics refer to securityauthz instances.
417 +
418 +Labels:
419 +
420 +| Label | Description |
421 +|:-----------|:----------------|
422 +| node | Node identifier |
423 +| server | Server identifier |
424 +
425 +Metrics:
426 +
427 +| Metric | Dimensions | Unit |
428 +|:------|:----------|:----|
429 +| websphere_pmi.security_authz_time | web, ejb, admin, cwwja | milliseconds |
430 +
431 +### Per sessionmanager
432 +
433 +These metrics refer to sessionmanager instances.
434 +
435 +Labels:
436 +
437 +| Label | Description |
438 +|:-----------|:----------------|
439 +| node | Node identifier |
440 +| server | Server identifier |
441 +| app | App identifier |
442 +
443 +Metrics:
444 +
445 +| Metric | Dimensions | Unit |
446 +|:------|:----------|:----|
447 +| websphere_pmi.session_manager_active | active, live | sessions |
448 +| websphere_pmi.session_manager_events | created, invalidated, timeout_invalidations, affinity_breaks, cache_discards, no_room, activate_non_exist | events/s |
449 +
450 +### Per IBM WebSphere PMI instance
451 +
452 +These metrics refer to the entire monitored instance.
453 +
454 +This scope has no labels.
455 +
456 +Metrics:
457 +
458 +| Metric | Dimensions | Unit |
459 +|:------|:----------|:----|
460 +| websphere_pmi.cpu_utilization | utilization | percentage |
461 +
462 +### Per IBM WebSphere PMI instance
463 +
464 +These metrics refer to the entire monitored instance.
465 +
466 +This scope has no labels.
467 +
468 +Metrics:
469 +
470 +| Metric | Dimensions | Unit |
471 +|:------|:----------|:----|
472 +| websphere_pmi.system_data_usage | cpu_since_last, free_memory | value |
473 +
474 +### Per threadpool
475 +
476 +These metrics refer to threadpool instances.
477 +
478 +Labels:
479 +
480 +| Label | Description |
481 +|:-----------|:----------------|
482 +| name | Name identifier |
483 +
484 +Metrics:
485 +
486 +| Metric | Dimensions | Unit |
487 +|:------|:----------|:----|
488 +| websphere_pmi.threadpool_usage | active, size | threads |
489 +
490 +### Per transactionmanager
491 +
492 +These metrics refer to transactionmanager instances.
493 +
494 +Labels:
495 +
496 +| Label | Description |
497 +|:-----------|:----------------|
498 +| node | Node identifier |
499 +| server | Server identifier |
500 +
501 +Metrics:
502 +
503 +| Metric | Dimensions | Unit |
504 +|:------|:----------|:----|
505 +| websphere_pmi.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 |
506 +| websphere_pmi.transaction_active | global, local | transactions |
507 +| websphere_pmi.transaction_time | global_total, global_prepare, global_commit, global_before_completion, local_total, local_commit, local_before_completion | milliseconds |
508 +
509 +### Per url
510 +
511 +These metrics refer to url instances.
512 +
513 +Labels:
514 +
515 +| Label | Description |
516 +|:-----------|:----------------|
517 +| node | Node identifier |
518 +| server | Server identifier |
519 +| url | Url identifier |
520 +
521 +Metrics:
522 +
523 +| Metric | Dimensions | Unit |
524 +|:------|:----------|:----|
525 +| websphere_pmi.url_requests | requests | requests/s |
526 +| websphere_pmi.url_time | service, async | milliseconds |
527 +
528 +### Per webapp
529 +
530 +These metrics refer to webapp instances.
531 +
532 +Labels:
533 +
534 +| Label | Description |
535 +|:-----------|:----------------|
536 +| node | Node identifier |
537 +| server | Server identifier |
538 +| app | App identifier |
539 +
540 +Metrics:
541 +
542 +| Metric | Dimensions | Unit |
543 +|:------|:----------|:----|
544 +| websphere_pmi.webapp_load | loaded_servlets, reloads | events |
545 +
546 +### Per webservices
547 +
548 +These metrics refer to webservices instances.
549 +
550 +Labels:
551 +
552 +| Label | Description |
553 +|:-----------|:----------------|
554 +| node | Node identifier |
555 +| server | Server identifier |
556 +| service | Service identifier |
557 +
558 +Metrics:
559 +
560 +| Metric | Dimensions | Unit |
561 +|:------|:----------|:----|
562 +| websphere_pmi.web_services_loaded | loaded | services |
563 +
564 +### Per webservicesgateway
565 +
566 +These metrics refer to webservicesgateway instances.
567 +
568 +Labels:
569 +
570 +| Label | Description |
571 +|:-----------|:----------------|
572 +| node | Node identifier |
573 +| server | Server identifier |
574 +| gateway | Gateway identifier |
575 +
576 +Metrics:
577 +
578 +| Metric | Dimensions | Unit |
579 +|:------|:----------|:----|
580 +| websphere_pmi.web_services_gateway_requests | synchronous, synchronous_responses, asynchronous, asynchronous_responses | requests/s |
581 +
582 +
583 +
584 +## Alerts
585 +
586 +There are no alerts configured by default for this integration.
587 +
588 +
589 +## Setup
590 +
591 +
592 +### Prerequisites
593 +
594 +#### Enable monitoring interface
595 +
596 +Ensure the IBM WebSphere PMI monitoring interface is accessible.
597 +
598 +
599 +
600 +### Configuration
601 +
602 +#### Options
603 +
604 +Configuration options for the websphere_pmi collector.
605 +
606 +
607 +<details open><summary>Config options</summary>
608 +
609 +
610 +
611 +| Option | Description | Default | Required |
612 +|:-----|:------------|:--------|:---------:|
613 +| update_every | Data collection frequency. | 1 | no |
614 +| endpoint | Connection endpoint. | dummy://localhost | no |
615 +
616 +
617 +</details>
618 +
619 +
620 +
621 +#### via File
622 +
623 +The configuration file name for this integration is `ibm.d/websphere_pmi.conf`.
624 +
625 +
626 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
627 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
628 +
629 +```bash
630 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
631 +sudo ./edit-config ibm.d/websphere_pmi.conf
632 +```
633 +
634 +##### Examples
635 +
636 +###### Basic
637 +
638 +Basic configuration example.
639 +
640 +<details open><summary>Config</summary>
641 +
642 +```yaml
643 +jobs:
644 + - name: local
645 + endpoint: dummy://localhost
646 +
647 +```
648 +</details>
649 +
650 +