Skip to content

Commit 68cf3c4

Browse files
authored
move readme for jmx metrics (#13752)
1 parent 2449224 commit 68cf3c4

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

instrumentation/jmx-metrics/javaagent/README.md renamed to instrumentation/jmx-metrics/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To control the time interval between MBean detection attempts, one can use the `
1212

1313
## Predefined metrics
1414

15-
JMX is a popular metrics technology used throughout the JVM (see [runtime metrics](../../runtime-telemetry/runtime-telemetry-java8/library/README.md)), application servers, third-party libraries, and applications.
15+
JMX is a popular metrics technology used throughout the JVM (see [runtime metrics](../runtime-telemetry/runtime-telemetry-java8/library/README.md)), application servers, third-party libraries, and applications.
1616
JMX Metric Insight comes with a number of predefined configurations containing curated sets of JMX metrics for frequently used application servers or frameworks.
1717
To enable collection of the predefined metrics, specify a list of targets as the value for the `otel.jmx.target.system` property. For example
1818

@@ -25,13 +25,18 @@ $ java -javaagent:path/to/opentelemetry-javaagent.jar \
2525

2626
No targets are enabled by default. The supported target environments are listed below.
2727

28-
- [activemq](activemq.md)
29-
- [camel](camel.md)
30-
- [jetty](jetty.md)
31-
- [kafka-broker](kafka-broker.md)
32-
- [tomcat](tomcat.md)
33-
- [wildfly](wildfly.md)
34-
- [hadoop](hadoop.md)
28+
- [activemq](javaagent/activemq.md)
29+
- [camel](javaagent/camel.md)
30+
- [jetty](javaagent/jetty.md)
31+
- [kafka-broker](javaagent/kafka-broker.md)
32+
- [tomcat](javaagent/tomcat.md)
33+
- [wildfly](javaagent/wildfly.md)
34+
- [hadoop](javaagent/hadoop.md)
35+
36+
The [jvm](library/jvm.md) metrics definitions are also included in the [jmx-metrics library](./library)
37+
to allow reusing them without instrumentation. When using instrumentation, the [runtime-telemetry](../runtime-telemetry)
38+
instrumentation is used and recommended as it provides more metrics attributes that can't be captured
39+
through the YAML-based metric definitions.
3540

3641
## Configuration Files
3742

0 commit comments

Comments
 (0)