Common application properties

Various properties can be specified inside your application.properties file, inside your application.yml file, or as command line switches. This appendix provides a list of common Spring Cloud Sleuth OTel properties and references to the underlying classes that consume them.

Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. Also, you can define your own properties.

Name Default Description

Name	Default	Description
spring.sleuth.otel.config.instrumentation-name	`org.springframework.cloud.spring-cloud-sleuth`	Instrumentation name to be used to find a Tracer.
spring.sleuth.otel.config.instrumentation-version		Instrumentation version to be used to find a Tracer.
spring.sleuth.otel.config.max-attrs	`0`	Returns the global default max number of attributes per {@link Span}.
spring.sleuth.otel.config.max-event-attrs	`0`	Returns the global default max number of attributes per event.
spring.sleuth.otel.config.max-events	`0`	Returns the global default max number of events per {@link Span}.
spring.sleuth.otel.config.max-link-attrs	`0`	Returns the global default max number of attributes per link.
spring.sleuth.otel.config.max-links	`0`	Returns the global default max number of link entries per {@link Span}.
spring.sleuth.otel.config.trace-id-ratio-based	`0.1`	Sets the global default {@code Sampler} value.
spring.sleuth.otel.exporter.jaeger.enabled	`true`	Enables Jaeger exporter.
spring.sleuth.otel.exporter.jaeger.endpoint		Sets the Jaeger endpoint to connect to.
spring.sleuth.otel.exporter.jaeger.timeout		Timeout in millis.
spring.sleuth.otel.exporter.otlp.enabled	`true`	Enables OTLP exporter.
spring.sleuth.otel.exporter.otlp.endpoint		Sets the OTLP endpoint to connect to.
spring.sleuth.otel.exporter.otlp.headers		Map of headers to be added.
spring.sleuth.otel.exporter.otlp.timeout		Timeout in millis.
spring.sleuth.otel.exporter.sleuth-span-filter.enabled	`true`	Enables Sleuth span filter.
spring.sleuth.otel.log.exporter.enabled	`false`	Enable log exporter for OTel.
spring.sleuth.otel.log.slf4j.enabled	`false`	Enable slf4j support for OTel.
spring.sleuth.otel.multiple-tracer-configs-detector-enabled	`true`	Enable detection of autoconfiguration for multiple tracers (i.e.: Brave and OTel); only one of them should be used.
spring.sleuth.otel.processor.batch.exporter-timeout		Exporter timeout in millis.
spring.sleuth.otel.processor.batch.max-export-batch-size		Max export batch size.
spring.sleuth.otel.processor.batch.max-queue-size		Max queue size.
spring.sleuth.otel.processor.batch.schedule-delay		Schedule delay in millis.
spring.sleuth.otel.propagation.composite-text-map-propagator.enabled	`true`	Enable a composite text map propagator that can combine multiple propagation types into a single text map propagator.
spring.sleuth.otel.propagation.sleuth-baggage.enabled	`true`	Enable propagating baggage in a Sleuth compatible way (baggage key & value pair means e.g. a key & value HTTP pair).
spring.sleuth.otel.resource.attributes		Map of custom resource attributes (e.g. service.version)
spring.sleuth.otel.resource.enabled	`true`	Enables default {@link Resource} implementations.
spring.zipkin.activemq.message-max-bytes	`100000`	Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.
spring.zipkin.activemq.queue	`zipkin`	Name of the ActiveMQ queue where spans should be sent to Zipkin.
spring.zipkin.kafka.topic	`zipkin`	Name of the Kafka topic where spans should be sent to Zipkin.
spring.zipkin.rabbitmq.addresses		Addresses of the RabbitMQ brokers used to send spans to Zipkin
spring.zipkin.rabbitmq.queue	`zipkin`	Name of the RabbitMQ queue where spans should be sent to Zipkin.
spring.zipkin.sender.type		Means of sending spans to Zipkin.

spring.sleuth.otel.config.instrumentation-name

org.springframework.cloud.spring-cloud-sleuth

Instrumentation name to be used to find a Tracer.

spring.sleuth.otel.config.instrumentation-version

Instrumentation version to be used to find a Tracer.

spring.sleuth.otel.config.max-attrs

0

Returns the global default max number of attributes per {@link Span}.

spring.sleuth.otel.config.max-event-attrs

0

Returns the global default max number of attributes per event.

spring.sleuth.otel.config.max-events

0

Returns the global default max number of events per {@link Span}.

spring.sleuth.otel.config.max-link-attrs

0

Returns the global default max number of attributes per link.

spring.sleuth.otel.config.max-links

0

Returns the global default max number of link entries per {@link Span}.

spring.sleuth.otel.config.trace-id-ratio-based

0.1

Sets the global default {@code Sampler} value.

spring.sleuth.otel.exporter.jaeger.enabled

true

Enables Jaeger exporter.

spring.sleuth.otel.exporter.jaeger.endpoint

Sets the Jaeger endpoint to connect to.

spring.sleuth.otel.exporter.jaeger.timeout

Timeout in millis.

spring.sleuth.otel.exporter.otlp.enabled

true

Enables OTLP exporter.

spring.sleuth.otel.exporter.otlp.endpoint

Sets the OTLP endpoint to connect to.

spring.sleuth.otel.exporter.otlp.headers

Map of headers to be added.

spring.sleuth.otel.exporter.otlp.timeout

Timeout in millis.

spring.sleuth.otel.exporter.sleuth-span-filter.enabled

true

Enables Sleuth span filter.

spring.sleuth.otel.log.exporter.enabled

false

Enable log exporter for OTel.

spring.sleuth.otel.log.slf4j.enabled

false

Enable slf4j support for OTel.

spring.sleuth.otel.multiple-tracer-configs-detector-enabled

true

Enable detection of autoconfiguration for multiple tracers (i.e.: Brave and OTel); only one of them should be used.

spring.sleuth.otel.processor.batch.exporter-timeout

Exporter timeout in millis.

spring.sleuth.otel.processor.batch.max-export-batch-size

Max export batch size.

spring.sleuth.otel.processor.batch.max-queue-size

Max queue size.

spring.sleuth.otel.processor.batch.schedule-delay

Schedule delay in millis.

spring.sleuth.otel.propagation.composite-text-map-propagator.enabled

true

Enable a composite text map propagator that can combine multiple propagation types into a single text map propagator.

spring.sleuth.otel.propagation.sleuth-baggage.enabled

true

Enable propagating baggage in a Sleuth compatible way (baggage key & value pair means e.g. a key & value HTTP pair).

spring.sleuth.otel.resource.attributes

Map of custom resource attributes (e.g. service.version)

spring.sleuth.otel.resource.enabled

true

Enables default {@link Resource} implementations.

spring.zipkin.activemq.message-max-bytes

100000

Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.

spring.zipkin.activemq.queue

zipkin

Name of the ActiveMQ queue where spans should be sent to Zipkin.

spring.zipkin.kafka.topic

zipkin

Name of the Kafka topic where spans should be sent to Zipkin.

spring.zipkin.rabbitmq.addresses

Addresses of the RabbitMQ brokers used to send spans to Zipkin

spring.zipkin.rabbitmq.queue

zipkin

Name of the RabbitMQ queue where spans should be sent to Zipkin.

spring.zipkin.sender.type

Means of sending spans to Zipkin.