Skip to content

Unify Log4j2 appender tests #14859

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Unify Log4j2 appender tests #14859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3624e0c
Unify Log4j2 appender tests
trask Oct 8, 2025
98f6d92
private
trask Oct 8, 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
2 changes: 2 additions & 0 deletions instrumentation/log4j/log4j-appender-2.17/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ dependencies {

implementation(project(":instrumentation:log4j:log4j-appender-2.17:library"))

testImplementation(project(":instrumentation:log4j:log4j-appender-2.17:testing"))
testImplementation("org.awaitility:awaitility")

if (testLatestDeps) {
Expand Down Expand Up @@ -64,6 +65,7 @@ tasks.withType<Test>().configureEach {
jvmArgs("-Dotel.instrumentation.log4j-appender.experimental.capture-map-message-attributes=true")
jvmArgs("-Dotel.instrumentation.log4j-appender.experimental.capture-mdc-attributes=*")
jvmArgs("-Dotel.instrumentation.log4j-appender.experimental.capture-marker-attribute=true")
jvmArgs("-Dotel.instrumentation.log4j-appender.experimental.capture-event-name=true")
}

configurations {
Expand Down
272 changes: 4 additions & 268 deletions ...agent/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/Log4j2Test.java
View file
Open in desktop
Copy link
Member Author

Choose a reason for hiding this comment

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

these tests were moved to the shared testing base class

Original file line number Diff line number Diff line change
Expand Up @@ -5,281 +5,17 @@

package io.opentelemetry.instrumentation.log4j.appender.v2_17;

import static io.opentelemetry.instrumentation.testing.junit.code.SemconvCodeStabilityUtil.codeFileAndLineAssertions;
import static io.opentelemetry.instrumentation.testing.junit.code.SemconvCodeStabilityUtil.codeFunctionAssertions;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
import static io.opentelemetry.semconv.ExceptionAttributes.EXCEPTION_MESSAGE;
import static io.opentelemetry.semconv.ExceptionAttributes.EXCEPTION_STACKTRACE;
import static io.opentelemetry.semconv.ExceptionAttributes.EXCEPTION_TYPE;
import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID;
import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME;
import static java.util.concurrent.TimeUnit.MILLISECONDS;

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Value;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
import io.opentelemetry.sdk.logs.data.LogRecordData;
import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Stream;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.MarkerManager;
import org.apache.logging.log4j.ThreadContext;
import org.apache.logging.log4j.message.StringMapMessage;
import org.apache.logging.log4j.message.StructuredDataMessage;
import org.assertj.core.api.AssertAccess;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

class Log4j2Test {
class Log4j2Test extends AbstractLog4j2Test {

@RegisterExtension
static final InstrumentationExtension testing = AgentInstrumentationExtension.create();

private static final Logger logger = LogManager.getLogger("abc");

private static Stream<Arguments> provideParameters() {
return Stream.of(
Arguments.of(false, false),
Arguments.of(false, true),
Arguments.of(true, false),
Arguments.of(true, true));
}

private static List<AttributeAssertion> threadAttributesAssertions() {
return Arrays.asList(
equalTo(THREAD_NAME, Thread.currentThread().getName()),
equalTo(THREAD_ID, Thread.currentThread().getId()));
}

@ParameterizedTest
@MethodSource("provideParameters")
public void test(boolean logException, boolean withParent) throws InterruptedException {
test(Logger::debug, Logger::debug, logException, withParent, null, null, null);
testing.clearData();
test(Logger::info, Logger::info, logException, withParent, "abc", Severity.INFO, "INFO");
testing.clearData();
test(Logger::warn, Logger::warn, logException, withParent, "abc", Severity.WARN, "WARN");
testing.clearData();
test(Logger::error, Logger::error, logException, withParent, "abc", Severity.ERROR, "ERROR");
testing.clearData();
}

private static void test(
OneArgLoggerMethod oneArgLoggerMethod,
TwoArgLoggerMethod twoArgLoggerMethod,
boolean logException,
boolean withParent,
String expectedLoggerName,
Severity expectedSeverity,
String expectedSeverityText)
throws InterruptedException {

Instant start = Instant.now();

// when
if (withParent) {
testing.runWithSpan(
"parent", () -> performLogging(oneArgLoggerMethod, twoArgLoggerMethod, logException));
} else {
performLogging(oneArgLoggerMethod, twoArgLoggerMethod, logException);
}

// then
if (withParent) {
testing.waitForTraces(1);
}

if (expectedSeverity != null) {
testing.waitAndAssertLogRecords(
logRecord -> {
logRecord
.hasBody("xyz: 123")
.hasInstrumentationScope(
InstrumentationScopeInfo.builder(expectedLoggerName).build())
.hasSeverity(expectedSeverity)
.hasSeverityText(expectedSeverityText)
.hasSpanContext(
withParent
? testing.spans().get(0).getSpanContext()
: SpanContext.getInvalid());

List<AttributeAssertion> attributeAsserts =
new ArrayList<>(
Arrays.asList(
equalTo(THREAD_NAME, Thread.currentThread().getName()),
equalTo(THREAD_ID, Thread.currentThread().getId())));

attributeAsserts.addAll(codeFunctionAssertions(Log4j2Test.class, "performLogging"));
attributeAsserts.addAll(codeFileAndLineAssertions("Log4j2Test.java"));

if (logException) {
attributeAsserts.addAll(
Arrays.asList(
equalTo(EXCEPTION_TYPE, IllegalStateException.class.getName()),
equalTo(EXCEPTION_MESSAGE, "hello"),
satisfies(
EXCEPTION_STACKTRACE, v -> v.contains(Log4j2Test.class.getName()))));
}
logRecord.hasAttributesSatisfyingExactly(attributeAsserts);

LogRecordData logRecordData = AssertAccess.getActual(logRecord);
assertThat(logRecordData.getTimestampEpochNanos())
.isGreaterThanOrEqualTo(MILLISECONDS.toNanos(start.toEpochMilli()))
.isLessThanOrEqualTo(MILLISECONDS.toNanos(Instant.now().toEpochMilli()));
});
} else {
Thread.sleep(500); // sleep a bit just to make sure no log is captured
assertThat(testing.logRecords()).isEmpty();
}
}

@Test
void testContextData() {
ThreadContext.put("key1", "val1");
ThreadContext.put("key2", "val2");
try {
logger.info("xyz: {}", 123);
} finally {
ThreadContext.clearMap();
}

List<AttributeAssertion> assertions =
codeFunctionAssertions(Log4j2Test.class, "testContextData");
assertions.addAll(codeFileAndLineAssertions("Log4j2Test.java"));
assertions.addAll(threadAttributesAssertions());
assertions.add(equalTo(AttributeKey.stringKey("key1"), "val1"));
assertions.add(equalTo(AttributeKey.stringKey("key2"), "val2"));

testing.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasBody("xyz: 123")
.hasInstrumentationScope(InstrumentationScopeInfo.builder("abc").build())
.hasSeverity(Severity.INFO)
.hasSeverityText("INFO")
.hasAttributesSatisfyingExactly(assertions));
}

@Test
void testStringMapMessage() {
StringMapMessage message = new StringMapMessage();
message.put("key1", "val1");
message.put("key2", "val2");
logger.info(message);

List<AttributeAssertion> assertions =
codeFunctionAssertions(Log4j2Test.class, "testStringMapMessage");
assertions.addAll(codeFileAndLineAssertions("Log4j2Test.java"));
assertions.addAll(threadAttributesAssertions());
assertions.add(equalTo(AttributeKey.stringKey("log4j.map_message.key1"), "val1"));
assertions.add(equalTo(AttributeKey.stringKey("log4j.map_message.key2"), "val2"));

testing.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasBody((Value<?>) null)
.hasInstrumentationScope(InstrumentationScopeInfo.builder("abc").build())
.hasSeverity(Severity.INFO)
.hasSeverityText("INFO")
.hasAttributesSatisfyingExactly(assertions));
}

@Test
void testStringMapMessageWithSpecialAttribute() {
StringMapMessage message = new StringMapMessage();
message.put("key1", "val1");
message.put("message", "val2");
logger.info(message);

List<AttributeAssertion> assertions =
codeFunctionAssertions(Log4j2Test.class, "testStringMapMessageWithSpecialAttribute");
assertions.addAll(codeFileAndLineAssertions("Log4j2Test.java"));
assertions.addAll(threadAttributesAssertions());
assertions.add(equalTo(AttributeKey.stringKey("log4j.map_message.key1"), "val1"));

testing.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasBody("val2")
.hasInstrumentationScope(InstrumentationScopeInfo.builder("abc").build())
.hasSeverity(Severity.INFO)
.hasSeverityText("INFO")
.hasAttributesSatisfyingExactly(assertions));
}

@Test
void testStructuredDataMapMessage() {
StructuredDataMessage message = new StructuredDataMessage("an id", "a message", "a type");
message.put("key1", "val1");
message.put("key2", "val2");
logger.info(message);

List<AttributeAssertion> assertions =
codeFunctionAssertions(Log4j2Test.class, "testStructuredDataMapMessage");
assertions.addAll(codeFileAndLineAssertions("Log4j2Test.java"));
assertions.addAll(threadAttributesAssertions());
assertions.add(equalTo(AttributeKey.stringKey("log4j.map_message.key1"), "val1"));
assertions.add(equalTo(AttributeKey.stringKey("log4j.map_message.key2"), "val2"));

testing.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasBody("a message")
.hasInstrumentationScope(InstrumentationScopeInfo.builder("abc").build())
.hasSeverity(Severity.INFO)
.hasSeverityText("INFO")
.hasAttributesSatisfyingExactly(assertions));
}

@Test
public void testMarker() {
String markerName = "aMarker";
Marker marker = MarkerManager.getMarker(markerName);

logger.info(marker, "Message");

List<AttributeAssertion> assertions = codeFunctionAssertions(Log4j2Test.class, "testMarker");
assertions.addAll(codeFileAndLineAssertions("Log4j2Test.java"));
assertions.addAll(threadAttributesAssertions());
assertions.add(equalTo(AttributeKey.stringKey("log4j.marker"), markerName));

testing.waitAndAssertLogRecords(
logRecord -> logRecord.hasAttributesSatisfyingExactly(assertions));
}

private static void performLogging(
OneArgLoggerMethod oneArgLoggerMethod,
TwoArgLoggerMethod twoArgLoggerMethod,
boolean logException) {
if (logException) {
twoArgLoggerMethod.call(logger, "xyz: {}", 123, new IllegalStateException("hello"));
} else {
oneArgLoggerMethod.call(logger, "xyz: {}", 123);
}
}

@FunctionalInterface
interface OneArgLoggerMethod {
void call(Logger logger, String msg, Object arg);
}

@FunctionalInterface
interface TwoArgLoggerMethod {
void call(Logger logger, String msg, Object arg1, Object arg2);
@Override
protected InstrumentationExtension testing() {
return testing;
}
}
1 change: 1 addition & 0 deletions instrumentation/log4j/log4j-appender-2.17/library/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ dependencies {

implementation(project(":instrumentation:log4j:log4j-context-data:log4j-context-data-2.17:library-autoconfigure"))

testImplementation(project(":instrumentation:log4j:log4j-appender-2.17:testing"))
testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
testLibrary("com.lmax:disruptor:3.3.4")

Expand Down
10 changes: 9 additions & 1 deletion ...n/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/internal/LogEventMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import io.opentelemetry.semconv.ExceptionAttributes;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Supplier;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -76,9 +77,16 @@ public LogEventMapper(
this.captureExperimentalAttributes = captureExperimentalAttributes;
this.captureMapMessageAttributes = captureMapMessageAttributes;
this.captureMarkerAttribute = captureMarkerAttribute;
this.captureContextDataAttributes = captureContextDataAttributes;
this.captureAllContextDataAttributes =
captureContextDataAttributes.size() == 1 && captureContextDataAttributes.get(0).equals("*");
// If captureEventName is enabled, ensure "event.name" is in the list that we loop over
if (captureEventName
&& !captureAllContextDataAttributes
&& !captureContextDataAttributes.contains("event.name")) {
captureContextDataAttributes = new ArrayList<>(captureContextDataAttributes);
captureContextDataAttributes.add("event.name");
}
this.captureContextDataAttributes = captureContextDataAttributes;
this.captureEventName = captureEventName;
}

Expand Down
Loading
Loading