Skip to content

Add documentation for configuring OpenTelemetry SDK logs #41825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add documentation for configuring OpenTelemetry SDK logs #41825

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0cc8d1f
Added documentation for configuring OpenTelemetry SDK logs.
famaridon Aug 12, 2024
dcc65f5
pull request fix
famaridon Aug 29, 2024
c3ebcb4
add opentelemetry logger appeder link to Opentelemetry sdk sample
famaridon Aug 29, 2024
b4e1f06
remove sample code OpenTelemetryAppender s not in spring boot classpa…
famaridon Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .../spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/loggers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,23 @@ To configure a given logger, `POST` a partial entity to the resource's URI, as t
----

TIP: To "`reset`" the specific level of the logger (and use the default configuration instead), you can pass a value of `null` as the `configuredLevel`.



[[actuator.loggers.opentelemetry]]
== OpenTelemetry
By default, the OpenTelemetry SDK logs are not configured. You can provide the location of the OpenTelemetry logs endpoint to configure it:

[configprops,yaml]
----
management:
otlp:
logging:
endpoint: "https://otlp.example.com:4318/v1/logs"
----

NOTE: The OpenTelemetry Logback appender and Log4j appender are not part of Spring Boot, for more details, see the https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/logback/logback-appender-1.0/library[OpenTelemetry Logback appender] or https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/log4j/log4j-appender-2.17/library[OpenTelemetry Log4j2 appender] in the https://github.com/open-telemetry/opentelemetry-java-instrumentation[OpenTelemetry Java instrumentation GitHub repository]

TIP: Ensure that you add the appender to your `logback.xml` or `logback-spring.xml` (or the equivalent configuration file for Log4j).

TIP: The `OpenTelemetryAppender` requires access to an OpenTelemetry instance to function properly. This instance must be set programmatically during application startup by using an `ApplicationListener` for the `ApplicationReadyEvent`.