<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/jmx/README.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/ibm.d/modules/websphere/jmx/metadata.yaml"
sidebar_label: "IBM WebSphere JMX"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Collectors/Applications"
keywords: ['websphere_jmx']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# IBM WebSphere JMX

Plugin: ibm.d.plugin
Module: websphere_jmx

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application Server
via the embedded JMX bridge helper.


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


This collector is supported on all platforms.

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


### Default Behavior

#### Auto-Detection

This integration doesn't support auto-detection.

#### Limits

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

#### Performance Impact

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

## Setup


### Prerequisites

#### Enable monitoring interface

Ensure the IBM WebSphere JMX monitoring interface is accessible.



### Configuration

#### Options

Configuration options for the websphere_jmx collector.


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



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


</details>



#### via File

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


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
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).

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

##### Examples

###### Basic

Basic configuration example.

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

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

```
</details>



## Alerts

There are no alerts configured by default for this integration.



## Metrics

Metrics grouped by *scope*.

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




### Per applications

These metrics refer to applications instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| application | Application identifier |
| module | Module identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.app_requests | Application Requests | requests | requests |
| websphere_jmx.app_response_time | Application Response Time | response_time | milliseconds |
| websphere_jmx.app_sessions_active | Active Sessions | active | sessions |
| websphere_jmx.app_sessions_live | Live Sessions | live | sessions |
| websphere_jmx.app_session_events | Session Events | creates, invalidates | sessions |
| websphere_jmx.app_transactions | Application Transactions | committed, rolledback | transactions |


### Per jca

These metrics refer to jca instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| pool | Pool identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.jca_pool_size | JCA Pool Size | size | connections |
| websphere_jmx.jca_pool_usage | JCA Pool Usage | active, free | connections |
| websphere_jmx.jca_pool_wait_time | JCA Average Wait Time | wait | milliseconds |
| websphere_jmx.jca_pool_use_time | JCA Average Use Time | use | milliseconds |
| websphere_jmx.jca_pool_connections | JCA Connections Totals | created, destroyed | connections |
| websphere_jmx.jca_pool_waiting_threads | JCA Waiting Threads | waiting | threads |


### Per jdbc

These metrics refer to jdbc instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| pool | Pool identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.jdbc_pool_size | JDBC Pool Size | size | connections |
| websphere_jmx.jdbc_pool_usage | JDBC Pool Usage | active, free | connections |
| websphere_jmx.jdbc_pool_wait_time | JDBC Average Wait Time | wait | milliseconds |
| websphere_jmx.jdbc_pool_use_time | JDBC Average Use Time | use | milliseconds |
| websphere_jmx.jdbc_pool_connections | JDBC Connections Totals | created, destroyed | connections |
| websphere_jmx.jdbc_pool_waiting_threads | JDBC Waiting Threads | waiting | threads |


### Per jms

These metrics refer to jms instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| destination | Destination identifier |
| destination_type | Destination_type identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.jms_messages_current | JMS Messages Current Depth | current | messages |
| websphere_jmx.jms_messages_pending | JMS Messages Pending | pending | messages |
| websphere_jmx.jms_messages_total | JMS Messages Added Total | total | messages |
| websphere_jmx.jms_consumers | JMS Consumers | consumers | consumers |


### Per IBM WebSphere JMX instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.jvm_heap_memory | JVM Heap Memory | used, committed, max | bytes |
| websphere_jmx.jvm_heap_usage | JVM Heap Usage | usage | percentage |
| websphere_jmx.jvm_nonheap_memory | JVM Non-Heap Memory | used, committed | bytes |
| websphere_jmx.jvm_gc_count | JVM Garbage Collection Count | collections | collections |
| websphere_jmx.jvm_gc_time | JVM Garbage Collection Time | time | milliseconds |
| websphere_jmx.jvm_threads | JVM Threads | total, daemon | threads |
| websphere_jmx.jvm_thread_states | JVM Thread States | peak, started | threads |
| websphere_jmx.jvm_classes | JVM Classes | loaded, unloaded | classes |
| websphere_jmx.jvm_process_cpu_usage | JVM Process CPU Usage | cpu | percentage |
| websphere_jmx.jvm_uptime | JVM Uptime | uptime | seconds |


### Per threadpools

These metrics refer to threadpools instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| pool | Pool identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_jmx.threadpool_size | Thread Pool Size | size, max | threads |
| websphere_jmx.threadpool_active | Thread Pool Active Threads | active | threads |
