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

Commit ef0e80e

Browse files
Merge pull request #2350 from splunk/urbiz-OD6271-cassandra-rx
[6271]: Cassandra rx
2 parents 4867f75 + 6457795 commit ef0e80e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

gdi/opentelemetry/components/jmx-receiver.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +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+
You can use the JMX receiver to monitor services such as Cassandra using the ``target_system`` setting. See more at :ref:`jmx-receiver-advanced` and :ref:`jmx-receiver-settings`.
13+
1214
.. note:: Out-of-the-box dashboards and navigators aren't supported for the JMX receiver yet, but are planned for a future release.
1315

14-
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.
16+
Prerequisites
17+
======================
18+
19+
The 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.
1520

1621
In order to use the JMX receiver:
1722

@@ -77,7 +82,9 @@ This examples provides configuration details for the receiver:
7782
log_level: info
7883
additional_jars:
7984
- /path/to/other.jar
80-
85+
86+
.. _jmx-receiver-advanced:
87+
8188
Advanced settings
8289
-----------------------------------------------
8390

@@ -98,7 +105,9 @@ You can use the following advanced settings with the receiver:
98105

99106
* ``target_system``. The built-in target system (or systems) metric gatherer script to run.
100107

101-
* Must be a subset of: ``"activemq"``, ``"cassandra"``, ``"hbase"``, ``"hadoop"``, ``"jetty"``, ``"jvm"``, ``"kafka"``, ``"kafka-consumer"``, ``"kafka-producer"``, ``"solr"``, ``"tomcat"``, or ``"wildfly"``.
108+
* Possible values: ``"activemq"``, ``"cassandra"``, ``"hbase"``, ``"hadoop"``, ``"jetty"``, ``"jvm"``, ``"kafka"``, ``"kafka-consumer"``, ``"kafka-producer"``, ``"solr"``, ``"tomcat"``, or ``"wildfly"``.
109+
110+
* You can specify multiple target systems at the same time: ``"target_system": "activemq, kafka,kafka-consumer"``.
102111

103112
* If you need to support additional target systems because of a custom JMX metrics gatherer jar configured using the ``MetricsGathererHash`` build time config, add them with another build time flag. It corresponds to the ``otel.jmx.target.system`` property.
104113

0 commit comments

Comments
 (0)