Skip to content

Declarative config for logback appender installer #15813

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

Open
zeitlinger wants to merge 4 commits into
base: main
Choose a base branch
from
+36 −94
Open

Declarative config for logback appender installer #15813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
675e953
rename method for clarity
zeitlinger Jan 9, 2026
883c7d7
delete DeprecatedConfigProperties
zeitlinger Jan 9, 2026
f061178
pr review
zeitlinger Jan 9, 2026
4ed36d6
pr review
zeitlinger Jan 9, 2026
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
48 changes: 0 additions & 48 deletions ...entelemetry/instrumentation/spring/autoconfigure/internal/DeprecatedConfigProperties.java
View file
Open in desktop

This file was deleted.

23 changes: 2 additions & 21 deletions ...main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/EarlyConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,33 +50,14 @@ public static boolean isDefaultEnabled(Environment environment) {
}
}

public static String translatePropertyName(Environment environment, String name) {
if (isDeclarativeConfig(environment)) {
if (name.startsWith("otel.instrumentation.")) {
return toSnakeCase(
String.format(
"otel.instrumentation/development.java.%s",
name.substring("otel.instrumentation.".length())));
}

throw new IllegalStateException(
"No mapping found for property name: " + name + ". Please report this bug.");
} else {
return name;
}
}

private static String toSnakeCase(String string) {
return string.replace('-', '_');
}

public static boolean isInstrumentationEnabled(
Environment environment, String name, boolean defaultValue) {
String property =
getPropertyName(
environment,
String.format("otel.instrumentation.%s.enabled", name),
String.format("otel.instrumentation/development.java.%s.enabled", toSnakeCase(name)));
String.format(
"otel.instrumentation/development.java.%s.enabled", name.replace('-', '_')));
Boolean explicit = environment.getProperty(property, Boolean.class);
if (explicit != null) {
return explicit;
Expand Down
59 changes: 34 additions & 25 deletions ...ation/spring/autoconfigure/internal/instrumentation/logging/LogbackAppenderInstaller.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.Appender;
import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.DeprecatedConfigProperties;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.EarlyConfig;
import java.util.Iterator;
import java.util.Optional;
Expand Down Expand Up @@ -92,78 +91,76 @@ private static void initializeOpenTelemetryAppenderFromProperties(
// org.springframework.boot.context.logging.LoggingApplicationListener, config properties not
// available
Boolean codeAttribute =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-code-attributes");
if (codeAttribute != null) {
openTelemetryAppender.setCaptureCodeAttributes(codeAttribute.booleanValue());
openTelemetryAppender.setCaptureCodeAttributes(codeAttribute);
}

Boolean markerAttribute =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-marker-attribute");
if (markerAttribute != null) {
openTelemetryAppender.setCaptureMarkerAttribute(markerAttribute.booleanValue());
openTelemetryAppender.setCaptureMarkerAttribute(markerAttribute);
}

Boolean keyValuePairAttributes =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-key-value-pair-attributes");
if (keyValuePairAttributes != null) {
openTelemetryAppender.setCaptureKeyValuePairAttributes(keyValuePairAttributes.booleanValue());
openTelemetryAppender.setCaptureKeyValuePairAttributes(keyValuePairAttributes);
}

Boolean logAttributes =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental-log-attributes");
if (logAttributes != null) {
openTelemetryAppender.setCaptureExperimentalAttributes(logAttributes.booleanValue());
openTelemetryAppender.setCaptureExperimentalAttributes(logAttributes);
}

Boolean loggerContextAttributes =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-logger-context-attributes");
if (loggerContextAttributes != null) {
openTelemetryAppender.setCaptureLoggerContext(loggerContextAttributes.booleanValue());
openTelemetryAppender.setCaptureLoggerContext(loggerContextAttributes);
}

Boolean captureTemplate =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-template");
if (captureTemplate != null) {
openTelemetryAppender.setCaptureTemplate(captureTemplate.booleanValue());
openTelemetryAppender.setCaptureTemplate(captureTemplate);
}

Boolean captureArguments =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-arguments");
if (captureArguments != null) {
openTelemetryAppender.setCaptureArguments(captureArguments.booleanValue());
openTelemetryAppender.setCaptureArguments(captureArguments);
}

Boolean captureLogstashMarkerAttributes =
DeprecatedConfigProperties.getBoolean(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-logstash-markers",
"otel.instrumentation.logback-appender.experimental.capture-logstash-marker-attributes");
if (captureLogstashMarkerAttributes != null) {
openTelemetryAppender.setCaptureLogstashMarkerAttributes(
captureLogstashMarkerAttributes.booleanValue());
openTelemetryAppender.setCaptureLogstashMarkerAttributes(captureLogstashMarkerAttributes);
}

Boolean captureLogstashStructuredArguments =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent,
"otel.instrumentation.logback-appender.experimental.capture-logstash-structured-arguments");
if (captureLogstashStructuredArguments != null) {
openTelemetryAppender.setCaptureLogstashStructuredArguments(
captureLogstashStructuredArguments.booleanValue());
captureLogstashStructuredArguments);
}

String mdcAttributeProperty =
Expand Down Expand Up @@ -206,7 +203,7 @@ private static void initializeMdcAppenderFromProperties(
// org.springframework.boot.context.logging.LoggingApplicationListener, config properties not
// available
Boolean addBaggage =
evaluateBooleanProperty(
evaluateBooleanPropertyDeclarativeConfigOrLegacy(
applicationEnvironmentPreparedEvent, "otel.instrumentation.logback-mdc.add-baggage");
if (addBaggage != null) {
openTelemetryAppender.setAddBaggage(addBaggage);
Expand Down Expand Up @@ -237,11 +234,23 @@ private static void initializeMdcAppenderFromProperties(
}
}

private static Boolean evaluateBooleanProperty(
private static Boolean evaluateBooleanPropertyDeclarativeConfigOrLegacy(
Copy link
Member

@trask trask Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the "or legacy" part of this method?

Copy link
Member Author

@zeitlinger zeitlinger Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inlined it right into the method for clarity

    String key = property;
    if (EarlyConfig.isDeclarativeConfig(environment)) {
      if (property.startsWith("otel.instrumentation.")) {
        key =
            String.format(
                    "otel.instrumentation/development.java.%s",
                    property.substring("otel.instrumentation.".length()))
                .replace('-', '_');
      } else {
        throw new IllegalStateException(
            "No mapping found for property name: " + property + ". Please report this bug.");
      }
    }

Copy link
Member Author

@zeitlinger zeitlinger Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can also do the translation the other way round - but it's still a flat string

ApplicationEnvironmentPreparedEvent applicationEnvironmentPreparedEvent, String property) {
ConfigurableEnvironment environment = applicationEnvironmentPreparedEvent.getEnvironment();
return environment.getProperty(
EarlyConfig.translatePropertyName(environment, property), Boolean.class);
String key = property;
if (EarlyConfig.isDeclarativeConfig(environment)) {
if (property.startsWith("otel.instrumentation.")) {
key =
String.format(
"otel.instrumentation/development.java.%s",
property.substring("otel.instrumentation.".length()))
.replace('-', '_');
} else {
throw new IllegalStateException(
"No mapping found for property name: " + property + ". Please report this bug.");
}
}
return environment.getProperty(key, Boolean.class);
}

private static <T> Optional<T> findAppender(Class<T> appenderClass) {
Expand Down
Loading