Skip to content

Avoid overriding user's MDC in Log4j #13479

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

Merged
merged 4 commits into from
Mar 13, 2025
Merged

Avoid overriding user's MDC in Log4j #13479

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
2f78e0b
do not override user's MDC
123liuziming Mar 9, 2025
f3b9b45
do not override user's MDC
123liuziming Mar 9, 2025
a9b1d48
spotless apply
123liuziming Mar 9, 2025
1a6a84b
fix comment
123liuziming Mar 13, 2025
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
6 changes: 6 additions & 0 deletions ...entelemetry/instrumentation/log4j/contextdata/v2_17/OpenTelemetryContextDataProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.ThreadContext;
import org.apache.logging.log4j.core.util.ContextDataProvider;

/**
Expand Down Expand Up @@ -67,6 +68,11 @@ public Map<String, String> supplyContextData() {
return staticContextData;
}

if (ThreadContext.containsKey(ContextDataKeys.TRACE_ID_KEY)) {
// Assume already instrumented event if traceId is present.
return staticContextData;
}

Map<String, String> contextData = new HashMap<>(staticContextData);
SpanContext spanContext = currentSpan.getSpanContext();
contextData.put(ContextDataKeys.TRACE_ID_KEY, spanContext.getTraceId());
Expand Down
26 changes: 26 additions & 0 deletions .../testing/src/main/java/io/opentelemetry/instrumentation/log4j/contextdata/Log4j2Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.util.concurrent.atomic.AtomicReference;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -132,4 +133,29 @@ void testIdsWhenSpan() {
assertThat(events.get(3).getContextData().get(getLoggingKey("trace_flags"))).isEqualTo("01");
assertThat(events.get(3).getContextData().get("baggage.baggage_key")).isNull();
}

@Test
void testNoOverrideTraceId() {
Logger logger = LogManager.getLogger("TestLogger");

ThreadContext.put(getLoggingKey("trace_id"), "test_traceId");
ThreadContext.put(getLoggingKey("span_id"), "test_spanId");
ThreadContext.put(getLoggingKey("trace_flags"), "test_traceFlag");
getInstrumentationExtension()
.runWithSpan(
"test",
() -> {
logger.info("log span parent");
});
List<ListAppender.LoggedEvent> events = ListAppender.get().getEvents();
ThreadContext.clearAll();
assertThat(events.size()).isEqualTo(1);
assertThat(events.get(0).getMessage()).isEqualTo("log span parent");
assertThat(events.get(0).getContextData().get(getLoggingKey("trace_id")))
.isEqualTo("test_traceId");
assertThat(events.get(0).getContextData().get(getLoggingKey("span_id")))
.isEqualTo("test_spanId");
assertThat(events.get(0).getContextData().get(getLoggingKey("trace_flags")))
.isEqualTo("test_traceFlag");
}
}
Loading