Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/contributing/documenting-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,33 +86,33 @@ At a minimum, every instrumentation metadata file should include a `description`

Some example descriptions:

* This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server.
* This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.
* This instrumentation provides context propagation for Akka actors, it does not emit any telemetry
on its own.
* The Alibaba Druid instrumentation generates database connection pool metrics for druid data sources.
* The Apache Dubbo instrumentation provides CLIENT and SERVER spans
for 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.
* The Apache Dubbo instrumentation provides RPC client spans and RPC server spans for 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.

Some notes when writing descriptions:

* You don't always need to explicitly name the instrumentation, and you can start with "This
instrumentation..."
* Prefer the convention of using the word "enables" when describing what the instrumentation does,
"This instrumentation enables SERVER spans and metrics for the ActiveJ" instead of something like
"This instrumentation provides SERVER spans and metrics for the ActiveJ".
"This instrumentation **enables** HTTP server spans and HTTP server metrics for the ActiveJ" instead
of something like "This instrumentation **provides** HTTP server spans and HTTP server metrics for the ActiveJ".
* Explicitly state whether the instrumentation generates new telemetry (spans, metrics, logs).
* If it doesn't generate new telemetry, clearly explain what it's purpose is, for example whether it
augments or enriches existing telemetry produced by other instrumentations (e.g., by adding
attributes or ensuring context propagation).
* When describing the functionality of the instrumentation and the telemetry, specify using
[semantic convention categories](https://opentelemetry.io/docs/specs/semconv/) when possible
(e.g., "database client spans", "RPC server metrics", "consumer messaging spans").
* Do not include specific method names, class names, or other low-level implementation details in
the description unless they are essential to understanding the purpose of the instrumentation.
* It is not usually necessary to include specific library or framework version numbers in the
description, unless that context is significant in some way.
* When an instrumentation generates spans, be specific about the SpanKind (e.g., SERVER, CLIENT,
PRODUCER, CONSUMER, INTERNAL).
* Capitalize SpanKind values (e.g., SERVER, CLIENT) when used in descriptions.


### Configurations
Expand Down
127 changes: 65 additions & 62 deletions docs/instrumentation-list.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion instrumentation/activej-http-6.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables SERVER spans and metrics for the ActiveJ HTTP server.
description: This instrumentation enables HTTP server spans and HTTP server metrics for the ActiveJ HTTP server.
4 changes: 3 additions & 1 deletion instrumentation/akka/akka-http-10.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
description: This instrumentation enables CLIENT and SERVER spans and metrics for the Akka HTTP client and server.
description: >
This instrumentation enables HTTP client spans and metrics for the Akka HTTP client, and HTTP
server spans and metrics for the Akka HTTP server.
8 changes: 4 additions & 4 deletions instrumentation/apache-dubbo-2.7/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
description: The Apache Dubbo instrumentation provides client and server spans for 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.
description: The Apache Dubbo instrumentation provides RPC client spans and RPC server spans for
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.
configurations:
- name: otel.instrumentation.common.peer-service-mapping
description: Used to specify a mapping from host names or IP addresses to peer services.
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/apache-httpasyncclient-4.1/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for the Apache HttpAsyncClient.
description: This instrumentation enables HTTP client spans and HTTP client metrics for the Apache HttpAsyncClient.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for versions 2 and 3 of the Apache HttpClient.
description: This instrumentation enables HTTP client spans and HTTP client metrics for versions 2 and 3 of the Apache HttpClient.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for version 4 of the Apache HttpClient.
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 4 of the Apache HttpClient.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation provides a library integration that enables CLIENT spans and metrics for the Apache HttpClient.
description: This instrumentation provides a library integration that enables HTTP client spans and HTTP client metrics for the Apache HttpClient.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for version 5 of the Apache HttpClient.
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 5 of the Apache HttpClient.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation provides a library integration that enables CLIENT spans and metrics for the Apache HttpClient.
description: This instrumentation provides a library integration that enables HTTP client spans and HTTP client metrics for the Apache HttpClient.
2 changes: 1 addition & 1 deletion instrumentation/apache-shenyu-2.4/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
description: >
This instrumentation does not emit telemetry on its own. Instead, it augments existing SERVER
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.
configurations:
- name: otel.instrumentation.apache-shenyu.experimental-span-attributes
Expand Down
4 changes: 3 additions & 1 deletion instrumentation/armeria/armeria-1.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
description: This instrumentation enables CLIENT and SERVER spans and metrics for the Armeria HTTP client and server.
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.
4 changes: 3 additions & 1 deletion instrumentation/armeria/armeria-grpc-1.14/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
description: This instrumentation enables CLIENT and SERVER spans and metrics for the Armeria gRPC client and server.
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.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for version 1 of the AsyncHttpClient (AHC) HTTP client.
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 1 of the AsyncHttpClient (AHC) HTTP client.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT spans and metrics for version 2 of the AsyncHttpClient (AHC) HTTP client.
description: This instrumentation enables HTTP client spans and HTTP client metrics for version 2 of the AsyncHttpClient (AHC) HTTP client.
2 changes: 1 addition & 1 deletion instrumentation/avaje-jex-3.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,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 SERVER spans and HTTP server
Context to extract the HTTP route and attach it to existing HTTP server spans and HTTP server
metrics.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
description: >
Provides lightweight instrumentation of the Lambda core library, supporting all versions. It
generates FaaS SERVER spans with the `faas.invocation_id` attribute. Use this package if you only
generates FaaS server spans with the `faas.invocation_id` attribute. Use this package if you only
use `RequestStreamHandler` or know you don't use any event classes from `aws-lambda-java-events`.
This also includes when you are using `aws-serverless-java-container` to run e.g., a Spring Boot
application on Lambda.
Expand Down
6 changes: 3 additions & 3 deletions instrumentation/couchbase/couchbase-2.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: >
This instrumentation enables database CLIENT spans and metrics for Couchbase 2.0 operations.
It automatically traces key-value operations (get, upsert, replace, remove), view queries, N1QL
queries, and cluster management operations.
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.
6 changes: 3 additions & 3 deletions instrumentation/couchbase/couchbase-2.6/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
description: >
This instrumentation enables database CLIENT spans and metrics for Couchbase 2.6 operations.
It automatically traces key-value operations (get, upsert, replace, remove), view queries, N1QL
queries, and cluster management operations.
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.
configurations:
- name: otel.instrumentation.couchbase.experimental-span-attributes
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables database CLIENT spans and metrics for Elasticsearch REST clients.
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables database CLIENT spans and metrics for Elasticsearch REST clients.
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables database CLIENT spans and metrics for Elasticsearch REST clients.
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
description: >
This instrumentation enables CLIENT spans and metrics for Elasticsearch transport client requests.
Each call produces a span named after the Elasticsearch action, enriched with transport-specific
attributes.
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.
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
description: >
This instrumentation enables CLIENT spans and metrics for Elasticsearch transport client requests.
Each call produces a span named after the Elasticsearch action, enriched with transport-specific
attributes.
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.
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
description: >
This instrumentation enables CLIENT spans and metrics for Elasticsearch transport client requests.
Each call produces a span named after the Elasticsearch action, enriched with transport-specific
attributes.
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.
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: >
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/geode-1.4/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables database CLIENT spans and metrics for Apache Geode cache operations.
description: This instrumentation enables database client spans and database client metrics for Apache Geode cache operations.
configurations:
- name: otel.instrumentation.common.db-statement-sanitizer.enabled
description: Enables statement sanitization for database queries.
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/google-http-client-1.19/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables HTTP CLIENT spans and metrics for Google HTTP Client requests.
description: This instrumentation enables HTTP client spans and HTTP client metrics for Google HTTP Client requests.
configurations:
- name: otel.instrumentation.http.known-methods
description: >
Expand Down
4 changes: 2 additions & 2 deletions instrumentation/grails-3.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
description: >
This instrumentation enriches existing SERVER spans with route information, and optionally enables
experimental controller (INTERNAL) spans for Grails applications.
This instrumentation enriches existing HTTP server spans with HTTP route information, and
optionally enables experimental controller (INTERNAL) spans for Grails applications.
configurations:
- name: otel.instrumentation.common.experimental.controller-telemetry.enabled
description: Enables the creation of experimental controller (INTERNAL) spans.
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/grizzly-2.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables HTTP SERVER spans and metrics for Grizzly applications.
description: This instrumentation enables HTTP server spans and HTTP server metrics for Grizzly applications.
configurations:
- name: otel.instrumentation.http.known-methods
description: >
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/grpc-1.6/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables RPC CLIENT and SERVER spans and metrics for gRPC version 1.6 and above.
description: This instrumentation enables RPC client spans and metrics, and RPC server spans and metrics for gRPC version 1.6 and above.
configurations:
- name: otel.instrumentation.grpc.emit-message-events
type: boolean
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/gwt-2.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables SERVER spans for GWT RPC requests.
description: This instrumentation enables RPC server spans for GWT RPC requests.
2 changes: 1 addition & 1 deletion instrumentation/spark-2.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
description: >
This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and
attaches it to SERVER spans and HTTP server metrics.
attaches it to HTTP server spans and HTTP server metrics.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables PRODUCER and CONSUMER spans for Spring Integration.
description: This instrumentation enables producer and consumer messaging spans for Spring Integration.
configurations:
- name: otel.instrumentation.spring-integration.producer.enabled
type: boolean
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables the generation of CONSUMER spans for Spring JMS.
description: This instrumentation enables the generation of consumer messaging spans for Spring JMS.
configurations:
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
description: >
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables the generation of CONSUMER spans for Spring JMS.
description: This instrumentation enables the generation of consumer messaging spans for Spring JMS.
configurations:
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
description: >
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/spring/spring-kafka-2.7/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables CONSUMER spans for Spring Kafka listeners.
description: This instrumentation enables consumer messaging spans for Spring Kafka listeners.
configurations:
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
description: >
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/spring/spring-pulsar-1.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables CONSUMER spans for Spring Pulsar listeners.
description: This instrumentation enables consumer messaging spans for Spring Pulsar listeners.
configurations:
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
description: >
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/spring/spring-rabbit-1.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: This instrumentation enables CONSUMER spans for Spring RabbitMQ listeners.
description: This instrumentation enables consumer messaging spans for Spring RabbitMQ listeners.
configurations:
- name: otel.instrumentation.messaging.experimental.capture-headers
description: A comma-separated list of header names to capture as span attributes.
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/spring/spring-rmi-4.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
description: This instrumentation enables CLIENT and SERVER spans for Spring RMI applications.
description: This instrumentation enables RPC client and RPC server spans for Spring RMI applications.
Loading