more links

jaydeluca · jaydeluca · commit ded48b54c3fa · 2025-09-10T07:21:21.000-04:00
diff --git a/docs/contributing/documenting-instrumentation.md b/docs/contributing/documenting-instrumentation.md
@@ -80,6 +80,20 @@ Each instrumentation should have a `metadata.yaml` file in the root of the instr
 (`instrumentation/{some instrumentation}/metadata.yaml`) that contains structured metadata about the
 instrumentation.
 
+Example:
+
+```yaml
+description: "This instrumentation enables..."
+disabled_by_default: true
+classification: library
+library_link: "https://..."
+configurations:
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables statement sanitization for database queries.
+    type: boolean
+    default: true
+```
+
 ### Description (required)
 
 At a minimum, every instrumentation metadata file should include a `description`.
@@ -114,6 +128,10 @@ Some notes when writing descriptions:
 * It is not usually necessary to include specific library or framework version numbers in the
   description, unless that context is significant in some way.
 
+### Library Link
+
+For library instrumentations, include a `library_link` field with a URL to the library or framework's
+main website or documentation, or if those don't exist, the GitHub repository.
 
 ### Configurations
 
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
diff --git a/instrumentation-docs/readme.md b/instrumentation-docs/readme.md
@@ -114,6 +114,9 @@ public class SpringWebInstrumentationModule extends InstrumentationModule
 * name
   * Identifier for instrumentation module, used to enable/disable
   * Configured in `InstrumentationModule` code for each module
+* library_link
+  * URL to the library or framework's main website or documentation, or if those don't exist, the
+  GitHub repository.
 * source_path
   * Path to the source code of the instrumentation module
 * minimum_java_version
@@ -145,9 +148,10 @@ additional information about the instrumentation module.
 As of now, the following fields are supported, all of which are optional:
 
 ```yaml
-description: "Instruments..."   # Description of the instrumentation module
-disabled_by_default: true       # Defaults to `false`
-classification: internal        # instrumentation classification: library | internal | custom
+description: "This instrumentation enables..."    # Description of the instrumentation module
+disabled_by_default: true                         # Defaults to `false`
+classification: internal                          # instrumentation classification: library | internal | custom
+library_link: "https://..."                       # URL to the library or framework's main website or documentation
 configurations:
   - name: otel.instrumentation.common.db-statement-sanitizer.enabled
     description: Enables statement sanitization for database queries.
diff --git a/instrumentation/activej-http-6.0/metadata.yaml b/instrumentation/activej-http-6.0/metadata.yaml
@@ -1,2 +1,2 @@
 description: This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.
-library_link: https://activej.io/
+library_link: https://github.com/activej/activej
diff --git a/instrumentation/akka/akka-actor-2.3/metadata.yaml b/instrumentation/akka/akka-actor-2.3/metadata.yaml
@@ -1,2 +1,2 @@
 description: This instrumentation provides context propagation for Akka actors, it does not emit any telemetry on its own.
-library_link: https://doc.akka.io/docs/akka/current/typed/index.html
+library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
diff --git a/instrumentation/akka/akka-actor-fork-join-2.5/metadata.yaml b/instrumentation/akka/akka-actor-fork-join-2.5/metadata.yaml
@@ -1,2 +1,2 @@
 description: This instrumentation provides context propagation for the Akka Fork-Join Pool, it does not emit any telemetry on its own.
-library_link: https://doc.akka.io/docs/akka/current/typed/index.html
+library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
diff --git a/instrumentation/apache-dbcp-2.0/metadata.yaml b/instrumentation/apache-dbcp-2.0/metadata.yaml
@@ -5,3 +5,4 @@ description: >
   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.
+library_link: https://commons.apache.org/proper/commons-dbcp/
diff --git a/instrumentation/apache-dubbo-2.7/metadata.yaml b/instrumentation/apache-dubbo-2.7/metadata.yaml
@@ -2,6 +2,7 @@ description: The Apache Dubbo instrumentation provides RPC client spans and RPC
   Apache Dubbo RPC calls. Each call produces a span named after the Dubbo method, enriched with
   standard RPC attributes (system, service, method), network attributes, and error details if an
   exception occurs.
+library_link: https://github.com/apache/dubbo/
 configurations:
   - name: otel.instrumentation.common.peer-service-mapping
     description: Used to specify a mapping from host names or IP addresses to peer services.
diff --git a/instrumentation/apache-httpasyncclient-4.1/metadata.yaml b/instrumentation/apache-httpasyncclient-4.1/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for the Apache HttpAsyncClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-2.0/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for versions 2 and 3 of the Apache HttpClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-4.0/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for version 4 of the Apache HttpClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-4.3/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-4.3/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation provides a library integration that enables HTTP client spans and HTTP client metrics for the Apache HttpClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.0/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for version 5 of the Apache HttpClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/library/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml b/instrumentation/apache-httpclient/apache-httpclient-5.2/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation provides a library integration that enables HTTP client spans and HTTP client metrics for the Apache HttpClient.
+library_link: https://hc.apache.org/index.html
diff --git a/instrumentation/apache-shenyu-2.4/metadata.yaml b/instrumentation/apache-shenyu-2.4/metadata.yaml
@@ -1,6 +1,7 @@
 description: >
   This instrumentation does not emit telemetry on its own. Instead, it augments existing HTTP server
   spans and HTTP server metrics with the HTTP route and Shenyu specific attributes.
+library_link: https://shenyu.apache.org/
 configurations:
   - name: otel.instrumentation.apache-shenyu.experimental-span-attributes
     description: > 
diff --git a/instrumentation/armeria/armeria-1.3/metadata.yaml b/instrumentation/armeria/armeria-1.3/metadata.yaml
@@ -1,3 +1,4 @@
 description: >
   This instrumentation enables HTTP client spans and metrics for the Armeria HTTP client, and HTTP
   server spans and metrics for the Armeria HTTP server.
+library_link: https://armeria.dev/
diff --git a/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml b/instrumentation/armeria/armeria-grpc-1.14/metadata.yaml
@@ -1,3 +1,4 @@
 description: >
   This instrumentation enables RPC client spans and metrics for the Armeria gRPC client, and RPC
   server spans and metrics for the Armeria gRPC server.
+library_link: https://armeria.dev/
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
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for version 1 of the AsyncHttpClient (AHC) HTTP client.
+library_link: https://github.com/AsyncHttpClient/async-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
@@ -1 +1,2 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for version 2 of the AsyncHttpClient (AHC) HTTP client.
+library_link: https://github.com/AsyncHttpClient/async-http-client
diff --git a/instrumentation/avaje-jex-3.0/metadata.yaml b/instrumentation/avaje-jex-3.0/metadata.yaml
@@ -2,3 +2,4 @@ description: >
   This instrumentation does not emit telemetry on its own. Instead, it hooks into the Avaje Jex
   Context to extract the HTTP route and attach it to existing HTTP server spans and HTTP server
   metrics.
+library_link: https://avaje.io/jex/
diff --git a/instrumentation/aws-lambda/aws-lambda-core-1.0/metadata.yaml b/instrumentation/aws-lambda/aws-lambda-core-1.0/metadata.yaml
@@ -8,6 +8,7 @@ description: >
   For custom wrappers when using library instrumentation, you can configure the `OTEL_INSTRUMENTATION_AWS_LAMBDA_HANDLER`
   environment variable to contain your lambda handler method (in the format `package.ClassName::methodName`) and use
   one of wrappers as your lambda `Handler`.
+library_link: https://docs.aws.amazon.com/lambda/latest/dg/java-handler.html
 configurations:
   - name: otel.instrumentation.aws-lambda.flush-timeout
     type: int
diff --git a/instrumentation/aws-lambda/aws-lambda-events-2.2/metadata.yaml b/instrumentation/aws-lambda/aws-lambda-events-2.2/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This version of the library instrumentation is deprecated, please use the `aws-lambda-events-3.11`
   library instrumentation instead. This instrumentation builds on top of the `aws-lambda-core-1.0`
   instrumentation, expanding support to cover the Lambda library, including standard and custom event types.
+library_link: https://docs.aws.amazon.com/lambda/latest/dg/java-handler.html
 configurations:
   - name: otel.instrumentation.aws-lambda.flush-timeout
     type: int
diff --git a/instrumentation/aws-lambda/aws-lambda-events-3.11/metadata.yaml b/instrumentation/aws-lambda/aws-lambda-events-3.11/metadata.yaml
@@ -1,6 +1,7 @@
 description: >
   This instrumentation builds on top of the `aws-lambda-core-1.0` instrumentation, expanding support
   to cover the Lambda library, including standard and custom event types.
+library_link: https://docs.aws.amazon.com/lambda/latest/dg/java-handler.html
 configurations:
   - name: otel.instrumentation.aws-lambda.flush-timeout
     type: int
diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/metadata.yaml b/instrumentation/aws-sdk/aws-sdk-1.11/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This instrumentation covers the AWS SDK 1.11+ client library, enabling messaging and client spans
   and metrics for calls to AWS services including DynamoDB, EC2, Kinesis, Lambda, RDS, S3, secrets
   manager, SNS/SQS and step functions.
+library_link: https://aws.amazon.com/sdk-for-java/
 configurations:
   - name: otel.instrumentation.aws-sdk.experimental-span-attributes
     description: >
diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/metadata.yaml b/instrumentation/aws-sdk/aws-sdk-2.2/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This instrumentation covers the AWS SDK 2.2+ client library, enabling messaging and client spans
   and metrics for calls to AWS services including DynamoDB, EC2, Kinesis, Lambda, RDS, S3, SNS/SQS
   and Bedrock.
+library_link: https://aws.amazon.com/sdk-for-java/
 configurations:
   - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
     description: >
diff --git a/instrumentation/azure-core/azure-core-1.14/metadata.yaml b/instrumentation/azure-core/azure-core-1.14/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables context propagation for the Azure Core library, it does not emit any telemetry on its own.
+library_link: https://learn.microsoft.com/en-us/java/api/overview/azure/core-readme?view=azure-java-stable
diff --git a/instrumentation/azure-core/azure-core-1.19/metadata.yaml b/instrumentation/azure-core/azure-core-1.19/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables context propagation for the Azure Core library, it does not emit any telemetry on its own.
+library_link: https://learn.microsoft.com/en-us/java/api/overview/azure/core-readme?view=azure-java-stable
diff --git a/instrumentation/azure-core/azure-core-1.36/metadata.yaml b/instrumentation/azure-core/azure-core-1.36/metadata.yaml
@@ -1 +1,2 @@
 description: This instrumentation enables context propagation for the Azure Core library, it does not emit any telemetry on its own.
+library_link: https://learn.microsoft.com/en-us/java/api/overview/azure/core-readme?view=azure-java-stable
diff --git a/instrumentation/camel-2.20/metadata.yaml b/instrumentation/camel-2.20/metadata.yaml
@@ -2,6 +2,7 @@ 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.
+library_link: https://camel.apache.org/
 configurations:
   - name: otel.instrumentation.camel.experimental-span-attributes
     description: >
diff --git a/instrumentation/cassandra/cassandra-3.0/metadata.yaml b/instrumentation/cassandra/cassandra-3.0/metadata.yaml
@@ -1,6 +1,7 @@
 description: >
   Instruments the Cassandra database client, providing database client spans and metrics for
   Cassandra queries.
+library_link: https://github.com/apache/cassandra-java-driver
 configurations:
   - name: otel.instrumentation.common.db-statement-sanitizer.enabled
     description: Enables statement sanitization for database queries.
diff --git a/instrumentation/cassandra/cassandra-4.0/metadata.yaml b/instrumentation/cassandra/cassandra-4.0/metadata.yaml
@@ -1,6 +1,7 @@
 description: >
   Instruments the Cassandra database client, providing database client spans and metrics for
   Cassandra queries.
+library_link: https://github.com/apache/cassandra-java-driver
 configurations:
   - name: otel.instrumentation.common.db-statement-sanitizer.enabled
     description: Enables statement sanitization for database queries.
diff --git a/instrumentation/cassandra/cassandra-4.4/metadata.yaml b/instrumentation/cassandra/cassandra-4.4/metadata.yaml
@@ -1,6 +1,7 @@
 description: >
   Instruments the Cassandra database client, providing database client spans and metrics for
   Cassandra queries.
+library_link: https://github.com/apache/cassandra-java-driver
 configurations:
   - name: otel.instrumentation.common.db-statement-sanitizer.enabled
     description: Enables statement sanitization for database queries.
diff --git a/instrumentation/clickhouse-client-0.5/metadata.yaml b/instrumentation/clickhouse-client-0.5/metadata.yaml
@@ -1,4 +1,5 @@
 description: Instruments the V1 ClickHouseClient, providing database client spans and metrics.
+library_link: https://github.com/ClickHouse/clickhouse-java
 configurations:
   - name: otel.instrumentation.common.db-statement-sanitizer.enabled
     description: Enables statement sanitization for database queries.
diff --git a/instrumentation/couchbase/couchbase-2.0/metadata.yaml b/instrumentation/couchbase/couchbase-2.0/metadata.yaml
@@ -2,3 +2,4 @@ description: >
   This instrumentation enables database client spans and database client metrics for Couchbase 2.0
   operations. It automatically traces key-value operations (get, upsert, replace, remove), view
   queries, N1QL queries, and cluster management operations.
+library_link: https://github.com/couchbase/couchbase-java-client
diff --git a/instrumentation/couchbase/couchbase-2.6/metadata.yaml b/instrumentation/couchbase/couchbase-2.6/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This instrumentation enables database client spans and database client metrics for Couchbase 2.6
   operations. It automatically traces key-value operations (get, upsert, replace, remove), view
   queries, N1QL queries, and cluster management operations.
+library_link: https://github.com/couchbase/couchbase-java-client
 configurations:
   - name: otel.instrumentation.couchbase.experimental-span-attributes
     description: >
diff --git a/instrumentation/couchbase/couchbase-3.1.6/metadata.yaml b/instrumentation/couchbase/couchbase-3.1.6/metadata.yaml
@@ -1,3 +1,4 @@
 description: >
   Couchbase instrumentation is owned by the Couchbase project for versions 3+. This instrumentation
   automatically configures the instrumentation provided by the Couchbase library.
+library_link: https://github.com/couchbase/couchbase-java-client
diff --git a/instrumentation/couchbase/couchbase-3.1/metadata.yaml b/instrumentation/couchbase/couchbase-3.1/metadata.yaml
@@ -1,3 +1,4 @@
 description: >
   Couchbase instrumentation is owned by the Couchbase project for versions 3+. This instrumentation
   automatically configures the instrumentation provided by the Couchbase library.
+library_link: https://github.com/couchbase/couchbase-java-client
diff --git a/instrumentation/couchbase/couchbase-3.2/metadata.yaml b/instrumentation/couchbase/couchbase-3.2/metadata.yaml
@@ -1,3 +1,4 @@
 description: >
   Couchbase instrumentation is owned by the Couchbase project for versions 3+. This instrumentation
   automatically configures the instrumentation provided by the Couchbase library.
+library_link: https://github.com/couchbase/couchbase-java-client
diff --git a/instrumentation/dropwizard/dropwizard-metrics-4.0/metadata.yaml b/instrumentation/dropwizard/dropwizard-metrics-4.0/metadata.yaml
@@ -5,6 +5,7 @@ description: >
   The Dropwizard metrics API does not have a concept of metric labels/tags/attributes, thus the data
   produced by this integration might be of very low quality, depending on how the API is used in the
   instrumented application.
+library_link: https://metrics.dropwizard.io/4.2.0/
 disabled_by_default: true
 configurations:
   - name: otel.instrumentation.dropwizard-metrics.enabled
diff --git a/instrumentation/dropwizard/dropwizard-views-0.7/metadata.yaml b/instrumentation/dropwizard/dropwizard-views-0.7/metadata.yaml
@@ -1,4 +1,5 @@
 description: This instrumentation enables the creation of spans for Dropwizard views.
+library_link: https://www.dropwizard.io/en/latest/manual/views.html
 configurations:
   - name: otel.instrumentation.common.experimental.view-telemetry.enabled
     description: Enables the creation of experimental view (INTERNAL) spans.
diff --git a/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml
@@ -1,5 +1,6 @@
 description: >
   This instrumentation extends the elasticsearch-rest-7.0 instrumentation by adding
   additional `db.elasticsearch.path_parts.id` and `db.elasticsearch.path_parts.index` attributes to
-  Elasticsearch CLIENT spans. Versions 8.10 and later of the client have native support for
+  Elasticsearch database client spans. Versions 8.10 and later of the client have native support for
   OpenTelemetry.
+library_link: https://www.elastic.co/docs/reference/elasticsearch/clients/java
diff --git a/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml
@@ -1,4 +1,5 @@
 description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
 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
@@ -1,4 +1,5 @@
 description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
 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
@@ -1,4 +1,5 @@
 description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
 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
@@ -2,6 +2,7 @@ description: >
   This instrumentation enables database client spans and database client metrics for Elasticsearch
   transport client requests. Each call produces a span named after the Elasticsearch action,
   enriched with transport-specific attributes.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
 configurations:
   - name: otel.instrumentation.elasticsearch.experimental-span-attributes
     description: >
diff --git a/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This instrumentation enables database client spans and database client metrics for Elasticsearch
   transport client requests. Each call produces a span named after the Elasticsearch action,
   enriched with transport-specific attributes.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
 configurations:
   - name: otel.instrumentation.elasticsearch.experimental-span-attributes
     description: >
diff --git a/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml b/instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml
@@ -2,6 +2,7 @@ description: >
   This instrumentation enables database client spans and database client metrics for Elasticsearch
   transport client requests. Each call produces a span named after the Elasticsearch action,
   enriched with transport-specific attributes.
+library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
 configurations:
   - name: otel.instrumentation.elasticsearch.experimental-span-attributes
     description: >

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`description: This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.`
`2`		`-library_link: https://activej.io/`
	`2`	`+library_link: https://github.com/activej/activej`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`description: This instrumentation provides context propagation for Akka actors, it does not emit any telemetry on its own.`
`2`		`-library_link: https://doc.akka.io/docs/akka/current/typed/index.html`
	`2`	`+library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`description: This instrumentation enables HTTP client spans and HTTP client metrics for the Apache HttpAsyncClient.`
	`2`	`+library_link: https://hc.apache.org/index.html`