Add OpenTelemetryAppender.resetForTest()

Author: trask

instrumentation/log4j/log4j-appender-2.17/library/src/main/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/OpenTelemetryAppender.java

@@ -32,6 +32,7 @@
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 import java.util.function.BiConsumer;
+import java.util.function.Consumer;
 import javax.annotation.Nullable;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.ThreadContext;
@@ -72,6 +73,14 @@ public class OpenTelemetryAppender extends AbstractAppender {
    * the {@link LoggerContext}.
    */
   public static void install(OpenTelemetry openTelemetry) {
+    forEachAppender(appender -> appender.setOpenTelemetry(openTelemetry));
+  }
+
+  static void resetForTest() {
+    forEachAppender(OpenTelemetryAppender::resetAppenderForTest);
+  }
+
+  private static void forEachAppender(Consumer<OpenTelemetryAppender> consumer) {
     org.apache.logging.log4j.spi.LoggerContext loggerContextSpi = LogManager.getContext(false);
     if (!(loggerContextSpi instanceof LoggerContext)) {
       return;
@@ -84,7 +93,7 @@ public static void install(OpenTelemetry openTelemetry) {
         .forEach(
             appender -> {
               if (appender instanceof OpenTelemetryAppender) {
-                ((OpenTelemetryAppender) appender).setOpenTelemetry(openTelemetry);
+                consumer.accept((OpenTelemetryAppender) appender);
               }
             });
   }
@@ -295,6 +304,18 @@ public void setOpenTelemetry(OpenTelemetry openTelemetry) {
     }
   }
 
+  private void resetAppenderForTest() {
+    Lock writeLock = lock.writeLock();
+    writeLock.lock();
+    try {
+      openTelemetry = null;
+      eventsToReplay.clear();
+      replayLimitWarningLogged.set(false);
+    } finally {
+      writeLock.unlock();
+    }
+  }
+
   @SuppressWarnings("SystemOut")
   @Override
   public void append(LogEvent event) {

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/AbstractOpenTelemetryAppenderTest.java

@@ -46,7 +46,7 @@ static void generalBeforeEachSetup() {
   @AfterAll
   static void cleanupAll() {
     // This is to make sure that other test classes don't have issues with the logger provider set
-    OpenTelemetryAppender.install(null);
+    OpenTelemetryAppender.resetForTest();
   }
 
   protected abstract InstrumentationExtension getTesting();

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/Log4j2Test.java

@@ -26,7 +26,7 @@ void setup() {
 
   @AfterAll
   static void cleanup() {
-    OpenTelemetryAppender.install(null);
+    OpenTelemetryAppender.resetForTest();
   }
 
   @Override

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/LogReplayOpenTelemetryAppenderTest.java

@@ -35,7 +35,7 @@ void setup() {
 
   @AfterEach
   void resetOpenTelemetry() {
-    OpenTelemetryAppender.install(null);
+    OpenTelemetryAppender.resetForTest();
   }
 
   @Override

instrumentation/logback/logback-appender-1.0/library/src/main/java/io/opentelemetry/instrumentation/logback/appender/v1_0/OpenTelemetryAppender.java

@@ -25,6 +25,7 @@
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.function.Consumer;
 import org.slf4j.ILoggerFactory;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
@@ -60,23 +61,34 @@ public OpenTelemetryAppender() {}
    * the {@link LoggerContext}.
    */
   public static void install(OpenTelemetry openTelemetry) {
+    forEachAppender(appender -> appender.setOpenTelemetry(openTelemetry));
+  }
+
+  static void resetForTest() {
+    forEachAppender(OpenTelemetryAppender::resetAppenderForTest);
+  }
+
+  private static void forEachAppender(Consumer<OpenTelemetryAppender> consumer) {
     ILoggerFactory loggerFactorySpi = LoggerFactory.getILoggerFactory();
     if (!(loggerFactorySpi instanceof LoggerContext)) {
       return;
     }
     LoggerContext loggerContext = (LoggerContext) loggerFactorySpi;
     for (Logger logger : loggerContext.getLoggerList()) {
-      logger.iteratorForAppenders().forEachRemaining(appender -> install(openTelemetry, appender));
+      logger
+          .iteratorForAppenders()
+          .forEachRemaining(appender -> forEachAppender(consumer, appender));
     }
   }
 
-  private static void install(OpenTelemetry openTelemetry, Appender<?> appender) {
+  private static void forEachAppender(
+      Consumer<OpenTelemetryAppender> consumer, Appender<?> appender) {
     if (appender instanceof OpenTelemetryAppender) {
-      ((OpenTelemetryAppender) appender).setOpenTelemetry(openTelemetry);
+      consumer.accept((OpenTelemetryAppender) appender);
     } else if (appender instanceof AppenderAttachable) {
       ((AppenderAttachable<?>) appender)
           .iteratorForAppenders()
-          .forEachRemaining(a -> OpenTelemetryAppender.install(openTelemetry, a));
+          .forEachRemaining(a -> forEachAppender(consumer, a));
     }
   }
 
@@ -271,6 +283,18 @@ public void setOpenTelemetry(OpenTelemetry openTelemetry) {
     }
   }
 
+  private void resetAppenderForTest() {
+    Lock writeLock = lock.writeLock();
+    writeLock.lock();
+    try {
+      openTelemetry = null;
+      eventsToReplay.clear();
+      replayLimitWarningLogged.set(false);
+    } finally {
+      writeLock.unlock();
+    }
+  }
+
   private void emit(OpenTelemetry openTelemetry, ILoggingEvent event) {
     mapper.emit(openTelemetry.getLogsBridge(), event, -1);
   }

instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogbackTest.java

@@ -31,7 +31,7 @@ void setUp() {
 
   @AfterEach
   void tearDown() {
-    OpenTelemetryAppender.install(null);
+    OpenTelemetryAppender.resetForTest();
   }
 
   @Override