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

# IBM WebSphere MicroProfile


<img src="https://netdata.cloud/img/ibm.svg" width="150"/>


Plugin: ibm.d.plugin
Module: websphere_mp

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

## Overview

Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Liberty
servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint.


The collector connects to IBM WebSphere MicroProfile 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 MicroProfile monitoring interface is accessible.



### Configuration

#### Options

Configuration options for the websphere_mp 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_mp.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_mp.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 IBM WebSphere MicroProfile instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_mp.cpu_usage | JVM CPU Usage | process, utilization | percentage |
| websphere_mp.cpu_time | JVM CPU Time | total | seconds |


### Per IBM WebSphere MicroProfile instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_mp.jvm_memory_heap_usage | JVM Heap Memory Usage | used, free | bytes |
| websphere_mp.jvm_memory_heap_committed | JVM Heap Memory Committed | committed | bytes |
| websphere_mp.jvm_memory_heap_max | JVM Heap Memory Maximum | limit | bytes |
| websphere_mp.jvm_heap_utilization | JVM Heap Utilization | utilization | percentage |
| websphere_mp.jvm_gc_collections | JVM Garbage Collection Rate | rate | collections/s |
| websphere_mp.jvm_gc_time | JVM GC Time | total, per_cycle | milliseconds |
| websphere_mp.jvm_threads_current | JVM Current Threads | daemon, other | threads |
| websphere_mp.jvm_threads_peak | JVM Peak Threads | peak | threads |


### Per restendpoint

These metrics refer to restendpoint instances.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| method | Method identifier |
| endpoint | Endpoint identifier |

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_mp.rest_requests | REST Request Rate | requests | requests/s |
| websphere_mp.rest_response_time | REST Response Time | average | milliseconds |


### Per IBM WebSphere MicroProfile instance

These metrics refer to the entire monitored instance.

This scope has no labels.

Metrics:

| Metric | Description | Dimensions | Unit |
|:------|:------------|:----------|:----|
| websphere_mp.threadpool_usage | Thread Pool Usage | active, idle | threads |
| websphere_mp.threadpool_size | Thread Pool Size | size | threads |
