Skip to content

Commit 7571966

Browse files
committed
add comment to suggest to review yaml files
1 parent 7673de0 commit 7571966

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

jmx-scraper/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,13 @@ By default, `otel.jmx.target.source` is `auto`, which means for each value of `o
167167
There are multiple possible strategies depending on the ability or willingness to embrace change in metrics definitions:
168168

169169
- To preserve maximum compatibility, using `legacy` is the recommended option, however it means to not benefit from future updates and contributions.
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.
170+
- To only get the most recent definitions, using `instrumentation` ensures that none of the legacy definitions is used, only the reference from instrumentation closer to semconv recommendations, those could still evolve over time.
171171
- 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.
172172
- 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.
173173

174+
When using `otel.target.source` = `auto` or `legacy`, one or more legacy definitions might be used. If strict compatibility with metrics produced by JMX Gatherer is required it is recommended to review
175+
the [legacy metrics definitions YAML files](./src/main/resources/) as they contain comments on the minor differences with JMX Gatherer Groovy definitions.
176+
174177
## Component owners
175178

176179
- [Jason Plumb](https://github.com/breedx-splk), Splunk

0 commit comments

Comments
 (0)