Change logback logging level at runtime for Linux consumption plan (#1603)

Author: heyams

agent/agent-tooling/build.gradle

@@ -66,6 +66,7 @@ dependencies {
         exclude group: 'commons-logging', module: 'commons-logging'
     }
     implementation group: 'org.slf4j', name: 'jcl-over-slf4j', version: versions.slf4j
+    implementation group: 'ch.qos.logback', name: 'logback-classic', version: versions.logback
 
     implementation project(":agent:agent-profiler:agent-profiler-api")
 

agent/agent-tooling/gradle/dependency-locks/compileClasspath.lockfile

@@ -1,6 +1,8 @@
 # This is a Gradle generated file for dependency locking.
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
+ch.qos.logback:logback-classic:1.2.3
+ch.qos.logback:logback-core:1.2.3
 com.google.code.findbugs:jsr305:3.0.2
 com.google.errorprone:error_prone_annotations:2.5.1
 com.google.guava:failureaccess:1.0.1

agent/agent-tooling/gradle/dependency-locks/runtimeClasspath.lockfile

@@ -1,6 +1,8 @@
 # This is a Gradle generated file for dependency locking.
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
+ch.qos.logback:logback-classic:1.2.3
+ch.qos.logback:logback-core:1.2.3
 com.blogspot.mydailyjava:weak-lock-free:0.15
 com.github.oshi:oshi-core:5.6.0
 com.google.auto.service:auto-service-annotations:1.0-rc7

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

@@ -21,6 +21,8 @@
 
 package com.microsoft.applicationinsights.agent.internal;
 
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.LoggerContext;
 import com.google.common.base.Strings;
 import com.microsoft.applicationinsights.TelemetryConfiguration;
 import com.microsoft.applicationinsights.agent.internal.propagator.DelegatingPropagator;
@@ -30,6 +32,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.List;
+
 public class LazyConfigurationAccessor implements AiLazyConfiguration.Accessor {
 
     private static final Logger logger = LoggerFactory.getLogger(LazyConfigurationAccessor.class);
@@ -56,6 +60,7 @@ private void lazySetEnvVars() {
 
         setConnectionString(System.getenv("APPLICATIONINSIGHTS_CONNECTION_STRING"), System.getenv("APPINSIGHTS_INSTRUMENTATIONKEY"));
         setWebsiteSiteName(System.getenv("WEBSITE_SITE_NAME"));
+        setSelfDiagnosticsLevel(System.getenv("APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL"));
         setInstrumentationLoggingLevel(System.getenv("APPLICATIONINSIGHTS_INSTRUMENTATION_LOGGING_LEVEL"));
     }
 
@@ -91,6 +96,18 @@ static void setWebsiteSiteName(String websiteSiteName) {
         }
     }
 
+    static void setSelfDiagnosticsLevel(String loggingLevel) {
+        if (loggingLevel != null && !loggingLevel.isEmpty()) {
+            LoggerContext loggerContext = (LoggerContext)LoggerFactory.getILoggerFactory();
+            List<ch.qos.logback.classic.Logger> loggerList = loggerContext.getLoggerList();
+            logger.info("setting APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL to {}", loggingLevel);
+            loggerList.stream().forEach(tmpLogger -> tmpLogger.setLevel(Level.toLevel(loggingLevel)));
+            if (Level.toLevel(loggingLevel) == Level.DEBUG) {
+                logger.debug("This should get logged after the logging level update.");
+            }
+        }
+    }
+
     static boolean shouldSetConnectionString(boolean lazySetOptIn, String enableAgent) {
         if (lazySetOptIn) {
             // when LazySetOptIn is on, enable agent if APPLICATIONINSIGHTS_ENABLE_AGENT is null or true

agent/instrumentation/build.gradle

@@ -82,6 +82,12 @@ dependencies {
 // reference unshaded java.util.logging.Logger
 // (java.util.logging.Logger shading is not needed in any of the instrumentation modules,
 // but it is needed for the dependencies, e.g. guava, which use java.util.logging.Logger)
+// -- AND ALSO --
+// need to perform shading in two steps in order to avoid shading ch.qos.logback.*
+// in opentelemetry-javaagent-logback-spans-1.0 since that instrumentation needs to
+// reference unshaded ch.qos.logback.*
+// (ch.qos.logback.* shading is not needed in any of the instrumentation modules,
+// but it is needed for agent-tooling, which use logback to update levels dynamically in LazyConfigurationAccessor)
 task shadowJarStep1(type: com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
 
     archiveClassifier.set('step1')
@@ -91,17 +97,22 @@ task shadowJarStep1(type: com.github.jengelman.gradle.plugins.shadow.tasks.Shado
 
     dependencies {
         exclude(dependency('io.opentelemetry.javaagent.instrumentation:opentelemetry-javaagent-java-util-logging-spans'))
+        exclude(dependency('io.opentelemetry.javaagent.instrumentation:opentelemetry-javaagent-logback-spans-1.0'))
 
         // exclude bootstrap dependencies from shadowJar
         exclude(dependency('io.opentelemetry.javaagent.instrumentation:opentelemetry-javaagent-bootstrap'))
         exclude(dependency('io.opentelemetry:opentelemetry-api'))
         exclude(dependency('io.opentelemetry:opentelemetry-context-prop'))
         exclude(dependency('io.grpc:grpc-context'))
         exclude(dependency('org.slf4j:slf4j-api'))
+        exclude(dependency('ch.qos.logback:logback-classic'))
+        exclude(dependency('ch.qos.logback:logback-core'))
     }
 
     // rewrite dependencies calling Logger.getLogger
     relocate 'java.util.logging.Logger', 'io.opentelemetry.javaagent.bootstrap.PatchLogger'
+
+    relocate 'ch.qos.logback', "com.microsoft.applicationinsights.agent.shadow.ch.qos.logback"
 }
 
 
@@ -122,6 +133,8 @@ shadowJar {
         exclude(dependency('io.opentelemetry:opentelemetry-context-prop'))
         exclude(dependency('io.grpc:grpc-context'))
         exclude(dependency('org.slf4j:slf4j-api'))
+        exclude(dependency('ch.qos.logback:logback-classic'))
+        exclude(dependency('ch.qos.logback:logback-core'))
     }
 
     mergeServiceFiles()

agent/instrumentation/gradle/dependency-locks/runtimeClasspath.lockfile

@@ -1,6 +1,8 @@
 # This is a Gradle generated file for dependency locking.
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
+ch.qos.logback:logback-classic:1.2.3
+ch.qos.logback:logback-core:1.2.3
 com.azure:azure-core-tracing-opentelemetry:1.0.0-beta.8
 com.blogspot.mydailyjava:weak-lock-free:0.15
 com.github.oshi:oshi-core:5.6.0