From 9f855ee372866dd34a80c42ee6f751add72e2fa5 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Thu, 11 Sep 2025 12:34:54 -0400 Subject: [PATCH 1/2] add links to remaining files --- docs/instrumentation-list.yaml | 364 ++++-------------- instrumentation/executors/metadata.yaml | 2 +- .../finagle-http-23.11/metadata.yaml | 1 + instrumentation/finatra-2.9/metadata.yaml | 1 + instrumentation/geode-1.4/metadata.yaml | 1 + instrumentation/grails-3.0/metadata.yaml | 1 + .../graphql-java-20.0/metadata.yaml | 1 + instrumentation/grizzly-2.3/metadata.yaml | 1 + instrumentation/grpc-1.6/metadata.yaml | 1 + instrumentation/gwt-2.0/metadata.yaml | 1 + .../hibernate/hibernate-3.3/metadata.yaml | 1 + .../hibernate/hibernate-4.0/metadata.yaml | 1 + .../hibernate/hibernate-6.0/metadata.yaml | 1 + .../metadata.yaml | 1 + .../hibernate-reactive-1.0/metadata.yaml | 1 + instrumentation/hikaricp-3.0/metadata.yaml | 1 + .../http-url-connection/metadata.yaml | 1 + instrumentation/hystrix-1.4/metadata.yaml | 1 + instrumentation/influxdb-2.4/metadata.yaml | 1 + .../java-http-client/metadata.yaml | 1 + .../java-http-server/metadata.yaml | 1 + instrumentation/javalin-5.0/metadata.yaml | 1 + instrumentation/jdbc/metadata.yaml | 1 + .../kafka-clients-0.11/metadata.yaml | 1 + .../kafka-clients-2.6/metadata.yaml | 1 + .../kafka/kafka-streams-0.11/metadata.yaml | 1 + .../openai/openai-java-1.1/metadata.yaml | 1 + instrumentation/oracle-ucp-11.2/metadata.yaml | 1 + instrumentation/oshi/metadata.yaml | 1 + instrumentation/spark-2.3/metadata.yaml | 1 + .../spring/spring-batch-3.0/metadata.yaml | 1 + .../metadata.yaml | 1 + .../spring-boot-autoconfigure/metadata.yaml | 1 + .../spring-boot-resources/metadata.yaml | 2 +- .../spring/spring-cloud-aws-3.0/metadata.yaml | 1 + .../spring-cloud-gateway-2.0/metadata.yaml | 1 + .../spring-cloud-gateway-2.2/metadata.yaml | 1 + .../spring/spring-core-2.0/metadata.yaml | 1 + .../spring-data/spring-data-1.8/metadata.yaml | 1 + .../spring-data/spring-data-3.0/metadata.yaml | 1 + .../spring-integration-4.1/metadata.yaml | 1 + .../spring-jms/spring-jms-2.0/metadata.yaml | 1 + .../spring-jms/spring-jms-6.0/metadata.yaml | 1 + .../spring/spring-kafka-2.7/metadata.yaml | 1 + .../spring/spring-pulsar-1.0/metadata.yaml | 1 + .../spring/spring-rabbit-1.0/metadata.yaml | 1 + .../spring/spring-rmi-4.0/metadata.yaml | 1 + .../spring-scheduling-3.1/metadata.yaml | 1 + .../spring-security-config-6.0/metadata.yaml | 1 + .../spring-web/spring-web-3.1/metadata.yaml | 1 + .../spring-web/spring-web-6.0/metadata.yaml | 1 + .../spring-webflux-5.0/metadata.yaml | 1 + .../spring-webflux-5.3/metadata.yaml | 1 + .../spring-webmvc-3.1/metadata.yaml | 1 + .../spring-webmvc-5.3/metadata.yaml | 1 + .../spring-webmvc-6.0/metadata.yaml | 1 + .../spring/spring-ws-2.0/metadata.yaml | 1 + instrumentation/vibur-dbcp-11.0/metadata.yaml | 1 + 58 files changed, 134 insertions(+), 289 deletions(-) create mode 100644 instrumentation/kafka/kafka-streams-0.11/metadata.yaml create mode 100644 instrumentation/spring/spring-data/spring-data-3.0/metadata.yaml diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 9a4f2625e262..07ffb4dd55d6 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -2097,21 +2097,10 @@ libraries: - name: server.port type: LONG clickhouse: - - name: clickhouse-client-v1-0.5 - description: This instrumentation enables database client spans and metrics for - the V1 ClickHouse client. - library_link: https://github.com/ClickHouse/clickhouse-java - source_path: instrumentation/clickhouse/clickhouse-client-v1-0.5 + - name: clickhouse-client-0.5 + source_path: instrumentation/clickhouse-client-0.5 scope: - name: io.opentelemetry.clickhouse-client-v1-0.5 - target_versions: - javaagent: - - com.clickhouse.client:clickhouse-client:[0.5.0,) - configurations: - - name: otel.instrumentation.common.db-statement-sanitizer.enabled - description: Enables statement sanitization for database queries. - type: boolean - default: true + name: io.opentelemetry.clickhouse-client-0.5 telemetry: - when: default spans: @@ -2165,6 +2154,21 @@ libraries: type: STRING - name: server.port type: LONG + - name: clickhouse-client-v1-0.5 + description: This instrumentation enables database client spans and metrics for + the V1 ClickHouse client. + library_link: https://github.com/ClickHouse/clickhouse-java + source_path: instrumentation/clickhouse/clickhouse-client-v1-0.5 + scope: + name: io.opentelemetry.clickhouse-client-v1-0.5 + target_versions: + javaagent: + - com.clickhouse.client:clickhouse-client:[0.5.0,) + configurations: + - name: otel.instrumentation.common.db-statement-sanitizer.enabled + description: Enables statement sanitization for database queries. + type: boolean + default: true - name: clickhouse-client-v2-0.8 description: This instrumentation enables database client spans and metrics for the V2 ClickHouse client. @@ -2180,59 +2184,6 @@ libraries: description: Enables statement sanitization for database queries. type: boolean default: true - telemetry: - - when: default - spans: - - span_kind: CLIENT - attributes: - - name: db.name - type: STRING - - name: db.operation - type: STRING - - name: db.statement - type: STRING - - name: db.system - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG - - when: otel.semconv-stability.opt-in=database - metrics: - - name: db.client.operation.duration - description: Duration of database client operations. - type: HISTOGRAM - unit: s - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.system.name - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG - spans: - - span_kind: CLIENT - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.query.text - type: STRING - - name: db.response.status_code - type: STRING - - name: db.system.name - type: STRING - - name: error.type - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG couchbase: - name: couchbase-2.0 description: | @@ -2983,6 +2934,7 @@ libraries: - name: executors description: | The executor instrumentation ensures that context is automatically propagated when using common Java executors (e.g., ThreadPoolExecutor, ScheduledThreadPoolExecutor, ForkJoinPool). When a task is submitted, the current context is captured and bound to the task. Then, when the task eventually runs, even if it’s on a different thread, the instrumentation reactivates that context, enabling consistent correlation across concurrent and asynchronous workflows. + library_link: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html source_path: instrumentation/executors scope: name: io.opentelemetry.executors @@ -3002,6 +2954,7 @@ libraries: - name: finagle-http-23.11 description: | This instrumentation for Finagle HTTP clients and servers ensures that telemetry is correctly generated by the underlying Netty instrumentation. It augments existing telemetry by bridging the gap between Finagle's abstractions and Netty's pipeline, primarily for context propagation. + library_link: https://github.com/twitter/finagle source_path: instrumentation/finagle-http-23.11 scope: name: io.opentelemetry.finagle-http-23.11 @@ -3014,6 +2967,7 @@ libraries: description: This instrumentation for the Finatra web framework augments the telemetry generated by the underlying Netty instrumentation. It provides more specific, high-level context, such as route information, to the spans generated by Netty. + library_link: https://github.com/twitter/finatra source_path: instrumentation/finatra-2.9 scope: name: io.opentelemetry.finatra-2.9 @@ -3034,6 +2988,7 @@ libraries: - name: geode-1.4 description: This instrumentation enables database client spans and database client metrics for Apache Geode cache operations. + library_link: https://geode.apache.org/ source_path: instrumentation/geode-1.4 scope: name: io.opentelemetry.geode-1.4 @@ -3156,6 +3111,7 @@ libraries: - name: grails-3.0 description: | This instrumentation enriches existing HTTP server spans with HTTP route information, and optionally enables experimental controller (INTERNAL) spans for Grails applications. + library_link: https://grails.apache.org/ source_path: instrumentation/grails-3.0 scope: name: io.opentelemetry.grails-3.0 @@ -3208,6 +3164,7 @@ libraries: type: STRING - name: graphql-java-20.0 description: This instrumentation enables spans for GraphQL Java operations. + library_link: https://www.graphql-java.com/ source_path: instrumentation/graphql-java/graphql-java-20.0 minimum_java_version: 11 scope: @@ -3266,6 +3223,7 @@ libraries: - name: grizzly-2.3 description: This instrumentation enables HTTP server spans and HTTP server metrics for Grizzly applications. + library_link: https://javaee.github.io/grizzly/httpserverframework.html source_path: instrumentation/grizzly-2.3 scope: name: io.opentelemetry.grizzly-2.3 @@ -3347,6 +3305,7 @@ libraries: - name: grpc-1.6 description: This instrumentation enables RPC client spans and metrics, and RPC server spans and metrics for gRPC version 1.6 and above. + library_link: https://github.com/grpc/grpc-java source_path: instrumentation/grpc-1.6 scope: name: io.opentelemetry.grpc-1.6 @@ -3544,6 +3503,7 @@ libraries: gwt: - name: gwt-2.0 description: This instrumentation enables RPC server spans for GWT RPC requests. + library_link: https://www.gwtproject.org/ source_path: instrumentation/gwt-2.0 scope: name: io.opentelemetry.gwt-2.0 @@ -3566,6 +3526,7 @@ libraries: - name: hibernate-3.3 description: | This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. + library_link: https://github.com/hibernate/hibernate-orm source_path: instrumentation/hibernate/hibernate-3.3 scope: name: io.opentelemetry.hibernate-3.3 @@ -3592,6 +3553,7 @@ libraries: - name: hibernate-4.0 description: | This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. + library_link: https://github.com/hibernate/hibernate-orm source_path: instrumentation/hibernate/hibernate-4.0 scope: name: io.opentelemetry.hibernate-4.0 @@ -3618,6 +3580,7 @@ libraries: - name: hibernate-6.0 description: | This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. + library_link: https://github.com/hibernate/hibernate-orm source_path: instrumentation/hibernate/hibernate-6.0 minimum_java_version: 11 scope: @@ -3645,6 +3608,7 @@ libraries: - name: hibernate-procedure-call-4.3 description: This instrumentation enables the generation of INTERNAL spans for Hibernate stored procedure calls. + library_link: https://github.com/hibernate/hibernate-orm source_path: instrumentation/hibernate/hibernate-procedure-call-4.3 scope: name: io.opentelemetry.hibernate-procedure-call-4.3 @@ -3671,6 +3635,7 @@ libraries: - name: hibernate-reactive-1.0 description: | This instrumentation does not emit any telemetry on its own. Instead, it enables context propagation for Hibernate Reactive asynchronous operations. + library_link: https://hibernate.org/reactive/ source_path: instrumentation/hibernate/hibernate-reactive-1.0 scope: name: io.opentelemetry.hibernate-reactive-1.0 @@ -3681,6 +3646,7 @@ libraries: - name: hikaricp-3.0 description: | This instrumentation provides database client metrics for HikariCP 3.0+ connection pools. It reports metrics like connection timeouts, creation time, wait time, and usage time, along with connection pool statistics such as the number of active, idle, and pending connections. + library_link: https://github.com/brettwooldridge/HikariCP source_path: instrumentation/hikaricp-3.0 scope: name: io.opentelemetry.hikaricp-3.0 @@ -3821,6 +3787,7 @@ libraries: - name: http-url-connection description: | This instrumentation enables the generation of HTTP client spans and HTTP client metrics for requests made using `java.net.HttpURLConnection`. + library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/HttpURLConnection.html source_path: instrumentation/http-url-connection scope: name: io.opentelemetry.http-url-connection @@ -3894,6 +3861,7 @@ libraries: - name: hystrix-1.4 description: This instrumentation enables the generation of INTERNAL spans for Hystrix command executions and fallbacks. + library_link: https://github.com/Netflix/Hystrix source_path: instrumentation/hystrix-1.4 scope: name: io.opentelemetry.hystrix-1.4 @@ -3906,84 +3874,22 @@ libraries: and `hystrix.group` span attributes. type: boolean default: false - telemetry: - - when: default - spans: - - span_kind: INTERNAL - attributes: [] - - when: otel.instrumentation.hystrix.experimental-span-attributes=true - spans: - - span_kind: INTERNAL - attributes: - - name: hystrix.circuit_open - type: BOOLEAN - - name: hystrix.command - type: STRING - - name: hystrix.group - type: STRING influxdb: - name: influxdb-2.4 description: This instrumentation enables the generation of database client spans and metrics for the InfluxDB Java client. + library_link: https://github.com/influxdata/influxdb-java source_path: instrumentation/influxdb-2.4 scope: name: io.opentelemetry.influxdb-2.4 target_versions: javaagent: - org.influxdb:influxdb-java:[2.4,) - telemetry: - - when: default - spans: - - span_kind: CLIENT - attributes: - - name: db.name - type: STRING - - name: db.operation - type: STRING - - name: db.statement - type: STRING - - name: db.system - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG - - when: otel.semconv-stability.opt-in=database - metrics: - - name: db.client.operation.duration - description: Duration of database client operations. - type: HISTOGRAM - unit: s - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.system.name - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG - spans: - - span_kind: CLIENT - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.query.text - type: STRING - - name: db.system.name - type: STRING - - name: server.address - type: STRING - - name: server.port - type: LONG java: - name: java-http-client description: This instrumentation enables HTTP client spans and HTTP client metrics for requests made using the Java HTTP client. + library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html source_path: instrumentation/java-http-client minimum_java_version: 11 scope: @@ -4059,6 +3965,7 @@ libraries: - name: java-http-server description: This instrumentation enables HTTP server spans and HTTP server metrics for the Java HTTP server. + library_link: https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html source_path: instrumentation/java-http-server scope: name: io.opentelemetry.java-http-server @@ -4089,59 +3996,11 @@ libraries: Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.server.request.body.size` and `http.server.response.body.size` metrics. type: boolean default: false - telemetry: - - when: default - 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: 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 javalin: - name: javalin-5.0 description: This instrumentation enriches existing HTTP server spans with route information, it does not emit any telemetry on its own. + library_link: https://javalin.io/ source_path: instrumentation/javalin-5.0 minimum_java_version: 11 scope: @@ -4277,6 +4136,7 @@ libraries: description: | The JDBC instrumentation provides database client spans and metrics. Each call produces a span named after the SQL verb, enriched with standard DB client attributes (system, database, operation, sanitized statement, peer address) and error details if an exception occurs. There is also a "jdbc-datasource" instrumentation that creates spans for datasource connections, but is disabled by default due to the volume of telemetry produced. + library_link: https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html source_path: instrumentation/jdbc scope: name: io.opentelemetry.jdbc @@ -4561,6 +4421,7 @@ libraries: - name: kafka-clients-0.11 description: | 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. + library_link: https://kafka.apache.org/ source_path: instrumentation/kafka/kafka-clients/kafka-clients-0.11 scope: name: io.opentelemetry.kafka-clients-0.11 @@ -4588,6 +4449,7 @@ libraries: - name: kafka-clients-2.6 description: | This instrumentation provides a library integration that enables messaging spans and metrics for Apache Kafka 2.6+ clients. + library_link: https://kafka.apache.org/ source_path: instrumentation/kafka/kafka-clients/kafka-clients-2.6 scope: name: io.opentelemetry.kafka-clients-2.6 @@ -4605,6 +4467,7 @@ libraries: type: boolean default: false - name: kafka-streams-0.11 + library_link: https://kafka.apache.org/documentation/streams/ source_path: instrumentation/kafka/kafka-streams-0.11 scope: name: io.opentelemetry.kafka-streams-0.11 @@ -5208,6 +5071,7 @@ libraries: - name: openai-java-1.1 description: This instrumentation enables Gen AI client spans and metrics for OpenAI Java SDK 1.1+. + library_link: https://github.com/openai/openai-java source_path: instrumentation/openai/openai-java-1.1 scope: name: io.opentelemetry.openai-java-1.1 @@ -5317,10 +5181,16 @@ libraries: target_versions: javaagent: - org.opensearch.client:opensearch-rest-client:[3.0,) + opentelemetry: + - name: opentelemetry + source_path: instrumentation/internal/internal-application-logger/bootstrap/bin/main/io/opentelemetry + scope: + name: io.opentelemetry.opentelemetry oracle: - name: oracle-ucp-11.2 description: The Oracle Universal Connection Pool (UCP) instrumentation generates connection pool metrics. + library_link: https://docs.oracle.com/database/121/JJUCP/ source_path: instrumentation/oracle-ucp-11.2 scope: name: io.opentelemetry.oracle-ucp-11.2 @@ -5330,65 +5200,12 @@ libraries: library: - com.oracle.database.jdbc:ucp:11.2.0.4 - com.oracle.database.jdbc:ojdbc8:12.2.0.1 - telemetry: - - when: default - metrics: - - name: db.client.connections.max - description: The maximum number of open connections allowed. - type: LONG_SUM - unit: connections - attributes: - - name: pool.name - type: STRING - - name: db.client.connections.pending_requests - description: The number of pending requests for an open connection, cumulative - for the entire pool. - type: LONG_SUM - unit: requests - attributes: - - name: pool.name - type: STRING - - name: db.client.connections.usage - description: The number of connections that are currently in state described - by the state attribute. - type: LONG_SUM - unit: connections - attributes: - - name: pool.name - type: STRING - - name: state - type: STRING - - when: otel.semconv-stability.opt-in=database - metrics: - - name: db.client.connection.count - description: The number of connections that are currently in state described - by the state attribute. - type: LONG_SUM - unit: connection - attributes: - - name: db.client.connection.pool.name - type: STRING - - name: db.client.connection.state - type: STRING - - name: db.client.connection.max - description: The maximum number of open connections allowed. - type: LONG_SUM - unit: connection - attributes: - - name: db.client.connection.pool.name - type: STRING - - name: db.client.connection.pending_requests - description: The number of current pending requests for an open connection. - type: LONG_SUM - unit: request - attributes: - - name: db.client.connection.pool.name - type: STRING oshi: - name: oshi description: When the OSHI library is detected on the classpath, this instrumentation will use the system class loader to load classes from the oshi-core jar that are then used to generate system metrics. + library_link: https://github.com/oshi/oshi/ source_path: instrumentation/oshi scope: name: io.opentelemetry.oshi @@ -6107,6 +5924,7 @@ libraries: - name: spark-2.3 description: | This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and attaches it to HTTP server spans and HTTP server metrics. + library_link: https://github.com/perwendel/spark source_path: instrumentation/spark-2.3 scope: name: io.opentelemetry.spark-2.3 @@ -6117,6 +5935,7 @@ libraries: - name: spring-batch-3.0 description: This instrumentation enables INTERNAL spans for jobs run by the Spring Batch framework. + library_link: https://spring.io/projects/spring-batch disabled_by_default: true source_path: instrumentation/spring/spring-batch-3.0 scope: @@ -6149,6 +5968,7 @@ libraries: - name: spring-boot-actuator-autoconfigure-2.0 description: | This instrumentation configures the OpenTelemetry Micrometer bridge to receive metrics from Spring Boot Actuator. It does not produce telemetry on its own. + library_link: https://spring.io/projects/spring-boot disabled_by_default: true source_path: instrumentation/spring/spring-boot-actuator-autoconfigure-2.0 scope: @@ -6168,12 +5988,14 @@ libraries: - Check for application.yml in the current working dir - Check for --spring.application.name program argument (not jvm arg) via ProcessHandle - Check for --spring.application.name program argument via sun.java.command system property + library_link: https://spring.io/projects/spring-boot source_path: instrumentation/spring/spring-boot-resources scope: name: io.opentelemetry.spring-boot-resources - name: spring-cloud-aws-3.0 description: | This instrumentation enhances tracing for Spring Cloud AWS. It augments the existing AWS SDK instrumentation by providing higher-level tracing for SQS operations, capturing details specific to Spring Cloud AWS SQS usage and linking them to the underlying AWS SDK traces. + library_link: https://spring.io/projects/spring-cloud-aws source_path: instrumentation/spring/spring-cloud-aws-3.0 minimum_java_version: 17 scope: @@ -6184,6 +6006,7 @@ libraries: - name: spring-cloud-gateway-2.0 description: | This instrumentation enhances tracing for Spring Cloud Gateway. It does not generate new telemetry on its own, but rather enriches existing traces produced by other instrumentations like Netty and Spring WebFlux with Spring Cloud Gateway-specific attributes. + library_link: https://github.com/spring-cloud/spring-cloud-gateway source_path: instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0 scope: name: io.opentelemetry.spring-cloud-gateway-2.0 @@ -6199,6 +6022,7 @@ libraries: - name: spring-core-2.0 description: | This instrumentation ensures proper context propagation for asynchronous operations within Spring Core. It modifies how tasks are submitted and executed to ensure that spans created by other instrumentations are correctly linked across thread boundaries, rather than generating any new telemetry itself. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/package-summary.html source_path: instrumentation/spring/spring-core-2.0 minimum_java_version: 17 scope: @@ -6209,6 +6033,7 @@ libraries: - name: spring-data-1.8 description: | This instrumentation enhances tracing for Spring Data operations. It works in conjunction with other instrumentations, such as JDBC, to provide additional context and details for database interactions initiated through Spring Data. + library_link: https://spring.io/projects/spring-data source_path: instrumentation/spring/spring-data/spring-data-1.8 scope: name: io.opentelemetry.spring-data-1.8 @@ -6228,6 +6053,7 @@ libraries: - name: spring-integration-4.1 description: This instrumentation enables producer and consumer messaging spans for Spring Integration. + library_link: https://spring.io/projects/spring-integration source_path: instrumentation/spring/spring-integration-4.1 scope: name: io.opentelemetry.spring-integration-4.1 @@ -6270,6 +6096,7 @@ libraries: - name: spring-jms-2.0 description: This instrumentation enables the generation of consumer messaging spans for Spring JMS. + library_link: https://docs.spring.io/spring-framework/reference/integration/jms.html source_path: instrumentation/spring/spring-jms/spring-jms-2.0 scope: name: io.opentelemetry.spring-jms-2.0 @@ -6302,6 +6129,7 @@ libraries: - name: spring-jms-6.0 description: This instrumentation enables the generation of consumer messaging spans for Spring JMS. + library_link: https://docs.spring.io/spring-framework/reference/integration/jms.html source_path: instrumentation/spring/spring-jms/spring-jms-6.0 minimum_java_version: 17 scope: @@ -6319,22 +6147,10 @@ libraries: description: A comma-separated list of header names to capture as span attributes. type: list default: '' - telemetry: - - when: default - spans: - - span_kind: CONSUMER - attributes: - - name: messaging.destination.name - type: STRING - - name: messaging.message.id - type: STRING - - name: messaging.operation - type: STRING - - name: messaging.system - type: STRING - name: spring-kafka-2.7 description: This instrumentation enables consumer messaging spans for Spring Kafka listeners. + library_link: https://spring.io/projects/spring-kafka source_path: instrumentation/spring/spring-kafka-2.7 scope: name: io.opentelemetry.spring-kafka-2.7 @@ -6409,6 +6225,7 @@ libraries: - name: spring-pulsar-1.0 description: This instrumentation enables consumer messaging spans for Spring Pulsar listeners. + library_link: https://spring.io/projects/spring-pulsar source_path: instrumentation/spring/spring-pulsar-1.0 minimum_java_version: 17 scope: @@ -6449,6 +6266,7 @@ libraries: - name: spring-rabbit-1.0 description: This instrumentation enables consumer messaging spans for Spring RabbitMQ listeners. + library_link: https://spring.io/projects/spring-amqp source_path: instrumentation/spring/spring-rabbit-1.0 scope: name: io.opentelemetry.spring-rabbit-1.0 @@ -6476,6 +6294,7 @@ libraries: - name: spring-rmi-4.0 description: This instrumentation enables RPC client and RPC server spans for Spring RMI applications. + library_link: https://docs.spring.io/spring-framework/docs/4.0.x/javadoc-api/org/springframework/remoting/rmi/package-summary.html source_path: instrumentation/spring/spring-rmi-4.0 scope: name: io.opentelemetry.spring-rmi-4.0 @@ -6503,6 +6322,7 @@ libraries: type: STRING - name: spring-scheduling-3.1 description: This instrumentation enables tracing for Spring Scheduling tasks. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/package-summary.html source_path: instrumentation/spring/spring-scheduling-3.1 scope: name: io.opentelemetry.spring-scheduling-3.1 @@ -6538,6 +6358,7 @@ libraries: description: | This instrumentation does not emit any telemetry on its own. Instead, it captures enduser attributes, and is only enabled when at least one of the `enduser` configurations is enabled. NOTE: The `enduser` attributes have been deprecated and will be removed in 3.0+ of the java agent. + library_link: https://spring.io/projects/spring-security source_path: instrumentation/spring/spring-security-config-6.0 minimum_java_version: 17 scope: @@ -6577,6 +6398,7 @@ libraries: - name: spring-web-3.1 description: | This instrumentation provides a library integration that enables capturing HTTP client spans and metrics for Spring's RestTemplate. The agent integration enriches HTTP server spans and metrics with route information. + library_link: https://github.com/spring-projects/spring-framework source_path: instrumentation/spring/spring-web/spring-web-3.1 scope: name: io.opentelemetry.spring-web-3.1 @@ -6617,6 +6439,7 @@ libraries: - name: spring-web-6.0 description: This instrumentation enriches HTTP server spans and metrics with route information. + library_link: https://github.com/spring-projects/spring-framework source_path: instrumentation/spring/spring-web/spring-web-6.0 minimum_java_version: 17 scope: @@ -6627,6 +6450,7 @@ libraries: - name: spring-webflux-5.0 description: | This instrumentation enables HTTP client spans and metrics for Spring WebFlux 5.0. It also optionally enables experimental controller (INTERNAL) spans. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html source_path: instrumentation/spring/spring-webflux/spring-webflux-5.0 scope: name: io.opentelemetry.spring-webflux-5.0 @@ -6680,6 +6504,7 @@ libraries: - name: spring-webflux-5.3 description: | This instrumentation provides a library integration for the Spring WebFlux WebClient and Webflux server versions 5.3+ that enables HTTP client and server spans and metrics. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html source_path: instrumentation/spring/spring-webflux/spring-webflux-5.3 scope: name: io.opentelemetry.spring-webflux-5.3 @@ -6761,6 +6586,7 @@ libraries: - name: spring-webmvc-3.1 description: | This instrumentation enables optional Controller and View (INTERNAL) spans for Spring WebMVC 3.1+. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html source_path: instrumentation/spring/spring-webmvc/spring-webmvc-3.1 scope: name: io.opentelemetry.spring-webmvc-3.1 @@ -6803,6 +6629,7 @@ libraries: - name: spring-webmvc-5.3 description: | This instrumentation provides a library integration for Spring WebMVC controllers, that enables the creation of HTTP server spans and metrics for requests processed by the Spring servlet container. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html source_path: instrumentation/spring/spring-webmvc/spring-webmvc-5.3 scope: name: io.opentelemetry.spring-webmvc-5.3 @@ -6860,6 +6687,7 @@ libraries: - name: spring-webmvc-6.0 description: | This instrumentation enables optional Controller and View (INTERNAL) spans for Spring WebMVC 6.0+. + library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html source_path: instrumentation/spring/spring-webmvc/spring-webmvc-6.0 minimum_java_version: 17 scope: @@ -6901,6 +6729,7 @@ libraries: - name: spring-webmvc.view.type type: STRING - name: spring-ws-2.0 + library_link: https://spring.io/projects/spring-ws disabled_by_default: true source_path: instrumentation/spring/spring-ws-2.0 scope: @@ -7241,46 +7070,6 @@ libraries: type: STRING - name: server.port type: LONG - - when: otel.semconv-stability.opt-in=database - metrics: - - name: db.client.operation.duration - description: Duration of database client operations. - type: HISTOGRAM - unit: s - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.system.name - type: STRING - - name: network.peer.address - type: STRING - - name: network.peer.port - type: LONG - - name: server.address - type: STRING - - name: server.port - type: LONG - spans: - - span_kind: CLIENT - attributes: - - name: db.namespace - type: STRING - - name: db.operation.name - type: STRING - - name: db.query.text - type: STRING - - name: db.system.name - type: STRING - - name: network.peer.address - type: STRING - - name: network.peer.port - type: LONG - - name: server.address - type: STRING - - name: server.port - type: LONG - name: vertx-rx-java-3.5 source_path: instrumentation/vertx/vertx-rx-java-3.5 scope: @@ -7424,6 +7213,7 @@ libraries: - name: vibur-dbcp-11.0 description: Instrumentation for the vibur-dbcp library, which provides connection pool metrics. + library_link: https://www.vibur.org/ source_path: instrumentation/vibur-dbcp-11.0 scope: name: io.opentelemetry.vibur-dbcp-11.0 diff --git a/instrumentation/executors/metadata.yaml b/instrumentation/executors/metadata.yaml index d2b8978137a6..ac0dde35cb95 100644 --- a/instrumentation/executors/metadata.yaml +++ b/instrumentation/executors/metadata.yaml @@ -4,7 +4,7 @@ description: > is submitted, the current context is captured and bound to the task. Then, when the task eventually runs, even if it’s on a different thread, the instrumentation reactivates that context, enabling consistent correlation across concurrent and asynchronous workflows. - +library_link: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html configurations: - name: otel.instrumentation.executors.include description: List of Executor subclasses to be instrumented. diff --git a/instrumentation/finagle-http-23.11/metadata.yaml b/instrumentation/finagle-http-23.11/metadata.yaml index 44f7205b4ae5..7a0347ec55c3 100644 --- a/instrumentation/finagle-http-23.11/metadata.yaml +++ b/instrumentation/finagle-http-23.11/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation for Finagle HTTP clients and servers ensures that telemetry is correctly generated by the underlying Netty instrumentation. It augments existing telemetry by bridging the gap between Finagle's abstractions and Netty's pipeline, primarily for context propagation. +library_link: https://github.com/twitter/finagle diff --git a/instrumentation/finatra-2.9/metadata.yaml b/instrumentation/finatra-2.9/metadata.yaml index 366d7524d9fb..ce91068a77b8 100644 --- a/instrumentation/finatra-2.9/metadata.yaml +++ b/instrumentation/finatra-2.9/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation for the Finatra web framework augments the telemetry generated by the underlying Netty instrumentation. It provides more specific, high-level context, such as route information, to the spans generated by Netty. +library_link: https://github.com/twitter/finatra diff --git a/instrumentation/geode-1.4/metadata.yaml b/instrumentation/geode-1.4/metadata.yaml index 6d2a989fbd22..9a6927191655 100644 --- a/instrumentation/geode-1.4/metadata.yaml +++ b/instrumentation/geode-1.4/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables database client spans and database client metrics for Apache Geode cache operations. +library_link: https://geode.apache.org/ configurations: - name: otel.instrumentation.common.db-statement-sanitizer.enabled description: Enables statement sanitization for database queries. diff --git a/instrumentation/grails-3.0/metadata.yaml b/instrumentation/grails-3.0/metadata.yaml index fd2f40a01257..8277b165a4f2 100644 --- a/instrumentation/grails-3.0/metadata.yaml +++ b/instrumentation/grails-3.0/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enriches existing HTTP server spans with HTTP route information, and optionally enables experimental controller (INTERNAL) spans for Grails applications. +library_link: https://grails.apache.org/ configurations: - name: otel.instrumentation.common.experimental.controller-telemetry.enabled description: Enables the creation of experimental controller (INTERNAL) spans. diff --git a/instrumentation/graphql-java/graphql-java-20.0/metadata.yaml b/instrumentation/graphql-java/graphql-java-20.0/metadata.yaml index dc16c2abe4c8..7601d5633894 100644 --- a/instrumentation/graphql-java/graphql-java-20.0/metadata.yaml +++ b/instrumentation/graphql-java/graphql-java-20.0/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables spans for GraphQL Java operations. +library_link: https://www.graphql-java.com/ configurations: - name: otel.instrumentation.graphql.query-sanitizer.enabled description: Enables sanitization of sensitive information from queries so they aren't added as span attributes. diff --git a/instrumentation/grizzly-2.3/metadata.yaml b/instrumentation/grizzly-2.3/metadata.yaml index e854d88ae3ff..dcf6845fafac 100644 --- a/instrumentation/grizzly-2.3/metadata.yaml +++ b/instrumentation/grizzly-2.3/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables HTTP server spans and HTTP server metrics for Grizzly applications. +library_link: https://javaee.github.io/grizzly/httpserverframework.html configurations: - name: otel.instrumentation.http.known-methods description: > diff --git a/instrumentation/grpc-1.6/metadata.yaml b/instrumentation/grpc-1.6/metadata.yaml index 6daf252ca149..06687f61e3fd 100644 --- a/instrumentation/grpc-1.6/metadata.yaml +++ b/instrumentation/grpc-1.6/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables RPC client spans and metrics, and RPC server spans and metrics for gRPC version 1.6 and above. +library_link: https://github.com/grpc/grpc-java configurations: - name: otel.instrumentation.grpc.emit-message-events type: boolean diff --git a/instrumentation/gwt-2.0/metadata.yaml b/instrumentation/gwt-2.0/metadata.yaml index 9bb79b554de1..9a9ee7a9cd10 100644 --- a/instrumentation/gwt-2.0/metadata.yaml +++ b/instrumentation/gwt-2.0/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation enables RPC server spans for GWT RPC requests. +library_link: https://www.gwtproject.org/ diff --git a/instrumentation/hibernate/hibernate-3.3/metadata.yaml b/instrumentation/hibernate/hibernate-3.3/metadata.yaml index 0643cb6afdcb..f8ee68b40f38 100644 --- a/instrumentation/hibernate/hibernate-3.3/metadata.yaml +++ b/instrumentation/hibernate/hibernate-3.3/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. +library_link: https://github.com/hibernate/hibernate-orm configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes type: boolean diff --git a/instrumentation/hibernate/hibernate-4.0/metadata.yaml b/instrumentation/hibernate/hibernate-4.0/metadata.yaml index 0643cb6afdcb..f8ee68b40f38 100644 --- a/instrumentation/hibernate/hibernate-4.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-4.0/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. +library_link: https://github.com/hibernate/hibernate-orm configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes type: boolean diff --git a/instrumentation/hibernate/hibernate-6.0/metadata.yaml b/instrumentation/hibernate/hibernate-6.0/metadata.yaml index 0643cb6afdcb..f8ee68b40f38 100644 --- a/instrumentation/hibernate/hibernate-6.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-6.0/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enables the generation of INTERNAL spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. +library_link: https://github.com/hibernate/hibernate-orm configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes type: boolean diff --git a/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml b/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml index b8fc17ad471a..9ef27db898cd 100644 --- a/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml +++ b/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables the generation of INTERNAL spans for Hibernate stored procedure calls. +library_link: https://github.com/hibernate/hibernate-orm configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes type: boolean diff --git a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml index 154c232f9d36..f385670c021e 100644 --- a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml @@ -1,3 +1,4 @@ description: > This instrumentation does not emit any telemetry on its own. Instead, it enables context propagation for Hibernate Reactive asynchronous operations. +library_link: https://hibernate.org/reactive/ diff --git a/instrumentation/hikaricp-3.0/metadata.yaml b/instrumentation/hikaricp-3.0/metadata.yaml index 59cdb7f5812f..212c71342f0d 100644 --- a/instrumentation/hikaricp-3.0/metadata.yaml +++ b/instrumentation/hikaricp-3.0/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation provides database client metrics for HikariCP 3.0+ connection pools. It reports metrics like connection timeouts, creation time, wait time, and usage time, along with connection pool statistics such as the number of active, idle, and pending connections. +library_link: https://github.com/brettwooldridge/HikariCP diff --git a/instrumentation/http-url-connection/metadata.yaml b/instrumentation/http-url-connection/metadata.yaml index 3d2ea9234050..990f2f71a6ca 100644 --- a/instrumentation/http-url-connection/metadata.yaml +++ b/instrumentation/http-url-connection/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enables the generation of HTTP client spans and HTTP client metrics for requests made using `java.net.HttpURLConnection`. +library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/HttpURLConnection.html configurations: - name: otel.instrumentation.http.known-methods description: > diff --git a/instrumentation/hystrix-1.4/metadata.yaml b/instrumentation/hystrix-1.4/metadata.yaml index 1343efbd3737..90482242a5c9 100644 --- a/instrumentation/hystrix-1.4/metadata.yaml +++ b/instrumentation/hystrix-1.4/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables the generation of INTERNAL spans for Hystrix command executions and fallbacks. +library_link: https://github.com/Netflix/Hystrix configurations: - name: otel.instrumentation.hystrix.experimental-span-attributes description: Enables capturing the experimental `hystrix.command`, `hystrix.circuit_open` and `hystrix.group` span attributes. diff --git a/instrumentation/influxdb-2.4/metadata.yaml b/instrumentation/influxdb-2.4/metadata.yaml index fc4040fb3abb..6ef19652fa60 100644 --- a/instrumentation/influxdb-2.4/metadata.yaml +++ b/instrumentation/influxdb-2.4/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation enables the generation of database client spans and metrics for the InfluxDB Java client. +library_link: https://github.com/influxdata/influxdb-java diff --git a/instrumentation/java-http-client/metadata.yaml b/instrumentation/java-http-client/metadata.yaml index f7463c9e0171..9283e71e4fad 100644 --- a/instrumentation/java-http-client/metadata.yaml +++ b/instrumentation/java-http-client/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables HTTP client spans and HTTP client metrics for requests made using the Java HTTP client. +library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html configurations: - name: otel.instrumentation.http.known-methods description: > diff --git a/instrumentation/java-http-server/metadata.yaml b/instrumentation/java-http-server/metadata.yaml index e85c9b40e740..2d80c4936be2 100644 --- a/instrumentation/java-http-server/metadata.yaml +++ b/instrumentation/java-http-server/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables HTTP server spans and HTTP server metrics for the Java HTTP server. +library_link: https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html configurations: - name: otel.instrumentation.http.known-methods description: > diff --git a/instrumentation/javalin-5.0/metadata.yaml b/instrumentation/javalin-5.0/metadata.yaml index 828e20314bdc..683a861143e8 100644 --- a/instrumentation/javalin-5.0/metadata.yaml +++ b/instrumentation/javalin-5.0/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation enriches existing HTTP server spans with route information, it does not emit any telemetry on its own. +library_link: https://javalin.io/ diff --git a/instrumentation/jdbc/metadata.yaml b/instrumentation/jdbc/metadata.yaml index 696dfc541bd0..f3c143e99490 100644 --- a/instrumentation/jdbc/metadata.yaml +++ b/instrumentation/jdbc/metadata.yaml @@ -5,6 +5,7 @@ description: > There is also a "jdbc-datasource" instrumentation that creates spans for datasource connections, but is disabled by default due to the volume of telemetry produced. +library_link: https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html configurations: - name: otel.instrumentation.jdbc.statement-sanitizer.enabled description: Enables statement sanitization for database queries. Takes precedent to 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 84e85395ac72..edf9dc017838 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml @@ -1,6 +1,7 @@ description: > 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. +library_link: https://kafka.apache.org/ configurations: - name: otel.instrumentation.kafka.producer-propagation.enabled description: Enable context propagation for kafka message producers. diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml index 86c5678ca0d2..85d9ffa83e6c 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml @@ -1,5 +1,6 @@ description: > This instrumentation provides a library integration that enables messaging spans and metrics for Apache Kafka 2.6+ clients. +library_link: https://kafka.apache.org/ configurations: - name: otel.instrumentation.messaging.experimental.capture-headers description: A comma-separated list of header names to capture as span attributes. diff --git a/instrumentation/kafka/kafka-streams-0.11/metadata.yaml b/instrumentation/kafka/kafka-streams-0.11/metadata.yaml new file mode 100644 index 000000000000..7e93d3199ffe --- /dev/null +++ b/instrumentation/kafka/kafka-streams-0.11/metadata.yaml @@ -0,0 +1 @@ +library_link: https://kafka.apache.org/documentation/streams/ diff --git a/instrumentation/openai/openai-java-1.1/metadata.yaml b/instrumentation/openai/openai-java-1.1/metadata.yaml index f1f6cc9dcd50..7aaf7d895a2b 100644 --- a/instrumentation/openai/openai-java-1.1/metadata.yaml +++ b/instrumentation/openai/openai-java-1.1/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables Gen AI client spans and metrics for OpenAI Java SDK 1.1+. +library_link: https://github.com/openai/openai-java configurations: - name: otel.instrumentation.genai.capture-message-content type: boolean diff --git a/instrumentation/oracle-ucp-11.2/metadata.yaml b/instrumentation/oracle-ucp-11.2/metadata.yaml index b44ec44abf52..e7e186bcb828 100644 --- a/instrumentation/oracle-ucp-11.2/metadata.yaml +++ b/instrumentation/oracle-ucp-11.2/metadata.yaml @@ -1 +1,2 @@ description: The Oracle Universal Connection Pool (UCP) instrumentation generates connection pool metrics. +library_link: https://docs.oracle.com/database/121/JJUCP/ diff --git a/instrumentation/oshi/metadata.yaml b/instrumentation/oshi/metadata.yaml index 7abda9582c21..fc034b5ae85d 100644 --- a/instrumentation/oshi/metadata.yaml +++ b/instrumentation/oshi/metadata.yaml @@ -4,3 +4,4 @@ configurations: description: Enable the OSHI process runtime metrics. type: boolean default: false +library_link: https://github.com/oshi/oshi/ diff --git a/instrumentation/spark-2.3/metadata.yaml b/instrumentation/spark-2.3/metadata.yaml index b970d440db62..6898b7a3d3d7 100644 --- a/instrumentation/spark-2.3/metadata.yaml +++ b/instrumentation/spark-2.3/metadata.yaml @@ -1,3 +1,4 @@ description: > This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and attaches it to HTTP server spans and HTTP server metrics. +library_link: https://github.com/perwendel/spark diff --git a/instrumentation/spring/spring-batch-3.0/metadata.yaml b/instrumentation/spring/spring-batch-3.0/metadata.yaml index ee9d0349927c..011d79a36165 100644 --- a/instrumentation/spring/spring-batch-3.0/metadata.yaml +++ b/instrumentation/spring/spring-batch-3.0/metadata.yaml @@ -1,5 +1,6 @@ disabled_by_default: true description: This instrumentation enables INTERNAL spans for jobs run by the Spring Batch framework. +library_link: https://spring.io/projects/spring-batch configurations: - name: otel.instrumentation.spring-batch.experimental-span-attributes type: boolean diff --git a/instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/metadata.yaml b/instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/metadata.yaml index d0985f49b067..7734bf7b09f2 100644 --- a/instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/metadata.yaml +++ b/instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/metadata.yaml @@ -2,3 +2,4 @@ disabled_by_default: true description: > This instrumentation configures the OpenTelemetry Micrometer bridge to receive metrics from Spring Boot Actuator. It does not produce telemetry on its own. +library_link: https://spring.io/projects/spring-boot diff --git a/instrumentation/spring/spring-boot-autoconfigure/metadata.yaml b/instrumentation/spring/spring-boot-autoconfigure/metadata.yaml index 5a9cc7af0fc6..df014199ac42 100644 --- a/instrumentation/spring/spring-boot-autoconfigure/metadata.yaml +++ b/instrumentation/spring/spring-boot-autoconfigure/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation auto-configures OpenTelemetry instrumentation for spring-web, spring-webmvc, and spring-webflux to instrument Spring Boot applications. It does not produce telemetry on its own. This instrumentation is mostly used as part of the Spring Boot starter. +library_link: https://spring.io/projects/spring-boot diff --git a/instrumentation/spring/spring-boot-resources/metadata.yaml b/instrumentation/spring/spring-boot-resources/metadata.yaml index daab5c47f19e..633fc39d1ecd 100644 --- a/instrumentation/spring/spring-boot-resources/metadata.yaml +++ b/instrumentation/spring/spring-boot-resources/metadata.yaml @@ -11,4 +11,4 @@ description: > - Check for application.yml in the current working dir - Check for --spring.application.name program argument (not jvm arg) via ProcessHandle - Check for --spring.application.name program argument via sun.java.command system property - +library_link: https://spring.io/projects/spring-boot diff --git a/instrumentation/spring/spring-cloud-aws-3.0/metadata.yaml b/instrumentation/spring/spring-cloud-aws-3.0/metadata.yaml index e7ea9fa15697..7067687d4dcf 100644 --- a/instrumentation/spring/spring-cloud-aws-3.0/metadata.yaml +++ b/instrumentation/spring/spring-cloud-aws-3.0/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation enhances tracing for Spring Cloud AWS. It augments the existing AWS SDK instrumentation by providing higher-level tracing for SQS operations, capturing details specific to Spring Cloud AWS SQS usage and linking them to the underlying AWS SDK traces. +library_link: https://spring.io/projects/spring-cloud-aws diff --git a/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0/metadata.yaml b/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0/metadata.yaml index 49a20769279a..768b671f387a 100644 --- a/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0/metadata.yaml +++ b/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0/metadata.yaml @@ -2,6 +2,7 @@ description: > This instrumentation enhances tracing for Spring Cloud Gateway. It does not generate new telemetry on its own, but rather enriches existing traces produced by other instrumentations like Netty and Spring WebFlux with Spring Cloud Gateway-specific attributes. +library_link: https://github.com/spring-cloud/spring-cloud-gateway configurations: - name: otel.instrumentation.spring-cloud-gateway.experimental-span-attributes type: boolean diff --git a/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.2/metadata.yaml b/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.2/metadata.yaml index 3dd1f70808ce..5eeffa941736 100644 --- a/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.2/metadata.yaml +++ b/instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.2/metadata.yaml @@ -2,6 +2,7 @@ description: > This instrumentation enhances tracing for Spring Cloud Gateway. It does not generate new telemetry on its own, but rather enriches existing traces produced by other instrumentations like Netty and Spring WebFlux with Spring Cloud Gateway-specific attributes. +library_link: https://github.com/spring-cloud/spring-cloud-gateway configurations: - name: otel.instrumentation.spring-cloud-gateway.experimental-span-attributes type: boolean diff --git a/instrumentation/spring/spring-core-2.0/metadata.yaml b/instrumentation/spring/spring-core-2.0/metadata.yaml index 9203a45df486..da3c23a9ab05 100644 --- a/instrumentation/spring/spring-core-2.0/metadata.yaml +++ b/instrumentation/spring/spring-core-2.0/metadata.yaml @@ -3,3 +3,4 @@ description: > within Spring Core. It modifies how tasks are submitted and executed to ensure that spans created by other instrumentations are correctly linked across thread boundaries, rather than generating any new telemetry itself. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/package-summary.html diff --git a/instrumentation/spring/spring-data/spring-data-1.8/metadata.yaml b/instrumentation/spring/spring-data/spring-data-1.8/metadata.yaml index 9d4014d548d8..20ca05bee456 100644 --- a/instrumentation/spring/spring-data/spring-data-1.8/metadata.yaml +++ b/instrumentation/spring/spring-data/spring-data-1.8/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation enhances tracing for Spring Data operations. It works in conjunction with other instrumentations, such as JDBC, to provide additional context and details for database interactions initiated through Spring Data. +library_link: https://spring.io/projects/spring-data diff --git a/instrumentation/spring/spring-data/spring-data-3.0/metadata.yaml b/instrumentation/spring/spring-data/spring-data-3.0/metadata.yaml new file mode 100644 index 000000000000..7b746062f0d1 --- /dev/null +++ b/instrumentation/spring/spring-data/spring-data-3.0/metadata.yaml @@ -0,0 +1 @@ +library_link: https://spring.io/projects/spring-data diff --git a/instrumentation/spring/spring-integration-4.1/metadata.yaml b/instrumentation/spring/spring-integration-4.1/metadata.yaml index fd05e5eca4ca..d36d6c9a8fe2 100644 --- a/instrumentation/spring/spring-integration-4.1/metadata.yaml +++ b/instrumentation/spring/spring-integration-4.1/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables producer and consumer messaging spans for Spring Integration. +library_link: https://spring.io/projects/spring-integration configurations: - name: otel.instrumentation.spring-integration.producer.enabled type: boolean diff --git a/instrumentation/spring/spring-jms/spring-jms-2.0/metadata.yaml b/instrumentation/spring/spring-jms/spring-jms-2.0/metadata.yaml index 43766dc83bf8..843712dc2553 100644 --- a/instrumentation/spring/spring-jms/spring-jms-2.0/metadata.yaml +++ b/instrumentation/spring/spring-jms/spring-jms-2.0/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables the generation of consumer messaging spans for Spring JMS. +library_link: https://docs.spring.io/spring-framework/reference/integration/jms.html configurations: - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled description: > diff --git a/instrumentation/spring/spring-jms/spring-jms-6.0/metadata.yaml b/instrumentation/spring/spring-jms/spring-jms-6.0/metadata.yaml index 43766dc83bf8..843712dc2553 100644 --- a/instrumentation/spring/spring-jms/spring-jms-6.0/metadata.yaml +++ b/instrumentation/spring/spring-jms/spring-jms-6.0/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables the generation of consumer messaging spans for Spring JMS. +library_link: https://docs.spring.io/spring-framework/reference/integration/jms.html configurations: - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled description: > diff --git a/instrumentation/spring/spring-kafka-2.7/metadata.yaml b/instrumentation/spring/spring-kafka-2.7/metadata.yaml index 95e96fbde2db..d1d79df47610 100644 --- a/instrumentation/spring/spring-kafka-2.7/metadata.yaml +++ b/instrumentation/spring/spring-kafka-2.7/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables consumer messaging spans for Spring Kafka listeners. +library_link: https://spring.io/projects/spring-kafka configurations: - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled description: > diff --git a/instrumentation/spring/spring-pulsar-1.0/metadata.yaml b/instrumentation/spring/spring-pulsar-1.0/metadata.yaml index 8dcf52e19f46..434d81f4c054 100644 --- a/instrumentation/spring/spring-pulsar-1.0/metadata.yaml +++ b/instrumentation/spring/spring-pulsar-1.0/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables consumer messaging spans for Spring Pulsar listeners. +library_link: https://spring.io/projects/spring-pulsar configurations: - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled description: > diff --git a/instrumentation/spring/spring-rabbit-1.0/metadata.yaml b/instrumentation/spring/spring-rabbit-1.0/metadata.yaml index 8f991eaaa5bb..8e9386a684d9 100644 --- a/instrumentation/spring/spring-rabbit-1.0/metadata.yaml +++ b/instrumentation/spring/spring-rabbit-1.0/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables consumer messaging spans for Spring RabbitMQ listeners. +library_link: https://spring.io/projects/spring-amqp configurations: - name: otel.instrumentation.messaging.experimental.capture-headers description: A comma-separated list of header names to capture as span attributes. diff --git a/instrumentation/spring/spring-rmi-4.0/metadata.yaml b/instrumentation/spring/spring-rmi-4.0/metadata.yaml index e0c451ba87c8..f26c22bf4483 100644 --- a/instrumentation/spring/spring-rmi-4.0/metadata.yaml +++ b/instrumentation/spring/spring-rmi-4.0/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation enables RPC client and RPC server spans for Spring RMI applications. +library_link: https://docs.spring.io/spring-framework/docs/4.0.x/javadoc-api/org/springframework/remoting/rmi/package-summary.html diff --git a/instrumentation/spring/spring-scheduling-3.1/metadata.yaml b/instrumentation/spring/spring-scheduling-3.1/metadata.yaml index d246e781446e..61a4a8331f06 100644 --- a/instrumentation/spring/spring-scheduling-3.1/metadata.yaml +++ b/instrumentation/spring/spring-scheduling-3.1/metadata.yaml @@ -1,4 +1,5 @@ description: This instrumentation enables tracing for Spring Scheduling tasks. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/package-summary.html configurations: - name: otel.instrumentation.spring-scheduling.experimental-span-attributes description: Adds the experimental span attribute `job.system` with the value `spring_scheduling`. diff --git a/instrumentation/spring/spring-security-config-6.0/metadata.yaml b/instrumentation/spring/spring-security-config-6.0/metadata.yaml index a009f50b527a..01f796b4a337 100644 --- a/instrumentation/spring/spring-security-config-6.0/metadata.yaml +++ b/instrumentation/spring/spring-security-config-6.0/metadata.yaml @@ -3,6 +3,7 @@ description: > attributes, and is only enabled when at least one of the `enduser` configurations is enabled. NOTE: The `enduser` attributes have been deprecated and will be removed in 3.0+ of the java agent. +library_link: https://spring.io/projects/spring-security configurations: - name: otel.instrumentation.common.enduser.id.enabled description: Enables capturing the enduser.id attribute. diff --git a/instrumentation/spring/spring-web/spring-web-3.1/metadata.yaml b/instrumentation/spring/spring-web/spring-web-3.1/metadata.yaml index 969b249906f4..605729f25d17 100644 --- a/instrumentation/spring/spring-web/spring-web-3.1/metadata.yaml +++ b/instrumentation/spring/spring-web/spring-web-3.1/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation provides a library integration that enables capturing HTTP client spans and metrics for Spring's RestTemplate. The agent integration enriches HTTP server spans and metrics with route information. +library_link: https://github.com/spring-projects/spring-framework diff --git a/instrumentation/spring/spring-web/spring-web-6.0/metadata.yaml b/instrumentation/spring/spring-web/spring-web-6.0/metadata.yaml index 4b044e2b1fdb..03ec81331a22 100644 --- a/instrumentation/spring/spring-web/spring-web-6.0/metadata.yaml +++ b/instrumentation/spring/spring-web/spring-web-6.0/metadata.yaml @@ -1 +1,2 @@ description: This instrumentation enriches HTTP server spans and metrics with route information. +library_link: https://github.com/spring-projects/spring-framework diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.0/metadata.yaml b/instrumentation/spring/spring-webflux/spring-webflux-5.0/metadata.yaml index 630264ea798f..776f06d5655b 100644 --- a/instrumentation/spring/spring-webflux/spring-webflux-5.0/metadata.yaml +++ b/instrumentation/spring/spring-webflux/spring-webflux-5.0/metadata.yaml @@ -1,6 +1,7 @@ description: > This instrumentation enables HTTP client spans and metrics for Spring WebFlux 5.0. It also optionally enables experimental controller (INTERNAL) spans. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html configurations: - name: otel.instrumentation.common.experimental.controller-telemetry.enabled description: Enables the creation of experimental controller (INTERNAL) spans. diff --git a/instrumentation/spring/spring-webflux/spring-webflux-5.3/metadata.yaml b/instrumentation/spring/spring-webflux/spring-webflux-5.3/metadata.yaml index 4879f014a113..5dcb53a29913 100644 --- a/instrumentation/spring/spring-webflux/spring-webflux-5.3/metadata.yaml +++ b/instrumentation/spring/spring-webflux/spring-webflux-5.3/metadata.yaml @@ -1,3 +1,4 @@ description: > This instrumentation provides a library integration for the Spring WebFlux WebClient and Webflux server versions 5.3+ that enables HTTP client and server spans and metrics. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/metadata.yaml b/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/metadata.yaml index 44d7d559e3ed..d5bebf7ccbc6 100644 --- a/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/metadata.yaml +++ b/instrumentation/spring/spring-webmvc/spring-webmvc-3.1/metadata.yaml @@ -1,5 +1,6 @@ description: > This instrumentation enables optional Controller and View (INTERNAL) spans for Spring WebMVC 3.1+. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html configurations: - name: otel.instrumentation.spring-webmvc.experimental-span-attributes type: boolean diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/metadata.yaml b/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/metadata.yaml index 4beb4df459f4..b9d4aabccbf8 100644 --- a/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/metadata.yaml +++ b/instrumentation/spring/spring-webmvc/spring-webmvc-5.3/metadata.yaml @@ -2,3 +2,4 @@ description: > This instrumentation provides a library integration for Spring WebMVC controllers, that enables the creation of HTTP server spans and metrics for requests processed by the Spring servlet container. +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html diff --git a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/metadata.yaml b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/metadata.yaml index a38d74b6f05d..d83156806bc2 100644 --- a/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/metadata.yaml +++ b/instrumentation/spring/spring-webmvc/spring-webmvc-6.0/metadata.yaml @@ -15,3 +15,4 @@ configurations: description: Enables the creation of experimental view (INTERNAL) spans. type: boolean default: false +library_link: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html diff --git a/instrumentation/spring/spring-ws-2.0/metadata.yaml b/instrumentation/spring/spring-ws-2.0/metadata.yaml index 1aee203e711b..f31c0d39d62d 100644 --- a/instrumentation/spring/spring-ws-2.0/metadata.yaml +++ b/instrumentation/spring/spring-ws-2.0/metadata.yaml @@ -1 +1,2 @@ disabled_by_default: true +library_link: https://spring.io/projects/spring-ws diff --git a/instrumentation/vibur-dbcp-11.0/metadata.yaml b/instrumentation/vibur-dbcp-11.0/metadata.yaml index 991cdddecce9..bd49143610d0 100644 --- a/instrumentation/vibur-dbcp-11.0/metadata.yaml +++ b/instrumentation/vibur-dbcp-11.0/metadata.yaml @@ -1 +1,2 @@ description: Instrumentation for the vibur-dbcp library, which provides connection pool metrics. +library_link: https://www.vibur.org/ From 340d5d682e745e98e9ac432ec722dcabaed4ea19 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Thu, 11 Sep 2025 13:15:50 -0400 Subject: [PATCH 2/2] use alternate spark link --- docs/instrumentation-list.yaml | 2 +- instrumentation/spark-2.3/metadata.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index a466a60b4fea..260aaa239343 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -6135,7 +6135,7 @@ libraries: - name: spark-2.3 description: | This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and attaches it to HTTP server spans and HTTP server metrics. - library_link: https://github.com/perwendel/spark + library_link: https://sparkjava.com/ source_path: instrumentation/spark-2.3 scope: name: io.opentelemetry.spark-2.3 diff --git a/instrumentation/spark-2.3/metadata.yaml b/instrumentation/spark-2.3/metadata.yaml index 6898b7a3d3d7..a51d1eaab275 100644 --- a/instrumentation/spark-2.3/metadata.yaml +++ b/instrumentation/spark-2.3/metadata.yaml @@ -1,4 +1,4 @@ description: > This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and attaches it to HTTP server spans and HTTP server metrics. -library_link: https://github.com/perwendel/spark +library_link: https://sparkjava.com/