Skip to content

jmx-scraper replicate and document jmxmp/sasl config #1749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2025
Merged

jmx-scraper replicate and document jmxmp/sasl config #1749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6f2dc2
move terracotta repo to common settings
SylvainJuge Feb 19, 2025
9cb6f97
Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-c…
SylvainJuge Feb 20, 2025
54afabb
update documentation + add jmxmp lib
SylvainJuge Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions jmx-metrics/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@ otelJava.moduleName.set("io.opentelemetry.contrib.jmxmetrics")

application.mainClass.set("io.opentelemetry.contrib.jmxmetrics.JmxMetrics")

repositories {
mavenCentral()
maven {
setUrl("https://repo.terracotta.org/maven2")
content {
includeGroupByRegex("""org\.terracotta.*""")
}
}
}

val groovyVersion = "3.0.23"

dependencies {
Expand Down
18 changes: 10 additions & 8 deletions jmx-scraper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,16 @@ For example the `otel.jmx.service.url` option can be set with the `OTEL_JMX_SERV

## Configuration reference

| config option | default value | description |
|--------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| `otel.jmx.service.url` | - | mandatory JMX URL to connect to the remote JVM |
| `otel.jmx.target.system` | - | comma-separated list of systems to monitor, mandatory unless `otel.jmx.config` is set |
| `otel.jmx.config` | empty | comma-separated list of paths to custom YAML metrics definition, mandatory when `otel.jmx.target.system` is not set |
| `otel.jmx.username` | - | user name for JMX connection, mandatory when JMX authentication is set on target JVM with`com.sun.management.jmxremote.authenticate=true` |
| `otel.jmx.password` | - | password for JMX connection, mandatory when JMX authentication is set on target JVM with `com.sun.management.jmxremote.authenticate=true` |
| `otel.jmx.remote.registry.ssl` | `false` | connect to an SSL-protected registry when enabled on target JVM with `com.sun.management.jmxremote.registry.ssl=true` |
| config option | default value | description |
|--------------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `otel.jmx.service.url` | - | mandatory JMX URL to connect to the remote JVM |
| `otel.jmx.target.system` | - | comma-separated list of systems to monitor, mandatory unless `otel.jmx.config` is set |
| `otel.jmx.config` | empty | comma-separated list of paths to custom YAML metrics definition, mandatory when `otel.jmx.target.system` is not set |
| `otel.jmx.username` | - | user name for JMX connection, mandatory when JMX authentication is set on target JVM with`com.sun.management.jmxremote.authenticate=true` |
| `otel.jmx.password` | - | password for JMX connection, mandatory when JMX authentication is set on target JVM with `com.sun.management.jmxremote.authenticate=true` |
| `otel.jmx.remote.registry.ssl` | `false` | connect to an SSL-protected registry when enabled on target JVM with `com.sun.management.jmxremote.registry.ssl=true` |
| `otel.jmx.remote.profile` | - | SASL remote profile, supported values are `SASL/PLAIN`, `SASL/DIGEST-MD5`, `SASL/CRAM-MD5`, `TLS SASL/PLAIN`, `TLS SASL/DIGEST-MD5` and `TLS SASL/CRAM-MD5` |
| `otel.jmx.realm` | - | Realm required by profile `SASL/DIGEST-MD5` or `TLS SASL/DIGEST-MD5` |

When both `otel.jmx.target.system` and `otel.jmx.config` configuration options are used at the same time:

Expand Down
3 changes: 3 additions & 0 deletions jmx-scraper/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ dependencies {
runtimeOnly("io.opentelemetry:opentelemetry-exporter-otlp")
runtimeOnly("io.opentelemetry:opentelemetry-exporter-logging")

// for jmxmp protocol support
runtimeOnly("org.terracotta:jmxremote_optional-tc:1.0.8")

implementation("io.opentelemetry.instrumentation:opentelemetry-jmx-metrics")

testImplementation("org.junit-pioneer:junit-pioneer")
Expand Down
7 changes: 7 additions & 0 deletions settings.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ dependencyResolutionManagement {
repositories {
mavenCentral()
mavenLocal()
// terracotta repository for jmxmp connector
maven {
setUrl("https://repo.terracotta.org/maven2")
content {
includeGroupByRegex("""org\.terracotta.*""")
}
}
Comment on lines +18 to +23
Copy link
Contributor Author

@SylvainJuge SylvainJuge Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[for reviewer] moving this here allows to avoid duplication between gatherer and scraper to access this repository.

}
}

Expand Down
Loading