Kubernetes Client
OpenTelemetry Java agent instrumentation
This instrumentation enables HTTP client spans and HTTP client metrics for the Kubernetes Client for Java.
- Name:
kubernetes-client-7.0 - Scope:
io.opentelemetry.kubernetes-client-7.0 - Target versions:
io.kubernetes:client-java-api:[7.0.0,) - Library: https://github.com/kubernetes-client/java
Telemetry
- Metrics:
http.client.request.duration - Span attributes:
error.type,http.request.method,http.response.status_code,peer.service,server.address,server.port,url.full,kubernetes-client.name,kubernetes-client.namespace,service.peer.name
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.instrumentation.common.peer-service-mapping | map | Used to specify a mapping from host names or IP addresses to peer services. | |
otel.instrumentation.http.client.capture-request-headers | list | List of HTTP request headers to capture in HTTP client telemetry. | |
otel.instrumentation.http.client.capture-response-headers | list | List of HTTP response headers to capture in HTTP client telemetry. | |
otel.instrumentation.http.client.emit-experimental-telemetry | boolean | false | 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.body.size and http.client.response.body.size metrics. |
otel.instrumentation.http.known-methods | list | CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE | Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as _OTHER. |
java.common.http.client.url_template_rules | list | Rules for deriving low-cardinality URL templates (routes) from HTTP client request URLs. Only applied when experimental HTTP client telemetry is enabled. | |
otel.instrumentation.kubernetes-client.experimental-span-attributes | boolean | false | Enables experimental span attributes kubernetes-client.namespace and kubernetes-client.name for Kubernetes API requests. |
otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters | list | AWSAccessKeyId,Signature,sig,X-Goog-Signature | List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. |