Skip to content

Unify tests between log4j-appender-2.17 javaagent and library instrumentation #14843

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 11 commits into from
Closed

Unify tests between log4j-appender-2.17 javaagent and library instrumentation #14843

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
840e615
Initial plan
Copilot Sep 30, 2025
bbc3463
Create testing module with shared base test class
Copilot Sep 30, 2025
86c8349
Fix test assertions to work with both javaagent and library
Copilot Sep 30, 2025
8e87cca
Refactor assertion building to match original structure
Copilot Sep 30, 2025
0c93bad
Remove unnecessary dependencies from testing module
Copilot Sep 30, 2025
8e2318c
Change log4j-core from api to compileOnly dependency
Copilot Sep 30, 2025
4e458f4
Remove duplicative tests from AbstractOpenTelemetryAppenderTest
Copilot Sep 30, 2025
51813e1
spotless
trask Sep 30, 2025
85eaf45
fix
trask Sep 30, 2025
28ceb8e
Remove unnecessary test now
trask Sep 30, 2025
881d19d
./gradlew spotlessApply
otelbot[bot] Sep 30, 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
1 change: 1 addition & 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
272 changes: 4 additions & 268 deletions ...agent/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/Log4j2Test.java
View file
Open in desktop
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
34 changes: 34 additions & 0 deletions ...brary/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/Log4j2Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

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

import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.RegisterExtension;

class Log4j2Test extends AbstractLog4j2Test {

@RegisterExtension
static final LibraryInstrumentationExtension testing =
LibraryInstrumentationExtension.create();

@BeforeEach
void setup() {
OpenTelemetryAppender.install(testing.getOpenTelemetry());
}

@AfterAll
static void cleanup() {
OpenTelemetryAppender.install(null);
}

@Override
protected InstrumentationExtension testing() {
return testing;
}
}
4 changes: 4 additions & 0 deletions instrumentation/log4j/log4j-appender-2.17/library/src/test/resources/log4j2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
<AppenderRef ref="OpenTelemetryAppender"/>
<AppenderRef ref="Console"/>
</Logger>
<Logger name="abc" level="info">
<AppenderRef ref="OpenTelemetryAppender"/>
<AppenderRef ref="Console"/>
</Logger>
<Root level="All">
<AppenderRef ref="Console"/>
</Root>
Expand Down
14 changes: 14 additions & 0 deletions instrumentation/log4j/log4j-appender-2.17/testing/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
plugins {
id("otel.java-conventions")
}

dependencies {
api(project(":testing-common"))
api("io.opentelemetry:opentelemetry-sdk-testing")

api("org.apache.logging.log4j:log4j-core:2.17.0")
api("org.apache.logging.log4j:log4j-api:2.17.0")

compileOnly("com.google.auto.value:auto-value-annotations")
annotationProcessor("com.google.auto.value:auto-value")
}
Loading