|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.javaagent.instrumentation.log4j.mdc.v1_2; |
| 7 | + |
| 8 | +import static org.junit.jupiter.api.Assertions.assertEquals; |
| 9 | +import static org.junit.jupiter.api.Assertions.assertNull; |
| 10 | + |
| 11 | +import io.opentelemetry.api.trace.Span; |
| 12 | +import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension; |
| 13 | +import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; |
| 14 | +import java.util.List; |
| 15 | +import org.apache.log4j.LogManager; |
| 16 | +import org.apache.log4j.Logger; |
| 17 | +import org.apache.log4j.spi.LoggingEvent; |
| 18 | +import org.junit.jupiter.api.BeforeEach; |
| 19 | +import org.junit.jupiter.api.Test; |
| 20 | +import org.junit.jupiter.api.extension.RegisterExtension; |
| 21 | + |
| 22 | +public class Log4j1MdcTest { |
| 23 | + |
| 24 | + @RegisterExtension |
| 25 | + private static final InstrumentationExtension testing = AgentInstrumentationExtension.create(); |
| 26 | + |
| 27 | + private static final Logger logger = LogManager.getLogger("TestLogger"); |
| 28 | + |
| 29 | + @BeforeEach |
| 30 | + void cleanup() { |
| 31 | + ListAppender.clearEvents(); |
| 32 | + } |
| 33 | + |
| 34 | + @Test |
| 35 | + void noIdsWhenNoSpan() { |
| 36 | + logger.info("log message 1"); |
| 37 | + logger.info("log message 2"); |
| 38 | + |
| 39 | + List<LoggingEvent> events = ListAppender.getEvents(); |
| 40 | + |
| 41 | + assertEquals(2, events.size()); |
| 42 | + assertEquals("log message 1", events.get(0).getMessage()); |
| 43 | + assertNull(events.get(0).getMDC("trace_id")); |
| 44 | + assertNull(events.get(0).getMDC("span_id")); |
| 45 | + assertNull(events.get(0).getMDC("trace_flags")); |
| 46 | + |
| 47 | + assertEquals("log message 2", events.get(1).getMessage()); |
| 48 | + assertNull(events.get(1).getMDC("trace_id")); |
| 49 | + assertNull(events.get(1).getMDC("span_id")); |
| 50 | + assertNull(events.get(1).getMDC("trace_flags")); |
| 51 | + } |
| 52 | + |
| 53 | + @Test |
| 54 | + void idsWhenSpan() { |
| 55 | + Span span1 = |
| 56 | + testing.runWithSpan( |
| 57 | + "test", |
| 58 | + () -> { |
| 59 | + logger.info("log message 1"); |
| 60 | + return Span.current(); |
| 61 | + }); |
| 62 | + |
| 63 | + logger.info("log message 2"); |
| 64 | + |
| 65 | + Span span2 = |
| 66 | + testing.runWithSpan( |
| 67 | + "test 2", |
| 68 | + () -> { |
| 69 | + logger.info("log message 3"); |
| 70 | + return Span.current(); |
| 71 | + }); |
| 72 | + |
| 73 | + List<LoggingEvent> events = ListAppender.getEvents(); |
| 74 | + |
| 75 | + assertEquals(3, events.size()); |
| 76 | + assertEquals("log message 1", events.get(0).getMessage()); |
| 77 | + assertEquals(events.get(0).getMDC("trace_id"), span1.getSpanContext().getTraceId()); |
| 78 | + assertEquals(events.get(0).getMDC("span_id"), span1.getSpanContext().getSpanId()); |
| 79 | + assertEquals(events.get(0).getMDC("trace_flags"), "01"); |
| 80 | + |
| 81 | + assertEquals("log message 2", events.get(1).getMessage()); |
| 82 | + assertNull(events.get(1).getMDC("trace_id")); |
| 83 | + assertNull(events.get(1).getMDC("span_id")); |
| 84 | + assertNull(events.get(1).getMDC("trace_flags")); |
| 85 | + |
| 86 | + assertEquals("log message 3", events.get(2).getMessage()); |
| 87 | + // this explicit getMDCCopy() call here is to make sure that whole instrumentation is tested |
| 88 | + events.get(2).getMDCCopy(); |
| 89 | + assertEquals(events.get(2).getMDC("trace_id"), span2.getSpanContext().getTraceId()); |
| 90 | + assertEquals(events.get(2).getMDC("span_id"), span2.getSpanContext().getSpanId()); |
| 91 | + assertEquals(events.get(2).getMDC("trace_flags"), "01"); |
| 92 | + } |
| 93 | +} |
0 commit comments