From c6f8dd52258b8afa493a4908fd16013daa93f914 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Wed, 25 Jun 2025 07:53:02 -0400 Subject: [PATCH 1/5] more --- docs/instrumentation-list.yaml | 303 ++++++++++++++++++ instrumentation-docs/collect.sh | 122 +++---- .../library/build.gradle.kts | 7 + .../armeria-1.3/javaagent/build.gradle.kts | 2 + .../javaagent/build.gradle.kts | 3 + .../javaagent/build.gradle.kts | 3 + .../javaagent/build.gradle.kts | 3 + .../finatra-2.9/javaagent/build.gradle.kts | 5 + 8 files changed, 390 insertions(+), 58 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 2531a97646a9..fe149a90f9e6 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -596,6 +596,45 @@ libraries: target_versions: library: - org.apache.httpcomponents.client5:httpclient5:5.2.1 + telemetry: + - when: default + metrics: + - name: http.client.request.duration + description: Duration of HTTP client requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + spans: + - span_kind: CLIENT + attributes: + - name: error.type + type: STRING + - name: http.request.method + type: STRING + - name: http.request.method_original + type: STRING + - name: http.request.resend_count + type: LONG + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: url.full + type: STRING - name: apache-shenyu-2.4 source_path: instrumentation/apache-shenyu-2.4 scope: @@ -618,6 +657,90 @@ libraries: - com.linecorp.armeria:armeria:[1.3.0,) library: - com.linecorp.armeria:armeria:1.3.0 + telemetry: + - when: default + metrics: + - name: http.client.request.duration + description: Duration of HTTP client requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: http.server.request.duration + description: Duration of HTTP server requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: http.route + type: STRING + - name: network.protocol.version + type: STRING + - name: url.scheme + type: STRING + spans: + - span_kind: CLIENT + attributes: + - name: error.type + type: STRING + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.peer.address + type: STRING + - name: network.peer.port + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: url.full + type: STRING + - span_kind: SERVER + attributes: + - name: client.address + type: STRING + - name: error.type + type: STRING + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: http.route + type: STRING + - name: network.peer.address + type: STRING + - name: network.peer.port + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: url.path + type: STRING + - name: url.query + type: STRING + - name: url.scheme + type: STRING + - name: user_agent.original + type: STRING - name: armeria-grpc-1.14 source_path: instrumentation/armeria/armeria-grpc-1.14 scope: @@ -633,6 +756,39 @@ libraries: target_versions: javaagent: - com.ning:async-http-client:[1.9.0,) + telemetry: + - when: default + metrics: + - name: http.client.request.duration + description: Duration of HTTP client requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: server.address + type: STRING + - name: server.port + type: LONG + spans: + - span_kind: CLIENT + attributes: + - name: error.type + type: STRING + - name: http.request.method + type: STRING + - name: http.request.method_original + type: STRING + - name: http.response.status_code + type: LONG + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: url.full + type: STRING - name: async-http-client-2.0 source_path: instrumentation/async-http-client/async-http-client-2.0 scope: @@ -640,6 +796,47 @@ libraries: target_versions: javaagent: - org.asynchttpclient:async-http-client:[2.0.0,) + telemetry: + - when: default + metrics: + - name: http.client.request.duration + description: Duration of HTTP client requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + spans: + - span_kind: CLIENT + attributes: + - name: error.type + type: STRING + - name: http.request.method + type: STRING + - name: http.request.method_original + type: STRING + - name: http.response.status_code + type: LONG + - name: network.peer.address + type: STRING + - name: network.peer.port + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: url.full + type: STRING avaje: - name: avaje-jex-3.0 description: | @@ -1202,6 +1399,87 @@ libraries: javaagent: - com.twitter:finagle-http_2.13:[23.11.0,] - com.twitter:finagle-http_2.12:[23.11.0,] + telemetry: + - when: otel.instrumentation.http.client.emit-experimental-telemetry=true,otel.instrumentation.http.server.emit-experimental-telemetry=true + metrics: + - name: http.client.request.duration + description: Duration of HTTP client requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: http.client.response.body.size + description: Size of HTTP client response bodies. + type: HISTOGRAM + unit: By + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: server.address + type: STRING + - name: server.port + type: LONG + - name: http.server.active_requests + description: Number of active HTTP server requests. + type: LONG_SUM + unit: requests + attributes: + - name: http.request.method + type: STRING + - name: url.scheme + type: STRING + - name: http.server.request.body.size + description: Size of HTTP server request bodies. + type: HISTOGRAM + unit: By + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: url.scheme + type: STRING + - name: http.server.request.duration + description: Duration of HTTP server requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: url.scheme + type: STRING + - name: http.server.response.body.size + description: Size of HTTP server response bodies. + type: HISTOGRAM + unit: By + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: network.protocol.version + type: STRING + - name: url.scheme + type: STRING finatra: - name: finatra-2.9 source_path: instrumentation/finatra-2.9 @@ -1211,6 +1489,31 @@ libraries: javaagent: - com.twitter:finatra-http_2.11:[2.9.0,] - com.twitter:finatra-http_2.12:[2.9.0,] + telemetry: + - when: -Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true + metrics: + - name: http.server.request.duration + description: Duration of HTTP server requests. + type: HISTOGRAM + unit: s + attributes: + - name: http.request.method + type: STRING + - name: http.response.status_code + type: LONG + - name: http.route + type: STRING + - name: network.protocol.version + type: STRING + - name: url.scheme + type: STRING + spans: + - span_kind: INTERNAL + attributes: + - name: code.function + type: STRING + - name: code.namespace + type: STRING geode: - name: geode-1.4 source_path: instrumentation/geode-1.4 diff --git a/instrumentation-docs/collect.sh b/instrumentation-docs/collect.sh index 832b3626a880..0a41a3b4efed 100755 --- a/instrumentation-docs/collect.sh +++ b/instrumentation-docs/collect.sh @@ -14,64 +14,70 @@ fi readonly INSTRUMENTATIONS=( # : : [ gradle-task-suffix ] - "activej-http-6.0:javaagent:test" - "akka:akka-http-10.0:javaagent:test" - "apache-httpasyncclient-4.1:javaagent:test" - "alibaba-druid-1.0:javaagent:test" - "alibaba-druid-1.0:javaagent:testStableSemconv" - "apache-dbcp-2.0:javaagent:test" - "apache-dbcp-2.0:javaagent:testStableSemconv" - "apache-httpclient:apache-httpclient-2.0:javaagent:test" - "apache-httpclient:apache-httpclient-4.0:javaagent:test" - "apache-httpclient:apache-httpclient-4.3:library:test" - "apache-httpclient:apache-httpclient-5.0:javaagent:test" - "apache-dubbo-2.7:javaagent:testDubbo" - "c3p0-0.9:javaagent:test" - "c3p0-0.9:javaagent:testStableSemconv" - "clickhouse-client-0.5:javaagent:test" - "clickhouse-client-0.5:javaagent:testStableSemconv" - "aws-sdk:aws-sdk-1.11:javaagent:test" - "google-http-client-1.19:javaagent:test" - "http-url-connection:javaagent:test" - "java-http-client:javaagent:test" - "jetty-httpclient:jetty-httpclient-9.2:javaagent:test" - "jetty-httpclient:jetty-httpclient-12.0:javaagent:test" - "jodd-http-4.2:javaagent:test" - "netty:netty-3.8:javaagent:test" - "netty:netty-4.0:javaagent:test" - "netty:netty-4.1:javaagent:test" - "okhttp:okhttp-2.2:javaagent:test" - "okhttp:okhttp-3.0:javaagent:test" - "pekko:pekko-http-1.0:javaagent:test" - "play:play-ws:play-ws-1.0:javaagent:test" - "play:play-ws:play-ws-2.0:javaagent:test" - "play:play-ws:play-ws-2.1:javaagent:test" - "reactor:reactor-netty:reactor-netty-0.9:javaagent:test" - "reactor:reactor-netty:reactor-netty-1.0:javaagent:test" - "spring:spring-webflux:spring-webflux-5.0:javaagent:test" - "vertx:vertx-http-client:vertx-http-client-3.0:javaagent:test" - "vertx:vertx-http-client:vertx-http-client-4.0:javaagent:test" - "vertx:vertx-http-client:vertx-http-client-5.0:javaagent:test" - "vertx:vertx-redis-client-4.0:javaagent:test" - "vertx:vertx-redis-client-4.0:javaagent:testStableSemconv" - "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:test" - "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv" - "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:test" - "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:testStableSemconv" - "aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv" - "aws-sdk:aws-sdk-2.2:javaagent:test" - "aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv" - "aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime" - "hikaricp-3.0:javaagent:test" - "hikaricp-3.0:javaagent:testStableSemconv" - "tomcat:tomcat-jdbc:javaagent:test" - "tomcat:tomcat-jdbc:javaagent:testStableSemconv" - "oracle-ucp-11.2:javaagent:test" - "oracle-ucp-11.2:javaagent:testStableSemconv" - "oshi:javaagent:test" - "oshi:javaagent:testExperimental" - "vibur-dbcp-11.0:javaagent:test" - "vibur-dbcp-11.0:javaagent:testStableSemconv" +# "activej-http-6.0:javaagent:test" +# "akka:akka-http-10.0:javaagent:test" +# "apache-httpasyncclient-4.1:javaagent:test" +# "alibaba-druid-1.0:javaagent:test" +# "alibaba-druid-1.0:javaagent:testStableSemconv" +# "apache-dbcp-2.0:javaagent:test" +# "apache-dbcp-2.0:javaagent:testStableSemconv" +# "apache-httpclient:apache-httpclient-2.0:javaagent:test" +# "apache-httpclient:apache-httpclient-4.0:javaagent:test" +# "apache-httpclient:apache-httpclient-4.3:library:test" +# "apache-httpclient:apache-httpclient-5.0:javaagent:test" +# "apache-httpclient:apache-httpclient-5.2:library:test" +# "armeria:armeria-1.3:javaagent:test" +# "async-http-client:async-http-client-1.9:javaagent:test" +# "async-http-client:async-http-client-2.0:javaagent:test" +# "apache-dubbo-2.7:javaagent:testDubbo" +# "c3p0-0.9:javaagent:test" +# "c3p0-0.9:javaagent:testStableSemconv" +# "clickhouse-client-0.5:javaagent:test" +# "clickhouse-client-0.5:javaagent:testStableSemconv" +# "aws-sdk:aws-sdk-1.11:javaagent:test" +# "google-http-client-1.19:javaagent:test" +# "http-url-connection:javaagent:test" +# "java-http-client:javaagent:test" +# "jetty-httpclient:jetty-httpclient-9.2:javaagent:test" +# "jetty-httpclient:jetty-httpclient-12.0:javaagent:test" +# "jodd-http-4.2:javaagent:test" +# "netty:netty-3.8:javaagent:test" +# "netty:netty-4.0:javaagent:test" +# "netty:netty-4.1:javaagent:test" +# "okhttp:okhttp-2.2:javaagent:test" +# "okhttp:okhttp-3.0:javaagent:test" +# "pekko:pekko-http-1.0:javaagent:test" +# "play:play-ws:play-ws-1.0:javaagent:test" +# "play:play-ws:play-ws-2.0:javaagent:test" +# "play:play-ws:play-ws-2.1:javaagent:test" +# "reactor:reactor-netty:reactor-netty-0.9:javaagent:test" +# "reactor:reactor-netty:reactor-netty-1.0:javaagent:test" +# "spring:spring-webflux:spring-webflux-5.0:javaagent:test" +# "vertx:vertx-http-client:vertx-http-client-3.0:javaagent:test" +# "vertx:vertx-http-client:vertx-http-client-4.0:javaagent:test" +# "vertx:vertx-http-client:vertx-http-client-5.0:javaagent:test" +# "vertx:vertx-redis-client-4.0:javaagent:test" +# "vertx:vertx-redis-client-4.0:javaagent:testStableSemconv" +# "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:test" +# "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv" +# "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:test" +# "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:testStableSemconv" +# "aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv" +# "aws-sdk:aws-sdk-2.2:javaagent:test" +# "aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv" +# "aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime" +# "hikaricp-3.0:javaagent:test" +# "hikaricp-3.0:javaagent:testStableSemconv" +# "tomcat:tomcat-jdbc:javaagent:test" +# "tomcat:tomcat-jdbc:javaagent:testStableSemconv" +# "oracle-ucp-11.2:javaagent:test" +# "oracle-ucp-11.2:javaagent:testStableSemconv" +# "finagle-http-23.11:javaagent:test" + "finatra-2.9:javaagent:test" +# "oshi:javaagent:test" +# "oshi:javaagent:testExperimental" +# "vibur-dbcp-11.0:javaagent:test" +# "vibur-dbcp-11.0:javaagent:testStableSemconv" ) readonly TELEMETRY_DIR_NAME=".telemetry" diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/build.gradle.kts b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/build.gradle.kts index f395a7dc5b4d..f77bb9d13b72 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/build.gradle.kts +++ b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/build.gradle.kts @@ -7,3 +7,10 @@ plugins { dependencies { library("org.apache.httpcomponents.client5:httpclient5:5.2.1") } + +tasks { + test { + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) + } +} diff --git a/instrumentation/armeria/armeria-1.3/javaagent/build.gradle.kts b/instrumentation/armeria/armeria-1.3/javaagent/build.gradle.kts index 0966fc900a7a..56c3b19b085a 100644 --- a/instrumentation/armeria/armeria-1.3/javaagent/build.gradle.kts +++ b/instrumentation/armeria/armeria-1.3/javaagent/build.gradle.kts @@ -27,5 +27,7 @@ dependencies { tasks { withType().configureEach { systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean) + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) } } diff --git a/instrumentation/async-http-client/async-http-client-1.9/javaagent/build.gradle.kts b/instrumentation/async-http-client/async-http-client-1.9/javaagent/build.gradle.kts index 47e8d3d6a87b..e63e6fab8825 100644 --- a/instrumentation/async-http-client/async-http-client-1.9/javaagent/build.gradle.kts +++ b/instrumentation/async-http-client/async-http-client-1.9/javaagent/build.gradle.kts @@ -27,5 +27,8 @@ tasks { jvmArgs("-XX:+IgnoreUnrecognizedVMOptions") systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean) + + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) } } diff --git a/instrumentation/async-http-client/async-http-client-2.0/javaagent/build.gradle.kts b/instrumentation/async-http-client/async-http-client-2.0/javaagent/build.gradle.kts index 9c573a0fd4ec..2d00298ac42a 100644 --- a/instrumentation/async-http-client/async-http-client-2.0/javaagent/build.gradle.kts +++ b/instrumentation/async-http-client/async-http-client-2.0/javaagent/build.gradle.kts @@ -39,6 +39,9 @@ tasks.withType().configureEach { if (latestDepTest && testJavaVersion.isJava8) { enabled = false } + + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) } // async-http-client 2.0.0 does not work with Netty versions newer than this due to referencing an diff --git a/instrumentation/finagle-http-23.11/javaagent/build.gradle.kts b/instrumentation/finagle-http-23.11/javaagent/build.gradle.kts index 0d6b4fefd3ab..bf29b5e537f5 100644 --- a/instrumentation/finagle-http-23.11/javaagent/build.gradle.kts +++ b/instrumentation/finagle-http-23.11/javaagent/build.gradle.kts @@ -44,5 +44,8 @@ tasks { test { jvmArgs("-Dotel.instrumentation.http.client.emit-experimental-telemetry=true") jvmArgs("-Dotel.instrumentation.http.server.emit-experimental-telemetry=true") + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) + systemProperty("metaDataConfig", "otel.instrumentation.http.client.emit-experimental-telemetry=true,otel.instrumentation.http.server.emit-experimental-telemetry=true") } } diff --git a/instrumentation/finatra-2.9/javaagent/build.gradle.kts b/instrumentation/finatra-2.9/javaagent/build.gradle.kts index fa42693b732c..6f66c1b9c1f5 100644 --- a/instrumentation/finatra-2.9/javaagent/build.gradle.kts +++ b/instrumentation/finatra-2.9/javaagent/build.gradle.kts @@ -86,5 +86,10 @@ tasks { jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED") jvmArgs("-XX:+IgnoreUnrecognizedVMOptions") jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true") + + systemProperty("metaDataConfig", "otel.instrumentation.common.experimental.controller-telemetry.enabled=true") + + systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false") + systemProperty("collectSpans", true) } } From c313a12acef7e20894ced8cfad82a5abfa459df1 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Fri, 11 Jul 2025 13:57:14 -0400 Subject: [PATCH 2/5] descriptions --- .gemini/descriptions.md | 32 +++++++++++++++++++ .../apache-httpclient-5.0/metadata.yaml | 1 + .../library/metadata.yaml | 1 + .../apache-httpclient-5.2/metadata.yaml | 1 + 4 files changed, 35 insertions(+) create mode 100644 .gemini/descriptions.md create mode 100644 instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml create mode 100644 instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml create mode 100644 instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml diff --git a/.gemini/descriptions.md b/.gemini/descriptions.md new file mode 100644 index 000000000000..d81cf9600c63 --- /dev/null +++ b/.gemini/descriptions.md @@ -0,0 +1,32 @@ +# metadata.yaml Description Guidelines + +When investigating what a module does, you can find the code within the directory given. There should be a subdirectory for either a javaagent or library or both. +the gradle files will be located within each submodule: + +for example: /Users/jay/code/projects/opentelemetry-java-instrumentation/instrumentation/apache-httpclient/apache-httpclient-5.2/library/build.gradle.kts + +Key guidelines for writing descriptions in `metadata.yaml` files: + +1. **Clarity on Telemetry Generation:** + * Explicitly state whether the instrumentation generates new telemetry (spans, metrics, logs) on its own. + * If it *doesn't* generate new telemetry, clearly explain that it *augments* or *enriches* existing telemetry produced by other instrumentations (e.g., by adding attributes or ensuring context propagation). + +2. **Avoid Implementation Details:** + * Do not include specific method names, class names, or other low-level implementation details in the description. Focus on the *what* and *why* of the instrumentation, not the *how*. + +3. **Adhere to Style and Formatting:** + * Respect line length limits (e.g., 100 characters as per `.editorconfig`). + * Use appropriate line breaks to ensure readability and adherence to the repository's style. + +4. **No Explicit Version Numbers:** + * Do not include specific library or framework version numbers in the description. This information should be documented elsewhere (e.g., in `muzzle` rules or other documentation). The description should be more general about the instrumentation's purpose. + +# Generating test telemetry + +Sometimes in order to get more information about the telemetry emitted by an instrumentation, we need to run tests that exercise the code paths that generate the telemetry. This is especially true for spans and metrics. + +You can generate this telemetry by running the tests in the instrumentation module. To do this, you need to set the `collectMetadata` property to `true` in your Gradle command. For example: + +```bash +./gradlew :instrumentation-module-name:test -PcollectMetadata=true +``` diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml new file mode 100644 index 000000000000..a8c29faeb961 --- /dev/null +++ b/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml @@ -0,0 +1 @@ +description: This instrumentation provides CLIENT spans and metrics for version 5 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml new file mode 100644 index 000000000000..8a1d021ba818 --- /dev/null +++ b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml @@ -0,0 +1 @@ +description: This instrumentation provides CLIENT spans and metrics for the Apache HttpAsyncClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml new file mode 100644 index 000000000000..7ca71c47fe24 --- /dev/null +++ b/instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml @@ -0,0 +1 @@ +description: This instrumentation provides a library integration that enables CLIENT spans and metrics for the Apache HttpClient. From c9bad119bccfd1ef9372ec2a5b84bff95d859902 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Tue, 15 Jul 2025 20:51:10 -0400 Subject: [PATCH 3/5] merge main --- docs/instrumentation-list.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 9d2f0c4336d6..f16def5e143a 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -2441,6 +2441,8 @@ libraries: - org.apache.tomcat:tomcat-jasper:[7.0.19,10) kafka: - name: kafka-clients-0.11 + description: | + This instrumentation provides messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption. source_path: instrumentation/kafka/kafka-clients/kafka-clients-0.11 scope: name: io.opentelemetry.kafka-clients-0.11 @@ -2456,7 +2458,17 @@ libraries: description: Enables the capture of the experimental consumer attribute "kafka.record.queue_time_ms" type: boolean default: false + - name: otel.instrumentation.messaging.experimental.capture-headers + description: A comma-separated list of header names to capture as span attributes. + type: list + default: '' + - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled + description: Enables experimental receive telemetry for Kafka instrumentation. + type: boolean + default: false - name: kafka-clients-2.6 + description: | + This instrumentation provides a library integeration that enables messaging spans and metrics for Apache Kafka 2.6+ clients. source_path: instrumentation/kafka/kafka-clients/kafka-clients-2.6 scope: name: io.opentelemetry.kafka-clients-2.6 @@ -4212,6 +4224,10 @@ internal: source_path: instrumentation/internal/internal-reflection scope: name: io.opentelemetry.internal-reflection +- name: opentelemetry-api-1.52 + source_path: instrumentation/opentelemetry-api/opentelemetry-api-1.52 + scope: + name: io.opentelemetry.opentelemetry-api-1.52 - name: opentelemetry-instrumentation-api source_path: instrumentation/opentelemetry-instrumentation-api scope: From ab83554b93794cf7100df12efd2aa9e88a4c61b2 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Wed, 16 Jul 2025 07:09:51 -0400 Subject: [PATCH 4/5] be consistent with wording in descriptions, address code review comments --- docs/instrumentation-list.yaml | 50 +++++++++---------- .../activej-http-6.0/metadata.yaml | 2 +- instrumentation/apache-dbcp-2.0/metadata.yaml | 2 +- .../apache-httpasyncclient-4.1/metadata.yaml | 2 +- .../apache-httpclient-2.0/metadata.yaml | 2 +- .../apache-httpclient-4.0/metadata.yaml | 2 +- .../apache-httpclient-5.0/metadata.yaml | 2 +- .../library/metadata.yaml | 2 +- .../apache-shenyu-2.4/metadata.yaml | 8 +-- .../armeria/armeria-1.3/metadata.yaml | 2 +- .../armeria/armeria-grpc-1.14/metadata.yaml | 2 +- .../async-http-client-1.9/metadata.yaml | 2 +- .../async-http-client-2.0/metadata.yaml | 2 +- instrumentation/camel-2.20/metadata.yaml | 2 +- .../metadata.yaml | 2 +- .../elasticsearch-rest-5.0/metadata.yaml | 4 +- .../elasticsearch-rest-6.4/metadata.yaml | 4 +- .../elasticsearch-rest-7.0/metadata.yaml | 4 +- .../elasticsearch-transport-5.0/metadata.yaml | 2 +- .../elasticsearch-transport-5.3/metadata.yaml | 2 +- .../elasticsearch-transport-6.0/metadata.yaml | 2 +- .../kafka-clients-0.11/metadata.yaml | 2 +- 22 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index f16def5e143a..141402e3542a 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -5,7 +5,7 @@ libraries: activej: - name: activej-http-6.0 - description: This instrumentation provides SERVER spans and metrics for the ActiveJ + description: this instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server. source_path: instrumentation/activej-http-6.0 minimum_java_version: 17 @@ -260,7 +260,7 @@ libraries: apache: - name: apache-dbcp-2.0 description: | - This instrumentation provides database connection pools metrics for Apache DBCP. + this instrumentation enables database connection pools metrics for Apache DBCP. The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default. source_path: instrumentation/apache-dbcp-2.0 scope: @@ -382,7 +382,7 @@ libraries: - name: rpc.system type: STRING - name: apache-httpasyncclient-4.1 - description: This instrumentation provides CLIENT spans and metrics for the Apache + description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. source_path: instrumentation/apache-httpasyncclient-4.1 scope: @@ -428,7 +428,7 @@ libraries: - name: url.full type: STRING - name: apache-httpclient-2.0 - description: This instrumentation provides CLIENT spans and metrics for versions + description: this instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. source_path: instrumentation/apache-httpclient/apache-httpclient-2.0 scope: @@ -472,7 +472,7 @@ libraries: - name: url.full type: STRING - name: apache-httpclient-4.0 - description: This instrumentation provides CLIENT spans and metrics for version + description: this instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient. source_path: instrumentation/apache-httpclient/apache-httpclient-4.0 scope: @@ -567,7 +567,7 @@ libraries: - name: url.full type: STRING - name: apache-httpclient-5.0 - description: This instrumentation provides CLIENT spans and metrics for version + description: This instrumentation enables CLIENT spans and metrics for version 5 of the Apache HttpClient. source_path: instrumentation/apache-httpclient/apache-httpclient-5.0 scope: @@ -662,7 +662,7 @@ libraries: type: STRING - name: apache-shenyu-2.4 description: | - This instrumentation does not emit telemetry on its own. Instead, it hooks into the Shenyu Context and extracts meta data in order to attach it to existing SERVER spans and HTTP server metrics. + This instrumentation does not emit telemetry on its own. Instead, it augments existing SERVER spans and HTTP server metrics with the HTTP route and Shenyu specific attributes. source_path: instrumentation/apache-shenyu-2.4 scope: name: io.opentelemetry.apache-shenyu-2.4 @@ -672,13 +672,13 @@ libraries: configurations: - name: otel.instrumentation.apache-shenyu.experimental-span-attributes description: | - Enables experimental `apache-shenyu.meta.` prefixed span attributes like `app-name`, `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path`, and `rpc-ext`. + Enables experimental `apache-shenyu.meta.` prefixed span attributes `app-name`, `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path` and `rpc-ext`. type: boolean default: false armeria: - name: armeria-1.3 - description: This instrumentation enables CLIENT spans and metrics for the Armeria - HTTP client and server. + description: This instrumentation enables CLIENT and SERVER spans and metrics + for the Armeria HTTP client and server. source_path: instrumentation/armeria/armeria-1.3 scope: name: io.opentelemetry.armeria-1.3 @@ -772,8 +772,8 @@ libraries: - name: user_agent.original type: STRING - name: armeria-grpc-1.14 - description: This instrumentation enables CLIENT spans and metrics for the Armeria - gRPC client and server. + description: This instrumentation enables CLIENT and SERVER spans and metrics + for the Armeria gRPC client and server. source_path: instrumentation/armeria/armeria-grpc-1.14 scope: name: io.opentelemetry.armeria-grpc-1.14 @@ -782,7 +782,7 @@ libraries: - com.linecorp.armeria:armeria-grpc:[1.14.0,) async: - name: async-http-client-1.9 - description: This instrumentation provides CLIENT spans and metrics for version + description: This instrumentation enables CLIENT spans and metrics for version 1 of the AsyncHttpClient (AHC) HTTP client. source_path: instrumentation/async-http-client/async-http-client-1.9 scope: @@ -824,7 +824,7 @@ libraries: - name: url.full type: STRING - name: async-http-client-2.0 - description: This instrumentation provides CLIENT spans and metrics for version + description: This instrumentation enables CLIENT spans and metrics for version 2 of the AsyncHttpClient (AHC) HTTP client. source_path: instrumentation/async-http-client/async-http-client-2.0 scope: @@ -1119,7 +1119,7 @@ libraries: camel: - name: camel-2.20 description: | - This instrumentation provides tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. + this instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. source_path: instrumentation/camel-2.20 scope: name: io.opentelemetry.camel-2.20 @@ -1333,9 +1333,9 @@ libraries: default: false elasticsearch: - name: elasticsearch-api-client-7.16 - description: This instrumentation provides client spans for Elasticsearch API - client requests for version 7 of the client. Versions 8.10 and later have native - support for OpenTelemetry. + description: this instrumentation enables client spans for Elasticsearch API client + requests for version 7 of the client. Versions 8.10 and later have native support + for OpenTelemetry. source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16 scope: name: io.opentelemetry.elasticsearch-api-client-7.16 @@ -1344,7 +1344,7 @@ libraries: - co.elastic.clients:elasticsearch-java:[7.16,7.17.20) - co.elastic.clients:elasticsearch-java:[8.0.0,8.10) - name: elasticsearch-rest-5.0 - description: This instrumentation provides tracing for Elasticsearch REST clients. + description: this instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0 scope: name: io.opentelemetry.elasticsearch-rest-5.0 @@ -1375,7 +1375,7 @@ libraries: - name: url.full type: STRING - name: elasticsearch-rest-6.4 - description: This instrumentation provides tracing for Elasticsearch REST clients. + description: this instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4 scope: name: io.opentelemetry.elasticsearch-rest-6.4 @@ -1404,7 +1404,7 @@ libraries: - name: url.full type: STRING - name: elasticsearch-rest-7.0 - description: This instrumentation provides tracing for Elasticsearch REST clients. + description: this instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0 scope: name: io.opentelemetry.elasticsearch-rest-7.0 @@ -1436,7 +1436,7 @@ libraries: type: STRING - name: elasticsearch-transport-5.0 description: | - This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0 scope: name: io.opentelemetry.elasticsearch-transport-5.0 @@ -1512,7 +1512,7 @@ libraries: type: LONG - name: elasticsearch-transport-5.3 description: | - This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3 scope: name: io.opentelemetry.elasticsearch-transport-5.3 @@ -1598,7 +1598,7 @@ libraries: type: LONG - name: elasticsearch-transport-6.0 description: | - This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0 scope: name: io.opentelemetry.elasticsearch-transport-6.0 @@ -2442,7 +2442,7 @@ libraries: kafka: - name: kafka-clients-0.11 description: | - This instrumentation provides messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption. + This instrumentation enables messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption. source_path: instrumentation/kafka/kafka-clients/kafka-clients-0.11 scope: name: io.opentelemetry.kafka-clients-0.11 diff --git a/instrumentation/activej-http-6.0/metadata.yaml b/instrumentation/activej-http-6.0/metadata.yaml index d359736683f0..7810740c7d45 100644 --- a/instrumentation/activej-http-6.0/metadata.yaml +++ b/instrumentation/activej-http-6.0/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides SERVER spans and metrics for the ActiveJ HTTP server. +description: this instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server. diff --git a/instrumentation/apache-dbcp-2.0/metadata.yaml b/instrumentation/apache-dbcp-2.0/metadata.yaml index a7411e026fe3..874781d1b0dd 100644 --- a/instrumentation/apache-dbcp-2.0/metadata.yaml +++ b/instrumentation/apache-dbcp-2.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides database connection pools metrics for Apache DBCP. + this instrumentation enables database connection pools metrics for Apache DBCP. The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, diff --git a/instrumentation/apache-httpasyncclient-4.1/metadata.yaml b/instrumentation/apache-httpasyncclient-4.1/metadata.yaml index 8a1d021ba818..ed4743cd5be8 100644 --- a/instrumentation/apache-httpasyncclient-4.1/metadata.yaml +++ b/instrumentation/apache-httpasyncclient-4.1/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for the Apache HttpAsyncClient. +description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml index c9b610946760..5688c9723309 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. +description: this instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml index 517afd52ffaf..600d32ad970c 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for version 4 of the Apache HttpClient. +description: this instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml index a8c29faeb961..d5abba280e31 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for version 5 of the Apache HttpClient. +description: This instrumentation enables CLIENT spans and metrics for version 5 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml index 8a1d021ba818..ed4743cd5be8 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for the Apache HttpAsyncClient. +description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. diff --git a/instrumentation/apache-shenyu-2.4/metadata.yaml b/instrumentation/apache-shenyu-2.4/metadata.yaml index 010fc3f6bf16..54b38ebaf92c 100644 --- a/instrumentation/apache-shenyu-2.4/metadata.yaml +++ b/instrumentation/apache-shenyu-2.4/metadata.yaml @@ -1,11 +1,11 @@ description: > - This instrumentation does not emit telemetry on its own. Instead, it hooks into the Shenyu Context - and extracts meta data in order to attach it to existing SERVER spans and HTTP server metrics. + This instrumentation does not emit telemetry on its own. Instead, it augments existing SERVER + spans and HTTP server metrics with the HTTP route and Shenyu specific attributes. configurations: - name: otel.instrumentation.apache-shenyu.experimental-span-attributes description: > - Enables experimental `apache-shenyu.meta.` prefixed span attributes like `app-name`, - `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path`, and + Enables experimental `apache-shenyu.meta.` prefixed span attributes `app-name`, + `service-name`, `context-path`, `param-types`, `id`, `method-name`, `rpc-type`, `path` and `rpc-ext`. type: boolean default: false diff --git a/instrumentation/armeria/armeria-1.3/metadata.yaml b/instrumentation/armeria/armeria-1.3/metadata.yaml index 805eba091a2d..b58435f956a6 100644 --- a/instrumentation/armeria/armeria-1.3/metadata.yaml +++ b/instrumentation/armeria/armeria-1.3/metadata.yaml @@ -1 +1 @@ -description: This instrumentation enables CLIENT spans and metrics for the Armeria HTTP client and server. +description: This instrumentation enables CLIENT and SERVER spans and metrics for the Armeria HTTP client and server. diff --git a/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml b/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml index a6f591cc634b..480139208df6 100644 --- a/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml +++ b/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml @@ -1 +1 @@ -description: This instrumentation enables CLIENT spans and metrics for the Armeria gRPC client and server. +description: This instrumentation enables CLIENT and SERVER spans and metrics for the Armeria gRPC client and server. diff --git a/instrumentation/async-http-client/async-http-client-1.9/metadata.yaml b/instrumentation/async-http-client/async-http-client-1.9/metadata.yaml index e3a61bcff289..2badb74d86d4 100644 --- a/instrumentation/async-http-client/async-http-client-1.9/metadata.yaml +++ b/instrumentation/async-http-client/async-http-client-1.9/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for version 1 of the AsyncHttpClient (AHC) HTTP client. +description: This instrumentation enables CLIENT spans and metrics for version 1 of the AsyncHttpClient (AHC) HTTP client. diff --git a/instrumentation/async-http-client/async-http-client-2.0/metadata.yaml b/instrumentation/async-http-client/async-http-client-2.0/metadata.yaml index 6436b8546bfa..92cff9602ef9 100644 --- a/instrumentation/async-http-client/async-http-client-2.0/metadata.yaml +++ b/instrumentation/async-http-client/async-http-client-2.0/metadata.yaml @@ -1 +1 @@ -description: This instrumentation provides CLIENT spans and metrics for version 2 of the AsyncHttpClient (AHC) HTTP client. +description: This instrumentation enables CLIENT spans and metrics for version 2 of the AsyncHttpClient (AHC) HTTP client. diff --git a/instrumentation/camel-2.20/metadata.yaml b/instrumentation/camel-2.20/metadata.yaml index b3e34843018f..1f64815b7b57 100644 --- a/instrumentation/camel-2.20/metadata.yaml +++ b/instrumentation/camel-2.20/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides tracing for Apache Camel 2.x applications by generating spans for + this instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. configurations: diff --git a/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml index 83efc09a04c2..178b00f26ed1 100644 --- a/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml @@ -1,2 +1,2 @@ -description: This instrumentation provides client spans for Elasticsearch API client requests for +description: this instrumentation enables client spans for Elasticsearch API client requests for version 7 of the client. Versions 8.10 and later have native support for OpenTelemetry. diff --git a/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml index 2f50a9228ffb..645a6407eb33 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml @@ -1,8 +1,8 @@ -description: This instrumentation provides tracing for Elasticsearch REST clients. +description: this instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: | Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information. type: boolean - default: false \ No newline at end of file + default: false diff --git a/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml index 42af6c77f49e..3b24cb02c19a 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml @@ -1,8 +1,8 @@ -description: This instrumentation provides tracing for Elasticsearch REST clients. +description: this instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: > Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information. type: boolean - default: false \ No newline at end of file + default: false diff --git a/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml index 42af6c77f49e..3b24cb02c19a 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml @@ -1,8 +1,8 @@ -description: This instrumentation provides tracing for Elasticsearch REST clients. +description: this instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: > Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information. type: boolean - default: false \ No newline at end of file + default: false diff --git a/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml index 7a02d702e3ce..0279701cf8f5 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides client spans for Elasticsearch transport client requests. Each call + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes diff --git a/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml index 7a02d702e3ce..0279701cf8f5 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides client spans for Elasticsearch transport client requests. Each call + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes diff --git a/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml index 7a02d702e3ce..0279701cf8f5 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides client spans for Elasticsearch transport client requests. Each call + this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml index 5da6ed1a9c89..53601136d88a 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides messaging spans and metrics for Apache Kafka 0.11 clients. + This instrumentation enables messaging spans and metrics for Apache Kafka 0.11 clients. It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption. configurations: - name: otel.instrumentation.kafka.producer-propagation.enabled From e1ff9a8a9bdd321519e8c6a8c4c1bd0ea9317918 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Wed, 16 Jul 2025 07:11:24 -0400 Subject: [PATCH 5/5] fix capitalization --- docs/instrumentation-list.yaml | 26 +++++++++---------- .../activej-http-6.0/metadata.yaml | 2 +- instrumentation/apache-dbcp-2.0/metadata.yaml | 2 +- .../apache-httpasyncclient-4.1/metadata.yaml | 2 +- .../apache-httpclient-2.0/metadata.yaml | 2 +- .../apache-httpclient-4.0/metadata.yaml | 2 +- .../library/metadata.yaml | 2 +- instrumentation/camel-2.20/metadata.yaml | 2 +- .../metadata.yaml | 2 +- .../elasticsearch-rest-5.0/metadata.yaml | 2 +- .../elasticsearch-rest-6.4/metadata.yaml | 2 +- .../elasticsearch-rest-7.0/metadata.yaml | 2 +- .../elasticsearch-transport-5.0/metadata.yaml | 2 +- .../elasticsearch-transport-5.3/metadata.yaml | 2 +- .../elasticsearch-transport-6.0/metadata.yaml | 2 +- 15 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 141402e3542a..ce84a39bc10a 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -5,7 +5,7 @@ libraries: activej: - name: activej-http-6.0 - description: this instrumentation enables SERVER spans and metrics for the ActiveJ + description: This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server. source_path: instrumentation/activej-http-6.0 minimum_java_version: 17 @@ -260,7 +260,7 @@ libraries: apache: - name: apache-dbcp-2.0 description: | - this instrumentation enables database connection pools metrics for Apache DBCP. + This instrumentation enables database connection pools metrics for Apache DBCP. The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default. source_path: instrumentation/apache-dbcp-2.0 scope: @@ -382,7 +382,7 @@ libraries: - name: rpc.system type: STRING - name: apache-httpasyncclient-4.1 - description: this instrumentation enables CLIENT spans and metrics for the Apache + description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. source_path: instrumentation/apache-httpasyncclient-4.1 scope: @@ -428,7 +428,7 @@ libraries: - name: url.full type: STRING - name: apache-httpclient-2.0 - description: this instrumentation enables CLIENT spans and metrics for versions + description: This instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. source_path: instrumentation/apache-httpclient/apache-httpclient-2.0 scope: @@ -472,7 +472,7 @@ libraries: - name: url.full type: STRING - name: apache-httpclient-4.0 - description: this instrumentation enables CLIENT spans and metrics for version + description: This instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient. source_path: instrumentation/apache-httpclient/apache-httpclient-4.0 scope: @@ -1119,7 +1119,7 @@ libraries: camel: - name: camel-2.20 description: | - this instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. + This instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. source_path: instrumentation/camel-2.20 scope: name: io.opentelemetry.camel-2.20 @@ -1333,7 +1333,7 @@ libraries: default: false elasticsearch: - name: elasticsearch-api-client-7.16 - description: this instrumentation enables client spans for Elasticsearch API client + description: This instrumentation enables client spans for Elasticsearch API client requests for version 7 of the client. Versions 8.10 and later have native support for OpenTelemetry. source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16 @@ -1344,7 +1344,7 @@ libraries: - co.elastic.clients:elasticsearch-java:[7.16,7.17.20) - co.elastic.clients:elasticsearch-java:[8.0.0,8.10) - name: elasticsearch-rest-5.0 - description: this instrumentation enables tracing for Elasticsearch REST clients. + description: This instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0 scope: name: io.opentelemetry.elasticsearch-rest-5.0 @@ -1375,7 +1375,7 @@ libraries: - name: url.full type: STRING - name: elasticsearch-rest-6.4 - description: this instrumentation enables tracing for Elasticsearch REST clients. + description: This instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4 scope: name: io.opentelemetry.elasticsearch-rest-6.4 @@ -1404,7 +1404,7 @@ libraries: - name: url.full type: STRING - name: elasticsearch-rest-7.0 - description: this instrumentation enables tracing for Elasticsearch REST clients. + description: This instrumentation enables tracing for Elasticsearch REST clients. source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0 scope: name: io.opentelemetry.elasticsearch-rest-7.0 @@ -1436,7 +1436,7 @@ libraries: type: STRING - name: elasticsearch-transport-5.0 description: | - this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0 scope: name: io.opentelemetry.elasticsearch-transport-5.0 @@ -1512,7 +1512,7 @@ libraries: type: LONG - name: elasticsearch-transport-5.3 description: | - this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3 scope: name: io.opentelemetry.elasticsearch-transport-5.3 @@ -1598,7 +1598,7 @@ libraries: type: LONG - name: elasticsearch-transport-6.0 description: | - this instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0 scope: name: io.opentelemetry.elasticsearch-transport-6.0 diff --git a/instrumentation/activej-http-6.0/metadata.yaml b/instrumentation/activej-http-6.0/metadata.yaml index 7810740c7d45..61aeae5824c5 100644 --- a/instrumentation/activej-http-6.0/metadata.yaml +++ b/instrumentation/activej-http-6.0/metadata.yaml @@ -1 +1 @@ -description: this instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server. +description: This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server. diff --git a/instrumentation/apache-dbcp-2.0/metadata.yaml b/instrumentation/apache-dbcp-2.0/metadata.yaml index 874781d1b0dd..b4f5c4be5557 100644 --- a/instrumentation/apache-dbcp-2.0/metadata.yaml +++ b/instrumentation/apache-dbcp-2.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - this instrumentation enables database connection pools metrics for Apache DBCP. + This instrumentation enables database connection pools metrics for Apache DBCP. The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, diff --git a/instrumentation/apache-httpasyncclient-4.1/metadata.yaml b/instrumentation/apache-httpasyncclient-4.1/metadata.yaml index ed4743cd5be8..eb4297e91dfb 100644 --- a/instrumentation/apache-httpasyncclient-4.1/metadata.yaml +++ b/instrumentation/apache-httpasyncclient-4.1/metadata.yaml @@ -1 +1 @@ -description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. +description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml index 5688c9723309..8947340aaa9d 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml @@ -1 +1 @@ -description: this instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. +description: This instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml index 600d32ad970c..f38a5943cb29 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml @@ -1 +1 @@ -description: this instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient. +description: This instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient. diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml index ed4743cd5be8..eb4297e91dfb 100644 --- a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml +++ b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml @@ -1 +1 @@ -description: this instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. +description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient. diff --git a/instrumentation/camel-2.20/metadata.yaml b/instrumentation/camel-2.20/metadata.yaml index 1f64815b7b57..4d9a48b100b7 100644 --- a/instrumentation/camel-2.20/metadata.yaml +++ b/instrumentation/camel-2.20/metadata.yaml @@ -1,5 +1,5 @@ description: > - this instrumentation enables tracing for Apache Camel 2.x applications by generating spans for + This instrumentation enables tracing for Apache Camel 2.x applications by generating spans for each route execution. For Camel versions 3.5 and newer, users should instead use the native 'camel-opentelemetry' component provided directly by the Camel project. configurations: diff --git a/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml index 178b00f26ed1..3dc6d3cf9da4 100644 --- a/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml @@ -1,2 +1,2 @@ -description: this instrumentation enables client spans for Elasticsearch API client requests for +description: This instrumentation enables client spans for Elasticsearch API client requests for version 7 of the client. Versions 8.10 and later have native support for OpenTelemetry. diff --git a/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml index 645a6407eb33..091cbe4861c3 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml @@ -1,4 +1,4 @@ -description: this instrumentation enables tracing for Elasticsearch REST clients. +description: This instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: | diff --git a/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml index 3b24cb02c19a..224089a16b6f 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml @@ -1,4 +1,4 @@ -description: this instrumentation enables tracing for Elasticsearch REST clients. +description: This instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: > diff --git a/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml index 3b24cb02c19a..224089a16b6f 100644 --- a/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml @@ -1,4 +1,4 @@ -description: this instrumentation enables tracing for Elasticsearch REST clients. +description: This instrumentation enables tracing for Elasticsearch REST clients. configurations: - name: otel.instrumentation.elasticsearch.capture-search-query description: > diff --git a/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml index 0279701cf8f5..c327ced42d23 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - this instrumentation enables client spans for Elasticsearch transport client requests. Each call + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes diff --git a/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml index 0279701cf8f5..c327ced42d23 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml @@ -1,5 +1,5 @@ description: > - this instrumentation enables client spans for Elasticsearch transport client requests. Each call + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes diff --git a/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml index 0279701cf8f5..c327ced42d23 100644 --- a/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml +++ b/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml @@ -1,5 +1,5 @@ description: > - this instrumentation enables client spans for Elasticsearch transport client requests. Each call + This instrumentation enables client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes. configurations: - name: otel.instrumentation.elasticsearch.experimental-span-attributes