Skip to content

Commit

Permalink
Add tests for resource attributes in mdc
Browse files Browse the repository at this point in the history
  • Loading branch information
laurit authored and cleverchuk committed Nov 9, 2023
1 parent 9cf2689 commit 740ef8a
Show file tree
Hide file tree
Showing 12 changed files with 123 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ tasks {
test {
jvmArgs("-Dlog4j2.is.webapp=false")
jvmArgs("-Dlog4j2.enable.threadlocals=true")
jvmArgs("-Dotel.instrumentation.mdc.resource-attributes=service.name,telemetry.sdk.language")
}

named("check") {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,27 @@
* SPDX-License-Identifier: Apache-2.0
*/

import io.opentelemetry.instrumentation.log4j.contextdata.ListAppender
import io.opentelemetry.instrumentation.test.AgentTestTrait
import org.apache.logging.log4j.LogManager

class AutoLog4j2Test extends Log4j2Test implements AgentTestTrait {

def "resource attributes"() {
given:
def logger = LogManager.getLogger("TestLogger")

when:
logger.info("log message 1")

def events = ListAppender.get().getEvents()

then:
events.size() == 1
events[0].message == "log message 1"
events[0].contextData["trace_id"] == null
events[0].contextData["span_id"] == null
events[0].contextData["service.name"] == "unknown_service:java"
events[0].contextData["telemetry.sdk.language"] == "java"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ public class OpenTelemetryContextDataProvider implements ContextDataProvider {
private static final boolean configuredResourceAttributeAccessible =
isConfiguredResourceAttributeAccessible();

private static final Map<String, String> staticContextData = getStaticContextData();

private static Map<String, String> getStaticContextData() {
if (configuredResourceAttributeAccessible) {
return ConfiguredResourceAttributesHolder.getResourceAttributes();
}
return Collections.emptyMap();
}

/**
* Checks whether {@link ConfiguredResourceAttributesHolder} is available in classpath. The result
* is true if {@link ConfiguredResourceAttributesHolder} can be loaded, false otherwise.
Expand Down Expand Up @@ -61,19 +70,17 @@ public Map<String, String> supplyContextData() {
Context context = Context.current();
Span currentSpan = Span.fromContext(context);
if (!currentSpan.getSpanContext().isValid()) {
return Collections.emptyMap();
return staticContextData;
}

Map<String, String> contextData = new HashMap<>();
contextData.putAll(staticContextData);

SpanContext spanContext = currentSpan.getSpanContext();
contextData.put(TRACE_ID, spanContext.getTraceId());
contextData.put(SPAN_ID, spanContext.getSpanId());
contextData.put(TRACE_FLAGS, spanContext.getTraceFlags().asHex());

if (configuredResourceAttributeAccessible) {
contextData.putAll(ConfiguredResourceAttributesHolder.getResourceAttributes());
}

if (BAGGAGE_ENABLED) {
Baggage baggage = Baggage.fromContext(context);
for (Map.Entry<String, BaggageEntry> entry : baggage.asMap().entrySet()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ tasks {
filter {
excludeTestsMatching("Log4j27BaggageTest")
}
jvmArgs("-Dotel.instrumentation.mdc.resource-attributes=service.name,telemetry.sdk.language")
}

val testAddBaggage by registering(Test::class) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ public final class SpanDecoratingContextDataInjector implements ContextDataInjec
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.log4j-context-data.add-baggage", false);

private static final StringMap staticContextData = getStaticContextData();

private final ContextDataInjector delegate;

public SpanDecoratingContextDataInjector(ContextDataInjector delegate) {
Expand All @@ -41,26 +43,21 @@ public StringMap injectContextData(List<Property> list, StringMap stringMap) {

if (contextData.containsKey(TRACE_ID)) {
// Assume already instrumented event if traceId is present.
return contextData;
return staticContextData.isEmpty() ? contextData : newContextData(contextData);
}

Context context = Context.current();
Span span = Span.fromContext(context);
SpanContext currentContext = span.getSpanContext();
if (!currentContext.isValid()) {
return contextData;
return staticContextData.isEmpty() ? contextData : newContextData(contextData);
}

StringMap newContextData = new SortedArrayStringMap(contextData);
StringMap newContextData = newContextData(contextData);
newContextData.putValue(TRACE_ID, currentContext.getTraceId());
newContextData.putValue(SPAN_ID, currentContext.getSpanId());
newContextData.putValue(TRACE_FLAGS, currentContext.getTraceFlags().asHex());

for (Map.Entry<String, String> entry :
ConfiguredResourceAttributesHolder.getResourceAttributes().entrySet()) {
newContextData.putValue(entry.getKey(), entry.getValue());
}

if (BAGGAGE_ENABLED) {
Baggage baggage = Baggage.fromContext(context);
for (Map.Entry<String, BaggageEntry> entry : baggage.asMap().entrySet()) {
Expand All @@ -75,4 +72,19 @@ public StringMap injectContextData(List<Property> list, StringMap stringMap) {
public ReadOnlyStringMap rawContextData() {
return delegate.rawContextData();
}

private static StringMap newContextData(StringMap contextData) {
StringMap newContextData = new SortedArrayStringMap(contextData);
newContextData.putAll(staticContextData);
return newContextData;
}

private static StringMap getStaticContextData() {
StringMap map = new SortedArrayStringMap();
for (Map.Entry<String, String> entry :
ConfiguredResourceAttributesHolder.getResourceAttributes().entrySet()) {
map.putValue(entry.getKey(), entry.getValue());
}
return map;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,27 @@
* SPDX-License-Identifier: Apache-2.0
*/

import io.opentelemetry.instrumentation.log4j.contextdata.ListAppender
import io.opentelemetry.instrumentation.test.AgentTestTrait
import org.apache.logging.log4j.LogManager

class Log4j27Test extends Log4j2Test implements AgentTestTrait {

def "resource attributes"() {
given:
def logger = LogManager.getLogger("TestLogger")

when:
logger.info("log message 1")

def events = ListAppender.get().getEvents()

then:
events.size() == 1
events[0].message == "log message 1"
events[0].contextData["trace_id"] == null
events[0].contextData["span_id"] == null
events[0].contextData["service.name"] == "unknown_service:java"
events[0].contextData["telemetry.sdk.language"] == "java"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,9 @@ configurations {
exclude("javax.jms", "jms")
}
}

tasks {
test {
jvmArgs("-Dotel.instrumentation.mdc.resource-attributes=service.name,telemetry.sdk.language")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,8 @@ public static void onExit(
default:
// do nothing
}
} else if (ConfiguredResourceAttributesHolder.getAttributeValue(key) != null) {
if (value == null) {
value = ConfiguredResourceAttributesHolder.getAttributeValue(key);
}
} else if (value == null) {
value = ConfiguredResourceAttributesHolder.getAttributeValue(key);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,19 @@ void idsWhenSpan() {
assertEquals(events.get(2).getMDC("span_id"), span2.getSpanContext().getSpanId());
assertEquals(events.get(2).getMDC("trace_flags"), "01");
}

@Test
void resourceAttributes() {
logger.info("log message 1");

List<LoggingEvent> events = ListAppender.getEvents();

assertEquals(1, events.size());
assertEquals("log message 1", events.get(0).getMessage());
assertNull(events.get(0).getMDC("trace_id"));
assertNull(events.get(0).getMDC("span_id"));
assertNull(events.get(0).getMDC("trace_flags"));
assertEquals("unknown_service:java", events.get(0).getMDC("service.name"));
assertEquals("java", events.get(0).getMDC("telemetry.sdk.language"));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ dependencies {
}

tasks {
test {
jvmArgs("-Dotel.instrumentation.mdc.resource-attributes=service.name,telemetry.sdk.language")
}

named("check") {
dependsOn(testing.suites)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,8 @@ public static void onExit(
spanContextData.put(TRACE_ID, spanContext.getTraceId());
spanContextData.put(SPAN_ID, spanContext.getSpanId());
spanContextData.put(TRACE_FLAGS, spanContext.getTraceFlags().asHex());

spanContextData.putAll(ConfiguredResourceAttributesHolder.getResourceAttributes());
}
spanContextData.putAll(ConfiguredResourceAttributesHolder.getResourceAttributes());

if (LogbackSingletons.addBaggage()) {
Baggage baggage = Java8BytecodeBridge.baggageFromContext(context);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@

package io.opentelemetry.javaagent.instrumentation.logback.v1_0;

import static org.assertj.core.api.Assertions.assertThat;

import ch.qos.logback.classic.spi.ILoggingEvent;
import io.opentelemetry.instrumentation.logback.mdc.v1_0.AbstractLogbackTest;
import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

class LogbackTest extends AbstractLogbackTest {
Expand All @@ -19,4 +24,20 @@ class LogbackTest extends AbstractLogbackTest {
public InstrumentationExtension getInstrumentationExtension() {
return agentTesting;
}

@Test
void resourceAttributes() {
logger.info("log message 1");

List<ILoggingEvent> events = listAppender.list;

assertThat(events.size()).isEqualTo(1);
assertThat(events.get(0).getMessage()).isEqualTo("log message 1");
assertThat(events.get(0).getMDCPropertyMap().get("trace_id")).isNull();
assertThat(events.get(0).getMDCPropertyMap().get("span_id")).isNull();
assertThat(events.get(0).getMDCPropertyMap().get("trace_flags")).isNull();
assertThat(events.get(0).getMDCPropertyMap().get("service.name"))
.isEqualTo("unknown_service:java");
assertThat(events.get(0).getMDCPropertyMap().get("telemetry.sdk.language")).isEqualTo("java");
}
}

0 comments on commit 740ef8a

Please sign in to comment.