Enable ETW in integrated_auto only (#3560)

Author: heyams

CHANGELOG.md

@@ -1,6 +1,6 @@
 # CHANGELOG
 
-## Version 3.5 GA (02/26/2024)
+## Version 3.5 GA (02/28/2024)
 
 ### Enhancements:
 
@@ -13,6 +13,7 @@
 
 ### Bug fixes:
 
+* Fix ETW log for non-auto attach ([#3560](https://github.com/microsoft/ApplicationInsights-Java/pull/3560))
 * Fix duplicate exceptions ([#3555](https://github.com/microsoft/ApplicationInsights-Java/pull/3555))
 
 ## Version 3.4.19 GA (12/20/2023)

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

@@ -629,8 +629,8 @@ private static String getDefaultPath() {
         }
         return DEFAULT_NAME; // this will be relative to the directory where agent jar is located
       }
-      if (DiagnosticsHelper.isAppSvcRpIntegration()
-          || DiagnosticsHelper.isFunctionsRpIntegration()) {
+      if (DiagnosticsHelper.isAppSvcRpIntegratedAuto()
+          || DiagnosticsHelper.isFunctionsRpIntegratedAuto()) {
         return StatusFile.getLogDir() + File.separator + DEFAULT_NAME;
       }
       // azure spring cloud

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

@@ -978,8 +978,9 @@ static Configuration getConfigurationFromEnvVar(String json) {
 
     Configuration configuration = getConfiguration(json, JsonOrigin.ENV_VAR);
 
-    // restrict connection string in APPLICATIONINSIGHTS_CONFIGURATION_CONTENT for App Service only
-    if (configuration.connectionString != null && DiagnosticsHelper.isAppSvcRpIntegration()) {
+    // restrict connection string in APPLICATIONINSIGHTS_CONFIGURATION_CONTENT for App Service
+    // INTEGRATED_AUTO only
+    if (configuration.connectionString != null && DiagnosticsHelper.isAppSvcRpIntegratedAuto()) {
       throw new ConfigurationException(
           "\"connectionString\" attribute is not supported inside of "
               + APPLICATIONINSIGHTS_CONFIGURATION_CONTENT

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

@@ -13,8 +13,8 @@ public class DiagnosticsHelper {
   private DiagnosticsHelper() {}
 
   // visible for testing
-  private static volatile boolean appSvcRpIntegration;
-  private static volatile boolean functionsRpIntegration;
+  private static volatile boolean appSvcRpIntegratedAuto;
+  private static volatile boolean functionsRpIntegratedAuto;
 
   private static final boolean isWindows;
 
@@ -37,12 +37,16 @@ public static void initRpIntegration(Path agentPath) {
     // TODO (heya) refactor PropertyHelper and ResourceProvider to simplify logic for rp
     if ("java".equals(System.getenv("FUNCTIONS_WORKER_RUNTIME"))) {
       PropertyHelper.setRpIntegrationChar('f');
-      functionsRpIntegration = true;
       setRpAttachType(agentPath, "functions.codeless");
+      if (RpAttachType.INTEGRATED_AUTO.equals(RpAttachType.getRpAttachType())) {
+        functionsRpIntegratedAuto = true;
+      }
     } else if (!Strings.isNullOrEmpty(System.getenv("WEBSITE_SITE_NAME"))) {
       PropertyHelper.setRpIntegrationChar('a');
-      appSvcRpIntegration = true;
       setRpAttachType(agentPath, "appsvc.codeless");
+      if (RpAttachType.INTEGRATED_AUTO.equals(RpAttachType.getRpAttachType())) {
+        appSvcRpIntegratedAuto = true;
+      }
     } else if (!Strings.isNullOrEmpty(System.getenv("AKS_ARM_NAMESPACE_ID"))) {
       // AKS_ARM_NAMESPACE_ID is an env var available in AKS only and it's also used as the AKS
       // attach rate numerator
@@ -57,12 +61,12 @@ public static void initRpIntegration(Path agentPath) {
     }
   }
 
-  public static boolean isAppSvcRpIntegration() {
-    return appSvcRpIntegration;
+  public static boolean isAppSvcRpIntegratedAuto() {
+    return appSvcRpIntegratedAuto;
   }
 
-  public static boolean isFunctionsRpIntegration() {
-    return functionsRpIntegration;
+  public static boolean isFunctionsRpIntegratedAuto() {
+    return functionsRpIntegratedAuto;
   }
 
   public static ApplicationMetadataFactory getMetadataFactory() {
@@ -82,7 +86,7 @@ private static void setRpAttachType(Path agentPath, String markerFile) {
   }
 
   // only used by tests
-  public static void setAppSvcRpIntegration(boolean appSvcRpIntegration) {
-    DiagnosticsHelper.appSvcRpIntegration = appSvcRpIntegration;
+  public static void setAppSvcRpIntegratedAuto(boolean appSvcRpIntegratedAuto) {
+    DiagnosticsHelper.appSvcRpIntegratedAuto = appSvcRpIntegratedAuto;
   }
 }

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/diagnostics/status/StatusFile.java

@@ -230,7 +230,7 @@ public void run() {
       justification =
           "The constructed file path cannot be controlled by an end user of the instrumented application)")
   private static boolean writable() {
-    if (!DiagnosticsHelper.isAppSvcRpIntegration()) {
+    if (!DiagnosticsHelper.isAppSvcRpIntegratedAuto()) {
       return false;
     }
     return new File(logDir).canWrite();

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

@@ -57,9 +57,10 @@ public class LoggingConfigurator {
   void configure() {
     loggerContext.getLogger(ROOT_LOGGER_NAME).detachAndStopAllAppenders();
 
-    if (DiagnosticsHelper.isAppSvcRpIntegration()) {
+    // only enable ETW when it's INTEGRATED_AUTO
+    if (DiagnosticsHelper.isAppSvcRpIntegratedAuto()) {
       configureAppSvc();
-    } else if (DiagnosticsHelper.isFunctionsRpIntegration()) {
+    } else if (DiagnosticsHelper.isFunctionsRpIntegratedAuto()) {
       configureFunctions();
     } else if (destination == null || destination.equalsIgnoreCase("file+console")) {
       configureFileAndConsole();
@@ -203,7 +204,7 @@ private Appender<ILoggingEvent> configureConsoleAppender() {
     appender.setName("CONSOLE");
 
     // format Functions diagnostic log as comma separated
-    if (DiagnosticsHelper.isFunctionsRpIntegration()) {
+    if (DiagnosticsHelper.isFunctionsRpIntegratedAuto()) {
       appender.setLayout(
           new ApplicationInsightsCsvLayout(PropertyHelper.getQualifiedSdkVersionString()));
     } else {

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/configuration/ConfigurationTest.java

@@ -105,7 +105,7 @@ void shouldParseFromEnvVar() throws IOException {
 
   @Test
   void shouldThrowFromEnvVarIfEmbeddedConnectionStringAndAppSvcRpIntegration() {
-    DiagnosticsHelper.setAppSvcRpIntegration(true);
+    DiagnosticsHelper.setAppSvcRpIntegratedAuto(true);
     try {
       String contentJson =
           "{\"connectionString\":\"InstrumentationKey=55555555-5555-5555-5555-555555555555\","
@@ -115,7 +115,7 @@ void shouldThrowFromEnvVarIfEmbeddedConnectionStringAndAppSvcRpIntegration() {
       assertThatThrownBy(() -> ConfigurationBuilder.create(Paths.get("."), null))
           .isInstanceOf(ConfigurationBuilder.ConfigurationException.class);
     } finally {
-      DiagnosticsHelper.setAppSvcRpIntegration(false);
+      DiagnosticsHelper.setAppSvcRpIntegratedAuto(false);
     }
   }
 

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/diagnostics/DiagnosticsTestHelper.java

@@ -7,7 +7,7 @@ public class DiagnosticsTestHelper {
   private DiagnosticsTestHelper() {}
 
   public static void setIsAppSvcAttachForLoggingPurposes(boolean appSvcAttachForLoggingPurposes) {
-    DiagnosticsHelper.setAppSvcRpIntegration(appSvcAttachForLoggingPurposes);
+    DiagnosticsHelper.setAppSvcRpIntegratedAuto(appSvcAttachForLoggingPurposes);
   }
 
   public static void reset() {