Skip to content

Commit bdc817e

Browse files
committed
mark as ready for prod + enhance wording
1 parent a2e4291 commit bdc817e

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

jmx-scraper/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ This utility provides a way to query JMX metrics and export them to an OTLP endp
44
The JMX MBeans and their metric mappings are defined in YAML and reuse implementation from
55
[jmx-metrics instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/jmx-metrics).
66

7-
This is currently a work-in-progress component not ready to be used in production.
8-
The end goal is to provide an alternative to the [JMX Gatherer](../jmx-metrics/README.md) utility.
7+
This is an alternative to the [JMX Gatherer](../jmx-metrics/README.md) utility.
98

109
## Usage
1110

@@ -154,22 +153,22 @@ Like with the JMX Gatherer, the selection of provided metrics to use is still do
154153
However, there is now two distinct sets of metrics to select from using the `otel.jmx.target.source` configuration option:
155154

156155
- `legacy`: [metrics definitions](./src/main/resources) equivalent to JMX Gatherer definitions to help transition and preserve compatibility
157-
- `instrumentation`: [metrics definitions inherited from instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/), which is now used as a reference for JMX metrics.
156+
- `instrumentation`: [metrics definitions inherited from instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/), which is now used as a reference for JMX metrics, those also aim to provide better alignment with [metrics semantic conventions](https://opentelemetry.io/docs/specs/semconv/general/metrics/).
158157

159158
In both cases, the metrics definitions themselves are embedded in the JMX Scraper binary, thus they
160159
will only change if the release version of the JMX Scraper binary changes.
161160

162161
By default, `otel.jmx.target.source` is `auto`, which means for each value of `otel.jmx.target.system`:
163162

164-
- metrics definitions from instrumentation will be used by default, if available
165-
- legacy metrics definitions equivalent to JMX Gatherer will be used as fallback
166-
- whenever new metrics definitions are being added or modified in instrumentation, those newer definitions will be used
163+
- Metrics definitions from instrumentation will be used by default, if available.
164+
- Legacy metrics definitions equivalent to JMX Gatherer will be used as fallback.
165+
- Whenever new metrics definitions are being added or modified in instrumentation, those newer definitions will be used.
167166

168-
There are multiple strategies depending on the ability or willingness to embrace change in metrics definitions:
167+
There are multiple possible strategies depending on the ability or willingness to embrace change in metrics definitions:
169168

170169
- To preserve maximum compatibility, using `legacy` is the recommended option, however it means to not benefit from future updates and contributions.
171-
- To only get the most recent definitions, using `instrumentation` ensures that none of the legacy definitions is used, only the "reference" from instrumentation, which could still evolve over time.
172-
- To embrace newer definitions whenever they become available, using `auto` is the recommended option, however it means the metrics produced could change when updating the version of JMX Scraper.
170+
- To only get the most recent definitions, using `instrumentation` ensures that none of the legacy definitions is used, only the reference from instrumentation, which could still evolve over time.
171+
- To embrace reference definitions whenever they become available, using `auto` is the recommended option, however it means the metrics produced could change when updating the version of JMX Scraper.
173172
- To handle more complex migration strategies or for tight control of metrics definitions, using copies of the YAML metrics definitions and providing them explicitly with `otel.jmx.config` is the recommended option.
174173

175174
## Component owners

0 commit comments

Comments
 (0)