Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
54 changes: 54 additions & 0 deletions docs/instrumentation-list.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion instrumentation/executors/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/finagle-http-23.11/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions instrumentation/finatra-2.9/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions instrumentation/geode-1.4/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/grails-3.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/grizzly-2.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/grpc-1.6/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/gwt-2.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
description: This instrumentation enables RPC server spans for GWT RPC requests.
library_link: https://www.gwtproject.org/
1 change: 1 addition & 0 deletions instrumentation/hibernate/hibernate-3.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/hibernate/hibernate-4.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/hibernate/hibernate-6.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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/
1 change: 1 addition & 0 deletions instrumentation/hikaricp-3.0/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions instrumentation/http-url-connection/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/hystrix-1.4/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/influxdb-2.4/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions instrumentation/java-http-client/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/java-http-server/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/javalin-5.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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/
1 change: 1 addition & 0 deletions instrumentation/jdbc/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/kafka/kafka-streams-0.11/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
library_link: https://kafka.apache.org/documentation/streams/
1 change: 1 addition & 0 deletions instrumentation/openai/openai-java-1.1/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/oracle-ucp-11.2/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
description: The Oracle Universal Connection Pool (UCP) instrumentation generates connection pool metrics.
library_link: https://docs.oracle.com/database/121/JJUCP/
1 change: 1 addition & 0 deletions instrumentation/oshi/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ configurations:
description: Enable the OSHI process runtime metrics.
type: boolean
default: false
library_link: https://github.com/oshi/oshi/
1 change: 1 addition & 0 deletions instrumentation/spark-2.3/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Copy link
Member

Choose a reason for hiding this comment

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

maybe?

Suggested change
library_link: https://github.com/perwendel/spark
library_link: https://sparkjava.com

1 change: 1 addition & 0 deletions instrumentation/spring/spring-batch-3.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-core-2.0/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
library_link: https://spring.io/projects/spring-data
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-kafka-2.7/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-pulsar-1.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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: >
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-rabbit-1.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-rmi-4.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
description: This instrumentation enriches HTTP server spans and metrics with route information.
library_link: https://github.com/spring-projects/spring-framework
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions instrumentation/spring/spring-ws-2.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
disabled_by_default: true
library_link: https://spring.io/projects/spring-ws
1 change: 1 addition & 0 deletions instrumentation/vibur-dbcp-11.0/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
description: Instrumentation for the vibur-dbcp library, which provides connection pool metrics.
library_link: https://www.vibur.org/
Loading