Add a config to disable all logging appenders (#3208)

Author: heyams

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/configuration/Configuration.java

@@ -226,6 +226,7 @@ public static class DatabaseMaskingConfiguration {
 
   public static class LoggingInstrumentation {
     public String level = "INFO";
+    public boolean enabled = true;
 
     public int getSeverityThreshold() {
       return getSeverityThreshold(level);

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/init/AiConfigCustomizer.java

@@ -70,6 +70,13 @@ public Map<String, String> apply(ConfigProperties otelConfig) {
     properties.put("otel.instrumentation.log4j-appender.experimental-log-attributes", "true");
     properties.put("otel.instrumentation.logback-appender.experimental-log-attributes", "true");
 
+    // disable logging appender
+    if (!configuration.instrumentation.logging.enabled) {
+      properties.put("otel.instrumentation.logback-appender.enabled", "false");
+      properties.put("otel.instrumentation.log4j-appender.enabled", "false");
+      properties.put("otel.instrumentation.java-util-logging.enabled", "false");
+    }
+
     // custom instrumentation
     if (!configuration.preview.customInstrumentation.isEmpty()) {
       StringBuilder sb = new StringBuilder();

smoke-tests/apps/JavaUtilLogging/src/main/java/com/microsoft/applicationinsights/smoketestapp/JavaUtilLoggingDisabledServlet.java

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketestapp;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+@WebServlet("/testDisabled")
+public class JavaUtilLoggingDisabledServlet extends HttpServlet {
+
+  private static final Logger logger = Logger.getLogger("smoketestapp");
+
+  protected void doGet(HttpServletRequest request, HttpServletResponse response) {
+    logger.log(Level.WARNING, "this message will get suppressed.");
+  }
+}

smoke-tests/apps/JavaUtilLogging/src/smokeTest/java/com/microsoft/applicationinsights/smoketest/JavaUtilLoggingDisabledTest.java

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketest;
+
+import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_8;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.microsoft.applicationinsights.smoketest.schemav2.Data;
+import com.microsoft.applicationinsights.smoketest.schemav2.Envelope;
+import com.microsoft.applicationinsights.smoketest.schemav2.RequestData;
+import java.util.List;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+@Environment(TOMCAT_8_JAVA_8)
+@UseAgent("disabled_applicationinsights.json")
+class JavaUtilLoggingDisabledTest {
+
+  @RegisterExtension static final SmokeTestExtension testing = SmokeTestExtension.create();
+
+  @Test
+  @TargetUri("/testDisabled")
+  void testDisabled() throws Exception {
+    List<Envelope> rdList = testing.mockedIngestion.waitForItems("RequestData", 1);
+
+    Envelope rdEnvelope = rdList.get(0);
+    RequestData rd = (RequestData) ((Data<?>) rdEnvelope.getData()).getBaseData();
+    assertThat(rd.getName()).isEqualTo("GET /JavaUtilLogging/testDisabled");
+
+    assertThat(testing.mockedIngestion.getCountForType("MessageData")).isZero();
+  }
+}

smoke-tests/apps/JavaUtilLogging/src/smokeTest/resources/disabled_applicationinsights.json

@@ -0,0 +1,14 @@
+{
+  "role": {
+    "name": "testrolename",
+    "instance": "testroleinstance"
+  },
+  "sampling": {
+    "percentage": 100
+  },
+  "instrumentation": {
+    "logging": {
+      "enabled": "false"
+    }
+  }
+}

smoke-tests/apps/Log4j2/src/main/java/com/microsoft/applicationinsights/smoketestapp/Log4j2DisabledServlet.java

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketestapp;
+
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+@WebServlet("/testDisabled")
+public class Log4j2DisabledServlet extends HttpServlet {
+
+  private static final Logger logger = LogManager.getLogger("smoketestapp");
+
+  protected void doGet(HttpServletRequest request, HttpServletResponse response) {
+    logger.warn("This message will get suppressed");
+  }
+}

smoke-tests/apps/Log4j2/src/smokeTest/java/com/microsoft/applicationinsights/smoketest/Log4j2DisabledTest.java

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketest;
+
+import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_8;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.microsoft.applicationinsights.smoketest.schemav2.Data;
+import com.microsoft.applicationinsights.smoketest.schemav2.Envelope;
+import com.microsoft.applicationinsights.smoketest.schemav2.RequestData;
+import java.util.List;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+@Environment(TOMCAT_8_JAVA_8)
+@UseAgent("disabled_applicationinsights.json")
+class Log4j2DisabledTest {
+
+  @RegisterExtension static final SmokeTestExtension testing = SmokeTestExtension.create();
+
+  @Test
+  @TargetUri("/testDisabled")
+  void testDisabled() throws Exception {
+    List<Envelope> rdList = testing.mockedIngestion.waitForItems("RequestData", 1);
+
+    Envelope rdEnvelope = rdList.get(0);
+    RequestData rd = (RequestData) ((Data<?>) rdEnvelope.getData()).getBaseData();
+    assertThat(rd.getName()).isEqualTo("GET /Log4j2/testDisabled");
+
+    assertThat(testing.mockedIngestion.getCountForType("MessageData")).isZero();
+  }
+}

smoke-tests/apps/Log4j2/src/smokeTest/resources/disabled_applicationinsights.json

@@ -0,0 +1,14 @@
+{
+  "role": {
+    "name": "testrolename",
+    "instance": "testroleinstance"
+  },
+  "sampling": {
+    "percentage": 100
+  },
+  "instrumentation": {
+    "logging": {
+      "enabled": "false"
+    }
+  }
+}

smoke-tests/apps/Logback/src/main/java/com/microsoft/applicationinsights/smoketestapp/LogbackDisabledServlet.java

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketestapp;
+
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@WebServlet("/testDisabled")
+public class LogbackDisabledServlet extends HttpServlet {
+
+  private static final Logger logger = LoggerFactory.getLogger("smoketestapp");
+
+  protected void doGet(HttpServletRequest request, HttpServletResponse response) {
+    logger.warn("This message will get suppressed");
+  }
+}

smoke-tests/apps/Logback/src/smokeTest/java/com/microsoft/applicationinsights/smoketest/LogbackDisabledTest.java

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.applicationinsights.smoketest;
+
+import static com.microsoft.applicationinsights.smoketest.EnvironmentValue.TOMCAT_8_JAVA_8;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.microsoft.applicationinsights.smoketest.schemav2.Data;
+import com.microsoft.applicationinsights.smoketest.schemav2.Envelope;
+import com.microsoft.applicationinsights.smoketest.schemav2.RequestData;
+import java.util.List;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+@Environment(TOMCAT_8_JAVA_8)
+@UseAgent("disabled_applicationinsights.json")
+class LogbackDisabledTest {
+
+  @RegisterExtension static final SmokeTestExtension testing = SmokeTestExtension.create();
+
+  @Test
+  @TargetUri("/testDisabled")
+  void testDisabled() throws Exception {
+    List<Envelope> rdList = testing.mockedIngestion.waitForItems("RequestData", 1);
+
+    Envelope rdEnvelope = rdList.get(0);
+    RequestData rd = (RequestData) ((Data<?>) rdEnvelope.getData()).getBaseData();
+    assertThat(rd.getName()).isEqualTo("GET /Logback/testDisabled");
+
+    assertThat(testing.mockedIngestion.getCountForType("MessageData")).isZero();
+  }
+}