Add test to confirm request trigger parsing matches documentation (#3001)

Author: johnoliver

agent/agent-profiler/agent-alerting-api/src/main/java/com/microsoft/applicationinsights/alerting/aiconfig/AlertingConfig.java

@@ -9,6 +9,7 @@
 public class AlertingConfig {
 
   public enum RequestFilterType {
+    @JsonProperty("name-regex")
     NAME_REGEX
   }
 
@@ -44,6 +45,7 @@ public RequestAggregationConfig(
   }
 
   public enum RequestAggregationType {
+    @JsonProperty("breach-ratio")
     BREACH_RATIO
   }
 
@@ -64,6 +66,7 @@ public RequestAggregation(
   }
 
   public enum RequestTriggerThresholdType {
+    @JsonProperty("greater-than")
     GREATER_THAN
   }
 
@@ -89,6 +92,7 @@ public RequestTriggerThreshold(
   }
 
   public enum RequestTriggerThrottlingType {
+    @JsonProperty("fixed-duration-cooldown")
     FIXED_DURATION_COOLDOWN
   }
 
@@ -106,6 +110,7 @@ public RequestTriggerThrottling(
   }
 
   public enum RequestTriggerType {
+    @JsonProperty("latency")
     LATENCY
   }
 

agent/agent-profiler/request-triggers.md

@@ -20,7 +20,7 @@ An example of a complete configuration is as follows:
       "requestTriggerEndpoints": [
         {
           "name": "Users endpoint is responsive",
-          "type": "LATENCY",
+          "type": "latency",
           "filter": {
             "type": "name-regex",
             "value": "/users/get/.*"

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

@@ -1381,6 +1381,7 @@ public static class RequestTriggerThrottling {
   }
 
   public enum RequestTriggerType {
+    @JsonProperty("latency")
     LATENCY
   }
 

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

@@ -19,8 +19,14 @@
 import io.opentelemetry.api.common.AttributeKey;
 import java.io.IOException;
 import java.nio.file.Paths;
+import java.util.Collection;
 import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.DynamicTest;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestFactory;
 import org.junit.jupiter.api.extension.ExtendWith;
 import uk.org.webcompere.systemstubs.environment.EnvironmentVariables;
 import uk.org.webcompere.systemstubs.jupiter.SystemStub;
@@ -682,6 +688,26 @@ void shouldNotParseFaultyJson() {
         .isInstanceOf(UnrecognizedPropertyException.class);
   }
 
+  @TestFactory
+  public Collection<DynamicTest> canParseExampleProfilerConfigurations() {
+    return Stream.of(
+            "profile-configs/applicationinsights-trigger-example-1.json",
+            "profile-configs/applicationinsights-trigger-example-2.json",
+            "profile-configs/applicationinsights-trigger-example-3.json")
+        .map(
+            file ->
+                DynamicTest.dynamicTest(
+                    file,
+                    () -> {
+                      Configuration config = loadConfiguration(file, true);
+                      Assertions.assertNotNull(config);
+                      Assertions.assertNotNull(config.preview.profiler.requestTriggerEndpoints);
+                      Assertions.assertTrue(
+                          config.preview.profiler.requestTriggerEndpoints.length > 0);
+                    }))
+        .collect(Collectors.toList());
+  }
+
   private static Configuration loadConfiguration() throws IOException {
     return loadConfiguration("applicationinsights.json");
   }

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/profiler/triggers/RequestAlertPipelineBuilderTest.java

@@ -4,13 +4,19 @@
 package com.microsoft.applicationinsights.agent.internal.profiler.triggers;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.microsoft.applicationinsights.agent.internal.configuration.Configuration;
 import com.microsoft.applicationinsights.agent.internal.profiler.testutil.TestTimeSource;
 import com.microsoft.applicationinsights.alerting.aiconfig.AlertingConfig;
 import java.time.Instant;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.DynamicTest;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestFactory;
 
 public class RequestAlertPipelineBuilderTest {
 
@@ -30,15 +36,45 @@ public void configurationIsCorrectlyDuplicated() throws JsonProcessingException
     ObjectMapper mapper = new ObjectMapper();
     String configurationStr = mapper.writeValueAsString(triggerConfig);
     String alertingConfigStr = mapper.writeValueAsString(config);
-
-    // Account for serialization differences
-    alertingConfigStr =
-        alertingConfigStr
-            .replaceAll("NAME_REGEX", "name-regex")
-            .replaceAll("BREACH_RATIO", "breach-ratio")
-            .replaceAll("GREATER_THAN", "greater-than")
-            .replaceAll("FIXED_DURATION_COOLDOWN", "fixed-duration-cooldown");
+    ;
 
     Assertions.assertEquals(configurationStr, alertingConfigStr);
   }
+
+  @TestFactory
+  public List<DynamicTest> configExamplesCanBeParsedToAlertApiConfig() {
+    return Stream.of(
+            "profile-configs/applicationinsights-trigger-example-1.json",
+            "profile-configs/applicationinsights-trigger-example-2.json",
+            "profile-configs/applicationinsights-trigger-example-3.json")
+        .map(
+            file ->
+                DynamicTest.dynamicTest(
+                    file,
+                    () -> {
+                      ObjectMapper mapper = new ObjectMapper();
+                      JsonNode array =
+                          mapper
+                              .readTree(
+                                  RequestAlertPipelineBuilderTest.class
+                                      .getClassLoader()
+                                      .getResourceAsStream(file))
+                              .get("preview")
+                              .get("profiler")
+                              .withArray("requestTriggerEndpoints");
+
+                      array.forEach(
+                          config -> {
+                            try {
+                              AlertingConfig.RequestTrigger alertingConfig =
+                                  mapper.readValue(
+                                      config.toPrettyString(), AlertingConfig.RequestTrigger.class);
+                              Assertions.assertNotNull(alertingConfig);
+                            } catch (JsonProcessingException e) {
+                              Assertions.fail(e);
+                            }
+                          });
+                    }))
+        .collect(Collectors.toList());
+  }
 }

agent/agent-tooling/src/test/resources/profile-configs/applicationinsights-trigger-example-1.json

@@ -0,0 +1,32 @@
+{
+  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000",
+  "preview": {
+    "profiler": {
+      "enableRequestTriggering": true,
+      "requestTriggerEndpoints": [
+        {
+          "name": "Users endpoint is responsive",
+          "type": "latency",
+          "filter": {
+            "type": "name-regex",
+            "value": "/users/get/.*"
+          },
+          "aggregation": {
+            "configuration": {
+              "thresholdMillis": 7000
+            },
+            "type": "breach-ratio",
+            "windowSizeMillis": 60000
+          },
+          "threshold": {
+            "value": 0.75
+          },
+          "profileDuration": 30,
+          "throttling": {
+            "value": 60
+          }
+        }
+      ]
+    }
+  }
+}

agent/agent-tooling/src/test/resources/profile-configs/applicationinsights-trigger-example-2.json

@@ -0,0 +1,53 @@
+{
+  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000",
+  "preview": {
+    "profiler": {
+      "enabled": true,
+      "enableRequestTriggering": true,
+      "requestTriggerEndpoints": [
+        {
+          "name": "Users",
+          "type": "latency",
+          "profileDuration": 30,
+          "filter": {
+            "type": "name-regex",
+            "value": "/users/.*"
+          },
+          "aggregation": {
+            "configuration": {
+              "thresholdMillis": 7000
+            },
+            "type": "breach-ratio"
+          },
+          "threshold": {
+            "value": 0.75
+          },
+          "throttling": {
+            "value": 60
+          }
+        },
+        {
+          "name": "Index.html",
+          "type": "latency",
+          "profileDuration": 60,
+          "filter": {
+            "type": "name-regex",
+            "value": "/index\\.html"
+          },
+          "aggregation": {
+            "configuration": {
+              "thresholdMillis": 100
+            },
+            "type": "breach-ratio"
+          },
+          "threshold": {
+            "value": 0.5
+          },
+          "throttling": {
+            "value": 60
+          }
+        }
+      ]
+    }
+  }
+}

agent/agent-tooling/src/test/resources/profile-configs/applicationinsights-trigger-example-3.json

@@ -0,0 +1,31 @@
+{
+  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000",
+  "preview": {
+    "profiler": {
+      "enableRequestTriggering": true,
+      "requestTriggerEndpoints": [
+        {
+          "name": "All",
+          "type": "latency",
+          "profileDuration": 30,
+          "filter": {
+            "type": "name-regex",
+            "value": "/.*"
+          },
+          "aggregation": {
+            "configuration": {
+              "thresholdMillis": 7000
+            },
+            "type": "breach-ratio"
+          },
+          "threshold": {
+            "value": 0.75
+          },
+          "throttling": {
+            "value": 60
+          }
+        }
+      ]
+    }
+  }
+}