diff --git a/gdi/opentelemetry/components/jmx-receiver.rst b/gdi/opentelemetry/components/jmx-receiver.rst index 40dd504e8..1a42f243e 100644 --- a/gdi/opentelemetry/components/jmx-receiver.rst +++ b/gdi/opentelemetry/components/jmx-receiver.rst @@ -9,9 +9,14 @@ JMX receiver The JMX receiver works in conjunction with the :new-page:`OpenTelemetry JMX Metric Gatherer ` to report metrics from an MBean server. The supported pipeline type is ``metrics``. See :ref:`otel-data-processing` for more information. +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`. + .. note:: Out-of-the-box dashboards and navigators aren't supported for the JMX receiver yet, but are planned for a future release. -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. +Prerequisites +====================== + +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. In order to use the JMX receiver: @@ -77,7 +82,9 @@ This examples provides configuration details for the receiver: log_level: info additional_jars: - /path/to/other.jar - + +.. _jmx-receiver-advanced: + Advanced settings ----------------------------------------------- @@ -98,7 +105,9 @@ You can use the following advanced settings with the receiver: * ``target_system``. The built-in target system (or systems) metric gatherer script to run. - * Must be a subset of: ``"activemq"``, ``"cassandra"``, ``"hbase"``, ``"hadoop"``, ``"jetty"``, ``"jvm"``, ``"kafka"``, ``"kafka-consumer"``, ``"kafka-producer"``, ``"solr"``, ``"tomcat"``, or ``"wildfly"``. + * Possible values: ``"activemq"``, ``"cassandra"``, ``"hbase"``, ``"hadoop"``, ``"jetty"``, ``"jvm"``, ``"kafka"``, ``"kafka-consumer"``, ``"kafka-producer"``, ``"solr"``, ``"tomcat"``, or ``"wildfly"``. + + * You can specify multiple target systems at the same time: ``"target_system": "activemq, kafka,kafka-consumer"``. * 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.