JMX Metrics
OpenTelemetry Java agent instrumentation
Collects and reports metrics exposed through Java Management Extensions (JMX). It can be configured to extract JVM and application-level telemetry data from JMX MBeans such as memory usage, thread counts, and garbage collection statistics, and translate these measurements into OpenTelemetry metrics. Collected metrics can be filtered by name using include and exclude patterns.
- Name:
jmx-metrics - Scope:
io.opentelemetry.jmx-metrics
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.jmx.config | list | List of paths to JMX metric definition YAML files. | |
otel.jmx.discovery.delay | int | 60000 | Time in milliseconds between JMX MBean detection attempts. |
otel.jmx.enabled | boolean | true | Enables collection of JMX metrics. |
otel.jmx.metrics.excluded | list | Comma-separated list of case-sensitive glob patterns for metric names not to collect. "*" matches any number of characters and "?" matches one character. Excluded patterns take precedence over included patterns. When no included patterns are configured, all metrics that are not excluded are collected. With neither selector property configured, all metrics are collected. | |
otel.jmx.metrics.experimental.included | list | Comma-separated list of case-sensitive glob patterns for unstable (experimental) bundled metric names to opt in to. "*" matches any number of characters and "?" matches one character. Normal metric include and exclude filters also apply. Custom metric definitions do not require experimental opt-in. | |
otel.jmx.metrics.included | list | Comma-separated list of case-sensitive glob patterns for metric names to collect. "*" matches any number of characters and "?" matches one character. Excluded patterns take precedence over included patterns. When no included patterns are configured, all metrics that are not excluded are collected. With neither selector property configured, all metrics are collected. | |
otel.jmx.target.system | list | Deprecated list of predefined JMX target systems to collect metrics for, including their unstable metrics. Used when otel.jmx.metrics.experimental.included is empty. A nonempty experimental inclusion takes precedence. Remove this setting to use automatic stable metric collection and select unstable metrics by name. This setting will be removed in 3.0. |