http server 4xx configuration (#2037)

* http server 4xx configuration

* statsbeat

Author: trask

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

@@ -228,6 +228,7 @@ public static class PreviewConfiguration {
     // this is needed to unblock customer, but is not the ideal long-term solution
     // https://portal.microsofticm.com/imp/v3/incidents/details/266992200/home
     public boolean disablePropagation;
+    public boolean captureHttpServer4xxAsError = true;
 
     public List<InheritedAttribute> inheritedAttributes = new ArrayList<>();
 

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

@@ -46,7 +46,6 @@
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.api.trace.SpanId;
 import io.opentelemetry.api.trace.SpanKind;
-import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.instrumentation.api.aisdk.AiAppId;
 import io.opentelemetry.sdk.common.CompletableResultCode;
@@ -163,9 +162,11 @@ public class Exporter implements SpanExporter {
   }
 
   private final TelemetryClient telemetryClient;
+  private final boolean captureHttpServer4xxAsError;
 
-  public Exporter(TelemetryClient telemetryClient) {
+  public Exporter(TelemetryClient telemetryClient, boolean captureHttpServer4xxAsError) {
     this.telemetryClient = telemetryClient;
+    this.captureHttpServer4xxAsError = captureHttpServer4xxAsError;
   }
 
   @Override
@@ -839,20 +840,21 @@ private void exportRequest(SpanData span) {
     exportEvents(span, operationName, samplingPercentage);
   }
 
-  private static boolean getSuccess(SpanData span) {
-    if (span.getStatus().getStatusCode() == StatusCode.ERROR) {
-      return false;
-    }
-    if (span.getStatus().getStatusCode() == StatusCode.OK) {
-      // auto-instrumentation never sets OK, so this is explicit user override
-      return true;
-    }
-    Long statusCode = span.getAttributes().get(SemanticAttributes.HTTP_STATUS_CODE);
-    if (statusCode == null) {
-      return true;
+  private boolean getSuccess(SpanData span) {
+    switch (span.getStatus().getStatusCode()) {
+      case ERROR:
+        return false;
+      case OK:
+        // auto-instrumentation never sets OK, so this is explicit user override
+        return true;
+      case UNSET:
+        if (captureHttpServer4xxAsError) {
+          Long statusCode = span.getAttributes().get(SemanticAttributes.HTTP_STATUS_CODE);
+          return statusCode == null || statusCode < 400;
+        }
+        return true;
     }
-    // override default OpenTelemetry mapping of status codes 4xx
-    return statusCode < 400;
+    return true;
   }
 
   @Nullable

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

@@ -131,7 +131,9 @@ private static BatchSpanProcessor createExporter(Configuration configuration) {
     // Reversing the order of processors before passing it to SpanProcessor
     Collections.reverse(processors);
 
-    SpanExporter currExporter = new Exporter(TelemetryClient.getActive());
+    SpanExporter currExporter =
+        new Exporter(
+            TelemetryClient.getActive(), configuration.preview.captureHttpServer4xxAsError);
 
     // NOTE if changing the span processor to something async, flush it in the shutdown hook before
     // flushing TelemetryClient

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

@@ -53,7 +53,8 @@ enum Feature {
   APACHE_CAMEL_DISABLED(22), // preview instrumentation, apache camel is ON by default in OTEL
   AKKA_DISABLED(23), // preview instrumentation, akka is ON by default in OTEL
   PROPAGATION_DISABLED(24),
-  PLAY_DISABLED(25); // preview instrumentation, play is ON by default in OTEL
+  PLAY_DISABLED(25), // preview instrumentation, play is ON by default in OTEL
+  CAPTURE_HTTP_SERVER_4XX_AS_SUCCESS(26);
 
   private static final Map<String, Feature> javaVendorFeatureMap;
 

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

@@ -156,5 +156,8 @@ void trackConfigurationOptions(Configuration config) {
     if (config.preview.disablePropagation) {
       featureList.add(Feature.PROPAGATION_DISABLED);
     }
+    if (!config.preview.captureHttpServer4xxAsError) {
+      featureList.add(Feature.CAPTURE_HTTP_SERVER_4XX_AS_SUCCESS);
+    }
   }
 }

settings.gradle

@@ -89,6 +89,7 @@ include ':test:smoke:testApps:gRPC'
 include ':test:smoke:testApps:HeartBeat'
 include ':test:smoke:testApps:HttpClients'
 include ':test:smoke:testApps:HttpHeaders'
+include ':test:smoke:testApps:HttpServer4xx'
 include ':test:smoke:testApps:InheritedAttributes'
 include ':test:smoke:testApps:Jdbc'
 include ':test:smoke:testApps:Jedis'

test/smoke/appServers/global-resources/httpserver4xx_applicationinsights.json

@@ -0,0 +1,10 @@
+{
+  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-0FEEDDADBEEF;IngestionEndpoint=http://host.docker.internal:6060/",
+  "role": {
+    "name": "testrolename",
+    "instance": "testroleinstance"
+  },
+  "preview": {
+    "captureHttpServer4xxAsError": false
+  }
+}

test/smoke/testApps/HttpServer4xx/build.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+  id("ai.smoke-test-war")
+}
+
+dependencies {
+  implementation("com.microsoft.azure:applicationinsights-web-auto")
+  implementation("org.springframework.boot:spring-boot-starter-web:2.1.7.RELEASE") {
+    exclude("org.springframework.boot", "spring-boot-starter-tomcat")
+  }
+  // this dependency is needed to make wildfly happy
+  implementation("org.reactivestreams:reactive-streams:1.0.3")
+}

test/smoke/testApps/HttpServer4xx/src/main/java/com/microsoft/applicationinsights/smoketestapp/SpringBootApp.java

@@ -0,0 +1,34 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package com.microsoft.applicationinsights.smoketestapp;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.builder.SpringApplicationBuilder;
+import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
+
+@SpringBootApplication
+public class SpringBootApp extends SpringBootServletInitializer {
+  @Override
+  protected SpringApplicationBuilder configure(SpringApplicationBuilder applicationBuilder) {
+    return applicationBuilder.sources(SpringBootApp.class);
+  }
+}

test/smoke/testApps/HttpServer4xx/src/main/java/com/microsoft/applicationinsights/smoketestapp/TestController.java

@@ -0,0 +1,41 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package com.microsoft.applicationinsights.smoketestapp;
+
+import javax.servlet.http.HttpServletResponse;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class TestController {
+
+  @GetMapping("/")
+  public String root() {
+    return "OK";
+  }
+
+  @GetMapping("/test4xx")
+  public String test4xx(HttpServletResponse response) {
+    response.setStatus(400);
+    return "Not OK!";
+  }
+}