Micronaut Tracing Configuration Reference

Every documented configuration property of Micronaut Tracing, with types, descriptions, and defaults.

Micronaut Tracing documentation

159 properties across 10 sections

Micronaut Tracing Brave Config Properties

Configuration properties for BraveTracerConfiguration

PropertyTypeDescription
tracing.zipkin.enabledbooleanDefault value (false).

Configuration properties for Tracing$Builder

PropertyTypeDescription
tracing.zipkin.local-service-namejava.lang.String
tracing.zipkin.local-ipjava.lang.String
tracing.zipkin.local-portint
tracing.zipkin.trace-id128-bitboolean
tracing.zipkin.supports-joinboolean
tracing.zipkin.add-span-handlerbrave.handler.SpanHandler

Configuration properties for Tracing$Builder

PropertyTypeDescription
tracing.zipkin.local-service-namejava.lang.String
tracing.zipkin.local-ipjava.lang.String
tracing.zipkin.local-portint
tracing.zipkin.trace-id128-bitboolean
tracing.zipkin.supports-joinboolean
tracing.zipkin.add-span-handlerbrave.handler.SpanHandler

Configuration properties for BraveTracerConfiguration$BraveHttpClientSenderConfiguration

PropertyTypeDescription
tracing.zipkin.http.http-versionHttpVersion
tracing.zipkin.http.log-levelLogLevel
tracing.zipkin.http.event-loop-groupjava.lang.String
tracing.zipkin.http.ssl-configurationSslConfiguration
tracing.zipkin.http.follow-redirectsboolean
tracing.zipkin.http.exception-on-error-statusboolean
tracing.zipkin.http.decompression-enabledboolean
tracing.zipkin.http.logger-namejava.lang.String
tracing.zipkin.http.redirect-always-filtered-headersjava.util.Set
tracing.zipkin.http.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
tracing.zipkin.http.redirect-cross-origin-filtered-headersjava.util.Set
tracing.zipkin.http.max-redirectsint
tracing.zipkin.http.default-charsetjava.nio.charset.Charset
tracing.zipkin.http.channel-optionsjava.util.Map
tracing.zipkin.http.read-timeoutjava.time.Duration
tracing.zipkin.http.request-timeoutjava.time.Duration
tracing.zipkin.http.read-idle-timeoutjava.time.Duration
tracing.zipkin.http.connection-pool-idle-timeoutjava.time.Duration
tracing.zipkin.http.connect-timeoutjava.time.Duration
tracing.zipkin.http.connect-ttljava.time.Duration
tracing.zipkin.http.shutdown-quiet-periodjava.time.Duration
tracing.zipkin.http.shutdown-timeoutjava.time.Duration
tracing.zipkin.http.num-of-threadsjava.lang.Integer
tracing.zipkin.http.thread-factoryjava.lang.Class
tracing.zipkin.http.max-content-lengthint
tracing.zipkin.http.max-header-sizeint
tracing.zipkin.http.max-initial-line-lengthint
tracing.zipkin.http.max-chunk-sizeint
tracing.zipkin.http.proxy-typejava.net.Proxy$Type
tracing.zipkin.http.proxy-addressjava.net.SocketAddress
tracing.zipkin.http.proxy-usernamejava.lang.String
tracing.zipkin.http.proxy-passwordjava.lang.String
tracing.zipkin.http.proxy-selectorjava.net.ProxySelector
tracing.zipkin.http.plaintext-modeHttpVersionSelection$PlaintextMode
tracing.zipkin.http.alpn-modesjava.util.List
tracing.zipkin.http.allow-block-event-loopboolean
tracing.zipkin.http.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
tracing.zipkin.http.address-resolver-group-namejava.lang.String
tracing.zipkin.http.pcap-logging-path-patternjava.lang.String

Configuration properties for HttpClientSender$Builder

PropertyTypeDescription
tracing.zipkin.http.encodingzipkin2.reporter.Encoding
tracing.zipkin.http.message-max-bytesint
tracing.zipkin.http.compression-enabledboolean
tracing.zipkin.http.serverjava.net.URI
tracing.zipkin.http.urljava.net.URI
tracing.zipkin.http.urlsjava.util.List
tracing.zipkin.http.pathjava.lang.String
tracing.zipkin.http.buildjakarta.inject.Provider

Configuration properties for AsyncReporter$Builder

PropertyTypeDescription
tracing.zipkin.reporter.thread-factoryjava.util.concurrent.ThreadFactory
tracing.zipkin.reporter.metricszipkin2.reporter.ReporterMetrics
tracing.zipkin.reporter.message-max-bytesint
tracing.zipkin.reporter.message-timeoutjava.time.Duration
tracing.zipkin.reporter.close-timeoutjava.time.Duration
tracing.zipkin.reporter.queued-max-spansint
tracing.zipkin.reporter.buildzipkin2.reporter.BytesEncoder

Configuration properties for BraveTracerConfiguration$SamplerConfiguration

PropertyTypeDescription
tracing.zipkin.sampler.probabilityfloatSets the sampler probability used by the default {@code CountingSampler}. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

Micronaut Tracing Core Config Properties

Configuration properties for TracingExclusionsConfiguration

PropertyTypeDescription
tracing.exclusionsjava.util.ListSets the URI patterns to be excluded from tracing.

Micronaut Tracing Jaeger Config Properties

Configuration properties for JaegerConfiguration

PropertyTypeDescription
tracing.jaeger.expand-exception-logsbooleanWhether to expand exception logs.
tracing.jaeger.zipkin-shared-rpc-spanbooleanWhether to use Zipkin shared RPC.
tracing.jaeger.enabledbooleanEnable/disable Jaeger. Default value (false).
tracing.jaeger.codecsjava.lang.StringSet codecs from comma-delimited string.

Configuration properties for Configuration

PropertyTypeDescription
tracing.jaeger.tracer-tagsjava.util.Map

Configuration properties for Configuration

PropertyTypeDescription
tracing.jaeger.tracer-tagsjava.util.Map

Configuration properties for Configuration$ReporterConfiguration

PropertyTypeDescription
tracing.jaeger.reporter.log-spansjava.lang.Boolean
tracing.jaeger.reporter.flush-intervaljava.lang.Integer
tracing.jaeger.reporter.max-queue-sizejava.lang.Integer
tracing.jaeger.reporter.senderio.jaegertracing.Configuration$SenderConfiguration

Configuration properties for JaegerConfiguration$JaegerSamplerConfiguration

PropertyTypeDescription
tracing.jaeger.sampler.probabilityfloatSets the sampler probability used by the Jaeger sampler. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

Configuration properties for Configuration$SamplerConfiguration

PropertyTypeDescription
tracing.jaeger.sampler.typejava.lang.String
tracing.jaeger.sampler.paramjava.lang.Number
tracing.jaeger.sampler.manager-host-portjava.lang.String

Configuration properties for Configuration$SenderConfiguration

PropertyTypeDescription
tracing.jaeger.sender.agent-hostjava.lang.String
tracing.jaeger.sender.agent-portjava.lang.Integer
tracing.jaeger.sender.endpointjava.lang.String
tracing.jaeger.sender.auth-tokenjava.lang.String
tracing.jaeger.sender.auth-usernamejava.lang.String
tracing.jaeger.sender.auth-passwordjava.lang.String

Micronaut Tracing Opentelemetry Config Properties

Configuration properties for OpenTelemetryConfigurationProperties

PropertyTypeDescription
micronaut.otel.enabledbooleanSets whether the OpenTelemetry integration is enabled. Default value (true).

Configuration properties for OpenTelemetryExclusionsConfiguration

PropertyTypeDescription
otel.exclusionsjava.util.ListSets the URI patterns to be excluded from tracing.

Micronaut Tracing Opentelemetry Http Config Properties

Configuration properties for OpenTelemetryHttpClientConfig

PropertyTypeDescription
otel.http.client.response-headersjava.util.ListThe List of response headers that will be included inside spans
otel.http.client.request-headersjava.util.ListThe List of request headers that will be included inside spans

Configuration properties for OpenTelemetryHttpServerConfig

PropertyTypeDescription
otel.http.server.response-headersjava.util.ListThe List of response headers that will be included inside spans
otel.http.server.request-headersjava.util.ListThe List of request headers that will be included inside spans

Micronaut Tracing Opentelemetry Jdbc Config Properties

Configuration properties for JdbcTelemetryConfiguration

PropertyTypeDescription
otel.instrumentation.jdbc.enabledjava.lang.Booleanis jdbc telemetry enabled.
otel.instrumentation.jdbc.statement-sanitization-enabledbooleanenables SQL query sanitization.

Configuration properties for JdbcTelemetryBuilder

PropertyTypeDescription
otel.instrumentation.jdbc.data-source-instrumenter-enabledboolean
otel.instrumentation.jdbc.statement-instrumenter-enabledboolean
otel.instrumentation.jdbc.query-sanitization-enabledboolean
otel.instrumentation.jdbc.transaction-instrumenter-enabledboolean
otel.instrumentation.jdbc.capture-query-parametersboolean

Micronaut Tracing Opentelemetry Kafka Config Properties

Configuration properties for KafkaTelemetryConfiguration

PropertyTypeDescription
otel.instrumentation.kafka.headers-as-listsbooleanSetter for headersAsLists flag.
otel.instrumentation.kafka.captured-headersjava.util.SetSetter for captured headers set.
otel.instrumentation.kafka.included-topicsjava.util.SetSetter for included topics set.
otel.instrumentation.kafka.excluded-topicsjava.util.SetSetter for excluded topics set.
otel.instrumentation.kafka.attribute-with-prefixbooleanSetter for attributeWithPrefix flag.
otel.instrumentation.kafka.attribute-prefixjava.lang.StringSetter for attributePrefix.

Micronaut Tracing Opentelemetry R2dbc Config Properties

Configuration properties for R2dbcTelemetryConfiguration

PropertyTypeDescription
otel.instrumentation.r2dbc.enabledbooleanWhether R2DBC telemetry is enabled.

Configuration properties for R2dbcTelemetryBuilder

PropertyTypeDescription
otel.instrumentation.r2dbc.query-sanitization-enabledboolean
otel.instrumentation.r2dbc.span-name-extractor-customizerjava.util.function.UnaryOperator

Micronaut Tracing Opentelemetry Ucp Config Properties

Configuration properties for OracleUcpTelemetryConfiguration

PropertyTypeDescription
otel.instrumentation.ucp.enabledjava.lang.Booleanis Oracle UCP telemetry enabled.

Micronaut Tracing Opentelemetry Zipkin Exporter Config Properties

Configuration properties for OtelHttpClientSenderConfiguration

PropertyTypeDescription
otel.exporter.zipkin.http-versionHttpVersion
otel.exporter.zipkin.log-levelLogLevel
otel.exporter.zipkin.event-loop-groupjava.lang.String
otel.exporter.zipkin.ssl-configurationSslConfiguration
otel.exporter.zipkin.follow-redirectsboolean
otel.exporter.zipkin.exception-on-error-statusboolean
otel.exporter.zipkin.decompression-enabledboolean
otel.exporter.zipkin.logger-namejava.lang.String
otel.exporter.zipkin.redirect-always-filtered-headersjava.util.Set
otel.exporter.zipkin.redirect-additional-non-preserve-body-filtered-headersjava.util.Set
otel.exporter.zipkin.redirect-cross-origin-filtered-headersjava.util.Set
otel.exporter.zipkin.max-redirectsint
otel.exporter.zipkin.default-charsetjava.nio.charset.Charset
otel.exporter.zipkin.channel-optionsjava.util.Map
otel.exporter.zipkin.read-timeoutjava.time.Duration
otel.exporter.zipkin.request-timeoutjava.time.Duration
otel.exporter.zipkin.read-idle-timeoutjava.time.Duration
otel.exporter.zipkin.connection-pool-idle-timeoutjava.time.Duration
otel.exporter.zipkin.connect-timeoutjava.time.Duration
otel.exporter.zipkin.connect-ttljava.time.Duration
otel.exporter.zipkin.shutdown-quiet-periodjava.time.Duration
otel.exporter.zipkin.shutdown-timeoutjava.time.Duration
otel.exporter.zipkin.num-of-threadsjava.lang.Integer
otel.exporter.zipkin.thread-factoryjava.lang.Class
otel.exporter.zipkin.max-content-lengthint
otel.exporter.zipkin.max-header-sizeint
otel.exporter.zipkin.max-initial-line-lengthint
otel.exporter.zipkin.max-chunk-sizeint
otel.exporter.zipkin.proxy-typejava.net.Proxy$Type
otel.exporter.zipkin.proxy-addressjava.net.SocketAddress
otel.exporter.zipkin.proxy-usernamejava.lang.String
otel.exporter.zipkin.proxy-passwordjava.lang.String
otel.exporter.zipkin.proxy-selectorjava.net.ProxySelector
otel.exporter.zipkin.plaintext-modeHttpVersionSelection$PlaintextMode
otel.exporter.zipkin.alpn-modesjava.util.List
otel.exporter.zipkin.allow-block-event-loopboolean
otel.exporter.zipkin.dns-resolution-modeHttpClientConfiguration$DnsResolutionMode
otel.exporter.zipkin.address-resolver-group-namejava.lang.String
otel.exporter.zipkin.pcap-logging-path-patternjava.lang.String

Configuration properties for HttpClientSender$Builder

PropertyTypeDescription
otel.exporter.zipkin.encodingzipkin2.reporter.Encoding
otel.exporter.zipkin.message-max-bytesint
otel.exporter.zipkin.compression-enabledboolean
otel.exporter.zipkin.serverjava.net.URI
otel.exporter.zipkin.urljava.net.URI
otel.exporter.zipkin.urlsjava.util.List
otel.exporter.zipkin.pathjava.lang.String
otel.exporter.zipkin.buildjakarta.inject.Provider