add support for environment variable POWERTOOLS_LOGGER_LOG_EVENT

Author: jeromevdl

powertools-logging/pom.xml

@@ -89,11 +89,6 @@
             <artifactId>junit-jupiter-engine</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.junit-pioneer</groupId>
-            <artifactId>junit-pioneer</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>

powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/internal/LambdaLoggingAspect.java

@@ -56,6 +56,7 @@
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
 import org.slf4j.event.Level;
+import software.amazon.lambda.powertools.common.internal.SystemWrapper;
 import software.amazon.lambda.powertools.logging.Logging;
 import software.amazon.lambda.powertools.logging.LoggingUtils;
 import software.amazon.lambda.powertools.utilities.JsonConfig;
@@ -186,7 +187,7 @@ public Object around(ProceedingJoinPoint pjp,
 
         getXrayTraceId().ifPresent(xRayTraceId -> appendKey(FUNCTION_TRACE_ID.getName(), xRayTraceId));
 
-        if (logging.logEvent()) {
+        if (logging.logEvent() || "true".equals(SystemWrapper.getenv("POWERTOOLS_LOGGER_LOG_EVENT"))) {
             proceedArgs = logEvent(pjp);
         }
 
@@ -236,7 +237,7 @@ private void setLogLevelBasedOnSamplingRate(final ProceedingJoinPoint pjp,
     }
 
     private double samplingRate(final Logging logging) {
-        String sampleRate = System.getenv("POWERTOOLS_LOGGER_SAMPLE_RATE");
+        String sampleRate = SystemWrapper.getenv("POWERTOOLS_LOGGER_SAMPLE_RATE");
         if (null != sampleRate) {
             try {
                 return Double.parseDouble(sampleRate);

powertools-logging/src/test/java/software/amazon/lambda/powertools/logging/internal/LambdaLoggingAspectTest.java

@@ -46,15 +46,14 @@
 import java.lang.reflect.Method;
 import java.nio.channels.FileChannel;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.NoSuchFileException;
 import java.nio.file.Paths;
 import java.nio.file.StandardOpenOption;
 import java.util.Collections;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
-import org.junitpioneer.jupiter.ClearEnvironmentVariable;
-import org.junitpioneer.jupiter.SetEnvironmentVariable;
 import org.mockito.Mock;
 import org.mockito.MockedStatic;
 import org.slf4j.MDC;
@@ -86,15 +85,19 @@ class LambdaLoggingAspectTest {
     private Context context;
 
     @BeforeEach
-    @ClearEnvironmentVariable(key = "POWERTOOLS_LOGGER_SAMPLE_RATE")
-    void setUp() throws IllegalAccessException, IOException, NoSuchMethodException, InvocationTargetException {
+    void setUp() throws IllegalAccessException, NoSuchMethodException, InvocationTargetException, IOException {
         openMocks(this);
         MDC.clear();
         writeStaticField(LambdaHandlerProcessor.class, "IS_COLD_START", null, true);
         setupContext();
         requestHandler = new PowertoolsLogEnabled();
         requestStreamHandler = new PowertoolsLogEnabledForStream();
         resetLogLevel(Level.INFO);
+        try {
+            FileChannel.open(Paths.get("target/logfile.json"), StandardOpenOption.WRITE).truncate(0).close();
+        } catch (NoSuchFileException e) {
+            // may not be there in the first run
+        }
     }
 
     @AfterEach
@@ -188,29 +191,42 @@ void shouldLogDebugWhenSamplingEqualsOne() {
     }
 
     @Test
-    @SetEnvironmentVariable(key = "POWERTOOLS_LOGGER_SAMPLE_RATE", value = "1")
     void shouldLogDebugWhenSamplingEnvVarEqualsOne() {
-        PowertoolsLogEnabled handler = new PowertoolsLogEnabled();
-        handler.handleRequest(new Object(), context);
-        File logFile = new File("target/logfile.json");
-        assertThat(contentOf(logFile)).contains("Test debug event");
+        try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class)) {
+            mocked.when(() -> getenv("POWERTOOLS_LOGGER_SAMPLE_RATE"))
+                    .thenReturn("1");
+
+            PowertoolsLogEnabled handler = new PowertoolsLogEnabled();
+            handler.handleRequest(new Object(), context);
+            File logFile = new File("target/logfile.json");
+            assertThat(contentOf(logFile)).contains("Test debug event");
+        }
     }
 
     @Test
-    @SetEnvironmentVariable(key = "POWERTOOLS_LOGGER_SAMPLE_RATE", value = "42")
     void shouldNotLogDebugWhenSamplingEnvVarIsTooBig() {
-        requestHandler.handleRequest(new Object(), context);
-        File logFile = new File("target/logfile.json");
-        assertThat(contentOf(logFile)).doesNotContain("Test debug event");
+        try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class)) {
+            mocked.when(() -> getenv("POWERTOOLS_LOGGER_SAMPLE_RATE"))
+                    .thenReturn("42");
+
+            requestHandler.handleRequest(new Object(), context);
+            File logFile = new File("target/logfile.json");
+            assertThat(contentOf(logFile)).doesNotContain("Test debug event");
+        }
     }
 
     @Test
-    @SetEnvironmentVariable(key = "POWERTOOLS_LOGGER_SAMPLE_RATE", value = "NotANumber")
     void shouldNotLogDebugWhenSamplingEnvVarIsInvalid() {
-        requestHandler.handleRequest(new Object(), context);
-        File logFile = new File("target/logfile.json");
-        assertThat(contentOf(logFile)).doesNotContain("Test debug event");
-        assertThat(contentOf(logFile)).contains("Skipping sampling rate on environment variable configuration because of invalid value");
+        try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class)) {
+            mocked.when(() -> getenv("POWERTOOLS_LOGGER_SAMPLE_RATE"))
+                    .thenReturn("NotANumber");
+
+            requestHandler.handleRequest(new Object(), context);
+            File logFile = new File("target/logfile.json");
+            assertThat(contentOf(logFile)).doesNotContain("Test debug event");
+            assertThat(contentOf(logFile)).contains(
+                    "Skipping sampling rate on environment variable configuration because of invalid value");
+        }
     }
 
     @Test
@@ -256,7 +272,7 @@ void shouldLogxRayTraceIdEnvVarSet() {
     }
 
     @Test
-    void shouldLogEventForHandler() throws IOException {
+    void shouldLogEventForHandlerWithLogEventAnnotation() {
         requestHandler = new PowertoolsLogEvent();
 
         requestHandler.handleRequest(Collections.singletonList("ListOfOneElement"), context);
@@ -265,6 +281,21 @@ void shouldLogEventForHandler() throws IOException {
         assertThat(contentOf(logFile)).contains("[\"ListOfOneElement\"]");
     }
 
+    @Test
+    void shouldLogEventForHandlerWithLogEventEnvVar() {
+        requestHandler = new PowertoolsLogEnabled();
+
+        try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class)) {
+            mocked.when(() -> getenv("POWERTOOLS_LOGGER_LOG_EVENT"))
+                    .thenReturn("true");
+
+            requestHandler.handleRequest(Collections.singletonList("ListOfOneElement"), context);
+
+            File logFile = new File("target/logfile.json");
+            assertThat(contentOf(logFile)).contains("[\"ListOfOneElement\"]");
+        }
+    }
+
     @Test
     void shouldLogEventForStreamHandler() throws IOException {
         requestStreamHandler = new PowertoolsLogEventForStream();