Skip to content

making/otel-logs-autoconfigure

Repository files navigation

AutoConfiguration for OpenTelemetry Logs

This is an experimental project to address spring-projects/spring-boot#40961.

  • Autoconfigures SdkLoggerProvider and OtlpHttpLogRecordExporter.
  • Autoconfigures the Logback Appender.
<dependency>
	<groupId>am.ik.spring.opentelemetry</groupId>
	<artifactId>otel-logs-autoconfigure</artifactId>
	<version>0.2.2</version>
</dependency>

Note

Please ensure that am.ik.spring.opentelemetry:otel-logs-autoconfigure is defined before io.micrometer:micrometer-tracing-bridge-otel so that the intended version of io.opentelemetry.semconv:opentelemetry-semconv is used.

Configuration Properties for OtlpHttpLogRecordExporter

management.otlp.logging.endpoint=http://localhost:4318/v1/logs
management.otlp.logging.headers.authorization=Bearer changeme
management.otlp.logging.compression=gzip
management.otlp.logging.timeout=10s

If you need a quick and easy-to-use OTLP log receiver, please use LogN'Roll.

You can try it immediately with the following commands:

docker run --rm -p 4318:4318 ghcr.io/making/lognroll:jvm

or

# works only on amd64
docker run --rm -p 4318:4318 ghcr.io/making/lognroll:native

Configuration Properties for the Logback Appender

See https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/logback/logback-appender-1.0/library#settings-for-the-logback-appender for the details.

management.opentelemetry.instrumentation.logback-appender.enabled=true
management.opentelemetry.instrumentation.logback-appender.capture-code-attributes=false
management.opentelemetry.instrumentation.logback-appender.capture-experimental-attributes=false
management.opentelemetry.instrumentation.logback-appender.capture-key-value-pair-attributes=false
management.opentelemetry.instrumentation.logback-appender.capture-logger-context=false
management.opentelemetry.instrumentation.logback-appender.capture-marker-attribute=false
management.opentelemetry.instrumentation.logback-appender.capture-mdc-attributes= # comma-separated names or `*`
management.opentelemetry.instrumentation.logback-appender.num-logs-captured-before-otel-install=1000

About

AutoConfiguration for OpenTelemetry Logs

Resources

License

Stars

Watchers

Forks

Packages

No packages published