component: Splunk Distribution of OpenTelemetry Java
version: 2.22.0
dependencies:
- name: OpenTelemetry Java
source_href: https://github.com/open-telemetry/opentelemetry-java
version: 1.56.0
stability: stable
- name: OpenTelemetry Instrumentation for Java
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation
version: 2.22.0
stability: stable
- name: OpenTelemetry Java Contrib Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/resource-providers
version: 1.52.0-alpha
stability: experimental
- name: OpenTelemetry Java Contrib Samplers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/samplers
version: 1.52.0-alpha
stability: experimental
settings:
- property: otel.sdk.disabled
env: OTEL_SDK_DISABLED
description: If true, disable the OpenTelemetry SDK. Defaults to false.
default: 'false'
type: boolean
category: general
- property: otel.traces.exporter
env: OTEL_TRACES_EXPORTER
description: List of exporters to be used for tracing, separated by commas. Default
is otlp. none means no autoconfigured exporter.
default: otlp
type: string
category: exporter
- property: otel.metrics.exporter
env: OTEL_METRICS_EXPORTER
description: List of exporters to be used for tracing, separated by commas. Default
is otlp. none means no autoconfigured exporter.
default: otlp
type: string
category: exporter
- property: otel.logs.exporter
env: OTEL_LOGS_EXPORTER
description: List of exporters to be used for tracing, separated by commas. Default
is otlp. none means no autoconfigured exporter.
default: otlp
type: string
category: exporter
- property: otel.java.experimental.exporter.memory_mode
env: OTEL_JAVA_EXPERIMENTAL_EXPORTER_MEMORY_MODE
description: If `reusable_data`, enable reusable memory mode (on exporters which
support it) to reduce allocations. Default is `immutable_data`. This option
is experimental and subject to change or removal.
default: immutable_data
type: string
category: exporter
- property: otel.exporter.otlp.endpoint
env: OTEL_EXPORTER_OTLP_ENDPOINT
description: The OTLP traces, metrics, and logs endpoint to connect to. Must be
a URL with a scheme of either http or https based on the use of TLS. If protocol
is http/protobuf the version and signal will be appended to the path (e.g. v1/traces,
v1/metrics, or v1/logs). Default is http://localhost:4317 when protocol is grpc,
and http://localhost:4318/v1/{signal} when protocol is http/protobuf.
default: http://localhost:4318
type: string
category: exporter
- property: otel.exporter.otlp.traces.endpoint
env: OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
description: The OTLP traces endpoint to connect to. Must be a URL with a scheme
of either http or https based on the use of TLS. Default is http://localhost:4317
when protocol is grpc, and http://localhost:4318/v1/traces when protocol is
http/protobuf.
default: http://localhost:4318/v1/traces
type: string
category: exporter
- property: otel.exporter.otlp.metrics.endpoint
env: OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
description: The OTLP metrics endpoint to connect to. Must be a URL with a scheme
of either http or https based on the use of TLS. Default is http://localhost:4317
when protocol is grpc, and http://localhost:4318/v1/metrics when protocol is
http/protobuf.
default: http://localhost:4318/v1/metrics
type: string
category: exporter
- property: otel.exporter.otlp.logs.endpoint
env: OTEL_EXPORTER_OTLP_LOGS_ENDPOINT
description: The OTLP logs endpoint to connect to. Must be a URL with a scheme
of either http or https based on the use of TLS. Default is http://localhost:4317
when protocol is grpc, and http://localhost:4318/v1/logs when protocol is http/protobuf.
default: http://localhost:4318/v1/logs
type: string
category: exporter
- property: otel.exporter.otlp.certificate
env: OTEL_EXPORTER_OTLP_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP trace, metric, or log server's TLS credentials. The file should
contain one or more X.509 certificates in PEM format. By default the host platform's
trusted root certificates are used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.traces.certificate
env: OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP trace server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default the host platform's trusted
root certificates are used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.metrics.certificate
env: OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP metric server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default the host platform's trusted
root certificates are used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.logs.certificate
env: OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP log server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default the host platform's trusted
root certificates are used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.client.key
env: OTEL_EXPORTER_OTLP_CLIENT_KEY
description: The path to the file containing private client key to use when verifying
an OTLP trace, metric, or log client's TLS credentials. The file should contain
one private key PKCS8 PEM format. By default no client key is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.traces.client.key
env: OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY
description: The path to the file containing private client key to use when verifying
an OTLP trace client's TLS credentials. The file should contain one private
key PKCS8 PEM format. By default no client key file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.metrics.client.key
env: OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY
description: The path to the file containing private client key to use when verifying
an OTLP metric client's TLS credentials. The file should contain one private
key PKCS8 PEM format. By default no client key file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.logs.client.key
env: OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY
description: The path to the file containing private client key to use when verifying
an OTLP log client's TLS credentials. The file should contain one private key
PKCS8 PEM format. By default no client key file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.client.certificate
env: OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP trace, metric, or log client's TLS credentials. The file should
contain one or more X.509 certificates in PEM format. By default no chain file
is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.traces.client.certificate
env: OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP trace server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default no chain file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.metrics.client.certificate
env: OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP metric server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default no chain file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.logs.client.certificate
env: OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE
description: The path to the file containing trusted certificates to use when
verifying an OTLP log server's TLS credentials. The file should contain one
or more X.509 certificates in PEM format. By default no chain file is used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.headers
env: OTEL_EXPORTER_OTLP_HEADERS
description: Key-value pairs separated by commas to pass as request headers on
OTLP trace, metric, and log requests.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.traces.headers
env: OTEL_EXPORTER_OTLP_TRACES_HEADERS
description: Key-value pairs separated by commas to pass as request headers on
OTLP trace requests.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.metrics.headers
env: OTEL_EXPORTER_OTLP_METRICS_HEADERS
description: Key-value pairs separated by commas to pass as request headers on
OTLP metrics requests.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.logs.headers
env: OTEL_EXPORTER_OTLP_LOGS_HEADERS
description: Key-value pairs separated by commas to pass as request headers on
OTLP logs requests.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.compression
env: OTEL_EXPORTER_OTLP_COMPRESSION
description: The compression type to use on OTLP trace, metric, and log requests.
Options include gzip. By default no compression will be used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.traces.compression
env: OTEL_EXPORTER_OTLP_TRACES_COMPRESSION
description: The compression type to use on OTLP trace requests. Options include
gzip. By default no compression will be used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.metrics.compression
env: OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
description: The compression type to use on OTLP metric requests. Options include
gzip. By default no compression will be used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.logs.compression
env: OTEL_EXPORTER_OTLP_LOGS_COMPRESSION
description: The compression type to use on OTLP log requests. Options include
gzip. By default no compression will be used.
default: ''
type: string
category: exporter
- property: otel.exporter.otlp.timeout
env: OTEL_EXPORTER_OTLP_TIMEOUT
description: The maximum waiting time, in milliseconds, allowed to send each OTLP
trace, metric, and log batch. Default is 10000.
default: '10000'
type: int
category: exporter
- property: otel.exporter.otlp.traces.timeout
env: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
description: The maximum waiting time, in milliseconds, allowed to send each OTLP
trace batch. Default is 10000.
default: '10000'
type: int
category: exporter
- property: otel.exporter.otlp.metrics.timeout
env: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
description: The maximum waiting time, in milliseconds, allowed to send each OTLP
metric batch. Default is 10000.
default: '10000'
type: int
category: exporter
- property: otel.exporter.otlp.logs.timeout
env: OTEL_EXPORTER_OTLP_LOGS_TIMEOUT
description: The maximum waiting time, in milliseconds, allowed to send each OTLP
log batch. Default is 10000.
default: '10000'
type: int
category: exporter
- property: otel.exporter.otlp.protocol
env: OTEL_EXPORTER_OTLP_PROTOCOL
description: The transport protocol to use on OTLP trace, metric, and log requests.
Options include grpc and http/protobuf.
default: http/protobuf
type: string
category: exporter
- property: otel.exporter.otlp.traces.protocol
env: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
description: The transport protocol to use on OTLP trace requests. Options include
grpc and http/protobuf.
default: http/protobuf
type: string
category: exporter
- property: otel.exporter.otlp.metrics.protocol
env: OTEL_EXPORTER_OTLP_METRICS_PROTOCOL
description: The transport protocol to use on OTLP metric requests. Options include
grpc and http/protobuf.
default: http/protobuf
type: string
category: exporter
- property: otel.exporter.otlp.logs.protocol
env: OTEL_EXPORTER_OTLP_LOGS_PROTOCOL
description: The transport protocol to use on OTLP log requests. Options include
grpc and http/protobuf.
default: http/protobuf
type: string
category: exporter
- property: otel.exporter.otlp.metrics.temporality.preference
env: OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
description: The preferred output aggregation temporality. Options include DELTA,
LOWMEMORY, and CUMULATIVE. If CUMULATIVE, all instruments will have cumulative
temporality. If DELTA, counter (sync and async) and histograms will be delta,
up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter
and histograms will be delta, async counter and up down counters (sync and async)
will be cumulative. Default is CUMULATIVE.
default: CUMULATIVE
type: string
category: exporter
- property: otel.exporter.otlp.metrics.default.histogram.aggregation
env: OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION
description: The preferred default histogram aggregation. Options include BASE2_EXPONENTIAL_BUCKET_HISTOGRAM
and EXPLICIT_BUCKET_HISTOGRAM. Default is EXPLICIT_BUCKET_HISTOGRAM.
default: EXPLICIT_BUCKET_HISTOGRAM
type: string
category: exporter
- property: otel.experimental.exporter.otlp.retry.enabled
env: OTEL_EXPERIMENTAL_EXPORTER_OTLP_RETRY_ENABLED
description: If true, enable experimental retry support. Default is false.
default: 'false'
type: boolean
category: exporter
- property: otel.resource.attributes
env: OTEL_RESOURCE_ATTRIBUTES
description: 'Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3'
default: ''
type: string
category: instrumentation
- property: otel.service.name
env: OTEL_SERVICE_NAME
description: Specify logical service name. Takes precedence over service.name
defined with otel.resource.attributes
default: ''
type: string
category: instrumentation
- property: otel.experimental.resource.disabled-keys
env: OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS
description: Specify resource attribute keys that are filtered.
default: ''
type: string
category: instrumentation
- property: otel.java.enabled.resource.providers
env: OTEL_JAVA_ENABLED_RESOURCE_PROVIDERS
description: Enables one or more ResourceProvider types. If unset, all resource
providers are enabled.
default: ''
type: string
category: resource provider
- property: otel.java.disabled.resource.providers
env: OTEL_JAVA_DISABLED_RESOURCE_PROVIDERS
description: Disables one or more ResourceProvider types.
default: ''
type: string
category: resource provider
- property: otel.attribute.value.length.limit
env: OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
description: The maximum length of attribute values. Applies to spans and logs.
By default there is no limit.
default: ''
type: int
category: instrumentation
- property: otel.attribute.count.limit
env: OTEL_ATTRIBUTE_COUNT_LIMIT
description: The maximum number of attributes. Applies to spans, span events,
span links, and logs. Default is 128.
default: '128'
type: int
category: instrumentation
- property: otel.propagators
env: OTEL_PROPAGATORS
description: The propagators to be used. Use a comma-separated list for multiple
propagators. Default is tracecontext,baggage (W3C).
default: tracecontext,baggage
type: string
category: general
- property: otel.exporter.zipkin.endpoint
env: OTEL_EXPORTER_ZIPKIN_ENDPOINT
description: The Zipkin endpoint to connect to. Default is http://localhost:9411/api/v2/spans.
Currently only HTTP is supported.
default: http://localhost:9411/api/v2/spans
type: string
category: exporter
- property: otel.bsp.schedule.delay
env: OTEL_BSP_SCHEDULE_DELAY
description: The interval, in milliseconds, between two consecutive exports. Default
is 5000.
default: '5000'
type: int
category: general
- property: otel.bsp.max.queue.size
env: OTEL_BSP_MAX_QUEUE_SIZE
description: The maximum queue size. Default is 2048.
default: '2048'
type: int
category: general
- property: otel.bsp.max.export.batch.size
env: OTEL_BSP_MAX_EXPORT_BATCH_SIZE
description: The maximum batch size. Default is 512.
default: '512'
type: int
category: general
- property: otel.bsp.export.timeout
env: OTEL_BSP_EXPORT_TIMEOUT
description: The maximum allowed time, in milliseconds, to export data. Default
is 30000.
default: '30000'
type: int
category: general
- property: otel.traces.sampler
env: OTEL_TRACES_SAMPLER
description: The sampler to use for tracing. Defaults to parentbased_always_on
default: always_on
type: string
category: general
- property: otel.traces.sampler.arg
env: OTEL_TRACES_SAMPLER_ARG
description: An argument to the configured tracer if supported, for example a
ratio.
default: ''
type: string
category: general
- property: otel.span.attribute.value.length.limit
env: OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
description: The maximum length of span attribute values. Takes precedence over
otel.attribute.value.length.limit. By default there is no limit.
default: ''
type: int
category: instrumentation
- property: otel.span.attribute.count.limit
env: OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
description: The maximum number of attributes per span. Takes precedence over
otel.attribute.count.limit. Default is 128.
default: '128'
type: int
category: instrumentation
- property: otel.span.event.count.limit
env: OTEL_SPAN_EVENT_COUNT_LIMIT
description: The maximum number of events per span. Default is 128.
default: '128'
type: int
category: instrumentation
- property: otel.span.link.count.limit
env: OTEL_SPAN_LINK_COUNT_LIMIT
description: TThe maximum number of links per span. Default is 128.
default: '128'
type: int
category: instrumentation
- property: otel.metric.export.interval
env: OTEL_METRIC_EXPORT_INTERVAL
description: The interval, in milliseconds, between the start of two export attempts.
Default is 60000.
default: '60000'
type: int
category: exporter
- property: otel.metrics.exemplar.filter
env: OTEL_METRICS_EXEMPLAR_FILTER
description: The filter for exemplar sampling. Can be ALWAYS_OFF, ALWAYS_ON or
TRACE_BASED. Default is TRACE_BASED.
default: TRACE_BASED
type: string
category: general
- property: otel.java.metrics.cardinality.limit
env: OTEL_JAVA_METRICS_CARDINALITY_LIMIT
description: If set, configure cardinality limit. The value dictates the maximum
number of distinct points per metric. Default is 2000.
default: '2000'
type: int
category: instrumentation
- property: otel.exporter.prometheus.port
env: OTEL_EXPORTER_PROMETHEUS_PORT
description: The local port used to bind the prometheus metric server. Default
is 9464.
default: '9464'
type: int
category: exporter
- property: otel.exporter.prometheus.host
env: OTEL_EXPORTER_PROMETHEUS_HOST
description: The local address used to bind the prometheus metric server. Default
is 0.0.0.0.
default: 0.0.0.0
type: int
category: exporter
- property: otel.blrp.schedule.delay
env: OTEL_BLRP_SCHEDULE_DELAY
description: The interval, in milliseconds, between two consecutive exports. Default
is 1000.
default: '1000'
type: int
category: general
- property: otel.blrp.max.queue.size
env: OTEL_BLRP_MAX_QUEUE_SIZE
description: The maximum queue size. Default is 2048.
default: '2048'
type: int
category: general
- property: otel.blrp.max.export.batch.size
env: OTEL_BLRP_MAX_EXPORT_BATCH_SIZE
description: The maximum batch size. Default is 512.
default: '512'
type: int
category: general
- property: otel.blrp.export.timeout
env: OTEL_BLRP_EXPORT_TIMEOUT
description: The maximum allowed time, in milliseconds, to export data. Default
is 30000.
default: '30000'
type: int
category: general
- property: otel.experimental.config.file
env: OTEL_EXPERIMENTAL_CONFIG_FILE
description: The path to the SDK configuration file. Defaults to unset.
default: ''
type: string
category: general
- property: otel.javaagent.configuration-file
env: OTEL_JAVAAGENT_CONFIGURATION_FILE
description: Path to valid Java properties file which contains the agent configuration.
default: ''
type: string
category: general
- property: otel.javaagent.extensions
env: OTEL_JAVAAGENT_EXTENSIONS
description: Path to an extension jar file or folder, containing jar files. If
pointing to a folder, every jar file in that folder will be treated as separate,
independent extension.
default: ''
type: string
category: general
- property: otel.javaagent.logging
env: OTEL_JAVAAGENT_LOGGING
description: |-
The Java agent logging mode. The following 3 modes are supported:
simple: The agent will print out its logs using the standard error stream. Only INFO or higher logs will be printed. This is the default Java agent logging mode.
none: The agent will not log anything - not even its own version.
application: The agent will attempt to redirect its own logs to the instrumented application's slf4j logger. This works the best for simple one-jar applications that do not use multiple classloaders; Spring Boot apps are supported as well. The Java agent output logs can be further configured using the instrumented application's logging configuration (e.g. logback.xml or log4j2.xml). Make sure to test that this mode works for your application before running it in a production environment.
default: simple
type: string
category: general
- property: otel.instrumentation.common.peer-service-mapping
env: OTEL_INSTRUMENTATION_COMMON_PEER_SERVICE_MAPPING
description: Used to specify a mapping from host names or IP addresses to peer
services, as a comma-separated list of <host_or_ip>=<user_assigned_name>
pairs. The peer service is added as an attribute to a span whose host or IP
address match the mapping.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.common.db-statement-sanitizer.enabled
env: OTEL_INSTRUMENTATION_COMMON_DB_STATEMENT_SANITIZER_ENABLED
description: Enables the DB statement sanitization.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.http.client.capture-request-headers
env: OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_REQUEST_HEADERS
description: A comma-separated list of HTTP header names. HTTP client instrumentations
will capture HTTP request header values for all configured header names.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.http.client.capture-response-headers
env: OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_RESPONSE_HEADERS
description: A comma-separated list of HTTP header names. HTTP client instrumentations
will capture HTTP response header values for all configured header names.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.http.server.capture-request-headers
env: OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_HEADERS
description: A comma-separated list of HTTP header names. HTTP server instrumentations
will capture HTTP request header values for all configured header names.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.http.server.capture-response-headers
env: OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_RESPONSE_HEADERS
description: A comma-separated list of HTTP header names. HTTP server instrumentations
will capture HTTP response header values for all configured header names.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.servlet.experimental.capture-request-parameters
env: OTEL_INSTRUMENTATION_SERVLET_EXPERIMENTAL_CAPTURE_REQUEST_PARAMETERS
description: A comma-separated list of request parameter names.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
env: OTEL_INSTRUMENTATION_MESSAGING_EXPERIMENTAL_RECEIVE_TELEMETRY_ENABLED
description: Enables the consumer message receive telemetry. Note that this will
cause the consumer side to start a new trace, with only a span link connecting
it to the producer trace.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.enduser.enabled
env: OTEL_INSTRUMENTATION_COMMON_ENDUSER_ENABLED
description: Common flag for enabling/disabling enduser attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.enduser.id.enabled
env: OTEL_INSTRUMENTATION_COMMON_ENDUSER_ID_ENABLED
description: Determines whether to capture `enduser.id` semantic attribute.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.enduser.role.enabled
env: OTEL_INSTRUMENTATION_COMMON_ENDUSER_ROLE_ENABLED
description: Determines whether to capture `enduser.role` semantic attribute.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.enduser.scope.enabled
env: OTEL_INSTRUMENTATION_COMMON_ENDUSER_SCOPE_ENABLED
description: Determines whether to capture `enduser.scope` semantic attribute.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.http.client.emit-experimental-telemetry
env: OTEL_INSTRUMENTATION_HTTP_CLIENT_EMIT_EXPERIMENTAL_TELEMETRY
description: Enables experimental http client telemetry.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.http.server.emit-experimental-telemetry
env: OTEL_INSTRUMENTATION_HTTP_SERVER_EMIT_EXPERIMENTAL_TELEMETRY
description: Enables experimental http server telemetry.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.http.client.experimental.redact-query-parameters
env: OTEL_INSTRUMENTATION_HTTP_CLIENT_EXPERIMENTAL_REDACT_QUERY_PARAMETERS
description: Redact sensitive parameter values from URL query string, see https://opentelemetry.io/docs/specs/semconv/http/http-spans.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.default-enabled
env: OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED
description: Disable all instrumentations in the agent.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.{name}.enabled
env: OTEL_INSTRUMENTATION_{NAME}_ENABLED
description: Suppresses agent instrumentation of specific library where `{name}`
is the corresponding instrumentation name.
default: ''
type: boolean
category: instrumentation
- property: otel.instrumentation.common.experimental.controller-telemetry.enabled
env: OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CONTROLLER_TELEMETRY_ENABLED
description: Enables the controller telemetry.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.experimental.view-telemetry.enabled
env: OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_VIEW_TELEMETRY_ENABLED
description: Enables the view telemetry.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.experimental.span-suppression-strategy
env: OTEL_INSTRUMENTATION_EXPERIMENTAL_SPAN_SUPPRESSION_STRATEGY
description: |
The Java agent span suppression strategy. The following 3 strategies are supported:
semconv: The agent will suppress duplicate semantic conventions. This is the default behavior of the Java agent.
span-kind: The agent will suppress spans with the same kind (except INTERNAL).
none: The agent will not suppress anything at all. We do not recommend using this option for anything other than debug purposes, as it generates lots of duplicate telemetry data.
default: semconv
type: string
category: instrumentation
- property: otel.javaagent.exclude-classes
env: OTEL_JAVAAGENT_EXCLUDE_CLASSES
description: Suppresses all instrumentation for specific classes, format is "my.package.MyClass,my.package2.*".
default: ''
type: string
category: general
- property: otel.javaagent.exclude-class-loaders
env: OTEL_JAVAAGENT_EXCLUDE_CLASS_LOADERS
description: Ignore the specified class loaders, format is "my.package.MyClass,my.package2.".
default: ''
type: string
category: general
- property: otel.javaagent.experimental.security-manager-support.enabled
env: OTEL_JAVAAGENT_EXPERIMENTAL_SECURITY_MANAGER_SUPPORT_ENABLED
description: 'Grant all privileges to agent code. Disclaimer: agent can provide
application means for escaping security manager sandbox. Do not usethis option
if your application relies on security manager to run untrusted code.'
default: 'false'
type: boolean
category: general
- property: otel.experimental.javascript-snippet
env: OTEL_EXPERIMENTAL_JAVASCRIPT_SNIPPET
description: Experimental setting to inject a JavaScript snippet into servlet
HTML responses after the opening `
` tag.
default: ''
type: string
category: instrumentation
- property: otel.resource.providers.aws.enabled
env: OTEL_RESOURCE_PROVIDERS_AWS_ENABLED
description: Enables the AWS Resource Provider.
default: 'false'
type: boolean
category: resource provider
- property: otel.resource.providers.gcp.enabled
env: OTEL_RESOURCE_PROVIDERS_GCP_ENABLED
description: Enables the GCP Resource Provider.
default: 'false'
type: boolean
category: resource provider
- property: splunk.access.token
env: SPLUNK_ACCESS_TOKEN
description: (Optional) Auth token allowing exporters to communicate directly
with the Splunk cloud, passed as X-SF-TOKEN header.
default: ''
type: string
category: general
- property: splunk.realm
env: SPLUNK_REALM
description: Specify your organization's realm name, such as `us0` or `us1. When
the realm is set, telemetry data is sent directly to the ingest endpoint of
Splunk Observability Cloud, bypassing the Splunk Distribution of the OpenTelemetry
Collector. If no realm is specified, telemetry is routed to a Splunk OpenTelemetry
Collector deployed locally. This configuration applies only to metrics and traces.
default: none
type: string
category: general
- property: splunk.metrics.force_full_commandline
env: SPLUNK_METRICS_FORCE_FULL_COMMANDLINE
description: Adds the full command line as a resource attribute for all metrics.
If false, commands longer than 255 characters are truncated.
default: 'false'
type: boolean
category: general
- property: splunk.trace-response-header.enabled
env: SPLUNK_TRACE_RESPONSE_HEADER_ENABLED
description: Enables adding server trace information to HTTP response headers.
[See this document](https://docs.splunk.com/observability/en/gdi/get-data-in/application/java/configuration/advanced-java-otel-configuration.html#server-trace-information)
for more information.
default: 'true'
type: boolean
category: general
- property: otel.instrumentation.methods.include
env: OTEL_INSTRUMENTATION_METHODS_INCLUDE
description: Same as adding @WithSpan annotation functionality for the target
method string, e.g. my.package.MyClass1[method1,method2];my.package.MyClass2[method3]
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.opentelemetry-annotations.exclude-methods
env: OTEL_INSTRUMENTATION_OPENTELEMETRY_ANNOTATIONS_EXCLUDE_METHODS
description: Suppress @WithSpan instrumentation for specific methods, e.g. my.package.MyClass1[method1,method2];my.package.MyClass2[method3]
default: ''
type: string
category: instrumentation
- property: splunk.profiler.enabled
env: SPLUNK_PROFILER_ENABLED
description: Enables cpu profiler.
default: 'false'
type: boolean
category: profiler
- property: splunk.profiler.directory
env: SPLUNK_PROFILER_DIRECTORY
description: Location of JFR files, defaults to System.getProperty("java.io.tmpdir").
default: value of System.getProperty("java.io.tmpdir")
type: string
category: profiler
- property: splunk.profiler.recording.duration
env: SPLUNK_PROFILER_RECORDING_DURATION
description: Recording unit duration.
default: 20s
type: string
category: profiler
- property: splunk.profiler.keep-files
env: SPLUNK_PROFILER_KEEP_FILES
description: Leave JFR files on disk if true.
default: 'false'
type: boolean
category: profiler
- property: splunk.profiler.logs-endpoint
env: SPLUNK_PROFILER_LOGS_ENDPOINT
description: Where to send OTLP logs, defaults to `otel.exporter.otlp.endpoint.
default: http://localhost:4318/v1/logs
type: string
category: profiler
- property: splunk.profiler.call.stack.interval
env: SPLUNK_PROFILER_CALL_STACK_INTERVAL
description: How often to sample call stacks.
default: 10000ms
type: string
category: profiler
- property: splunk.profiler.memory.enabled
env: SPLUNK_PROFILER_MEMORY_ENABLED
description: Enables allocation profiler.
default: 'false'
type: boolean
category: profiler
- property: splunk.profiler.memory.event.rate
env: SPLUNK_PROFILER_MEMORY_EVENT_RATE
description: Allocation event rate.
default: 150/s
type: string
category: profiler
- property: splunk.profiler.include.internal.stacks
env: SPLUNK_PROFILER_INCLUDE_INTERNAL_STACKS
description: Set to `true` to include stack traces of agent internal threads and
stack traces with only JDK internal frames.
default: 'false'
type: boolean
category: profiler
- property: splunk.profiler.tracing.stacks.only
env: SPLUNK_PROFILER_TRACING_STACKS_ONLY
description: Set to `true` to include only stack traces that are linked to a span
context.
default: 'false'
type: boolean
category: profiler
- property: splunk.profiler.otlp.protocol
env: SPLUNK_PROFILER_OTLP_PROTOCOL
description: The transport protocol to use on profiling OTLP log requests. Options
include grpc and http/protobuf.
default: http/protobuf
type: string
category: profiler
- property: otel.instrumentation.aws-sdk.experimental-span-attributes
env: OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging
env: OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_USE_PROPAGATOR_FOR_MESSAGING
description: v2 only, inject into SNS/SQS attributes with configured propagator.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging
env: OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_USE_PROPAGATOR_FOR_MESSAGING
description: v2 only, record errors returned by each individual HTTP request as
events for the SDK span.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.genai.capture-message-content
env: OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT
description: v2 only, record content of user and LLM messages when using Bedrock.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.camel.experimental-span-attributes
env: OTEL_INSTRUMENTATION_CAMEL_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.apache-shenyu.experimental-span-attributes
env: OTEL_INSTRUMENTATION_APACHE_SHENYU_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.couchbase.experimental-span-attributes
env: OTEL_INSTRUMENTATION_COUCHBASE_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enables the capture of experimental span attributes (for version
2.6 and higher of this instrumentation).
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.elasticsearch.capture-search-query
env: OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY
description: 'Enable the capture of search query bodies. Attention: Elasticsearch
queries may contain personal or sensitive information.'
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.elasticsearch.experimental-span-attributes
env: OTEL_INSTRUMENTATION_ELASTICSEARCH_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.graphql.query-sanitizer.enabled
env: OTEL_INSTRUMENTATION_GRAPHQL_QUERY_SANITIZER_ENABLED
description: Whether to remove sensitive information from query source that is
added as span attribute.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.graphql.add-operation-name-to-span-name.enabled
env: OTEL_INSTRUMENTATION_GRAPHQL_ADD_OPERATION_NAME_TO_SPAN_NAME_ENABLED
description: 'Whether GraphQL operation name is added to the span name. **WARNING**:
GraphQL operation name is provided by the client and can have high cardinality.
Use only when the server is not exposed to malicious clients.'
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.graphql.data-fetcher.enabled
env: OTEL_INSTRUMENTATION_GRAPHQL_DATA_FETCHER_ENABLED
description: Whether to create spans for data fetchers (GraphQL 20 and later).
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.graphql.trivial-data-fetcher.enabled
env: OTEL_INSTRUMENTATION_GRAPHQL_TRIVIAL_DATA_FETCHER_ENABLED
description: Whether to create spans for trivial data fetchers. A trivial data
fetcher is one that simply maps data from an object to a field (GraphQL 20 and
later).
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.grpc.emit-message-events
env: OTEL_INSTRUMENTATION_GRPC_EMIT_MESSAGE_EVENTS
description: Determines whether to emit span event for each individual message
received and sent.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.grpc.experimental-span-attributes
env: OTEL_INSTRUMENTATION_GRPC_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.grpc.capture-metadata.client.request
env: OTEL_INSTRUMENTATION_GRPC_CAPTURE_METADATA_CLIENT_REQUEST
description: A comma-separated list of request metadata keys. gRPC client instrumentation
will capture metadata values corresponding to configured keys as span attributes.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.grpc.capture-metadata.server.request
env: OTEL_INSTRUMENTATION_GRPC_CAPTURE_METADATA_SERVER_REQUEST
description: A comma-separated list of request metadata keys. gRPC server instrumentation
will capture metadata values corresponding to configured keys as span attributes.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.guava.experimental-span-attributes
env: OTEL_INSTRUMENTATION_GUAVA_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.hibernate.experimental-span-attributes
env: OTEL_INSTRUMENTATION_HIBERNATE_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.hystrix.experimental-span-attributes
env: OTEL_INSTRUMENTATION_HYSTRIX_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.java-util-logging.experimental-log-attributes
env: OTEL_INSTRUMENTATION_JAVA_UTIL_LOGGING_EXPERIMENTAL_LOG_ATTRIBUTES
description: Enable the capture of experimental log attributes `thread.name` and
`thread.id`.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jaxrs.experimental-span-attributes
env: OTEL_INSTRUMENTATION_JAXRS_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jboss-logmanager.experimental-log-attributes
env: OTEL_INSTRUMENTATION_JBOSS_LOGMANAGER_EXPERIMENTAL_LOG_ATTRIBUTES
description: Enable the capture of experimental log attributes `thread.name` and
`thread.id`.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jboss-logmanager.experimental.capture-mdc-attributes
env: OTEL_INSTRUMENTATION_JBOSS_LOGMANAGER_EXPERIMENTAL_CAPTURE_MDC_ATTRIBUTES
description: Comma separated list of MDC attributes to capture. Use the wildcard
character `*` to capture all attributes.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.jboss-logmanager.experimental.capture-event-name
env: OTEL_INSTRUMENTATION_JBOSS_LOGMANAGER_EXPERIMENTAL_CAPTURE_EVENT_NAME
description: Enable moving the `event.name` attribute (captured by one of the
other mechanisms of capturing attributes) to the log event name.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jdbc.statement-sanitizer.enabled
env: OTEL_INSTRUMENTATION_JDBC_STATEMENT_SANITIZER_ENABLED
description: Enables the DB statement sanitization.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.jdbc.experimental.capture-query-parameters
env: OTEL_INSTRUMENTATION_JDBC_EXPERIMENTAL_CAPTURE_QUERY_PARAMETERS
description: 'Enable the capture of query parameters as span attributes. Enabling
this option disables the statement sanitization.
WARNING: captured query
parameters may contain sensitive information such as passwords, personally identifiable
information or protected health info.'
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jdbc.experimental.transaction.enabled
env: OTEL_INSTRUMENTATION_JDBC_EXPERIMENTAL_TRANSACTION_ENABLED
description: Enables experimental instrumentation to create spans for COMMIT and
ROLLBACK operations.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jdbc.experimental.sqlcommenter.enabled
env: OTEL_INSTRUMENTATION_JDBC_EXPERIMENTAL_SQLCOMMENTER_ENABLED
description: 'Enables augmenting queries with a comment containing the tracing
information. See [sqlcommenter](https://google.github.io/sqlcommenter/) for
more info. WARNING: augmenting queries with tracing context will make query
texts unique, which may have adverse impact on database performance. Consult
with database experts before enabling.'
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.jsp.experimental-span-attributes
env: OTEL_INSTRUMENTATION_JSP_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.kafka.experimental-span-attributes
env: OTEL_INSTRUMENTATION_KAFKA_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.kafka.producer-propagation.enabled
env: OTEL_INSTRUMENTATION_KAFKA_PRODUCER_PROPAGATION_ENABLED
description: Enable context propagation for kafka message producer.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.kubernetes-client.experimental-span-attributes
env: OTEL_INSTRUMENTATION_KUBERNETES_CLIENT_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.lettuce.experimental-span-attributes
env: OTEL_INSTRUMENTATION_LETTUCE_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental-log-attributes
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_LOG_ATTRIBUTES
description: Enable the capture of experimental log attributes `thread.name` and
`thread.id`.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental.capture-code-attributes
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_CAPTURE_CODE_ATTRIBUTES
description: Enable the capture of [source code attributes](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#source-code-attributes).
Note that capturing source code attributes at logging sites might add a performance
overhead.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental.capture-map-message-attributes
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_CAPTURE_MAP_MESSAGE_ATTRIBUTES
description: Enable the capture of `MapMessage` attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental.capture-marker-attribute
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_CAPTURE_MARKER_ATTRIBUTE
description: Enable the capture of Log4j markers as attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental.capture-mdc-attributes
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_CAPTURE_MDC_ATTRIBUTES
description: Comma separated list of context data attributes to capture. Use the
wildcard character `*` to capture all attributes.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.log4j-appender.experimental.capture-event-name
env: OTEL_INSTRUMENTATION_LOG4J_APPENDER_EXPERIMENTAL_CAPTURE_EVENT_NAME
description: Enable moving the `event.name` attribute (captured by one of the
other mechanisms of capturing attributes) to the log event name.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.log4j-context-data.add-baggage
env: OTEL_INSTRUMENTATION_LOG4J_CONTEXT_DATA_ADD_BAGGAGE
description: Enable exposing baggage attributes through MDC.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.mdc.resource-attributes
env: OTEL_INSTRUMENTATION_COMMON_MDC_RESOURCE_ATTRIBUTES
description: Comma separated list of resource attributes to expose through MDC.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.common.logging.trace-id
env: OTEL_INSTRUMENTATION_COMMON_LOGGING_TRACE_ID
description: Customize MDC key name for the trace id.
default: trace_id
type: string
category: instrumentation
- property: otel.instrumentation.common.logging.span-id
env: OTEL_INSTRUMENTATION_COMMON_LOGGING_SPAN_ID
description: Customize MDC key name for the span id.
default: span_id
type: string
category: instrumentation
- property: otel.instrumentation.common.logging.trace-flags
env: OTEL_INSTRUMENTATION_COMMON_LOGGING_TRACE_FLAGS
description: Customize MDC key name for the trace flags.
default: trace_flags
type: string
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental-log-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_LOG_ATTRIBUTES
description: Enable the capture of experimental log attributes `thread.name` and
`thread.id`.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-code-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_CODE_ATTRIBUTES
description: Enable the capture of [source code attributes](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md#source-code-attributes).
Note that capturing source code attributes at logging sites might add a performance
overhead.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-marker-attribute
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_MARKER_ATTRIBUTE
description: Enable the capture of Logback markers as attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-key-value-pair-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_KEY_VALUE_PAIR_ATTRIBUTES
description: Enable the capture of Logback key value pairs as attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-logger-context-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_LOGGER_CONTEXT_ATTRIBUTES
description: Enable the capture of Logback logger context properties as attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-arguments
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_ARGUMENTS
description: Enable the capture of Logback logger arguments.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-logstash-marker-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_LOGSTASH_MARKER_ATTRIBUTES
description: Enable the capture of Logstash markers, supported are those added
to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()`
and `Markers.appendRaw()` methods.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-logstash-structured-arguments
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_LOGSTASH_STRUCTURED_ARGUMENTS
description: Enable the capture of Logstash StructuredArguments as attributes
(e.g., `StructuredArguments.v()` and `StructuredArguments.keyValue()`).
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-mdc-attributes
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_MDC_ATTRIBUTES
description: Comma separated list of MDC attributes to capture. Use the wildcard
character `*` to capture all attributes.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.logback-appender.experimental.capture-event-name
env: OTEL_INSTRUMENTATION_LOGBACK_APPENDER_EXPERIMENTAL_CAPTURE_EVENT_NAME
description: Enable moving the `event.name` attribute (captured by one of the
other mechanisms of capturing attributes) to the log event name.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.logback-mdc.add-baggage
env: OTEL_INSTRUMENTATION_LOGBACK_MDC_ADD_BAGGAGE
description: Enable exposing baggage attributes through MDC.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.common.mdc.resource-attributes
env: OTEL_INSTRUMENTATION_COMMON_MDC_RESOURCE_ATTRIBUTES
description: Comma separated list of resource attributes to expose through MDC.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.micrometer.base-time-unit
env: OTEL_INSTRUMENTATION_MICROMETER_BASE_TIME_UNIT
description: Set the base time unit for the OpenTelemetry `MeterRegistry` implementation.
Valid values
`ns`, `nanoseconds`, `us`, `microseconds`,
`ms`, `milliseconds`, `s`, `seconds`, `min`, `minutes`, `h`, `hours`, `d`, `days`
default: s
type: string
category: instrumentation
- property: otel.instrumentation.micrometer.prometheus-mode.enabled
env: OTEL_INSTRUMENTATION_MICROMETER_PROMETHEUS_MODE_ENABLED
description: Enable the "Prometheus mode" this will simulate the behavior of Micrometer's
PrometheusMeterRegistry. The instruments will be renamed to match Micrometer
instrument naming, and the base time unit will be set to seconds.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.micrometer.histogram-gauges.enabled
env: OTEL_INSTRUMENTATION_MICROMETER_HISTOGRAM_GAUGES_ENABLED
description: Enables the generation of gauge-based Micrometer histograms for `DistributionSummary`
and `Timer` instruments.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.mongo.statement-sanitizer.enabled
env: OTEL_INSTRUMENTATION_MONGO_STATEMENT_SANITIZER_ENABLED
description: Enables the DB statement sanitization.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.netty.connection-telemetry.enabled
env: OTEL_INSTRUMENTATION_NETTY_CONNECTION_TELEMETRY_ENABLED
description: Enable the creation of Connect and DNS spans by default for Netty
4.0 and higher instrumentation.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.netty.ssl-telemetry.enabled
env: OTEL_INSTRUMENTATION_NETTY_SSL_TELEMETRY_ENABLED
description: Enable SSL telemetry for Netty 4.0 and higher instrumentation.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.genai.capture-message-content
env: OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT
description: Record content of user and LLM messages.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.opentelemetry-annotations.exclude-methods
env: OTEL_INSTRUMENTATION_OPENTELEMETRY_ANNOTATIONS_EXCLUDE_METHODS
description: All methods to be excluded from auto-instrumentation by annotation-based
advices.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.opentelemetry-instrumentation-annotations.exclude-methods
env: OTEL_INSTRUMENTATION_OPENTELEMETRY_INSTRUMENTATION_ANNOTATIONS_EXCLUDE_METHODS
description: All methods to be excluded from auto-instrumentation by annotation-based
advices.
default: ''
type: string
category: instrumentation
- property: otel.instrumentation.oshi.experimental-metrics.enabled
env: OTEL_INSTRUMENTATION_OSHI_EXPERIMENTAL_METRICS_ENABLED
description: Enable the OSHI metrics.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.powerjob.experimental-span-attributes
env: OTEL_INSTRUMENTATION_POWERJOB_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.pulsar.experimental-span-attributes
env: OTEL_INSTRUMENTATION_PULSAR_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.quartz.experimental-span-attributes
env: OTEL_INSTRUMENTATION_QUARTZ_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.r2dbc.statement-sanitizer.enabled
env: OTEL_INSTRUMENTATION_R2DBC_STATEMENT_SANITIZER_ENABLED
description: Enables the DB statement sanitization.
default: 'true'
type: boolean
category: instrumentation
- property: otel.instrumentation.rabbitmq.experimental-span-attributes
env: OTEL_INSTRUMENTATION_RABBITMQ_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.reactor.experimental-span-attributes
env: OTEL_INSTRUMENTATION_REACTOR_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.reactor-netty.connection-telemetry.enabled
env: OTEL_INSTRUMENTATION_REACTOR_NETTY_CONNECTION_TELEMETRY_ENABLED
description: Enable the creation of Connect and DNS spans by default.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.rocketmq-client.experimental-span-attributes
env: OTEL_INSTRUMENTATION_ROCKETMQ_CLIENT_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.runtime-telemetry.emit-experimental-telemetry
env: OTEL_INSTRUMENTATION_RUNTIME_TELEMETRY_EMIT_EXPERIMENTAL_TELEMETRY
description: Enable the capture of experimental metrics.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.runtime-telemetry-java17.enable-all
env: OTEL_INSTRUMENTATION_RUNTIME_TELEMETRY_JAVA17_ENABLE_ALL
description: Enable the capture of all JFR based metrics.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.runtime-telemetry-java17.enabled
env: OTEL_INSTRUMENTATION_RUNTIME_TELEMETRY_JAVA17_ENABLED
description: Enable the capture of JFR based metrics.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.runtime-telemetry.package-emitter.enabled
env: OTEL_INSTRUMENTATION_RUNTIME_TELEMETRY_PACKAGE_EMITTER_ENABLED
description: Enable creating events for JAR libraries used by the application.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.runtime-telemetry.package-emitter.jars-per-second
env: OTEL_INSTRUMENTATION_RUNTIME_TELEMETRY_PACKAGE_EMITTER_JARS_PER_SECOND
description: The number of JAR files processed per second.
default: '10'
type: int
category: instrumentation
- property: otel.instrumentation.rxjava.experimental-span-attributes
env: OTEL_INSTRUMENTATION_RXJAVA_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.servlet.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SERVLET_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-batch.item.enabled
env: OTEL_INSTRUMENTATION_SPRING_BATCH_ITEM_ENABLED
description: Enable creating span for each item.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-batch.experimental.chunk.new-trace
env: OTEL_INSTRUMENTATION_SPRING_BATCH_EXPERIMENTAL_CHUNK_NEW_TRACE
description: Enable staring a new trace for each chunk.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-scheduling.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPRING_SCHEDULING_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes for Spring Batch
version 3.0.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-integration.global-channel-interceptor-patterns
env: OTEL_INSTRUMENTATION_SPRING_INTEGRATION_GLOBAL_CHANNEL_INTERCEPTOR_PATTERNS
description: An array of Spring channel name patterns that will be intercepted.
See [Spring Integration docs](https://docs.spring.io/spring-integration/reference/channel/configuration.html#global-channel-configuration-interceptors)
for more details.
default: '*'
type: string
category: instrumentation
- property: otel.instrumentation.spring-integration.producer.enabled
env: OTEL_INSTRUMENTATION_SPRING_INTEGRATION_PRODUCER_ENABLED
description: Create producer spans when messages are sent to an output channel.
Enable when you're using a messaging library that doesn't have its own instrumentation
for generating producer spans. Note that the detection of output channels only
works for [Spring Cloud Stream](https://spring.io/projects/spring-cloud-stream)
`DirectWithAttributesChannel`.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-scheduling.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPRING_SCHEDULING_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes for Spring Scheduling
version 3.1.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-webflux.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPRING_WEBFLUX_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes for Spring WebFlux
version 5.0.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-webmvc.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPRING_WEBMVC_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes for Spring Web
MVC version 3.1.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-cloud-gateway.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPRING_CLOUD_GATEWAY_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.spring-security.enduser.role.granted-authority-prefix
env: OTEL_INSTRUMENTATION_SPRING_SECURITY_ENDUSER_ROLE_GRANTED_AUTHORITY_PREFIX
description: Prefix of granted authorities identifying roles to capture in the
`enduser.role` semantic attribute.
default: ROLE_
type: string
category: instrumentation
- property: otel.instrumentation.spring-security.enduser.scope.granted-authority-prefix
env: OTEL_INSTRUMENTATION_SPRING_SECURITY_ENDUSER_SCOPE_GRANTED_AUTHORITY_PREFIX
description: Prefix of granted authorities identifying scopes to capture in the
`enduser.scopes` semantic attribute.
default: SCOPE_
type: string
category: instrumentation
- property: otel.instrumentation.spymemcached.experimental-span-attributes
env: OTEL_INSTRUMENTATION_SPYMEMCACHED_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.twilio.experimental-span-attributes
env: OTEL_INSTRUMENTATION_TWILIO_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
- property: otel.instrumentation.xxl-job.experimental-span-attributes
env: OTEL_INSTRUMENTATION_XXL_JOB_EXPERIMENTAL_SPAN_ATTRIBUTES
description: Enable the capture of experimental span attributes.
default: 'false'
type: boolean
category: instrumentation
metrics:
- instrumentation_scope_name: io.opentelemetry.sdk.trace
metric_name: queueSize
instrument: gauge
description: The number of items queued
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- instrumentation_scope_name: io.opentelemetry.sdk.trace
metric_name: processedSpans
instrument: counter
description: The number of spans processed by the BatchSpanProcessor. [dropped=true
if they were dropped due to high throughput]
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- instrumentation_scope_name: io.opentelemetry.sdk.logs
metric_name: queueSize
instrument: gauge
description: The number of items queued
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- instrumentation_scope_name: io.opentelemetry.sdk.logs
metric_name: processedLogs
instrument: counter
description: The number of logs processed by the BatchLogRecordProcessor. [dropped=true
if they were dropped due to high throughput]
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: otlp.exporter.exported
instrument: counter
description: The number of items exported by the otlp exporter.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: otlp.exporter.seen
instrument: counter
description: The number of items seen by the otlp exporter.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
instrumentations:
- keys:
- activej-http
instrumented_components:
- name: ActiveJ HTTP Server
supported_versions: 6.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- methods
instrumented_components:
- name: Additional methods tracing
stability: experimental
support: community
- keys:
- external-annotations
instrumented_components:
- name: Additional tracing annotations
stability: experimental
support: community
- keys:
- akka-actor
instrumented_components:
- name: Akka Actors
supported_versions: 2.3 and higher
stability: experimental
support: community
- keys:
- akka-http
instrumented_components:
- name: Akka HTTP
supported_versions: 10.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- axis2
instrumented_components:
- name: Apache Axis2
supported_versions: 1.6 and higher
stability: experimental
support: community
- keys:
- camel
instrumented_components:
- name: Apache Camel
supported_versions: 2.20 to 3.0
stability: experimental
support: community
- keys:
- cxf
instrumented_components:
- name: Apache CXF JAX-RS
supported_versions: 3.2 and higher
- name: Apache CXF JAX-WS
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- apache-dbcp
instrumented_components:
- name: Apache DBCP
supported_versions: 2.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.idle.max
instrument: updowncounter
description: The maximum number of idle open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.idle.min
instrument: updowncounter
description: The minimum number of idle open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.max
instrument: updowncounter
description: The maximum number of open connections allowed.
category_notes: Custom metric.
- keys:
- apache-dubbo
instrumented_components:
- name: Apache DBCP
supported_versions: 2.7 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: rpc.client.duration
instrument: histogram
description: The duration of an outbound RPC invocation.
category_notes: Custom metric.
- metric_name: rpc.server.duration
instrument: histogram
description: The duration of an inbound RPC invocation.
category_notes: Custom metric.
- keys:
- apache-httpasyncclient
instrumented_components:
- name: Apache HttpAsyncClient
supported_versions: 4.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- apache-httpclient
instrumented_components:
- name: Apache HttpClient
supported_versions: 2.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- kafka
- kafka-clients-metrics
instrumented_components:
- name: Apache Kafka Producer/Consumer API
supported_versions: 0.11 and higher
- name: Apache Kafka Streams API
supported_versions: 0.11 and higher
- name: Apache Kafka Connect API
supported_versions: 2.6 and higher
description: Consult documentation of the used kafka version for the exact metrics
it generates.
stability: experimental
support: community
signals:
- metrics:
- metric_name: kafka.consumer.assigned_partitions
instrument: gauge
description: The number of partitions currently assigned to this consumer.
category_notes: Custom metric.
- metric_name: kafka.consumer.commit_latency_avg
instrument: gauge
description: The average time taken for a commit request.
category_notes: Custom metric.
- metric_name: kafka.consumer.commit_latency_max
instrument: gauge
description: The max time taken for a commit request.
category_notes: Custom metric.
- metric_name: kafka.consumer.commit_rate
instrument: gauge
description: The number of commit calls per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.commit_total
instrument: counter
description: The total number of commit calls.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_rebalance_rate_per_hour
instrument: gauge
description: The number of failed rebalance events per hour.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_rebalance_total
instrument: counter
description: The total number of failed rebalance events.
category_notes: Custom metric.
- metric_name: kafka.consumer.heartbeat_rate
instrument: gauge
description: The number of heartbeats per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.heartbeat_response_time_max
instrument: gauge
description: The max time taken to receive a response to a heartbeat request.
category_notes: Custom metric.
- metric_name: kafka.consumer.heartbeat_total
instrument: counter
description: The total number of heartbeats.
category_notes: Custom metric.
- metric_name: kafka.consumer.join_rate
instrument: gauge
description: The number of group joins per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.join_time_avg
instrument: gauge
description: The average time taken for a group rejoin.
category_notes: Custom metric.
- metric_name: kafka.consumer.join_time_max
instrument: gauge
description: The max time taken for a group rejoin.
category_notes: Custom metric.
- metric_name: kafka.consumer.join_total
instrument: counter
description: The total number of group joins.
category_notes: Custom metric.
- metric_name: kafka.consumer.last_heartbeat_seconds_ago
instrument: gauge
description: The number of seconds since the last coordinator heartbeat
was sent.
category_notes: Custom metric.
- metric_name: kafka.consumer.last_rebalance_seconds_ago
instrument: gauge
description: The number of seconds since the last successful rebalance
event.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_assigned_latency_avg
instrument: gauge
description: The average time taken for a partition-assigned rebalance
listener callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_assigned_latency_max
instrument: gauge
description: The max time taken for a partition-assigned rebalance listener
callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_lost_latency_avg
instrument: gauge
description: The average time taken for a partition-lost rebalance listener
callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_lost_latency_max
instrument: gauge
description: The max time taken for a partition-lost rebalance listener
callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_revoked_latency_avg
instrument: gauge
description: The average time taken for a partition-revoked rebalance
listener callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.partition_revoked_latency_max
instrument: gauge
description: The max time taken for a partition-revoked rebalance listener
callback.
category_notes: Custom metric.
- metric_name: kafka.consumer.rebalance_latency_avg
instrument: gauge
description: The average time taken for a group to complete a successful
rebalance, which may be composed of several failed re-trials until it
succeeded.
category_notes: Custom metric.
- metric_name: kafka.consumer.rebalance_latency_max
instrument: gauge
description: The max time taken for a group to complete a successful rebalance,
which may be composed of several failed re-trials until it succeeded.
category_notes: Custom metric.
- metric_name: kafka.consumer.rebalance_latency_total
instrument: counter
description: The total number of milliseconds this consumer has spent
in successful rebalances since creation.
category_notes: Custom metric.
- metric_name: kafka.consumer.rebalance_rate_per_hour
instrument: gauge
description: The number of successful rebalance events per hour, each
event is composed of several failed re-trials until it succeeded.
category_notes: Custom metric.
- metric_name: kafka.consumer.rebalance_total
instrument: counter
description: The total number of successful rebalance events, each event
is composed of several failed re-trials until it succeeded.
category_notes: Custom metric.
- metric_name: kafka.consumer.sync_rate
instrument: gauge
description: The number of group syncs per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.sync_time_avg
instrument: gauge
description: The average time taken for a group sync.
category_notes: Custom metric.
- metric_name: kafka.consumer.sync_time_max
instrument: gauge
description: The max time taken for a group sync.
category_notes: Custom metric.
- metric_name: kafka.consumer.sync_total
instrument: counter
description: The total number of group syncs.
category_notes: Custom metric.
- metric_name: kafka.consumer.bytes_consumed_rate
instrument: gauge
description: The average number of bytes consumed per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.bytes_consumed_total
instrument: counter
description: The total number of bytes consumed.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_latency_avg
instrument: gauge
description: The average time taken for a fetch request.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_latency_max
instrument: gauge
description: The max time taken for any fetch request.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_rate
instrument: gauge
description: The number of fetch requests per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_size_avg
instrument: gauge
description: The average number of bytes fetched per request.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_size_max
instrument: gauge
description: The maximum number of bytes fetched per request.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_throttle_time_avg
instrument: gauge
description: The average throttle time in ms.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_throttle_time_max
instrument: gauge
description: The maximum throttle time in ms.
category_notes: Custom metric.
- metric_name: kafka.consumer.fetch_total
instrument: counter
description: The total number of fetch requests.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_consumed_rate
instrument: gauge
description: The average number of records consumed per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_consumed_total
instrument: counter
description: The total number of records consumed.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lag
instrument: gauge
description: The latest lag of the partition.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lag_avg
instrument: gauge
description: The average lag of the partition.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lag_max
instrument: gauge
description: 'The maximum lag in terms of number of records for any partition
in this window. NOTE: This is based on current offset and not committed
offset.'
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lead
instrument: gauge
description: The latest lead of the partition.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lead_avg
instrument: gauge
description: The average lead of the partition.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_lead_min
instrument: gauge
description: The minimum lead in terms of number of records for any partition
in this window.
category_notes: Custom metric.
- metric_name: kafka.consumer.records_per_request_avg
instrument: gauge
description: The average number of records in each request.
category_notes: Custom metric.
- metric_name: kafka.consumer.commit_sync_time_ns_total
instrument: counter
description: The total time the consumer has spent in commitSync in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.committed_time_ns_total
instrument: counter
description: The total time the consumer has spent in committed in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.connection_close_rate
instrument: gauge
description: The number of connections closed per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.connection_close_total
instrument: counter
description: The total number of connections closed.
category_notes: Custom metric.
- metric_name: kafka.consumer.connection_count
instrument: gauge
description: The current number of active connections.
category_notes: Custom metric.
- metric_name: kafka.consumer.connection_creation_rate
instrument: gauge
description: The number of new connections established per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.connection_creation_total
instrument: counter
description: The total number of new connections established.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_authentication_rate
instrument: gauge
description: The number of connections with failed authentication per
second.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_authentication_total
instrument: counter
description: The total number of connections with failed authentication.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_reauthentication_rate
instrument: gauge
description: The number of failed re-authentication of connections per
second.
category_notes: Custom metric.
- metric_name: kafka.consumer.failed_reauthentication_total
instrument: counter
description: The total number of failed re-authentication of connections.
category_notes: Custom metric.
- metric_name: kafka.consumer.io_ratio
instrument: gauge
description: ' *Deprecated* The fraction of time the I/O thread spent
doing I/O.'
category_notes: Custom metric.
- metric_name: kafka.consumer.io_time_ns_avg
instrument: gauge
description: The average length of time for I/O per select call in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.io_time_ns_total
instrument: counter
description: The total time the I/O thread spent doing I/O.
category_notes: Custom metric.
- metric_name: kafka.consumer.io_wait_ratio
instrument: gauge
description: '*Deprecated* The fraction of time the I/O thread spent waiting.'
category_notes: Custom metric.
- metric_name: kafka.consumer.io_wait_time_ns_avg
instrument: gauge
description: The average length of time the I/O thread spent waiting for
a socket ready for reads or writes in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.io_wait_time_ns_total
instrument: counter
description: The total time the I/O thread spent waiting
category_notes: Custom metric.
- metric_name: kafka.consumer.io_waittime_total
instrument: counter
description: '*Deprecated* The total time the I/O thread spent waiting.'
category_notes: Custom metric.
- metric_name: kafka.consumer.iotime_total
instrument: counter
description: '*Deprecated* The total time the I/O thread spent doing I/O.'
category_notes: Custom metric.
- metric_name: kafka.consumer.last_poll_seconds_ago
instrument: gauge
description: The number of seconds since the last poll() invocation.
category_notes: Custom metric.
- metric_name: kafka.consumer.network_io_rate
instrument: gauge
description: The number of network operations (reads or writes) on all
connections per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.network_io_total
instrument: counter
description: The total number of network operations (reads or writes)
on all connections.
category_notes: Custom metric.
- metric_name: kafka.consumer.poll_idle_ratio_avg
instrument: gauge
description: The average fraction of time the consumer's poll() is idle
as opposed to waiting for the user code to process records.
category_notes: Custom metric.
- metric_name: kafka.consumer.reauthentication_latency_avg
instrument: gauge
description: The average latency observed due to re-authentication.
category_notes: Custom metric.
- metric_name: kafka.consumer.reauthentication_latency_max
instrument: gauge
description: The max latency observed due to re-authentication.
category_notes: Custom metric.
- metric_name: kafka.consumer.select_rate
instrument: gauge
description: The number of times the I/O layer checked for new I/O to
perform per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.select_total
instrument: counter
description: The total number of times the I/O layer checked for new I/O
to perform.
category_notes: Custom metric.
- metric_name: kafka.consumer.successful_authentication_no_reauth_total
instrument: counter
description: The total number of connections with successful authentication
where the client does not support re-authentication.
category_notes: Custom metric.
- metric_name: kafka.consumer.successful_authentication_rate
instrument: gauge
description: The number of connections with successful authentication
per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.successful_authentication_total
instrument: counter
description: The total number of connections with successful authentication.
category_notes: Custom metric.
- metric_name: kafka.consumer.successful_reauthentication_rate
instrument: gauge
description: The number of successful re-authentication of connections
per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.successful_reauthentication_total
instrument: counter
description: The total number of successful re-authentication of connections.
category_notes: Custom metric.
- metric_name: kafka.consumer.time_between_poll_avg
instrument: gauge
description: The average delay between invocations of poll() in milliseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.time_between_poll_max
instrument: gauge
description: The max delay between invocations of poll() in milliseconds.
category_notes: Custom metric.
- metric_name: kafka.consumer.incoming_byte_rate
instrument: gauge
description: The number of bytes read off all sockets per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.incoming_byte_total
instrument: counter
description: The total number of bytes read off all sockets.
category_notes: Custom metric.
- metric_name: kafka.consumer.outgoing_byte_rate
instrument: gauge
description: The number of outgoing bytes sent to all servers per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.outgoing_byte_total
instrument: counter
description: The total number of outgoing bytes sent to all servers.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_latency_avg
instrument: gauge
description: The average request latency in ms.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_latency_max
instrument: gauge
description: The maximum request latency in ms.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_rate
instrument: gauge
description: The number of requests sent per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_size_avg
instrument: gauge
description: The average size of requests sent.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_size_max
instrument: gauge
description: The maximum size of any request sent.
category_notes: Custom metric.
- metric_name: kafka.consumer.request_total
instrument: counter
description: The total number of requests sent.
category_notes: Custom metric.
- metric_name: kafka.consumer.response_rate
instrument: gauge
description: The number of responses received per second.
category_notes: Custom metric.
- metric_name: kafka.consumer.response_total
instrument: counter
description: The total number of responses received.
category_notes: Custom metric.
- metric_name: kafka.producer.batch_size_avg
instrument: gauge
description: The average number of bytes sent per partition per-request.
category_notes: Custom metric.
- metric_name: kafka.producer.batch_size_max
instrument: gauge
description: The max number of bytes sent per partition per-request.
category_notes: Custom metric.
- metric_name: kafka.producer.batch_split_rate
instrument: gauge
description: The average number of batch splits per second.
category_notes: Custom metric.
- metric_name: kafka.producer.batch_split_total
instrument: counter
description: The total number of batch splits.
category_notes: Custom metric.
- metric_name: kafka.producer.buffer_available_bytes
instrument: gauge
description: The total amount of buffer memory that is not being used
(either unallocated or in the free list).
category_notes: Custom metric.
- metric_name: kafka.producer.buffer_exhausted_rate
instrument: gauge
description: The average per-second number of record sends that are dropped
due to buffer exhaustion.
category_notes: Custom metric.
- metric_name: kafka.producer.buffer_exhausted_total
instrument: counter
description: The total number of record sends that are dropped due to
buffer exhaustion.
category_notes: Custom metric.
- metric_name: kafka.producer.buffer_total_bytes
instrument: gauge
description: The maximum amount of buffer memory the client can use (whether
or not it is currently used).
category_notes: Custom metric.
- metric_name: kafka.producer.bufferpool_wait_ratio
instrument: gauge
description: The fraction of time an appender waits for space allocation.
category_notes: Custom metric.
- metric_name: kafka.producer.bufferpool_wait_time_ns_total
instrument: counter
description: The total time in nanoseconds an appender waits for space
allocation.
category_notes: Custom metric.
- metric_name: kafka.producer.bufferpool_wait_time_total
instrument: counter
description: '*Deprecated* The total time an appender waits for space
allocation.'
category_notes: Custom metric.
- metric_name: kafka.producer.compression_rate_avg
instrument: gauge
description: The average compression rate of record batches.
category_notes: Custom metric.
- metric_name: kafka.producer.connection_close_rate
instrument: gauge
description: The number of connections closed per second.
category_notes: Custom metric.
- metric_name: kafka.producer.connection_close_total
instrument: counter
description: The total number of connections closed.
category_notes: Custom metric.
- metric_name: kafka.producer.connection_count
instrument: gauge
description: The current number of active connections.
category_notes: Custom metric.
- metric_name: kafka.producer.connection_creation_rate
instrument: gauge
description: The number of new connections established per second.
category_notes: Custom metric.
- metric_name: kafka.producer.connection_creation_total
instrument: counter
description: The total number of new connections established.
category_notes: Custom metric.
- metric_name: kafka.producer.failed_authentication_rate
instrument: gauge
description: The number of connections with failed authentication per
second.
category_notes: Custom metric.
- metric_name: kafka.producer.failed_authentication_total
instrument: counter
description: The total number of connections with failed authentication.
category_notes: Custom metric.
- metric_name: kafka.producer.failed_reauthentication_rate
instrument: gauge
description: The number of failed re-authentication of connections per
second.
category_notes: Custom metric.
- metric_name: kafka.producer.failed_reauthentication_total
instrument: counter
description: The total number of failed re-authentication of connections.
category_notes: Custom metric.
- metric_name: kafka.producer.flush_time_ns_total
instrument: counter
description: Total time producer has spent in flush in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.io_ratio
instrument: gauge
description: '*Deprecated* The fraction of time the I/O thread spent doing
I/O.'
category_notes: Custom metric.
- metric_name: kafka.producer.io_time_ns_avg
instrument: gauge
description: The average length of time for I/O per select call in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.io_time_ns_total
instrument: counter
description: The total time the I/O thread spent doing I/O.
category_notes: Custom metric.
- metric_name: kafka.producer.io_wait_ratio
instrument: gauge
description: '*Deprecated* The fraction of time the I/O thread spent waiting.'
category_notes: Custom metric.
- metric_name: kafka.producer.io_wait_time_ns_avg
instrument: gauge
description: The average length of time the I/O thread spent waiting for
a socket ready for reads or writes in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.io_wait_time_ns_total
instrument: counter
description: The total time the I/O thread spent waiting.
category_notes: Custom metric.
- metric_name: kafka.producer.io_waittime_total
instrument: counter
description: '*Deprecated* The total time the I/O thread spent waiting.'
category_notes: Custom metric.
- metric_name: kafka.producer.iotime_total
instrument: counter
description: '*Deprecated* The total time the I/O thread spent doing I/O.'
category_notes: Custom metric.
- metric_name: kafka.producer.metadata_age
instrument: gauge
description: The age in seconds of the current producer metadata being
used.
category_notes: Custom metric.
- metric_name: kafka.producer.metadata_wait_time_ns_total
instrument: counter
description: Total time producer has spent waiting on topic metadata in
nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.network_io_rate
instrument: gauge
description: The number of network operations (reads or writes) on all
connections per second.
category_notes: Custom metric.
- metric_name: kafka.producer.network_io_total
instrument: counter
description: The total number of network operations (reads or writes)
on all connections.
category_notes: Custom metric.
- metric_name: kafka.producer.produce_throttle_time_avg
instrument: gauge
description: The average time in ms a request was throttled by a broker.
category_notes: Custom metric.
- metric_name: kafka.producer.produce_throttle_time_max
instrument: gauge
description: The maximum time in ms a request was throttled by a broker.
category_notes: Custom metric.
- metric_name: kafka.producer.reauthentication_latency_avg
instrument: gauge
description: The average latency observed due to re-authentication.
category_notes: Custom metric.
- metric_name: kafka.producer.reauthentication_latency_max
instrument: gauge
description: The max latency observed due to re-authentication.
category_notes: Custom metric.
- metric_name: kafka.producer.record_queue_time_avg
instrument: gauge
description: The average time in ms record batches spent in the send buffer.
category_notes: Custom metric.
- metric_name: kafka.producer.record_queue_time_max
instrument: gauge
description: The maximum time in ms record batches spent in the send buffer.
category_notes: Custom metric.
- metric_name: kafka.producer.record_size_avg
instrument: gauge
description: The average record size.
category_notes: Custom metric.
- metric_name: kafka.producer.record_size_max
instrument: gauge
description: The maximum record size.
category_notes: Custom metric.
- metric_name: kafka.producer.records_per_request_avg
instrument: gauge
description: The average number of records per request.
category_notes: Custom metric.
- metric_name: kafka.producer.requests_in_flight
instrument: gauge
description: The current number of in-flight requests awaiting a response.
category_notes: Custom metric.
- metric_name: kafka.producer.select_rate
instrument: gauge
description: The number of times the I/O layer checked for new I/O to
perform per second.
category_notes: Custom metric.
- metric_name: kafka.producer.select_total
instrument: counter
description: The total number of times the I/O layer checked for new I/O
to perform.
category_notes: Custom metric.
- metric_name: kafka.producer.successful_authentication_no_reauth_total
instrument: counter
description: The total number of connections with successful authentication
where the client does not support re-authentication.
category_notes: Custom metric.
- metric_name: kafka.producer.successful_authentication_rate
instrument: gauge
description: The number of connections with successful authentication
per second.
category_notes: Custom metric.
- metric_name: kafka.producer.successful_authentication_total
instrument: counter
description: The total number of connections with successful authentication.
category_notes: Custom metric.
- metric_name: kafka.producer.successful_reauthentication_rate
instrument: gauge
description: The number of successful re-authentication of connections
per second.
category_notes: Custom metric.
- metric_name: kafka.producer.successful_reauthentication_total
instrument: counter
description: The total number of successful re-authentication of connections.
category_notes: Custom metric.
- metric_name: kafka.producer.txn_abort_time_ns_total
instrument: counter
description: Total time producer has spent in abortTransaction in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.txn_begin_time_ns_total
instrument: counter
description: Total time producer has spent in beginTransaction in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.txn_commit_time_ns_total
instrument: counter
description: Total time producer has spent in commitTransaction in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.txn_init_time_ns_total
instrument: counter
description: Total time producer has spent in initTransactions in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.txn_send_offsets_time_ns_total
instrument: counter
description: Total time producer has spent in sendOffsetsToTransaction
in nanoseconds.
category_notes: Custom metric.
- metric_name: kafka.producer.waiting_threads
instrument: gauge
description: The number of user threads blocked waiting for buffer memory
to enqueue their records.
category_notes: Custom metric.
- metric_name: kafka.producer.incoming_byte_rate
instrument: gauge
description: The number of bytes read off all sockets per second.
category_notes: Custom metric.
- metric_name: kafka.producer.incoming_byte_total
instrument: counter
description: The total number of bytes read off all sockets.
category_notes: Custom metric.
- metric_name: kafka.producer.outgoing_byte_rate
instrument: gauge
description: The number of outgoing bytes sent to all servers per second.
category_notes: Custom metric.
- metric_name: kafka.producer.outgoing_byte_total
instrument: counter
description: The total number of outgoing bytes sent to all servers.
category_notes: Custom metric.
- metric_name: kafka.producer.request_latency_avg
instrument: gauge
description: The average request latency in ms.
category_notes: Custom metric.
- metric_name: kafka.producer.request_latency_max
instrument: gauge
description: The maximum request latency in ms.
category_notes: Custom metric.
- metric_name: kafka.producer.request_rate
instrument: gauge
description: The number of requests sent per second.
category_notes: Custom metric.
- metric_name: kafka.producer.request_size_avg
instrument: gauge
description: The average size of requests sent.
category_notes: Custom metric.
- metric_name: kafka.producer.request_size_max
instrument: gauge
description: The maximum size of any request sent.
category_notes: Custom metric.
- metric_name: kafka.producer.request_total
instrument: counter
description: The total number of requests sent.
category_notes: Custom metric.
- metric_name: kafka.producer.response_rate
instrument: gauge
description: The number of responses received per second.
category_notes: Custom metric.
- metric_name: kafka.producer.response_total
instrument: counter
description: The total number of responses received.
category_notes: Custom metric.
- metric_name: kafka.producer.byte_rate
instrument: gauge
description: The average number of bytes sent per second for a topic.
category_notes: Custom metric.
- metric_name: kafka.producer.byte_total
instrument: counter
description: The total number of bytes sent for a topic.
category_notes: Custom metric.
- metric_name: kafka.producer.compression_rate
instrument: gauge
description: The average compression rate of record batches for a topic.
category_notes: Custom metric.
- metric_name: kafka.producer.record_error_rate
instrument: gauge
description: The average per-second number of record sends that resulted
in errors.
category_notes: Custom metric.
- metric_name: kafka.producer.record_error_total
instrument: counter
description: The total number of record sends that resulted in errors.
category_notes: Custom metric.
- metric_name: kafka.producer.record_retry_rate
instrument: gauge
description: The average per-second number of retried record sends.
category_notes: Custom metric.
- metric_name: kafka.producer.record_retry_total
instrument: counter
description: The total number of retried record sends.
category_notes: Custom metric.
- metric_name: kafka.producer.record_send_rate
instrument: gauge
description: The average number of records sent per second.
category_notes: Custom metric.
- metric_name: kafka.producer.record_send_total
instrument: counter
description: The total number of records sent.
category_notes: Custom metric.
- keys:
- jsf-myfaces
instrumented_components:
- name: Apache MyFaces
supported_versions: 1.2 and higher
stability: experimental
support: community
- keys:
- pekko-actor
instrumented_components:
- name: Apache Pekko Actors
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- pekko-http
instrumented_components:
- name: Apache Pekko HTTP
supported_versions: 1.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- pulsar
instrumented_components:
- name: Apache Pulsar
supported_versions: 2.8 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: messaging.publish.duration
instrument: histogram
description: Measures the duration of publish operation.
category_notes: Custom metric.
- metric_name: messaging.receive.duration
instrument: histogram
description: Measures the duration of receive operation.
category_notes: Custom metric.
- metric_name: messaging.receive.messages
instrument: counter
description: Measures the number of received messages.
category_notes: Custom metric.
- keys:
- rocketmq-client
instrumented_components:
- name: Apache RocketMQ gRPC/Protobuf-based Client
supported_versions: 5.0 and higher
- name: Apache RocketMQ Remoting-based Client
supported_versions: 4.8 and higher
stability: experimental
support: community
- keys:
- apache-shenyu
instrumented_components:
- name: Apache ShenYu
supported_versions: 2.4 and higher
stability: experimental
support: community
- keys:
- struts
instrumented_components:
- name: Apache Struts 2
supported_versions: 2.3 and higher
stability: experimental
support: community
- keys:
- tomcat
instrumented_components:
- name: Apache Tomcat
supported_versions: 7.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- tapestry
instrumented_components:
- name: Apache Tapestry
supported_versions: 5.4 and higher
stability: experimental
support: community
- keys:
- wicket
instrumented_components:
- name: Apache Wicket
supported_versions: 8.0 and higher
stability: experimental
support: community
- keys:
- armeria
instrumented_components:
- name: Armeria
supported_versions: 1.3 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- armeria
instrumented_components:
- name: Armeria gRPC
supported_versions: 1.14 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: rpc.client.duration
instrument: histogram
description: The duration of an outbound RPC invocation.
category_notes: Custom metric.
- metric_name: rpc.client.request.size
instrument: histogram
description: Measures the size of RPC request messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.client.response.size
instrument: histogram
description: Measures the size of RPC response messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.server.duration
instrument: histogram
description: The duration of an inbound RPC invocation.
category_notes: Custom metric.
- metric_name: rpc.server.request.size
instrument: histogram
description: Measures the size of RPC request messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.server.response.size
instrument: histogram
description: Measures the size of RPC response messages (uncompressed).
category_notes: Custom metric.
- keys:
- async-http-client
instrumented_components:
- name: AsyncHttpClient
supported_versions: 1.8 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- avaje-jex
instrumented_components:
- name: Avaje Jex
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- aws-lambda
instrumented_components:
- name: AWS Lambda
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- aws-sdk
instrumented_components:
- name: AWS SDK 1
supported_versions: 1.11 and higher
- name: AWS SDK 2
supported_versions: 2.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- metric_name: gen_ai.client.token.usage
instrument: histogram
description: Measures number of input and output tokens used.
category_notes: Custom metric.
- metric_name: gen_ai.client.operation.duration
instrument: histogram
description: GenAI operation duration.
category_notes: Custom metric.
- keys:
- azure-core
instrumented_components:
- name: Azure Core
supported_versions: 1.14 and higher
stability: experimental
support: community
- keys:
- cassandra
instrumented_components:
- name: Cassandra Driver
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- clickhouse-client-v1
instrumented_components:
- name: Clickhouse Client V1
supported_versions: 0.5 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- clickhouse-client-v2
instrumented_components:
- name: Clickhouse Client V2
supported_versions: 0.8 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- couchbase
instrumented_components:
- name: Couchbase Client
supported_versions: 2.0 to 3.0 and 3.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- c3p0
instrumented_components:
- name: c3p0
supported_versions: 0.9.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.pending_requests
instrument: updowncounter
description: The number of pending requests for an open connection, cumulative
for the entire pool.
category_notes: Custom metric.
- keys:
- dropwizard-metrics
instrumented_components:
- name: Dropwizard Metrics
supported_versions: 4.0 and higher
description: Disabled by default
stability: experimental
support: community
- keys:
- dropwizard-views
instrumented_components:
- name: Dropwizard Views
supported_versions: 0.7 and higher
stability: experimental
support: community
- keys:
- grizzly
instrumented_components:
- name: Eclipse Grizzly
supported_versions: 2.3 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- jersey
instrumented_components:
- name: Eclipse Jersey
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- jetty
instrumented_components:
- name: Eclipse Jetty
supported_versions: 8.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- jetty-httpclient
instrumented_components:
- name: Eclipse Jetty HTTP Client
supported_versions: 9.2 to 10.0, 12.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- metro
instrumented_components:
- name: Eclipse Metro
supported_versions: 2.2 and higher
stability: experimental
support: community
- keys:
- jsf-mojarra
instrumented_components:
- name: Eclipse Mojarra
supported_versions: 1.2 and higher
stability: experimental
support: community
- keys:
- elasticsearch-api-client
instrumented_components:
- name: Elasticsearch API Client
supported_versions: 7.16 and higher
stability: experimental
support: community
- keys:
- elasticsearch-rest
instrumented_components:
- name: Elasticsearch REST Client
supported_versions: 5.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- elasticsearch-transport
instrumented_components:
- name: Elasticsearch Transport Client
supported_versions: 5.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- finagle-http
instrumented_components:
- name: Finagle
supported_versions: 23.11 and higher
stability: experimental
support: community
- keys:
- finatra
instrumented_components:
- name: Finatra
supported_versions: 2.9 and higher
stability: experimental
support: community
- keys:
- geode
instrumented_components:
- name: Geode Client
supported_versions: 1.4 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- google-http-client
instrumented_components:
- name: Google HTTP Client
supported_versions: 1.19 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- grails
instrumented_components:
- name: Grails
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- graphql-java
instrumented_components:
- name: GaphQL Java
supported_versions: 12.0 and higher
stability: experimental
support: community
- keys:
- grpc
instrumented_components:
- name: gRPC
supported_versions: 1.6 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: rpc.client.duration
instrument: histogram
description: The duration of an outbound RPC invocation.
category_notes: Custom metric.
- metric_name: rpc.client.request.size
instrument: histogram
description: Measures the size of RPC request messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.client.response.size
instrument: histogram
description: Measures the size of RPC response messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.server.duration
instrument: histogram
description: The duration of an inbound RPC invocation.
category_notes: Custom metric.
- metric_name: rpc.server.request.size
instrument: histogram
description: Measures the size of RPC request messages (uncompressed).
category_notes: Custom metric.
- metric_name: rpc.server.response.size
instrument: histogram
description: Measures the size of RPC response messages (uncompressed).
category_notes: Custom metric.
- keys:
- guava
instrumented_components:
- name: Guava ListenableFuture
supported_versions: 0.9.2 and higher
stability: experimental
support: community
- keys:
- gwt
instrumented_components:
- name: GWT
supported_versions: 0.9.2 and higher
stability: experimental
support: community
- keys:
- helidon
instrumented_components:
- name: Helidon
supported_versions: 0.9.2 and higher
stability: experimental
support: community
- keys:
- hibernate
instrumented_components:
- name: Hibernate
supported_versions: 4.3 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- hibernate-reactive
instrumented_components:
- name: Hibernate Reactive
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- hikaricp
instrumented_components:
- name: HikariCP
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.idle.min
instrument: updowncounter
description: The minimum number of idle open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.max
instrument: updowncounter
description: The maximum number of open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.pending_requests
instrument: updowncounter
description: The number of pending requests for an open connection, cumulative
for the entire pool.
category_notes: Custom metric.
- metric_name: db.client.connections.timeouts
instrument: counter
description: The number of connection timeouts that have occurred trying
to obtain a connection from the pool.
category_notes: Custom metric.
- metric_name: db.client.connections.create_time
instrument: histogram
description: The time it took to create a new connection.
category_notes: Custom metric.
- metric_name: db.client.connections.use_time
instrument: histogram
description: The time between borrowing a connection and returning it
to the pool.
category_notes: Custom metric.
- metric_name: db.client.connections.wait_time
instrument: histogram
description: The time it took to obtain an open connection from the pool.
category_notes: Custom metric.
- keys:
- http-url-connection
instrumented_components:
- name: HttpURLConnection
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- hystrix
instrumented_components:
- name: Hystrix
supported_versions: 1.4 and higher
stability: experimental
support: community
- keys:
- influxdb
instrumented_components:
- name: InfluxDB Client
supported_versions: 2.4 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- executors
instrumented_components:
- name: Java Executors
stability: experimental
support: community
- keys:
- java-http-client
instrumented_components:
- name: Java HTTP Client
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- java-http-server
instrumented_components:
- name: Java HTTP Server
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- java-util-logging
instrumented_components:
- name: java.util.logging
stability: experimental
support: community
- keys:
- runtime-telemetry
instrumented_components:
- name: Java Platform
stability: experimental
support: community
signals:
- metrics:
- metric_name: jvm.class.loaded
instrument: counter
description: Number of classes loaded since JVM start.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.class.unloaded
instrument: counter
description: Number of classes unloaded since JVM start.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.class.count
instrument: updowncounter
description: Number of classes currently loaded.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.cpu.time
instrument: counter
description: CPU time used by the process as reported by the JVM.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.cpu.count
instrument: updowncounter
description: Number of processors available to the Java virtual machine.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.cpu.recent_utilization
instrument: gauge
description: Recent CPU utilization for the process as reported by the
JVM.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.gc.duration
instrument: histogram
description: Duration of JVM garbage collection actions.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.memory.used
instrument: updowncounter
description: Measure of memory used.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.memory.committed
instrument: updowncounter
description: Measure of memory committed.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.memory.limit
instrument: updowncounter
description: Measure of max obtainable memory.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.memory.used_after_last_gc
instrument: updowncounter
description: Measure of memory used, as measured after the most recent
garbage collection event on this pool.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.thread.count
instrument: updowncounter
description: Number of executing platform threads (disabled by default).
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.buffer.memory.used
instrument: updowncounter
description: Measure of memory used by buffers (disabled by default).
category_notes: Custom metric.
- metric_name: jvm.buffer.memory.limit
instrument: updowncounter
description: Measure of total memory capacity of buffers (disabled by
default).
category_notes: Custom metric.
- metric_name: jvm.buffer.count
instrument: updowncounter
description: Number of buffers in the pool (disabled by default).
category_notes: Custom metric.
- metric_name: jvm.system.cpu.load_1m
instrument: gauge
description: Average CPU load of the whole system for the last minute
as reported by the JVM (disabled by default).
category_notes: Custom metric.
- metric_name: jvm.system.cpu.utilization
instrument: gauge
description: Recent CPU utilization for the whole system as reported by
the JVM (disabled by default).
category_notes: Custom metric.
- metric_name: jvm.memory.init
instrument: updowncounter
description: Measure of initial memory requested (disabled by default).
category_notes: Custom metric.
- metric_name: jvm.file_descriptor.count
instrument: updowncounter
description: Number of open file descriptors as reported by the JVM (disabled
by default).
category_notes: Custom metric.
- keys:
- javalin
instrumented_components:
- name: Javalin
supported_versions: 5.0 and higher
stability: experimental
support: community
- keys:
- jaxrs
instrumented_components:
- name: JAX-RS
supported_versions: 0.5 and higher
stability: experimental
support: community
- keys:
- jaxrs-client
instrumented_components:
- name: JAX-RS Client
supported_versions: 1.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- jaxws
instrumented_components:
- name: JAX-WS
supported_versions: 2.0 to 3.0
stability: experimental
support: community
- keys:
- jboss-logmanager-appender
- jboss-logmanager-mdc
instrumented_components:
- name: JBoss Log Manager
supported_versions: 1.1 and higher
stability: experimental
support: community
- keys:
- jdbc
- jdbc-datasource
instrumented_components:
- name: JDBC
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- jedis
instrumented_components:
- name: Jedis
supported_versions: 1.4 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- jfinal
instrumented_components:
- name: JFinal
supported_versions: 3.2 and higher
stability: experimental
support: community
- keys:
- jms
instrumented_components:
- name: JMS
supported_versions: 1.1 and higher
stability: experimental
support: community
- keys:
- jodd-http
instrumented_components:
- name: Jodd HTTP
supported_versions: 4.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- jsp
instrumented_components:
- name: JSP
supported_versions: 2.3 and higher
stability: experimental
support: community
- keys:
- kotlinx-coroutines
instrumented_components:
- name: Kotlin Coroutines
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- ktor
instrumented_components:
- name: Ktor
supported_versions: 2.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- kubernetes-client
instrumented_components:
- name: Kubernetes Client
supported_versions: 7.0 and higher
stability: experimental
support: community
- keys:
- lettuce
instrumented_components:
- name: Lettuce
supported_versions: 4.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- liberty
instrumented_components:
- name: Liberty
supported_versions: 20.0 and higher
stability: experimental
support: community
- keys:
- log4j-appender
- log4j-mdc
- log4j-context-data
instrumented_components:
- name: Log4j
supported_versions: 1.2 and higher
stability: experimental
support: community
- keys:
- logback-appender
- logback-mdc
instrumented_components:
- name: Logback
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- micrometer
instrumented_components:
- name: Micrometer
supported_versions: 1.5 and higher
stability: experimental
support: community
- keys:
- mongo
instrumented_components:
- name: MongoDB Drive
supported_versions: 3.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- mybatis
instrumented_components:
- name: MyBatis
supported_versions: 3.2 and higher
stability: experimental
support: community
- keys:
- netty
instrumented_components:
- name: Netty
supported_versions: 3.8 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- okhttp
instrumented_components:
- name: OkHttp
supported_versions: 2.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- liberty
instrumented_components:
- name: OpenLiberty
supported_versions: 20.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- nats
instrumented_components:
- name: NATS Client
supported_versions: 2.17.2 and higher
stability: experimental
support: community
- keys:
- opensearch
instrumented_components:
- name: OpenSearch REST Client
supported_versions: 1.0 and higher
- name: OpenSearch Java Client
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- openai-java
instrumented_components:
- name: OpenAI Java SDK
supported_versions: 1.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: gen_ai.client.token.usage
instrument: histogram
description: Measures number of input and output tokens used.
category_notes: Custom metric.
- metric_name: gen_ai.client.operation.duration
instrument: histogram
description: GenAI operation duration.
category_notes: Custom metric.
- keys:
- opentelemetry-api
instrumented_components:
- name: OpenTelemetry API
stability: experimental
support: community
- keys:
- opentelemetry-extension-annotations
instrumented_components:
- name: OpenTelemetry Extension Annotations
stability: experimental
support: community
- keys:
- opentelemetry-instrumentation-annotations
instrumented_components:
- name: OpenTelemetry Instrumentation Annotations
stability: experimental
support: community
- keys:
- oracle-ucp
instrumented_components:
- name: Oracle UCP
supported_versions: 11.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.max
instrument: updowncounter
description: The maximum number of open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.pending_requests
instrument: updowncounter
description: The number of pending requests for an open connection, cumulative
for the entire pool.
category_notes: Custom metric.
- keys:
- oshi
instrumented_components:
- name: OSHI
supported_versions: 5.3.1 and higher
stability: experimental
support: community
- keys:
- payara
instrumented_components:
- name: Payara
supported_versions: 5.0 and higher
stability: experimental
support: community
- keys:
- play-mvc
instrumented_components:
- name: Play
supported_versions: 2.4 and higher
stability: experimental
support: community
- keys:
- play-ws
instrumented_components:
- name: Play WS
supported_versions: 1.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- powerjob
instrumented_components:
- name: PowerJob
supported_versions: 4.0 and higher
stability: experimental
support: community
- keys:
- quarkus-resteasy-reactive
instrumented_components:
- name: Quarkus Resteasy Reactive
supported_versions: 2.16.7 and higher
stability: experimental
support: community
- keys:
- quartz
instrumented_components:
- name: Quartz
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- r2dbc
instrumented_components:
- name: R2DBC
supported_versions: 1.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- rabbitmq
instrumented_components:
- name: RabbitMQ Client
supported_versions: 2.7 and higher
stability: experimental
support: community
- keys:
- ratpack
instrumented_components:
- name: Ratpack
supported_versions: 1.4 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- reactor
instrumented_components:
- name: Reactor
supported_versions: 3.1 and higher
stability: experimental
support: community
- keys:
- reactor-netty
instrumented_components:
- name: Reactor Netty
supported_versions: 0.9 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- rediscala
instrumented_components:
- name: Rediscala
supported_versions: 1.8 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- redisson
instrumented_components:
- name: Redisson
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- resteasy
instrumented_components:
- name: RESTEasy
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- restlet
instrumented_components:
- name: Restlet
supported_versions: 1.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- rmi
instrumented_components:
- name: RMI
stability: experimental
support: community
- keys:
- rxjava
instrumented_components:
- name: RxJava
supported_versions: 2.2 and higher
stability: experimental
support: community
- keys:
- scala-fork-join
instrumented_components:
- name: Scala ForkJoinPool
supported_versions: 2.8 and higher
stability: experimental
support: community
- keys:
- servlet
instrumented_components:
- name: Servlet
supported_versions: 2.2 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- spark
instrumented_components:
- name: Spark Web Framework
supported_versions: 2.3 and higher
stability: experimental
support: community
- keys:
- spring-batch
instrumented_components:
- name: Spring Batch
supported_versions: 2.0 and higher
description: Disabled by default
stability: experimental
support: community
- keys:
- spring-cloud-gateway
instrumented_components:
- name: Spring Cloud AWS
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- spring-cloud-gateway
instrumented_components:
- name: Spring Cloud Gateway
supported_versions: 1.8 and higher
stability: experimental
support: community
- keys:
- spring-core
instrumented_components:
- name: Spring Core
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- spring-data
instrumented_components:
- name: Spring Data
supported_versions: 1.8 and higher
stability: experimental
support: community
- keys:
- spring-integration
instrumented_components:
- name: Spring Integration
supported_versions: 4.1 to 6.0
stability: experimental
support: community
- keys:
- spring-jms
instrumented_components:
- name: Spring JMS
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- spring-kafka
instrumented_components:
- name: Spring Kafka
supported_versions: 2.7 and higher
stability: experimental
support: community
- keys:
- spring-pulsar
instrumented_components:
- name: Spring Pulsar
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- spring-rabbit
instrumented_components:
- name: Spring RabbitMQ
supported_versions: 1.0 and higher
stability: experimental
support: community
- keys:
- spring-web
instrumented_components:
- name: Spring RestTemplate
supported_versions: 3.1 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- spring-rmi
instrumented_components:
- name: Spring RMI
supported_versions: 4.0 and higher
stability: experimental
support: community
- keys:
- spring-scheduling
instrumented_components:
- name: Spring Scheduling
supported_versions: 3.1 and higher
stability: experimental
support: community
- keys:
- spring-webmvc
instrumented_components:
- name: Spring Web MVC
supported_versions: 3.1 and higher
stability: experimental
support: community
- keys:
- spring-ws
instrumented_components:
- name: Spring Web Service
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- spring-webflux
instrumented_components:
- name: Spring WebFlux
supported_versions: 5.3 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- spymemcached
instrumented_components:
- name: Spymemcached
supported_versions: 2.12 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- tomcat-jdbc
instrumented_components:
- name: Tomcat JDBC
supported_versions: 8.5 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.idle.max
instrument: updowncounter
description: The maximum number of idle open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.idle.min
instrument: updowncounter
description: The minimum number of idle open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.max
instrument: updowncounter
description: The maximum number of open connections allowed.
category_notes: Custom metric.
- metric_name: db.client.connections.pending_requests
instrument: updowncounter
description: The number of pending requests for an open connection, cumulative
for the entire pool.
category_notes: Custom metric.
- keys:
- twilio
instrumented_components:
- name: Twilio
supported_versions: 6.6 to 8.0
stability: experimental
support: community
- keys:
- undertow
instrumented_components:
- name: Undertow
supported_versions: 1.4 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.server.request.duration
instrument: histogram
description: Duration of HTTP server requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.server.active_requests
instrument: updowncounter
description: Number of active HTTP server requests (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.request.body.size
instrument: histogram
description: Size of HTTP server request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.server.response.body.size
instrument: histogram
description: Size of HTTP server response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- vaadin
instrumented_components:
- name: Vaadin
supported_versions: 14.2 and higher
stability: experimental
support: community
- keys:
- vertx-http-client
instrumented_components:
- name: Vert.x HttpClient
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: http.client.request.duration
instrument: histogram
description: Duration of HTTP client requests.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: http.client.request.body.size
instrument: histogram
description: Size of HTTP client request bodies (disabled by default).
category_notes: Custom metric.
- metric_name: http.client.response.body.size
instrument: histogram
description: Size of HTTP client response bodies (disabled by default).
category_notes: Custom metric.
- keys:
- vertx-kafka-client
instrumented_components:
- name: Vert.x Kafka Client
supported_versions: 3.6 and higher
stability: experimental
support: community
- keys:
- vertx-redis-client
instrumented_components:
- name: Vert.x Redis Client
supported_versions: 3.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- vertx-rx-java
instrumented_components:
- name: Vert.x RxJava2
supported_versions: 3.5 and higher
stability: experimental
support: community
- keys:
- vertx-sql-client
instrumented_components:
- name: Vert.x SQL Client
supported_versions: 4.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.operation.duration
instrument: histogram
description: Duration of database client operations.
category_notes: Custom metric.
- keys:
- vertx-web
instrumented_components:
- name: Vert.x Web
supported_versions: 3.0 and higher
stability: experimental
support: community
- keys:
- vibur-dbcp
instrumented_components:
- name: Vibur DBCP
supported_versions: 11.0 and higher
stability: experimental
support: community
signals:
- metrics:
- metric_name: db.client.connections.usage
instrument: updowncounter
description: The number of connections that are currently in state described
by the state attribute.
category_notes: Custom metric.
- metric_name: db.client.connections.max
instrument: updowncounter
description: The maximum number of open connections allowed.
category_notes: Custom metric.
- keys:
- xxl-job
instrumented_components:
- name: XXL-JOB
supported_versions: 1.9.2 and higher
stability: experimental
support: community
- keys:
- zio
instrumented_components:
- name: ZIO
supported_versions: 2.0 and higher
stability: experimental
support: community
- keys:
- jvm-metrics.splunk
instrumented_components:
- name: Java Platform
stability: experimental
support: supported
signals:
- metrics:
- metric_name: jvm.memory.allocated
instrument: counter
description: Approximate sum of heap allocations.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.gc.pause.count
instrument: counter
description: Number of gc pauses. This metric will be removed in a future
release.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- metric_name: jvm.gc.pause.totalTime
instrument: counter
description: Time spent in GC pause. This metric will be removed in a
future release.
category_notes: APM bundled, if data points for the metric contain `telemetry.sdk.language`
attribute.
- keys:
- khttp
instrumented_components:
- name: khttp
supported_versions: 0.1 and higher
stability: experimental
support: supported
- keys:
- glassfish
instrumented_components:
- name: GlassFish
supported_versions: 5.0 and higher
stability: experimental
support: supported
- keys:
- jetty
instrumented_components:
- name: Jetty
supported_versions: 9.4 and higher
stability: experimental
support: supported
- keys:
- liberty
instrumented_components:
- name: Liberty
supported_versions: 20.0 and higher
stability: experimental
support: supported
- keys:
- tomcat
- tomcat-metrics-splunk
instrumented_components:
- name: Tomcat
supported_versions: 7.0 and higher
stability: experimental
support: supported
- keys:
- tomee
instrumented_components:
- name: TomEE
supported_versions: 7.0 and higher
stability: experimental
support: supported
- keys:
- weblogic
- weblogic-metrics-splunk
instrumented_components:
- name: WebLogic
supported_versions: 12.1 and higher
stability: experimental
support: supported
- keys:
- websphere
instrumented_components:
- name: WebSphere
supported_versions: 8.5.5 and higher
stability: experimental
support: supported
- keys:
- wildfly
instrumented_components:
- name: WildFly
supported_versions: 13.0 and higher
stability: experimental
support: supported
resource_detectors:
- key: io.opentelemetry.instrumentation.resources.ContainerResourceProvider
description: Container detector.
attributes:
- id: container.id
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.HostIdResourceProvider
description: Host id detector.
attributes:
- id: host.id
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.HostResourceProvider
description: Host detector.
attributes:
- id: host.name
- id: host.arch
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.JarServiceNameDetector
description: Jar service name detector.
attributes:
- id: service.name
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.ManifestResourceProvider
description: Manifest service name and version detector.
attributes:
- id: service.name
- id: service.version
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.OsResourceProvider
description: Os detector.
attributes:
- id: os.type
- id: os.description
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.ProcessResourceProvider
description: Process detector.
attributes:
- id: process.pid
- id: process.executable.path
- id: process.command_args
- id: process.command_line
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.resources.ProcessRuntimeResourceProvider
description: Process runtime detector.
attributes:
- id: process.runtime.name
- id: process.runtime.version
- id: process.runtime.description
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.spring.resources.SpringBootServiceNameDetector
description: Spring boot service name detector.
attributes:
- id: service.name
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Spring Boot Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/spring/spring-boot-resources/javaagent
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-spring-boot-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.instrumentation.spring.resources.SpringBootServiceVersionDetector
description: Spring boot service version detector.
attributes:
- id: service.version
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Instrumentation Spring Boot Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/spring/spring-boot-resources/javaagent
package_href: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-spring-boot-resources
version: 2.22.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.resourceproviders.AppServerServiceNameProvider
description: Application server service name detector.
attributes:
- id: service.name
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Java Contrib Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/resource-providers
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-resource-providers
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.aws.resource.BeanstalkResourceProvider
description: Beanstalk detector.
attributes:
- id: service.instance.id
- id: service.version
- id: service.namespace
- id: cloud.provider
- id: cloud.platform
stability: experimental
support: community
dependencies:
- name: OpenTelemetry AWS Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/aws-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-aws-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.aws.resource.Ec2ResourceProvider
description: Ec2 detector.
attributes:
- id: cloud.provider
- id: cloud.platform
- id: host.id
- id: cloud.availability_zone
- id: host.type
- id: host.image.id
- id: cloud.account.id
- id: cloud.region
- id: host.name
stability: experimental
support: community
dependencies:
- name: OpenTelemetry AWS Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/aws-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-aws-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.aws.resource.EcsResourceProvider
description: Ecs detector.
attributes:
- id: cloud.provider
- id: container.id
- id: container.name
- id: aws.ecs.container.arn
- id: container.image.name
- id: container.image.tag
- id: aws.ecs.container.image.id
- id: aws.log.group.names
- id: aws.log.stream.names
- id: aws.log.group.arns
- id: aws.log.stream.arns
- id: aws.ecs.task.arn
- id: aws.ecs.launchtype
- id: aws.ecs.task.family
- id: aws.ecs.task.revision
stability: experimental
support: community
dependencies:
- name: OpenTelemetry AWS Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/aws-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-aws-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.aws.resource.EksResourceProvider
description: Eks detector.
attributes:
- id: cloud.provider
- id: cloud.platform
- id: k8s.cluster.name
- id: container.id
stability: experimental
support: community
dependencies:
- name: OpenTelemetry AWS Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/aws-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-aws-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.aws.resource.LambdaResourceProvider
description: Lambda detector.
attributes:
- id: cloud.provider
- id: cloud.platform
- id: cloud.region
- id: faas.name
- id: faas.version
stability: experimental
support: community
dependencies:
- name: OpenTelemetry AWS Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/aws-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-aws-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.gcp.resource.GCPResourceProvider
description: GCP detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: cloud.account.id
- id: cloud.availability_zone
- id: cloud.region
- id: host.id
- id: host.name
- id: host.type
- id: k8s.pod.name
- id: k8s.namespace.name
- id: k8s.container.name
- id: k8s.cluster.name
- id: faas.name
- id: faas.version
- id: faas.instance
stability: experimental
support: community
dependencies:
- name: OpenTelemetry GCP Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/gcp-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-gcp-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.azure.resource.AzureAksResourceProvider
description: AKS detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: k8s.cluster.name
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Azure Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/azure-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-azure-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.azure.resource.AzureAppServiceResourceProvider
description: App service detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: service.name
- id: cloud.region
- id: cloud.resource_id
- id: deployment.environment.name
- id: host.id
- id: service.instance.id
- id: azure.app.service.stamp
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Azure Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/azure-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-azure-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.azure.resource.AzureContainersResourceProvider
description: Container detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: service.name
- id: service.instance.id
- id: service.version
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Azure Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/azure-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-azure-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.azure.resource.AzureFunctionsResourceProvider
description: Function detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: faas.max_memory
- id: cloud.region
- id: faas.name
- id: faas.version
- id: faas.instance
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Azure Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/azure-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-azure-resources
version: 1.52.0-alpha
stability: experimental
- key: io.opentelemetry.contrib.azure.resource.AzureVmResourceProvider
description: Vm detector.
attributes:
- id: cloud.platform
- id: cloud.provider
- id: cloud.region
- id: cloud.resource_id
- id: host.id
- id: host.name
- id: host.type
- id: os.type
- id: os.version
- id: azure.vm.scaleset.name
- id: azure.vm.sku
stability: experimental
support: community
dependencies:
- name: OpenTelemetry Azure Resource Providers
source_href: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/azure-resources
package_href: https://central.sonatype.com/artifact/io.opentelemetry.contrib/opentelemetry-azure-resources
version: 1.52.0-alpha
stability: experimental