Regenerate integrations docs (#21807)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Feb 24, 2026 at 15:44 UTC
fff0515b0d7d929b6be2dafaa0ff44a93329c3bb
6 files changed
+966
-998
src/go/plugin/ibm.d/modules/as400/integrations/ibm_i_as-400.md
+172
-176
@@ -1,4 +1,24 @@
1
-# IBM i (AS/400) collector
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.png" 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
@@ -140,72 +160,44 @@ values on pre-7.4 systems.
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
143
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
163
+The collector connects to IBM i (AS/400) and collects metrics via its monitoring interface.
164
145
-## Collected metrics
165
147
-Metrics grouped by scope.
166
+This collector is supported on all platforms.
167
149
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
168
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
169
151
-### Per IBM i (AS/400) instance
170
171
+### Default Behavior
172
154
-These metrics refer to the entire monitored IBM i (AS/400) instance.
173
+#### Auto-Detection
174
156
-This scope has no labels.
175
+This integration doesn't support auto-detection.
176
158
-Metrics:
177
+#### Limits
178
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 |
179
+The default configuration for this integration does not impose any limits on data collection.
180
166
-These metrics refer to the entire monitored IBM i (AS/400) instance.
181
+#### Performance Impact
182
168
-This scope has no labels.
183
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
184
170
-Metrics:
185
+## Metrics
186
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 |
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
203
-These metrics refer to individual activejob instances.
195
+These metrics refer to activejob instances.
196
197
Labels:
198
207
-| Label | Description |
208
-|:------|:------------|
199
+| Label | Description |
200
+|:-----------|:----------------|
201
| job_name | Job_name identifier |
202
| job_status | Job_status identifier |
203
| subsystem | Subsystem identifier |
@@ -214,7 +206,7 @@ Labels:
206
Metrics:
207
208
| Metric | Dimensions | Unit |
217
-|:-------|:-----------|:-----|
209
+|:------|:----------|:----|
210
| as400.activejob_cpu | cpu | percentage |
211
| as400.activejob_resources | temp_storage | MiB |
212
| as400.activejob_time | cpu_time, total_time | seconds |
@@ -223,12 +215,12 @@ Metrics:
215
216
### Per disk
217
226
-These metrics refer to individual disk instances.
218
+These metrics refer to disk instances.
219
220
Labels:
221
230
-| Label | Description |
231
-|:------|:------------|
222
+| Label | Description |
223
+|:-----------|:----------------|
224
| disk_unit | Disk_unit identifier |
225
| disk_type | Disk_type identifier |
226
| disk_model | Disk_model identifier |
@@ -238,7 +230,7 @@ Labels:
230
Metrics:
231
232
| Metric | Dimensions | Unit |
241
-|:-------|:-----------|:-----|
233
+|:------|:----------|:----|
234
| as400.disk_busy | busy | percentage |
235
| as400.disk_io_requests | read, write | requests/s |
236
| as400.disk_space_usage | used | percentage |
@@ -249,19 +241,19 @@ Metrics:
241
242
### Per httpserver
243
252
-These metrics refer to individual httpserver instances.
244
+These metrics refer to httpserver instances.
245
246
Labels:
247
256
-| Label | Description |
257
-|:------|:------------|
248
+| Label | Description |
249
+|:-----------|:----------------|
250
| server | Server identifier |
251
| function | Function identifier |
252
253
Metrics:
254
255
| Metric | Dimensions | Unit |
264
-|:-------|:-----------|:-----|
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 |
@@ -269,12 +261,12 @@ Metrics:
261
262
### Per jobqueue
263
272
-These metrics refer to individual jobqueue instances.
264
+These metrics refer to jobqueue instances.
265
266
Labels:
267
276
-| Label | Description |
277
-|:------|:------------|
268
+| Label | Description |
269
+|:-----------|:----------------|
270
| job_queue | Job_queue identifier |
271
| library | Library identifier |
272
| status | Status identifier |
@@ -282,35 +274,35 @@ Labels:
274
Metrics:
275
276
| Metric | Dimensions | Unit |
285
-|:-------|:-----------|:-----|
277
+|:------|:----------|:----|
278
| as400.jobqueue_length | jobs | jobs |
279
280
### Per messagequeue
281
290
-These metrics refer to individual messagequeue instances.
282
+These metrics refer to messagequeue instances.
283
284
Labels:
285
294
-| Label | Description |
295
-|:------|:------------|
286
+| Label | Description |
287
+|:-----------|:----------------|
288
| library | Library identifier |
289
| queue | Queue identifier |
290
291
Metrics:
292
293
| Metric | Dimensions | Unit |
302
-|:-------|:-----------|:-----|
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
308
-These metrics refer to individual networkinterface instances.
300
+These metrics refer to networkinterface instances.
301
302
Labels:
303
312
-| Label | Description |
313
-|:------|:------------|
304
+| Label | Description |
305
+|:-----------|:----------------|
306
| interface | Interface identifier |
307
| interface_type | Interface_type identifier |
308
| connection_type | Connection_type identifier |
@@ -321,18 +313,32 @@ Labels:
313
Metrics:
314
315
| Metric | Dimensions | Unit |
324
-|:-------|:-----------|:-----|
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
330
-These metrics refer to individual outputqueue instances.
336
+These metrics refer to outputqueue instances.
337
338
Labels:
339
334
-| Label | Description |
335
-|:------|:------------|
340
+| Label | Description |
341
+|:-----------|:----------------|
342
| library | Library identifier |
343
| queue | Queue identifier |
344
| status | Status identifier |
@@ -340,53 +346,53 @@ Labels:
346
Metrics:
347
348
| Metric | Dimensions | Unit |
343
-|:-------|:-----------|:-----|
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
350
-These metrics refer to individual plancache instances.
356
+These metrics refer to plancache instances.
357
358
Labels:
359
354
-| Label | Description |
355
-|:------|:------------|
360
+| Label | Description |
361
+|:-----------|:----------------|
362
| metric | Metric identifier |
363
364
Metrics:
365
366
| Metric | Dimensions | Unit |
361
-|:-------|:-----------|:-----|
367
+|:------|:----------|:----|
368
| as400.plan_cache_summary | value | value |
369
370
### Per queueoverview
371
366
-These metrics refer to individual queueoverview instances.
372
+These metrics refer to queueoverview instances.
373
374
Labels:
375
370
-| Label | Description |
371
-|:------|:------------|
376
+| Label | Description |
377
+|:-----------|:----------------|
378
| queue_type | Queue_type identifier |
379
| item_type | Item_type identifier |
380
381
Metrics:
382
383
| Metric | Dimensions | Unit |
378
-|:-------|:-----------|:-----|
384
+|:------|:----------|:----|
385
| as400.queues_count | queues | queues |
386
| as400.queued_items | items | items |
387
388
### Per subsystem
389
384
-These metrics refer to individual subsystem instances.
390
+These metrics refer to subsystem instances.
391
392
Labels:
393
388
-| Label | Description |
389
-|:------|:------------|
394
+| Label | Description |
395
+|:-----------|:----------------|
396
| subsystem | Subsystem identifier |
397
| library | Library identifier |
398
| status | Status identifier |
@@ -394,136 +400,126 @@ Labels:
400
Metrics:
401
402
| Metric | Dimensions | Unit |
397
-|:-------|:-----------|:-----|
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
402
-These metrics refer to individual tempstoragebucket instances.
443
+These metrics refer to tempstoragebucket instances.
444
445
Labels:
446
406
-| Label | Description |
407
-|:------|:------------|
447
+| Label | Description |
448
+|:-----------|:----------------|
449
| bucket | Bucket identifier |
450
451
Metrics:
452
453
| Metric | Dimensions | Unit |
413
-|:-------|:-----------|:-----|
454
+|:------|:----------|:----|
455
| as400.temp_storage_bucket | current, peak | bytes |
456
457
417
-## Configuration
458
419
-### File
459
+## Alerts
460
421
-The configuration file name for this integration is `ibm.d/as400.conf`.
461
+There are no alerts configured by default for this integration.
462
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).
463
426
-```bash
427
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
428
-sudo ./edit-config ibm.d/as400.conf
429
-```
464
+## Setup
465
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>
466
482
-```yaml
483
-jobs:
484
- - name: local
485
- endpoint: dummy://localhost
486
-```
467
+### Prerequisites
468
488
-</details>
469
+#### Enable monitoring interface
470
490
-## Troubleshooting
471
+Ensure the IBM i (AS/400) monitoring interface is accessible.
472
492
-### Debug Mode
473
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.
474
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:
475
+### Configuration
476
501
-```bash
502
-sudo -u netdata ./ibm.d.plugin -d -m as400
503
-```
477
+#### Options
478
505
-## Getting Logs
479
+Configuration options for the as400 collector.
480
507
-If you're encountering problems with the `as400` collector, follow these steps to retrieve logs and identify potential issues:
481
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.
482
+<details open><summary>Config options</summary>
483
512
-### For systemd systems (most Linux distributions)
484
514
-```bash
515
-sudo journalctl -u netdata --reverse | grep as400
516
-```
485
518
-### For non-systemd systems
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
521
-sudo grep as400 /var/log/netdata/error.log
522
-sudo grep as400 /var/log/netdata/collector.log
505
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
506
+sudo ./edit-config ibm.d/as400.conf
507
```
508
525
-### For Docker containers
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
527
-```bash
528
-sudo docker logs netdata 2>&1 | grep as400
522
```
523
+</details>
524
+
525
+
src/go/plugin/ibm.d/modules/db2/integrations/ibm_db2.md
+192
-197
@@ -1,4 +1,24 @@
1
-# IBM DB2 collector
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
@@ -19,81 +39,51 @@ application prefix, or buffer pool family) are always emitted so high-level
39
visibility is preserved even when individual instances are trimmed.
40
41
22
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
42
+The collector connects to IBM DB2 and collects metrics via its monitoring interface.
43
24
-## Collected metrics
44
26
-Metrics grouped by scope.
45
+This collector is supported on all platforms.
46
28
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
47
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
48
30
-### Per IBM DB2 instance
49
50
+### Default Behavior
51
33
-These metrics refer to the entire monitored IBM DB2 instance.
52
+#### Auto-Detection
53
35
-This scope has no labels.
54
+This integration doesn't support auto-detection.
55
37
-Metrics:
56
+#### Limits
57
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 |
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
84
-These metrics refer to individual bufferpool instances.
74
+These metrics refer to bufferpool instances.
75
76
Labels:
77
88
-| Label | Description |
89
-|:------|:------------|
78
+| Label | Description |
79
+|:-----------|:----------------|
80
| bufferpool | Bufferpool identifier |
81
| page_size | Page_size identifier |
82
83
Metrics:
84
85
| Metric | Dimensions | Unit |
96
-|:-------|:-----------|:-----|
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 |
@@ -104,18 +94,18 @@ Metrics:
94
95
### Per bufferpoolgroup
96
107
-These metrics refer to individual bufferpoolgroup instances.
97
+These metrics refer to bufferpoolgroup instances.
98
99
Labels:
100
111
-| Label | Description |
112
-|:------|:------------|
101
+| Label | Description |
102
+|:-----------|:----------------|
103
| group | Group identifier |
104
105
Metrics:
106
107
| Metric | Dimensions | Unit |
118
-|:-------|:-----------|:-----|
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 |
@@ -126,12 +116,12 @@ Metrics:
116
117
### Per connection
118
129
-These metrics refer to individual connection instances.
119
+These metrics refer to connection instances.
120
121
Labels:
122
133
-| Label | Description |
134
-|:------|:------------|
123
+| Label | Description |
124
+|:-----------|:----------------|
125
| application_id | Application_id identifier |
126
| application_name | Application_name identifier |
127
| client_hostname | Client_hostname identifier |
@@ -142,7 +132,7 @@ Labels:
132
Metrics:
133
134
| Metric | Dimensions | Unit |
145
-|:-------|:-----------|:-----|
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 |
@@ -150,18 +140,18 @@ Metrics:
140
141
### Per connectiongroup
142
153
-These metrics refer to individual connectiongroup instances.
143
+These metrics refer to connectiongroup instances.
144
145
Labels:
146
157
-| Label | Description |
158
-|:------|:------------|
147
+| Label | Description |
148
+|:-----------|:----------------|
149
| group | Group identifier |
150
151
Metrics:
152
153
| Metric | Dimensions | Unit |
164
-|:-------|:-----------|:-----|
154
+|:------|:----------|:----|
155
| db2.connection_group.count | count | connections |
156
| db2.connection_group.state | state | state |
157
| db2.connection_group.activity | read, written | rows/s |
@@ -170,79 +160,79 @@ Metrics:
160
161
### Per database
162
173
-These metrics refer to individual database instances.
163
+These metrics refer to database instances.
164
165
Labels:
166
177
-| Label | Description |
178
-|:------|:------------|
167
+| Label | Description |
168
+|:-----------|:----------------|
169
| database | Database identifier |
170
| status | Status identifier |
171
172
Metrics:
173
174
| Metric | Dimensions | Unit |
185
-|:-------|:-----------|:-----|
175
+|:------|:----------|:----|
176
| db2.database_instance_status | status | status |
177
| db2.database_applications | applications | applications |
178
179
### Per index
180
191
-These metrics refer to individual index instances.
181
+These metrics refer to index instances.
182
183
Labels:
184
195
-| Label | Description |
196
-|:------|:------------|
185
+| Label | Description |
186
+|:-----------|:----------------|
187
| index | Index identifier |
188
189
Metrics:
190
191
| Metric | Dimensions | Unit |
202
-|:-------|:-----------|:-----|
192
+|:------|:----------|:----|
193
| db2.index_usage | index, full | scans/s |
194
195
### Per indexgroup
196
207
-These metrics refer to individual indexgroup instances.
197
+These metrics refer to indexgroup instances.
198
199
Labels:
200
211
-| Label | Description |
212
-|:------|:------------|
201
+| Label | Description |
202
+|:-----------|:----------------|
203
| group | Group identifier |
204
205
Metrics:
206
207
| Metric | Dimensions | Unit |
218
-|:-------|:-----------|:-----|
208
+|:------|:----------|:----|
209
| db2.index_group_usage | index, full | scans/s |
210
211
### Per memorypool
212
223
-These metrics refer to individual memorypool instances.
213
+These metrics refer to memorypool instances.
214
215
Labels:
216
227
-| Label | Description |
228
-|:------|:------------|
217
+| Label | Description |
218
+|:-----------|:----------------|
219
| pool_type | Pool_type identifier |
220
221
Metrics:
222
223
| Metric | Dimensions | Unit |
234
-|:-------|:-----------|:-----|
224
+|:------|:----------|:----|
225
| db2.memory_pool_usage | used | bytes |
226
| db2.memory_pool_hwm | hwm | bytes |
227
228
### Per memoryset
229
240
-These metrics refer to individual memoryset instances.
230
+These metrics refer to memoryset instances.
231
232
Labels:
233
244
-| Label | Description |
245
-|:------|:------------|
234
+| Label | Description |
235
+|:-----------|:----------------|
236
| host | Host identifier |
237
| database | Database identifier |
238
| set_type | Set_type identifier |
@@ -251,7 +241,7 @@ Labels:
241
Metrics:
242
243
| Metric | Dimensions | Unit |
254
-|:-------|:-----------|:-----|
244
+|:------|:----------|:----|
245
| db2.memory_set_usage | used | bytes |
246
| db2.memory_set_committed | committed | bytes |
247
| db2.memory_set_high_water_mark | hwm | bytes |
@@ -260,18 +250,18 @@ Metrics:
250
251
### Per prefetcher
252
263
-These metrics refer to individual prefetcher instances.
253
+These metrics refer to prefetcher instances.
254
255
Labels:
256
267
-| Label | Description |
268
-|:------|:------------|
257
+| Label | Description |
258
+|:-----------|:----------------|
259
| bufferpool | Bufferpool identifier |
260
261
Metrics:
262
263
| Metric | Dimensions | Unit |
274
-|:-------|:-----------|:-----|
264
+|:------|:----------|:----|
265
| db2.prefetcher_prefetch_ratio | ratio | percentage |
266
| db2.prefetcher_cleaner_ratio | ratio | percentage |
267
| db2.prefetcher_physical_reads | reads | reads/s |
@@ -279,54 +269,103 @@ Metrics:
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
284
-These metrics refer to individual table instances.
323
+These metrics refer to table instances.
324
325
Labels:
326
288
-| Label | Description |
289
-|:------|:------------|
327
+| Label | Description |
328
+|:-----------|:----------------|
329
| table | Table identifier |
330
331
Metrics:
332
333
| Metric | Dimensions | Unit |
295
-|:-------|:-----------|:-----|
334
+|:------|:----------|:----|
335
| db2.table_size | data, index, long_obj | bytes |
336
| db2.table_activity | read, written | rows/s |
337
338
### Per tablegroup
339
301
-These metrics refer to individual tablegroup instances.
340
+These metrics refer to tablegroup instances.
341
342
Labels:
343
305
-| Label | Description |
306
-|:------|:------------|
344
+| Label | Description |
345
+|:-----------|:----------------|
346
| group | Group identifier |
347
348
Metrics:
349
350
| Metric | Dimensions | Unit |
312
-|:-------|:-----------|:-----|
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
318
-These metrics refer to individual tableio instances.
357
+These metrics refer to tableio instances.
358
359
Labels:
360
322
-| Label | Description |
323
-|:------|:------------|
361
+| Label | Description |
362
+|:-----------|:----------------|
363
| table | Table identifier |
364
365
Metrics:
366
367
| Metric | Dimensions | Unit |
329
-|:-------|:-----------|:-----|
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 |
@@ -334,12 +373,12 @@ Metrics:
373
374
### Per tablespace
375
337
-These metrics refer to individual tablespace instances.
376
+These metrics refer to tablespace instances.
377
378
Labels:
379
341
-| Label | Description |
342
-|:------|:------------|
380
+| Label | Description |
381
+|:-----------|:----------------|
382
| tablespace | Tablespace identifier |
383
| type | Type identifier |
384
| content_type | Content_type identifier |
@@ -348,7 +387,7 @@ Labels:
387
Metrics:
388
389
| Metric | Dimensions | Unit |
351
-|:-------|:-----------|:-----|
390
+|:------|:----------|:----|
391
| db2.tablespace_usage | used | percentage |
392
| db2.tablespace_size | used, free | bytes |
393
| db2.tablespace_usable_size | total, usable | bytes |
@@ -356,133 +395,89 @@ Metrics:
395
396
### Per tablespacegroup
397
359
-These metrics refer to individual tablespacegroup instances.
398
+These metrics refer to tablespacegroup instances.
399
400
Labels:
401
363
-| Label | Description |
364
-|:------|:------------|
402
+| Label | Description |
403
+|:-----------|:----------------|
404
| group | Group identifier |
405
406
Metrics:
407
408
| Metric | Dimensions | Unit |
370
-|:-------|:-----------|:-----|
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
377
-## Configuration
416
379
-### File
417
+## Alerts
418
381
-The configuration file name for this integration is `ibm.d/db2.conf`.
419
+There are no alerts configured by default for this integration.
420
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).
421
386
-```bash
387
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
388
-sudo ./edit-config ibm.d/db2.conf
389
-```
422
+## Setup
423
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>
424
441
-```yaml
442
-jobs:
443
- - name: local
444
- endpoint: dummy://localhost
445
-```
425
+### Prerequisites
426
447
-</details>
427
+#### Enable monitoring interface
428
449
-## Troubleshooting
429
+Ensure the IBM DB2 monitoring interface is accessible.
430
451
-### Debug Mode
431
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.
432
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:
433
+### Configuration
434
460
-```bash
461
-sudo -u netdata ./ibm.d.plugin -d -m db2
462
-```
435
+#### Options
436
464
-## Getting Logs
437
+Configuration options for the db2 collector.
438
466
-If you're encountering problems with the `db2` collector, follow these steps to retrieve logs and identify potential issues:
439
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.
440
+<details open><summary>Config options</summary>
441
471
-### For systemd systems (most Linux distributions)
442
473
-```bash
474
-sudo journalctl -u netdata --reverse | grep db2
475
-```
443
477
-### For non-systemd systems
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
480
-sudo grep db2 /var/log/netdata/error.log
481
-sudo grep db2 /var/log/netdata/collector.log
463
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
464
+sudo ./edit-config ibm.d/db2.conf
465
```
466
484
-### For Docker containers
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
486
-```bash
487
-sudo docker logs netdata 2>&1 | grep db2
480
```
481
+</details>
482
+
483
+
src/go/plugin/ibm.d/modules/mq/integrations/ibm_mq.md
+150
-152
@@ -1,4 +1,24 @@
1
-# IBM MQ collector
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.png" 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
@@ -19,65 +39,51 @@ prefix (first two dot-separated segments, collapsing all `SYSTEM.*` queues toget
39
high-level visibility is never lost even when detailed charts are trimmed.
40
41
22
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
42
+The collector connects to IBM MQ and collects metrics via its monitoring interface.
43
24
-## Collected metrics
44
26
-Metrics grouped by scope.
45
+This collector is supported on all platforms.
46
28
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
47
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
48
30
-### Per IBM MQ instance
49
50
+### Default Behavior
51
33
-These metrics refer to the entire monitored IBM MQ instance.
52
+#### Auto-Detection
53
35
-This scope has no labels.
54
+This integration doesn't support auto-detection.
55
37
-Metrics:
56
+#### Limits
57
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 |
58
+The default configuration for this integration does not impose any limits on data collection.
59
49
-These metrics refer to the entire monitored IBM MQ instance.
60
+#### Performance Impact
61
51
-This scope has no labels.
62
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
63
53
-Metrics:
64
+## Metrics
65
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 |
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
68
-These metrics refer to individual channel instances.
74
+These metrics refer to channel instances.
75
76
Labels:
77
72
-| Label | Description |
73
-|:------|:------------|
78
+| Label | Description |
79
+|:-----------|:----------------|
80
| channel | Channel identifier |
81
| type | Type identifier |
82
83
Metrics:
84
85
| Metric | Dimensions | Unit |
80
-|:-------|:-----------|:-----|
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 |
@@ -101,19 +107,19 @@ Metrics:
107
108
### Per channelstatistics
109
104
-These metrics refer to individual channelstatistics instances.
110
+These metrics refer to channelstatistics instances.
111
112
Labels:
113
108
-| Label | Description |
109
-|:------|:------------|
114
+| Label | Description |
115
+|:-----------|:----------------|
116
| channel | Channel identifier |
117
| type | Type identifier |
118
119
Metrics:
120
121
| Metric | Dimensions | Unit |
116
-|:-------|:-----------|:-----|
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 |
@@ -122,12 +128,12 @@ Metrics:
128
129
### Per listener
130
125
-These metrics refer to individual listener instances.
131
+These metrics refer to listener instances.
132
133
Labels:
134
129
-| Label | Description |
130
-|:------|:------------|
135
+| Label | Description |
136
+|:-----------|:----------------|
137
| listener | Listener identifier |
138
| port | Port identifier |
139
| ip_address | Ip_address identifier |
@@ -135,25 +141,25 @@ Labels:
141
Metrics:
142
143
| Metric | Dimensions | Unit |
138
-|:-------|:-----------|:-----|
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
145
-These metrics refer to individual mqistatistics instances.
151
+These metrics refer to mqistatistics instances.
152
153
Labels:
154
149
-| Label | Description |
150
-|:------|:------------|
155
+| Label | Description |
156
+|:-----------|:----------------|
157
| queue_manager | Queue_manager identifier |
158
159
Metrics:
160
161
| Metric | Dimensions | Unit |
156
-|:-------|:-----------|:-----|
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 |
@@ -161,19 +167,19 @@ Metrics:
167
168
### Per queue
169
164
-These metrics refer to individual queue instances.
170
+These metrics refer to queue instances.
171
172
Labels:
173
168
-| Label | Description |
169
-|:------|:------------|
174
+| Label | Description |
175
+|:-----------|:----------------|
176
| queue | Queue identifier |
177
| type | Type identifier |
178
179
Metrics:
180
181
| Metric | Dimensions | Unit |
176
-|:-------|:-----------|:-----|
182
+|:------|:----------|:----|
183
| mq.queue.depth | current, max | messages |
184
| mq.queue.depth_percentage | percentage | percentage |
185
| mq.queue.messages | enqueued, dequeued | messages/s |
@@ -199,18 +205,18 @@ Metrics:
205
206
### Per queuegroup
207
202
-These metrics refer to individual queuegroup instances.
208
+These metrics refer to queuegroup instances.
209
210
Labels:
211
206
-| Label | Description |
207
-|:------|:------------|
212
+| Label | Description |
213
+|:-----------|:----------------|
214
| group | Group identifier |
215
216
Metrics:
217
218
| Metric | Dimensions | Unit |
213
-|:-------|:-----------|:-----|
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 |
@@ -219,21 +225,56 @@ Metrics:
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
224
-These metrics refer to individual queuestatistics instances.
265
+These metrics refer to queuestatistics instances.
266
267
Labels:
268
228
-| Label | Description |
229
-|:------|:------------|
269
+| Label | Description |
270
+|:-----------|:----------------|
271
| queue | Queue identifier |
272
| type | Type identifier |
273
274
Metrics:
275
276
| Metric | Dimensions | Unit |
236
-|:-------|:-----------|:-----|
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 |
@@ -244,150 +285,107 @@ Metrics:
285
286
### Per subscription
287
247
-These metrics refer to individual subscription instances.
288
+These metrics refer to subscription instances.
289
290
Labels:
291
251
-| Label | Description |
252
-|:------|:------------|
292
+| Label | Description |
293
+|:-----------|:----------------|
294
| subscription | Subscription identifier |
295
| topic | Topic identifier |
296
297
Metrics:
298
299
| Metric | Dimensions | Unit |
259
-|:-------|:-----------|:-----|
300
+|:------|:----------|:----|
301
| mq.subscription.messages | pending | messages |
302
| mq.subscription.last_message_age | age | seconds |
303
304
### Per topic
305
265
-These metrics refer to individual topic instances.
306
+These metrics refer to topic instances.
307
308
Labels:
309
269
-| Label | Description |
270
-|:------|:------------|
310
+| Label | Description |
311
+|:-----------|:----------------|
312
| topic | Topic identifier |
313
314
Metrics:
315
316
| Metric | Dimensions | Unit |
276
-|:-------|:-----------|:-----|
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
283
-## Configuration
324
285
-### File
325
+## Alerts
326
287
-The configuration file name for this integration is `ibm.d/mq.conf`.
327
+There are no alerts configured by default for this integration.
328
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).
329
292
-```bash
293
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
294
-sudo ./edit-config ibm.d/mq.conf
295
-```
330
+## Setup
331
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>
332
346
-```yaml
347
-jobs:
348
- - name: local
349
- endpoint: dummy://localhost
350
-```
333
+### Prerequisites
334
352
-</details>
335
+#### Enable monitoring interface
336
354
-## Troubleshooting
337
+Ensure the IBM MQ monitoring interface is accessible.
338
356
-### Debug Mode
339
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.
340
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:
341
+### Configuration
342
365
-```bash
366
-sudo -u netdata ./ibm.d.plugin -d -m mq
367
-```
343
+#### Options
344
369
-## Getting Logs
345
+Configuration options for the mq collector.
346
371
-If you're encountering problems with the `mq` collector, follow these steps to retrieve logs and identify potential issues:
347
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.
348
+<details open><summary>Config options</summary>
349
376
-### For systemd systems (most Linux distributions)
350
378
-```bash
379
-sudo journalctl -u netdata --reverse | grep mq
380
-```
351
382
-### For non-systemd systems
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
385
-sudo grep mq /var/log/netdata/error.log
386
-sudo grep mq /var/log/netdata/collector.log
371
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
372
+sudo ./edit-config ibm.d/mq.conf
373
```
374
389
-### For Docker containers
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
391
-```bash
392
-sudo docker logs netdata 2>&1 | grep mq
388
```
389
+</details>
390
+
391
+
src/go/plugin/ibm.d/modules/websphere/jmx/integrations/ibm_websphere_jmx.md
+120
-138
@@ -1,4 +1,20 @@
1
-# IBM WebSphere JMX collector
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
@@ -6,53 +22,51 @@ Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application
22
via the embedded JMX bridge helper.
23
24
9
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
25
+The collector connects to IBM WebSphere JMX and collects metrics via its monitoring interface.
26
11
-## Collected metrics
27
13
-Metrics grouped by scope.
28
+This collector is supported on all platforms.
29
15
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
30
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
31
17
-### Per IBM WebSphere JMX instance
32
33
+### Default Behavior
34
20
-These metrics refer to the entire monitored IBM WebSphere JMX instance.
35
+#### Auto-Detection
36
22
-This scope has no labels.
37
+This integration doesn't support auto-detection.
38
24
-Metrics:
39
+#### Limits
40
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 |
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
43
-These metrics refer to individual applications instances.
57
+These metrics refer to applications instances.
58
59
Labels:
60
47
-| Label | Description |
48
-|:------|:------------|
61
+| Label | Description |
62
+|:-----------|:----------------|
63
| application | Application identifier |
64
| module | Module identifier |
65
66
Metrics:
67
68
| Metric | Dimensions | Unit |
55
-|:-------|:-----------|:-----|
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 |
@@ -62,18 +76,18 @@ Metrics:
76
77
### Per jca
78
65
-These metrics refer to individual jca instances.
79
+These metrics refer to jca instances.
80
81
Labels:
82
69
-| Label | Description |
70
-|:------|:------------|
83
+| Label | Description |
84
+|:-----------|:----------------|
85
| pool | Pool identifier |
86
87
Metrics:
88
89
| Metric | Dimensions | Unit |
76
-|:-------|:-----------|:-----|
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 |
@@ -83,18 +97,18 @@ Metrics:
97
98
### Per jdbc
99
86
-These metrics refer to individual jdbc instances.
100
+These metrics refer to jdbc instances.
101
102
Labels:
103
90
-| Label | Description |
91
-|:------|:------------|
104
+| Label | Description |
105
+|:-----------|:----------------|
106
| pool | Pool identifier |
107
108
Metrics:
109
110
| Metric | Dimensions | Unit |
97
-|:-------|:-----------|:-----|
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 |
@@ -104,160 +118,128 @@ Metrics:
118
119
### Per jms
120
107
-These metrics refer to individual jms instances.
121
+These metrics refer to jms instances.
122
123
Labels:
124
111
-| Label | Description |
112
-|:------|:------------|
125
+| Label | Description |
126
+|:-----------|:----------------|
127
| destination | Destination identifier |
128
| destination_type | Destination_type identifier |
129
130
Metrics:
131
132
| Metric | Dimensions | Unit |
119
-|:-------|:-----------|:-----|
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
127
-These metrics refer to individual threadpools instances.
162
+These metrics refer to threadpools instances.
163
164
Labels:
165
131
-| Label | Description |
132
-|:------|:------------|
166
+| Label | Description |
167
+|:-----------|:----------------|
168
| pool | Pool identifier |
169
170
Metrics:
171
172
| Metric | Dimensions | Unit |
138
-|:-------|:-----------|:-----|
173
+|:------|:----------|:----|
174
| websphere_jmx.threadpool_size | size, max | threads |
175
| websphere_jmx.threadpool_active | active | threads |
176
177
143
-## Configuration
178
145
-### File
179
+## Alerts
180
147
-The configuration file name for this integration is `ibm.d/websphere_jmx.conf`.
181
+There are no alerts configured by default for this integration.
182
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).
183
152
-```bash
153
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
154
-sudo ./edit-config ibm.d/websphere_jmx.conf
155
-```
184
+## Setup
185
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>
186
216
-```yaml
217
-jobs:
218
- - name: local
219
- endpoint: dummy://localhost
220
-```
187
+### Prerequisites
188
222
-</details>
189
+#### Enable monitoring interface
190
224
-## Troubleshooting
191
+Ensure the IBM WebSphere JMX monitoring interface is accessible.
192
226
-### Debug Mode
193
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.
194
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:
195
+### Configuration
196
235
-```bash
236
-sudo -u netdata ./ibm.d.plugin -d -m websphere_jmx
237
-```
197
+#### Options
198
239
-## Getting Logs
199
+Configuration options for the websphere_jmx collector.
200
241
-If you're encountering problems with the `websphere_jmx` collector, follow these steps to retrieve logs and identify potential issues:
201
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.
202
+<details open><summary>Config options</summary>
203
246
-### For systemd systems (most Linux distributions)
204
248
-```bash
249
-sudo journalctl -u netdata --reverse | grep websphere_jmx
250
-```
205
252
-### For non-systemd systems
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
255
-sudo grep websphere_jmx /var/log/netdata/error.log
256
-sudo grep websphere_jmx /var/log/netdata/collector.log
225
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
226
+sudo ./edit-config ibm.d/websphere_jmx.conf
227
```
228
259
-### For Docker containers
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
261
-```bash
262
-sudo docker logs netdata 2>&1 | grep websphere_jmx
242
```
243
+</details>
244
+
245
+
src/go/plugin/ibm.d/modules/websphere/mp/integrations/ibm_websphere_microprofile.md
+110
-100
@@ -1,4 +1,24 @@
1
-# IBM WebSphere MicroProfile collector
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
@@ -6,36 +26,59 @@ Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Li
26
servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint.
27
28
9
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
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
11
-## Collected metrics
37
+### Default Behavior
38
13
-Metrics grouped by scope.
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
17
-### Per IBM WebSphere MicroProfile instance
57
58
20
-These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
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 |
27
-|:-------|:-----------|:-----|
68
+|:------|:----------|:----|
69
| websphere_mp.cpu_usage | process, utilization | percentage |
70
| websphere_mp.cpu_time | total | seconds |
71
31
-These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
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 |
38
-|:-------|:-----------|:-----|
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 |
@@ -45,136 +88,103 @@ Metrics:
88
| websphere_mp.jvm_threads_current | daemon, other | threads |
89
| websphere_mp.jvm_threads_peak | peak | threads |
90
48
-These metrics refer to the entire monitored IBM WebSphere MicroProfile instance.
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 |
55
-|:-------|:-----------|:-----|
118
+|:------|:----------|:----|
119
| websphere_mp.threadpool_usage | active, idle | threads |
120
| websphere_mp.threadpool_size | size | threads |
121
122
123
61
-### Per restendpoint
124
+## Alerts
125
63
-These metrics refer to individual restendpoint instances.
126
+There are no alerts configured by default for this integration.
127
65
-Labels:
128
67
-| Label | Description |
68
-|:------|:------------|
69
-| method | Method identifier |
70
-| endpoint | Endpoint identifier |
129
+## Setup
130
72
-Metrics:
131
74
-| Metric | Dimensions | Unit |
75
-|:-------|:-----------|:-----|
76
-| websphere_mp.rest_requests | requests | requests/s |
77
-| websphere_mp.rest_response_time | average | milliseconds |
132
+### Prerequisites
133
134
+#### Enable monitoring interface
135
80
-## Configuration
136
+Ensure the IBM WebSphere MicroProfile monitoring interface is accessible.
137
82
-### File
138
84
-The configuration file name for this integration is `ibm.d/websphere_mp.conf`.
139
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).
140
+### Configuration
141
89
-```bash
90
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
91
-sudo ./edit-config ibm.d/websphere_mp.conf
92
-```
142
+#### Options
143
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>
144
+Configuration options for the websphere_mp collector.
145
133
-```yaml
134
-jobs:
135
- - name: local
136
- endpoint: dummy://localhost
137
-```
146
139
-</details>
147
+<details open><summary>Config options</summary>
148
141
-## Troubleshooting
149
143
-### Debug Mode
150
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.
151
+| Option | Description | Default | Required |
152
+|:-----|:------------|:--------|:---------:|
153
+| update_every | Data collection frequency. | 1 | no |
154
+| endpoint | Connection endpoint. | dummy://localhost | no |
155
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:
156
152
-```bash
153
-sudo -u netdata ./ibm.d.plugin -d -m websphere_mp
154
-```
157
+</details>
158
156
-## Getting Logs
159
158
-If you're encountering problems with the `websphere_mp` collector, follow these steps to retrieve logs and identify potential issues:
160
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.
161
+#### via File
162
163
-### For systemd systems (most Linux distributions)
163
+The configuration file name for this integration is `ibm.d/websphere_mp.conf`.
164
165
-```bash
166
-sudo journalctl -u netdata --reverse | grep websphere_mp
167
-```
165
169
-### For non-systemd systems
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
172
-sudo grep websphere_mp /var/log/netdata/error.log
173
-sudo grep websphere_mp /var/log/netdata/collector.log
170
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
171
+sudo ./edit-config ibm.d/websphere_mp.conf
172
```
173
176
-### For Docker containers
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
178
-```bash
179
-sudo docker logs netdata 2>&1 | grep websphere_mp
187
```
188
+</details>
189
+
190
+
src/go/plugin/ibm.d/modules/websphere/pmi/integrations/ibm_websphere_pmi.md
+222
-235
@@ -1,70 +1,69 @@
1
-# IBM WebSphere PMI collector
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
3
-## Overview
12
+# IBM WebSphere PMI
13
5
-Collects WebSphere Application Server performance metrics via the PerfServlet (PMI) interface,
6
-covering JVM, thread pools, JDBC/JMS resources, applications, and clustering information.
14
15
+<img src="https://netdata.cloud/img/ibm.svg" width="150"/>
16
9
-This collector is part of the [Netdata](https://github.com/netdata/netdata) monitoring solution.
17
11
-## Collected metrics
18
+Plugin: ibm.d.plugin
19
+Module: websphere_pmi
20
13
-Metrics grouped by scope.
21
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22
15
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
23
+## Overview
24
17
-### Per IBM WebSphere PMI instance
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
20
-These metrics refer to the entire monitored IBM WebSphere PMI instance.
29
+The collector connects to IBM WebSphere PMI and collects metrics via its monitoring interface.
30
22
-This scope has no labels.
31
24
-Metrics:
32
+This collector is supported on all platforms.
33
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 |
34
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
35
38
-These metrics refer to the entire monitored IBM WebSphere PMI instance.
36
40
-This scope has no labels.
37
+### Default Behavior
38
42
-Metrics:
39
+#### Auto-Detection
40
44
-| Metric | Dimensions | Unit |
45
-|:-------|:-----------|:-----|
46
-| websphere_pmi.cpu_utilization | utilization | percentage |
41
+This integration doesn't support auto-detection.
42
48
-These metrics refer to the entire monitored IBM WebSphere PMI instance.
43
+#### Limits
44
50
-This scope has no labels.
45
+The default configuration for this integration does not impose any limits on data collection.
46
52
-Metrics:
47
+#### Performance Impact
48
54
-| Metric | Dimensions | Unit |
55
-|:-------|:-----------|:-----|
56
-| websphere_pmi.system_data_usage | cpu_since_last, free_memory | value |
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
62
-These metrics refer to individual alarmmanager instances.
61
+These metrics refer to alarmmanager instances.
62
63
Labels:
64
66
-| Label | Description |
67
-|:------|:------------|
65
+| Label | Description |
66
+|:-----------|:----------------|
67
| node | Node identifier |
68
| server | Server identifier |
69
| manager | Manager identifier |
@@ -72,17 +71,17 @@ Labels:
71
Metrics:
72
73
| Metric | Dimensions | Unit |
75
-|:-------|:-----------|:-----|
74
+|:------|:----------|:----|
75
| websphere_pmi.alarm_manager_events | created, cancelled, fired | events/s |
76
77
### Per dynamiccache
78
80
-These metrics refer to individual dynamiccache instances.
79
+These metrics refer to dynamiccache instances.
80
81
Labels:
82
84
-| Label | Description |
85
-|:------|:------------|
83
+| Label | Description |
84
+|:-----------|:----------------|
85
| node | Node identifier |
86
| server | Server identifier |
87
| cache | Cache identifier |
@@ -90,18 +89,18 @@ Labels:
89
Metrics:
90
91
| Metric | Dimensions | Unit |
93
-|:-------|:-----------|:-----|
92
+|:------|:----------|:----|
93
| websphere_pmi.dynamic_cache_in_memory | entries | entries |
94
| websphere_pmi.dynamic_cache_capacity | max_entries | entries |
95
96
### Per enterprisebeans
97
99
-These metrics refer to individual enterprisebeans instances.
98
+These metrics refer to enterprisebeans instances.
99
100
Labels:
101
103
-| Label | Description |
104
-|:------|:------------|
102
+| Label | Description |
103
+|:-----------|:----------------|
104
| node | Node identifier |
105
| server | Server identifier |
106
| bean | Bean identifier |
@@ -109,7 +108,7 @@ Labels:
108
Metrics:
109
110
| Metric | Dimensions | Unit |
112
-|:-------|:-----------|:-----|
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 |
@@ -117,49 +116,49 @@ Metrics:
116
117
### Per extensionregistry
118
120
-These metrics refer to individual extensionregistry instances.
119
+These metrics refer to extensionregistry instances.
120
121
Labels:
122
124
-| Label | Description |
125
-|:------|:------------|
123
+| Label | Description |
124
+|:-----------|:----------------|
125
| node | Node identifier |
126
| server | Server identifier |
127
128
Metrics:
129
130
| Metric | Dimensions | Unit |
132
-|:-------|:-----------|:-----|
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
138
-These metrics refer to individual hamanager instances.
137
+These metrics refer to hamanager instances.
138
139
Labels:
140
142
-| Label | Description |
143
-|:------|:------------|
141
+| Label | Description |
142
+|:-----------|:----------------|
143
| node | Node identifier |
144
| server | Server identifier |
145
146
Metrics:
147
148
| Metric | Dimensions | Unit |
150
-|:-------|:-----------|:-----|
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
157
-These metrics refer to individual jcapool instances.
156
+These metrics refer to jcapool instances.
157
158
Labels:
159
161
-| Label | Description |
162
-|:------|:------------|
160
+| Label | Description |
161
+|:-----------|:----------------|
162
| node | Node identifier |
163
| server | Server identifier |
164
| provider | Provider identifier |
@@ -168,7 +167,7 @@ Labels:
167
Metrics:
168
169
| Metric | Dimensions | Unit |
171
-|:-------|:-----------|:-----|
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 |
@@ -176,12 +175,12 @@ Metrics:
175
176
### Per jdbcpool
177
179
-These metrics refer to individual jdbcpool instances.
178
+These metrics refer to jdbcpool instances.
179
180
Labels:
181
183
-| Label | Description |
184
-|:------|:------------|
182
+| Label | Description |
183
+|:-----------|:----------------|
184
| node | Node identifier |
185
| server | Server identifier |
186
| pool | Pool identifier |
@@ -189,7 +188,7 @@ Labels:
188
Metrics:
189
190
| Metric | Dimensions | Unit |
192
-|:-------|:-----------|:-----|
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 |
@@ -198,12 +197,12 @@ Metrics:
197
198
### Per jmsqueue
199
201
-These metrics refer to individual jmsqueue instances.
200
+These metrics refer to jmsqueue instances.
201
202
Labels:
203
205
-| Label | Description |
206
-|:------|:------------|
204
+| Label | Description |
205
+|:-----------|:----------------|
206
| node | Node identifier |
207
| server | Server identifier |
208
| engine | Engine identifier |
@@ -212,7 +211,7 @@ Labels:
211
Metrics:
212
213
| Metric | Dimensions | Unit |
215
-|:-------|:-----------|:-----|
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 |
@@ -221,12 +220,12 @@ Metrics:
220
221
### Per jmsstore
222
224
-These metrics refer to individual jmsstore instances.
223
+These metrics refer to jmsstore instances.
224
225
Labels:
226
228
-| Label | Description |
229
-|:------|:------------|
227
+| Label | Description |
228
+|:-----------|:----------------|
229
| node | Node identifier |
230
| server | Server identifier |
231
| engine | Engine identifier |
@@ -235,7 +234,7 @@ Labels:
234
Metrics:
235
236
| Metric | Dimensions | Unit |
238
-|:-------|:-----------|:-----|
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 |
@@ -243,12 +242,12 @@ Metrics:
242
243
### Per jmstopic
244
246
-These metrics refer to individual jmstopic instances.
245
+These metrics refer to jmstopic instances.
246
247
Labels:
248
250
-| Label | Description |
251
-|:------|:------------|
249
+| Label | Description |
250
+|:-----------|:----------------|
251
| node | Node identifier |
252
| server | Server identifier |
253
| engine | Engine identifier |
@@ -257,39 +256,59 @@ Labels:
256
Metrics:
257
258
| Metric | Dimensions | Unit |
260
-|:-------|:-----------|:-----|
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
269
-These metrics refer to individual orb instances.
288
+These metrics refer to orb instances.
289
290
Labels:
291
273
-| Label | Description |
274
-|:------|:------------|
292
+| Label | Description |
293
+|:-----------|:----------------|
294
| node | Node identifier |
295
| server | Server identifier |
296
297
Metrics:
298
299
| Metric | Dimensions | Unit |
281
-|:-------|:-----------|:-----|
300
+|:------|:----------|:----|
301
| websphere_pmi.orb_concurrent | concurrent_requests | requests |
302
| websphere_pmi.orb_requests | requests | requests/s |
303
304
### Per objectpool
305
287
-These metrics refer to individual objectpool instances.
306
+These metrics refer to objectpool instances.
307
308
Labels:
309
291
-| Label | Description |
292
-|:------|:------------|
310
+| Label | Description |
311
+|:-----------|:----------------|
312
| node | Node identifier |
313
| server | Server identifier |
314
| pool | Pool identifier |
@@ -297,18 +316,18 @@ Labels:
316
Metrics:
317
318
| Metric | Dimensions | Unit |
300
-|:-------|:-----------|:-----|
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
306
-These metrics refer to individual pmiwebservicemodule instances.
325
+These metrics refer to pmiwebservicemodule instances.
326
327
Labels:
328
310
-| Label | Description |
311
-|:------|:------------|
329
+| Label | Description |
330
+|:-----------|:----------------|
331
| node | Node identifier |
332
| server | Server identifier |
333
| module | Module identifier |
@@ -316,17 +335,17 @@ Labels:
335
Metrics:
336
337
| Metric | Dimensions | Unit |
319
-|:-------|:-----------|:-----|
338
+|:------|:----------|:----|
339
| websphere_pmi.pmi_web_service_module_services | loaded | services |
340
341
### Per portlet
342
324
-These metrics refer to individual portlet instances.
343
+These metrics refer to portlet instances.
344
345
Labels:
346
328
-| Label | Description |
329
-|:------|:------------|
347
+| Label | Description |
348
+|:-----------|:----------------|
349
| node | Node identifier |
350
| server | Server identifier |
351
| portlet | Portlet identifier |
@@ -334,7 +353,7 @@ Labels:
353
Metrics:
354
355
| Metric | Dimensions | Unit |
337
-|:-------|:-----------|:-----|
356
+|:------|:----------|:----|
357
| websphere_pmi.portlet_requests | requests | requests/s |
358
| websphere_pmi.portlet_concurrent | concurrent | requests |
359
| websphere_pmi.portlet_errors | errors | errors/s |
@@ -342,29 +361,29 @@ Metrics:
361
362
### Per portletapplication
363
345
-These metrics refer to individual portletapplication instances.
364
+These metrics refer to portletapplication instances.
365
366
Labels:
367
349
-| Label | Description |
350
-|:------|:------------|
368
+| Label | Description |
369
+|:-----------|:----------------|
370
| node | Node identifier |
371
| server | Server identifier |
372
373
Metrics:
374
375
| Metric | Dimensions | Unit |
357
-|:-------|:-----------|:-----|
376
+|:------|:----------|:----|
377
| websphere_pmi.portlet_application_loaded | loaded | portlets |
378
379
### Per schedulers
380
362
-These metrics refer to individual schedulers instances.
381
+These metrics refer to schedulers instances.
382
383
Labels:
384
366
-| Label | Description |
367
-|:------|:------------|
385
+| Label | Description |
386
+|:-----------|:----------------|
387
| node | Node identifier |
388
| server | Server identifier |
389
| scheduler | Scheduler identifier |
@@ -372,51 +391,51 @@ Labels:
391
Metrics:
392
393
| Metric | Dimensions | Unit |
375
-|:-------|:-----------|:-----|
394
+|:------|:----------|:----|
395
| websphere_pmi.scheduler_activity | finished, failures, polls | events/s |
396
397
### Per securityauth
398
380
-These metrics refer to individual securityauth instances.
399
+These metrics refer to securityauth instances.
400
401
Labels:
402
384
-| Label | Description |
385
-|:------|:------------|
403
+| Label | Description |
404
+|:-----------|:----------------|
405
| node | Node identifier |
406
| server | Server identifier |
407
408
Metrics:
409
410
| Metric | Dimensions | Unit |
392
-|:-------|:-----------|:-----|
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
397
-These metrics refer to individual securityauthz instances.
416
+These metrics refer to securityauthz instances.
417
418
Labels:
419
401
-| Label | Description |
402
-|:------|:------------|
420
+| Label | Description |
421
+|:-----------|:----------------|
422
| node | Node identifier |
423
| server | Server identifier |
424
425
Metrics:
426
427
| Metric | Dimensions | Unit |
409
-|:-------|:-----------|:-----|
428
+|:------|:----------|:----|
429
| websphere_pmi.security_authz_time | web, ejb, admin, cwwja | milliseconds |
430
431
### Per sessionmanager
432
414
-These metrics refer to individual sessionmanager instances.
433
+These metrics refer to sessionmanager instances.
434
435
Labels:
436
418
-| Label | Description |
419
-|:------|:------------|
437
+| Label | Description |
438
+|:-----------|:----------------|
439
| node | Node identifier |
440
| server | Server identifier |
441
| app | App identifier |
@@ -424,53 +443,77 @@ Labels:
443
Metrics:
444
445
| Metric | Dimensions | Unit |
427
-|:-------|:-----------|:-----|
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
433
-These metrics refer to individual threadpool instances.
476
+These metrics refer to threadpool instances.
477
478
Labels:
479
437
-| Label | Description |
438
-|:------|:------------|
480
+| Label | Description |
481
+|:-----------|:----------------|
482
| name | Name identifier |
483
484
Metrics:
485
486
| Metric | Dimensions | Unit |
444
-|:-------|:-----------|:-----|
487
+|:------|:----------|:----|
488
| websphere_pmi.threadpool_usage | active, size | threads |
489
490
### Per transactionmanager
491
449
-These metrics refer to individual transactionmanager instances.
492
+These metrics refer to transactionmanager instances.
493
494
Labels:
495
453
-| Label | Description |
454
-|:------|:------------|
496
+| Label | Description |
497
+|:-----------|:----------------|
498
| node | Node identifier |
499
| server | Server identifier |
500
501
Metrics:
502
503
| Metric | Dimensions | Unit |
461
-|:-------|:-----------|:-----|
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
468
-These metrics refer to individual url instances.
511
+These metrics refer to url instances.
512
513
Labels:
514
472
-| Label | Description |
473
-|:------|:------------|
515
+| Label | Description |
516
+|:-----------|:----------------|
517
| node | Node identifier |
518
| server | Server identifier |
519
| url | Url identifier |
@@ -478,18 +521,18 @@ Labels:
521
Metrics:
522
523
| Metric | Dimensions | Unit |
481
-|:-------|:-----------|:-----|
524
+|:------|:----------|:----|
525
| websphere_pmi.url_requests | requests | requests/s |
526
| websphere_pmi.url_time | service, async | milliseconds |
527
528
### Per webapp
529
487
-These metrics refer to individual webapp instances.
530
+These metrics refer to webapp instances.
531
532
Labels:
533
491
-| Label | Description |
492
-|:------|:------------|
534
+| Label | Description |
535
+|:-----------|:----------------|
536
| node | Node identifier |
537
| server | Server identifier |
538
| app | App identifier |
@@ -497,17 +540,17 @@ Labels:
540
Metrics:
541
542
| Metric | Dimensions | Unit |
500
-|:-------|:-----------|:-----|
543
+|:------|:----------|:----|
544
| websphere_pmi.webapp_load | loaded_servlets, reloads | events |
545
546
### Per webservices
547
505
-These metrics refer to individual webservices instances.
548
+These metrics refer to webservices instances.
549
550
Labels:
551
509
-| Label | Description |
510
-|:------|:------------|
552
+| Label | Description |
553
+|:-----------|:----------------|
554
| node | Node identifier |
555
| server | Server identifier |
556
| service | Service identifier |
@@ -515,17 +558,17 @@ Labels:
558
Metrics:
559
560
| Metric | Dimensions | Unit |
518
-|:-------|:-----------|:-----|
561
+|:------|:----------|:----|
562
| websphere_pmi.web_services_loaded | loaded | services |
563
564
### Per webservicesgateway
565
523
-These metrics refer to individual webservicesgateway instances.
566
+These metrics refer to webservicesgateway instances.
567
568
Labels:
569
527
-| Label | Description |
528
-|:------|:------------|
570
+| Label | Description |
571
+|:-----------|:----------------|
572
| node | Node identifier |
573
| server | Server identifier |
574
| gateway | Gateway identifier |
@@ -533,131 +576,75 @@ Labels:
576
Metrics:
577
578
| Metric | Dimensions | Unit |
536
-|:-------|:-----------|:-----|
579
+|:------|:----------|:----|
580
| websphere_pmi.web_services_gateway_requests | synchronous, synchronous_responses, asynchronous, asynchronous_responses | requests/s |
581
582
540
-## Configuration
583
542
-### File
584
+## Alerts
585
544
-The configuration file name for this integration is `ibm.d/websphere_pmi.conf`.
586
+There are no alerts configured by default for this integration.
587
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).
588
549
-```bash
550
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
551
-sudo ./edit-config ibm.d/websphere_pmi.conf
552
-```
589
+## Setup
590
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>
591
616
-```yaml
617
-jobs:
618
- - name: local
619
- endpoint: dummy://localhost
620
-```
592
+### Prerequisites
593
622
-</details>
594
+#### Enable monitoring interface
595
624
-## Troubleshooting
596
+Ensure the IBM WebSphere PMI monitoring interface is accessible.
597
626
-### Debug Mode
598
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.
599
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:
600
+### Configuration
601
635
-```bash
636
-sudo -u netdata ./ibm.d.plugin -d -m websphere_pmi
637
-```
602
+#### Options
603
639
-## Getting Logs
604
+Configuration options for the websphere_pmi collector.
605
641
-If you're encountering problems with the `websphere_pmi` collector, follow these steps to retrieve logs and identify potential issues:
606
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.
607
+<details open><summary>Config options</summary>
608
646
-### For systemd systems (most Linux distributions)
609
648
-```bash
649
-sudo journalctl -u netdata --reverse | grep websphere_pmi
650
-```
610
652
-### For non-systemd systems
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
655
-sudo grep websphere_pmi /var/log/netdata/error.log
656
-sudo grep websphere_pmi /var/log/netdata/collector.log
630
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
631
+sudo ./edit-config ibm.d/websphere_pmi.conf
632
```
633
659
-### For Docker containers
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
661
-```bash
662
-sudo docker logs netdata 2>&1 | grep websphere_pmi
647
```
648
+</details>
649
+
650
+