Skip to content

Commit 6e1400c

Browse files
committed
update doc and remove obsolete config option
1 parent c23fc0c commit 6e1400c

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

jmx-scraper/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Minimal configuration required
1616

1717
- `otel.jmx.service.url` for example `service:jmx:rmi:///jndi/rmi://server:9999/jmxrmi` for `server`
1818
host on port `9999` with RMI JMX connector.
19-
- `otel.jmx.target.system` or `otel.jmx.custom.scraping.config`
19+
- `otel.jmx.target.system` or `otel.jmx.config`
2020

2121
Configuration can be provided through:
2222

@@ -36,13 +36,13 @@ For example the `otel.jmx.service.url` option can be set with the `OTEL_JMX_SERV
3636

3737
## Configuration reference
3838

39-
| config option | description |
40-
|-----------------------------------|----------------------------------------------------------------------------------------------|
41-
| `otel.jmx.service.url` | mandatory JMX URL to connect to the remote JVM |
42-
| `otel.jmx.target.system` | comma-separated list of systems to monitor, mandatory unless a custom configuration is used |
43-
| `otel.jmx.custom.scraping.config` | path to a custom YAML metrics definition, mandatory when `otel.jmx.target.system` is not set |
44-
| `otel.jmx.username` | user name for JMX connection, mandatory when JMX authentication is enabled on target JVM |
45-
| `otel.jmx.password` | password for JMX connection, mandatory when JMX authentication is enabled on target JVM |
39+
| config option | description |
40+
|--------------------------|---------------------------------------------------------------------------------------------------------------------|
41+
| `otel.jmx.service.url` | mandatory JMX URL to connect to the remote JVM |
42+
| `otel.jmx.target.system` | comma-separated list of systems to monitor, mandatory unless a custom configuration is used |
43+
| `otel.jmx.config` | comma-separated list of paths to custom YAML metrics definition, mandatory when `otel.jmx.target.system` is not set |
44+
| `otel.jmx.username` | user name for JMX connection, mandatory when JMX authentication is enabled on target JVM |
45+
| `otel.jmx.password` | password for JMX connection, mandatory when JMX authentication is enabled on target JVM |
4646

4747
Supported values for `otel.jmx.target.system`:
4848

jmx-scraper/src/test/resources/validConfig.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
otel.jmx.service.url=service:jmx:rmi:///jndi/rmi://myhost:12345/jmxrmi
2-
otel.jmx.custom.scraping.config=/my/scraping-config.yaml
2+
otel.jmx.config=/my/scraping-config.yaml
33
otel.jmx.target.system=jvm,cassandra
44
otel.metrics.exporter=otlp
55
otel.metric.export.interval=1000

0 commit comments

Comments
 (0)