Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 13d1f8e

Browse files
Merge pull request #2274 from splunk/urbiz-OD6394-note-jmx
[6394]: JMX notes
2 parents 08410f6 + c23f6dd commit 13d1f8e

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

gdi/monitors-languages/genericjmx.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ GenericJMX
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the GenericJMX monitor. See benefits, install, configuration, and metrics
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
10-
``genericjmx`` monitor to expose metrics on Java Management Extensions
11-
(JMX), a generic framework to provide and query management information.
12-
The interface is used by the Java Virtual Machine (JVM) to provide
13-
information about the memory used and threads. For a more flexible
14-
alternative, use :ref:`the JMX monitor <genericjmx>`
9+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``genericjmx`` monitor to expose metrics on Java Management Extensions (JMX), a generic framework to provide and query management information. The interface is used by the Java Virtual Machine (JVM) to provide
10+
information about the memory used and threads. For a more flexible alternative, use :ref:`the JMX monitor <genericjmx>`.
11+
12+
.. note:: To monitor JMX with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`jmx-receiver`.
1513

1614
This integration is only available on Kubernetes and Linux.
1715

gdi/monitors-languages/jmx.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,15 @@ JMX
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the JMX monitor. See benefits, install, configuration, and metrics. Run an arbitrary Groovy script to convert JMX MBeans fetched from a remote Java application to SignalFx data points
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
10-
``jmx`` monitor type to run an arbitrary Groovy script to convert JMX
11-
MBeans fetched from a remote Java application to SignalFx data points.
12-
This is a more flexible alternative to the
13-
:ref:`GenericJMX <genericjmx>` monitor.
9+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``jmx`` monitor type to run an arbitrary Groovy script to convert JMX MBeans fetched from a remote Java application to SignalFx data points. This is a more flexible alternative to the :ref:`GenericJMX <genericjmx>` monitor.
1410

15-
.. note:: If you are instrumenting an application with the Splunk Distribution of OpenTelemetry Java, you can capture metrics with the Java agent instead of using a JMX monitor. To learn more, see :ref:`enable_automatic_metric_collection`
11+
.. note::
12+
13+
To monitor JMX with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`jmx-receiver`.
1614

17-
You can use the following utility helpers in the Groovy script within
18-
the ``util`` variable, which is set in the script's context:
15+
If you are instrumenting an application with the Splunk Distribution of OpenTelemetry Java, you can capture metrics with the Java agent instead of using a JMX monitor. To learn more, see :ref:`enable_automatic_metric_collection`.
16+
17+
You can use the following utility helpers in the Groovy script within the ``util`` variable, which is set in the script's context:
1918

2019
- ``util.queryJMX(String objectName)``: This helper queries the
2120
configured JMX application for the given ``objectName``, which can

gdi/opentelemetry/components/jmx-receiver.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ JMX receiver
99

1010
The JMX receiver works in conjunction with the :new-page:`OpenTelemetry JMX Metric Gatherer <https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md>` to report metrics from an MBean server. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information.
1111

12+
.. note:: Out-of-the-box dashboards and navigators aren't supported for the Apache Web Server receiver yet, but are planned for a future release.
13+
1214
This receiver launches a child JRE process which runs the JMX Metric Gatherer configured with your specified JMX connection information and target built-in OTel-helper Groovy script. It then reports metrics to an implicitly created OTLP receiver.
1315

1416
In order to use the JMX receiver:
1517

16-
* Download the most recent release of the JMX Metric Gatherer JAR and configure the receiver with its path.
17-
* JRE must be available on your system.
18+
* Download the most recent release of the JMX Metric Gatherer JAR and configure the receiver with its path
19+
* JRE must be available on your system
1820

1921
Get started
2022
======================

0 commit comments

Comments
 (0)