diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 9e4381b43b8e..4607f9b13ec7 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -9109,6 +9109,12 @@ libraries: type: STRING okhttp: - name: okhttp-2.2 + display_name: OkHttp + description: This instrumentation enables HTTP client spans and HTTP client metrics + for OkHttp. + semantic_conventions: + - HTTP_CLIENT_SPANS + - HTTP_CLIENT_METRICS source_path: instrumentation/okhttp/okhttp-2.2 scope: name: io.opentelemetry.okhttp-2.2 @@ -9116,6 +9122,34 @@ libraries: target_versions: javaagent: - com.squareup.okhttp:okhttp:[2.2,3) + configurations: + - name: otel.instrumentation.http.known-methods + description: | + Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`. + type: list + default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE + - name: otel.instrumentation.http.client.capture-request-headers + description: List of HTTP request headers to capture in HTTP client telemetry. + type: list + default: '' + - name: otel.instrumentation.http.client.capture-response-headers + description: List of HTTP response headers to capture in HTTP client telemetry. + type: list + default: '' + - name: otel.instrumentation.common.peer-service-mapping + description: Used to specify a mapping from host names or IP addresses to peer + services. + type: map + default: '' + - name: otel.instrumentation.http.client.emit-experimental-telemetry + description: | + Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.client.request.size` and `http.client.response.size` metrics. + type: boolean + default: false + - name: otel.instrumentation.http.client.experimental.redact-query-parameters + description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. + type: boolean + default: true telemetry: - when: default metrics: @@ -9156,6 +9190,13 @@ libraries: - name: url.full type: STRING - name: okhttp-3.0 + display_name: OkHttp + description: This instrumentation enables HTTP client spans and HTTP client metrics + for OkHttp. + semantic_conventions: + - HTTP_CLIENT_SPANS + - HTTP_CLIENT_METRICS + library_link: https://square.github.io/okhttp/ source_path: instrumentation/okhttp/okhttp-3.0 scope: name: io.opentelemetry.okhttp-3.0 @@ -9165,6 +9206,34 @@ libraries: - com.squareup.okhttp3:okhttp:[3.0,) library: - com.squareup.okhttp3:okhttp:3.0.0 + configurations: + - name: otel.instrumentation.http.known-methods + description: | + Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`. + type: list + default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE + - name: otel.instrumentation.http.client.capture-request-headers + description: List of HTTP request headers to capture in HTTP client telemetry. + type: list + default: '' + - name: otel.instrumentation.http.client.capture-response-headers + description: List of HTTP response headers to capture in HTTP client telemetry. + type: list + default: '' + - name: otel.instrumentation.common.peer-service-mapping + description: Used to specify a mapping from host names or IP addresses to peer + services. + type: map + default: '' + - name: otel.instrumentation.http.client.emit-experimental-telemetry + description: | + Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` and `http.response.body.size` attributes to spans, and records `http.client.request.size` and `http.client.response.size` metrics. + type: boolean + default: false + - name: otel.instrumentation.http.client.experimental.redact-query-parameters + description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. + type: boolean + default: true telemetry: - when: default metrics: @@ -9212,8 +9281,12 @@ libraries: type: STRING openai: - name: openai-java-1.1 + display_name: OpenAI Java SDK description: This instrumentation enables Gen AI client spans and metrics for - OpenAI Java SDK 1.1+. + the OpenAI Java SDK. + semantic_conventions: + - GENAI_CLIENT_SPANS + - GENAI_CLIENT_METRICS library_link: https://github.com/openai/openai-java source_path: instrumentation/openai/openai-java-1.1 scope: @@ -9445,8 +9518,11 @@ libraries: type: STRING oracle: - name: oracle-ucp-11.2 - description: The Oracle Universal Connection Pool (UCP) instrumentation generates - connection pool metrics. + display_name: Oracle UCP + description: | + The Oracle Universal Connection Pool (UCP) instrumentation enables database connection pool metrics for Oracle UCP data sources. + semantic_conventions: + - DATABASE_POOL_METRICS library_link: https://docs.oracle.com/database/121/JJUCP/ source_path: instrumentation/oracle-ucp-11.2 scope: @@ -9513,9 +9589,11 @@ libraries: 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. + display_name: OSHI + description: | + When the OSHI library is detected on the classpath, this instrumentation enables system metrics for memory, disk, and network operations. + semantic_conventions: + - SYSTEM_METRICS library_link: https://github.com/oshi/oshi/ source_path: instrumentation/oshi scope: @@ -9527,7 +9605,8 @@ libraries: - com.github.oshi:oshi-core:5.3.1 configurations: - name: otel.instrumentation.oshi.experimental-metrics.enabled - description: Enable the OSHI process runtime metrics. + description: Enable the experimental `runtime.java.memory` and `runtime.java.cpu_time` + metrics. type: boolean default: false telemetry: diff --git a/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/SemanticConvention.java b/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/SemanticConvention.java index c86a1b506d6f..c22e9c8769ec 100644 --- a/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/SemanticConvention.java +++ b/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/SemanticConvention.java @@ -26,5 +26,6 @@ public enum SemanticConvention { GRAPHQL_SERVER_SPANS, FAAS_SERVER_SPANS, GENAI_CLIENT_SPANS, - GENAI_CLIENT_METRICS + GENAI_CLIENT_METRICS, + SYSTEM_METRICS } diff --git a/instrumentation/okhttp/okhttp-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/okhttp/v2_2/OkHttp2Singletons.java b/instrumentation/okhttp/okhttp-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/okhttp/v2_2/OkHttp2Singletons.java index 0cc51730f0b9..5cc9ea14db88 100644 --- a/instrumentation/okhttp/okhttp-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/okhttp/v2_2/OkHttp2Singletons.java +++ b/instrumentation/okhttp/okhttp-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/okhttp/v2_2/OkHttp2Singletons.java @@ -27,10 +27,6 @@ public final class OkHttp2Singletons { new TracingInterceptor(INSTRUMENTER, GlobalOpenTelemetry.get().getPropagators()); } - public static Instrumenter instrumenter() { - return INSTRUMENTER; - } - public static Interceptor tracingInterceptor() { return TRACING_INTERCEPTOR; } diff --git a/instrumentation/okhttp/okhttp-2.2/metadata.yaml b/instrumentation/okhttp/okhttp-2.2/metadata.yaml new file mode 100644 index 000000000000..c6b2c1e4562b --- /dev/null +++ b/instrumentation/okhttp/okhttp-2.2/metadata.yaml @@ -0,0 +1,35 @@ +description: This instrumentation enables HTTP client spans and HTTP client metrics for OkHttp. +display_name: OkHttp +semantic_conventions: + - HTTP_CLIENT_SPANS + - HTTP_CLIENT_METRICS +configurations: + - name: otel.instrumentation.http.known-methods + description: > + Configures the instrumentation to recognize an alternative set of HTTP request methods. All + other methods will be treated as `_OTHER`. + type: list + default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE" + - name: otel.instrumentation.http.client.capture-request-headers + description: List of HTTP request headers to capture in HTTP client telemetry. + type: list + default: "" + - name: otel.instrumentation.http.client.capture-response-headers + description: List of HTTP response headers to capture in HTTP client telemetry. + type: list + default: "" + - name: otel.instrumentation.common.peer-service-mapping + description: Used to specify a mapping from host names or IP addresses to peer services. + type: map + default: "" + - name: otel.instrumentation.http.client.emit-experimental-telemetry + description: > + Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` + and `http.response.body.size` attributes to spans, and records `http.client.request.size` and + `http.client.response.size` metrics. + type: boolean + default: false + - name: otel.instrumentation.http.client.experimental.redact-query-parameters + description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. + type: boolean + default: true \ No newline at end of file diff --git a/instrumentation/okhttp/okhttp-3.0/metadata.yaml b/instrumentation/okhttp/okhttp-3.0/metadata.yaml new file mode 100644 index 000000000000..b09710ea43f4 --- /dev/null +++ b/instrumentation/okhttp/okhttp-3.0/metadata.yaml @@ -0,0 +1,36 @@ +description: This instrumentation enables HTTP client spans and HTTP client metrics for OkHttp. +display_name: OkHttp +semantic_conventions: + - HTTP_CLIENT_SPANS + - HTTP_CLIENT_METRICS +library_link: https://square.github.io/okhttp/ +configurations: + - name: otel.instrumentation.http.known-methods + description: > + Configures the instrumentation to recognize an alternative set of HTTP request methods. All + other methods will be treated as `_OTHER`. + type: list + default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE" + - name: otel.instrumentation.http.client.capture-request-headers + description: List of HTTP request headers to capture in HTTP client telemetry. + type: list + default: "" + - name: otel.instrumentation.http.client.capture-response-headers + description: List of HTTP response headers to capture in HTTP client telemetry. + type: list + default: "" + - name: otel.instrumentation.common.peer-service-mapping + description: Used to specify a mapping from host names or IP addresses to peer services. + type: map + default: "" + - name: otel.instrumentation.http.client.emit-experimental-telemetry + description: > + Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size` + and `http.response.body.size` attributes to spans, and records `http.client.request.size` and + `http.client.response.size` metrics. + type: boolean + default: false + - name: otel.instrumentation.http.client.experimental.redact-query-parameters + description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. + type: boolean + default: true \ No newline at end of file diff --git a/instrumentation/openai/openai-java-1.1/metadata.yaml b/instrumentation/openai/openai-java-1.1/metadata.yaml index 7aaf7d895a2b..cce96f1dff8f 100644 --- a/instrumentation/openai/openai-java-1.1/metadata.yaml +++ b/instrumentation/openai/openai-java-1.1/metadata.yaml @@ -1,4 +1,8 @@ -description: This instrumentation enables Gen AI client spans and metrics for OpenAI Java SDK 1.1+. +description: This instrumentation enables Gen AI client spans and metrics for the OpenAI Java SDK. +display_name: OpenAI Java SDK +semantic_conventions: + - GENAI_CLIENT_SPANS + - GENAI_CLIENT_METRICS library_link: https://github.com/openai/openai-java configurations: - name: otel.instrumentation.genai.capture-message-content diff --git a/instrumentation/oracle-ucp-11.2/metadata.yaml b/instrumentation/oracle-ucp-11.2/metadata.yaml index e7e186bcb828..77be5e3ba96b 100644 --- a/instrumentation/oracle-ucp-11.2/metadata.yaml +++ b/instrumentation/oracle-ucp-11.2/metadata.yaml @@ -1,2 +1,7 @@ -description: The Oracle Universal Connection Pool (UCP) instrumentation generates connection pool metrics. +description: > + The Oracle Universal Connection Pool (UCP) instrumentation enables database connection pool + metrics for Oracle UCP data sources. +display_name: Oracle UCP +semantic_conventions: + - DATABASE_POOL_METRICS library_link: https://docs.oracle.com/database/121/JJUCP/ diff --git a/instrumentation/oshi/metadata.yaml b/instrumentation/oshi/metadata.yaml index fc034b5ae85d..059c4c6fe5bc 100644 --- a/instrumentation/oshi/metadata.yaml +++ b/instrumentation/oshi/metadata.yaml @@ -1,7 +1,12 @@ -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. +description: > + When the OSHI library is detected on the classpath, this instrumentation enables system metrics + for memory, disk, and network operations. +display_name: OSHI +semantic_conventions: + - SYSTEM_METRICS configurations: - name: otel.instrumentation.oshi.experimental-metrics.enabled - description: Enable the OSHI process runtime metrics. + description: Enable the experimental `runtime.java.memory` and `runtime.java.cpu_time` metrics. type: boolean default: false library_link: https://github.com/oshi/oshi/