From 8fe901e661f196fe190fb306c4465074bab7c7c3 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 5 Sep 2025 12:03:36 +0200 Subject: [PATCH 1/8] add declarative config span logger --- .../SpanLoggingCustomizerProvider.java | 74 +++++++++++++++++++ .../SpanLoggingCustomizerProviderTest.java | 71 ++++++++++++++++++ 2 files changed, 145 insertions(+) create mode 100644 javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java create mode 100644 javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java diff --git a/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java new file mode 100644 index 000000000000..2087868f0cc6 --- /dev/null +++ b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java @@ -0,0 +1,74 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.javaagent.tooling; + +import com.google.auto.service.AutoService; +import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizer; +import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ConsoleExporterModel; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SimpleSpanProcessorModel; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SpanExporterModel; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SpanProcessorModel; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TracerProviderModel; + +/** Adds span logging exporter for debug mode */ +@AutoService(DeclarativeConfigurationCustomizerProvider.class) +public class SpanLoggingCustomizerProvider implements DeclarativeConfigurationCustomizerProvider { + + @Override + public void customize(DeclarativeConfigurationCustomizer customizer) { + customizer.addModelCustomizer( + model -> { + maybeEnableLoggingExporter(model); + return model; + }); + } + + private static void maybeEnableLoggingExporter(OpenTelemetryConfigurationModel model) { + // read from system properties as it's an early init property and the config bridge is not + // available here + if (!"true".equals(System.getProperty("otel.javaagent.debug"))) { + return; + } + // don't install another instance if the user has already explicitly requested it. + if (loggingExporterIsAlreadyConfigured(model)) { + return; + } + TracerProviderModel tracerProvider = model.getTracerProvider(); + if (tracerProvider == null) { + tracerProvider = new TracerProviderModel(); + model.withTracerProvider(tracerProvider); + } + SpanProcessorModel processor = + new SpanProcessorModel() + .withSimple( + new SimpleSpanProcessorModel() + .withExporter(new SpanExporterModel().withConsole(new ConsoleExporterModel()))); + tracerProvider.getProcessors().add(processor); + } + + private static boolean loggingExporterIsAlreadyConfigured(OpenTelemetryConfigurationModel model) { + TracerProviderModel tracerProvider = model.getTracerProvider(); + if (tracerProvider == null) { + return false; + } + for (SpanProcessorModel processor : tracerProvider.getProcessors()) { + SimpleSpanProcessorModel simple = processor.getSimple(); + if (simple == null) { + continue; + } + SpanExporterModel exporter = simple.getExporter(); + if (exporter == null) { + continue; + } + if (exporter.getConsole() != null) { + return true; + } + } + return false; + } +} diff --git a/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java b/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java new file mode 100644 index 000000000000..3f568d151de2 --- /dev/null +++ b/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java @@ -0,0 +1,71 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.javaagent.tooling; + +import static org.assertj.core.api.Assertions.assertThat; + +import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration; +import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel; +import java.io.ByteArrayInputStream; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; +import java.util.function.Function; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; +import org.junitpioneer.jupiter.ClearSystemProperty; + +class SpanLoggingCustomizerProviderTest { + + @ParameterizedTest + @CsvSource({ + "true, true, false", + "false, false, false", + ", false, false", // empty value means property is not set + "invalid, false, false", + "true, true, true", + }) + @ClearSystemProperty(key = "otel.javaagent.debug") + void addSpanLoggingExporter(String propertyValue, boolean expected, boolean alreadyAdded) { + if (propertyValue != null) { + System.setProperty("otel.javaagent.debug", propertyValue); + } + String yaml = + alreadyAdded + ? "file_format: \"1.0-rc.1\"\n" + + "tracer_provider:\n" + + " processors:\n" + + " - simple:\n" + + " exporter:\n" + + " console: {}\n" + : "file_format: \"1.0-rc.1\"\n"; + + OpenTelemetryConfigurationModel model = + applyCustomizer( + DeclarativeConfiguration.parse( + new ByteArrayInputStream(yaml.getBytes(StandardCharsets.UTF_8))), + new SpanLoggingCustomizerProvider()); + + String console = "ConsoleExporterModel"; + if (expected) { + assertThat(model.toString()).containsOnlyOnce(console); + } else { + assertThat(model.toString()).doesNotContain(console); + } + } + + private static OpenTelemetryConfigurationModel applyCustomizer( + OpenTelemetryConfigurationModel model, SpanLoggingCustomizerProvider provider) { + List> customizers = + new ArrayList<>(); + provider.customize(c -> customizers.add(c)); + for (Function customizer : + customizers) { + model = customizer.apply(model); + } + return model; + } +} From 8ec7f0455fadc71af093c6bd7beab16ad25a63b6 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 5 Sep 2025 13:31:08 +0200 Subject: [PATCH 2/8] fix test --- .../testing/provider/TestExporterCustomizerProvider.java | 6 ++++++ .../provider/AgentTestExporterCustomizerProvider.java | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/provider/TestExporterCustomizerProvider.java b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/provider/TestExporterCustomizerProvider.java index cc29c93af778..bc4b588a280f 100644 --- a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/provider/TestExporterCustomizerProvider.java +++ b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/provider/TestExporterCustomizerProvider.java @@ -26,6 +26,12 @@ import java.util.List; public class TestExporterCustomizerProvider implements DeclarativeConfigurationCustomizerProvider { + + @Override + public int order() { + return Integer.MIN_VALUE; // run before other customizers that might add exporters + } + @Override public void customize(DeclarativeConfigurationCustomizer customizer) { if (TestSpanExporterComponentProvider.getSpanExporter() == null) { diff --git a/testing/agent-exporter/src/main/java/io/opentelemetry/javaagent/testing/provider/AgentTestExporterCustomizerProvider.java b/testing/agent-exporter/src/main/java/io/opentelemetry/javaagent/testing/provider/AgentTestExporterCustomizerProvider.java index 487f1ff5bbf0..dbde9d790b4e 100644 --- a/testing/agent-exporter/src/main/java/io/opentelemetry/javaagent/testing/provider/AgentTestExporterCustomizerProvider.java +++ b/testing/agent-exporter/src/main/java/io/opentelemetry/javaagent/testing/provider/AgentTestExporterCustomizerProvider.java @@ -30,6 +30,12 @@ @AutoService(DeclarativeConfigurationCustomizerProvider.class) public class AgentTestExporterCustomizerProvider implements DeclarativeConfigurationCustomizerProvider { + + @Override + public int order() { + return Integer.MIN_VALUE; // run before other customizers that might add exporters + } + @Override public void customize(DeclarativeConfigurationCustomizer customizer) { TestExportersUtil.initTestExporters(); From c62dc3114c542a50a10e0622996a9c9c778d3596 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Mon, 6 Oct 2025 15:19:06 +0200 Subject: [PATCH 3/8] pr review --- .../javaagent/tooling/SpanLoggingCustomizerProvider.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java index 2087868f0cc6..4a012d253d46 100644 --- a/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java +++ b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java @@ -6,6 +6,7 @@ package io.opentelemetry.javaagent.tooling; import com.google.auto.service.AutoService; +import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil; import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizer; import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider; import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ConsoleExporterModel; @@ -31,7 +32,7 @@ public void customize(DeclarativeConfigurationCustomizer customizer) { private static void maybeEnableLoggingExporter(OpenTelemetryConfigurationModel model) { // read from system properties as it's an early init property and the config bridge is not // available here - if (!"true".equals(System.getProperty("otel.javaagent.debug"))) { + if (!ConfigPropertiesUtil.getBoolean("otel.javaagent.debug", false)) { return; } // don't install another instance if the user has already explicitly requested it. From acd05e3263153291fa3612869f83c2193215c70a Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 7 Oct 2025 17:42:05 +0200 Subject: [PATCH 4/8] fix native image --- .../logback/appender/v1_0/internal/LoggingEventMapperTest.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java index 072f348add64..a4ad2bed66d9 100644 --- a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java +++ b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java @@ -17,7 +17,9 @@ import java.util.HashMap; import java.util.Map; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.DisabledInNativeImage; +@DisabledInNativeImage class LoggingEventMapperTest { @Test From 82b2e912499053ddaded524926cb5eb6cececc70 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 7 Oct 2025 17:42:40 +0200 Subject: [PATCH 5/8] fix native image --- .../logback/appender/v1_0/internal/LoggingEventMapperTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java index a4ad2bed66d9..ade4d7772a96 100644 --- a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java +++ b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java @@ -19,7 +19,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.condition.DisabledInNativeImage; -@DisabledInNativeImage +@DisabledInNativeImage // conflict with Mockito class LoggingEventMapperTest { @Test From a573393ab93ea6c4feee2a11a37dcc5e06a32064 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 7 Oct 2025 18:17:25 +0200 Subject: [PATCH 6/8] Revert "fix native image" This reverts commit 82b2e912499053ddaded524926cb5eb6cececc70. --- .../logback/appender/v1_0/internal/LoggingEventMapperTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java index ade4d7772a96..a4ad2bed66d9 100644 --- a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java +++ b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java @@ -19,7 +19,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.condition.DisabledInNativeImage; -@DisabledInNativeImage // conflict with Mockito +@DisabledInNativeImage class LoggingEventMapperTest { @Test From 010ec074e364b9ca3e4036b36469fbae8085e8ec Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Tue, 7 Oct 2025 18:17:25 +0200 Subject: [PATCH 7/8] Revert "fix native image" This reverts commit acd05e3263153291fa3612869f83c2193215c70a. --- .../logback/appender/v1_0/internal/LoggingEventMapperTest.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java index a4ad2bed66d9..072f348add64 100644 --- a/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java +++ b/instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/internal/LoggingEventMapperTest.java @@ -17,9 +17,7 @@ import java.util.HashMap; import java.util.Map; import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.condition.DisabledInNativeImage; -@DisabledInNativeImage class LoggingEventMapperTest { @Test From c7418d67b41fbb7a10fe5a579b393df74b28075e Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Wed, 8 Oct 2025 08:27:59 +0200 Subject: [PATCH 8/8] pr review --- .../javaagent/tooling/SpanLoggingCustomizerProviderTest.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java b/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java index 3f568d151de2..93f040a01314 100644 --- a/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java +++ b/javaagent-tooling/src/test/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProviderTest.java @@ -22,14 +22,14 @@ class SpanLoggingCustomizerProviderTest { @ParameterizedTest @CsvSource({ - "true, true, false", + "true, false, true", "false, false, false", ", false, false", // empty value means property is not set "invalid, false, false", "true, true, true", }) @ClearSystemProperty(key = "otel.javaagent.debug") - void addSpanLoggingExporter(String propertyValue, boolean expected, boolean alreadyAdded) { + void addSpanLoggingExporter(String propertyValue, boolean alreadyAdded, boolean expected) { if (propertyValue != null) { System.setProperty("otel.javaagent.debug", propertyValue); }