Send sample-rate and throttling information with startup metric (#28)

Author: pboos

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/metrics/DefaultMetricsReporter.java

@@ -25,8 +25,15 @@ public void reportViolation(OpenApiViolation violation) {
     }
 
     @Override
-    public void reportStartup(boolean isValidationEnabled) {
-        metricsClient.increment(buildMetricName(".startup"), createTagsForStartup(isValidationEnabled));
+    public void reportStartup(
+        boolean isValidationEnabled,
+        double sampleRate,
+        int validationReportThrottleWaitSeconds
+    ) {
+        metricsClient.increment(
+            buildMetricName(".startup"),
+            createTagsForStartup(isValidationEnabled, sampleRate, validationReportThrottleWaitSeconds)
+        );
     }
 
     private String buildMetricName(String suffix) {
@@ -47,10 +54,16 @@ private MetricTag[] createTagsForViolation(OpenApiViolation violation) {
         return tags.toArray(MetricTag[]::new);
     }
 
-    private MetricTag[] createTagsForStartup(boolean isValidationEnabled) {
+    private MetricTag[] createTagsForStartup(
+        boolean isValidationEnabled,
+        double sampleRate,
+        int validationReportThrottleWaitSeconds
+    ) {
         var tags = new ArrayList<MetricTag>();
 
         tags.add(new MetricTag("validation_enabled", String.valueOf(isValidationEnabled)));
+        tags.add(new MetricTag("sample_rate", String.valueOf(sampleRate)));
+        tags.add(new MetricTag("throttling", String.valueOf(validationReportThrottleWaitSeconds)));
         addAdditionalTags(tags);
 
         return tags.toArray(MetricTag[]::new);

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/metrics/MetricsReporter.java

@@ -5,5 +5,5 @@
 public interface MetricsReporter {
     void reportViolation(OpenApiViolation violation);
 
-    void reportStartup(boolean isValidationEnabled);
+    void reportStartup(boolean isValidationEnabled, double sampleRate, int validationReportThrottleWaitSeconds);
 }

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/selector/DefaultTrafficSelector.java

@@ -10,8 +10,6 @@
 
 public class DefaultTrafficSelector implements TrafficSelector {
 
-    private static final double SAMPLE_RATE_DEFAULT = 0.001; // 1.0 = 100%
-
     private final double sampleRate;
     private final Set<String> excludedPaths;
     private final List<ExcludedHeader> excludedHeaders;
@@ -23,13 +21,13 @@ public DefaultTrafficSelector(Double sampleRate, Set<String> excludedPaths, List
     }
 
     public DefaultTrafficSelector(
-        Double sampleRate,
+        double sampleRate,
         Set<String> excludedPaths,
         List<ExcludedHeader> excludedHeaders,
         Boolean shouldFailOnRequestViolation,
         Boolean shouldFailOnResponseViolation
     ) {
-        this.sampleRate = sampleRate != null ? sampleRate : SAMPLE_RATE_DEFAULT;
+        this.sampleRate = sampleRate;
         this.excludedPaths = excludedPaths != null ? excludedPaths : Set.of();
         this.excludedHeaders = excludedHeaders != null ? excludedHeaders : Collections.emptyList();
         this.shouldFailOnRequestViolation = shouldFailOnRequestViolation != null ? shouldFailOnRequestViolation : false;

openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/OpenApiRequestValidationConfiguration.java

@@ -0,0 +1,11 @@
+package com.getyourguide.openapi.validation.core;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Builder
+@Getter
+public class OpenApiRequestValidationConfiguration {
+    private double sampleRate;
+    private int validationReportThrottleWaitSeconds;
+}

openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/OpenApiRequestValidator.java

@@ -28,13 +28,18 @@ public OpenApiRequestValidator(
         ThreadPoolExecutor threadPoolExecutor,
         ValidationReportHandler validationReportHandler,
         MetricsReporter metricsReporter,
-        OpenApiInteractionValidatorWrapper validator
+        OpenApiInteractionValidatorWrapper validator,
+        OpenApiRequestValidationConfiguration configuration
     ) {
         this.threadPoolExecutor = threadPoolExecutor;
         this.validator = validator;
         this.validationReportHandler = validationReportHandler;
 
-        metricsReporter.reportStartup(validator != null);
+        metricsReporter.reportStartup(
+            validator != null,
+            configuration.getSampleRate(),
+            configuration.getValidationReportThrottleWaitSeconds()
+        );
     }
 
     public boolean isReady() {

openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/OpenApiRequestValidatorTest.java

@@ -36,7 +36,8 @@ public void setup() {
             threadPoolExecutor,
             validationReportHandler,
             metricsReporter,
-            validator
+            validator,
+            mock()
         );
     }
 

spring-boot-starter/spring-boot-starter-core/src/main/java/com/getyourguide/openapi/validation/OpenApiValidationApplicationProperties.java

@@ -5,6 +5,7 @@
 import com.getyourguide.openapi.validation.api.exclusions.ExcludedHeader;
 import com.getyourguide.openapi.validation.api.log.LogLevel;
 import com.getyourguide.openapi.validation.api.metrics.MetricTag;
+import com.getyourguide.openapi.validation.core.OpenApiRequestValidationConfiguration;
 import com.getyourguide.openapi.validation.util.CommaSeparatedStringsUtil;
 import java.util.Arrays;
 import java.util.Collections;
@@ -25,6 +26,7 @@
 @Setter
 public class OpenApiValidationApplicationProperties {
     public static final String PROPERTY_PREFIX = "openapi.validation";
+    private static final double SAMPLE_RATE_DEFAULT = 0.001; // 1.0 = 100%
 
     private Double sampleRate;
     private String specificationFilePath;
@@ -37,6 +39,14 @@ public class OpenApiValidationApplicationProperties {
     private Boolean shouldFailOnRequestViolation;
     private Boolean shouldFailOnResponseViolation;
 
+    public double getSampleRate() {
+        return sampleRate != null ? sampleRate : SAMPLE_RATE_DEFAULT;
+    }
+
+    public int getValidationReportThrottleWaitSeconds() {
+        return validationReportThrottleWaitSeconds != null ? validationReportThrottleWaitSeconds : 0;
+    }
+
     public List<MetricTag> getValidationReportMetricAdditionalTags() {
         if (validationReportMetricAdditionalTags == null) {
             return null;
@@ -73,4 +83,11 @@ public List<ExcludedHeader> getExcludedHeaders() {
             .filter(Objects::nonNull)
             .toList();
     }
+
+    public OpenApiRequestValidationConfiguration toOpenApiRequestValidationConfiguration() {
+        return OpenApiRequestValidationConfiguration.builder()
+            .sampleRate(getSampleRate())
+            .validationReportThrottleWaitSeconds(getValidationReportThrottleWaitSeconds())
+            .build();
+    }
 }

spring-boot-starter/spring-boot-starter-core/src/main/java/com/getyourguide/openapi/validation/autoconfigure/LibraryAutoConfiguration.java

@@ -43,8 +43,7 @@ public class LibraryAutoConfiguration {
     @Bean
     @ConditionalOnMissingBean
     public ValidationReportThrottler requestBasedThrottleHelper() {
-        if (properties.getValidationReportThrottleWaitSeconds() == null
-            || properties.getValidationReportThrottleWaitSeconds() == 0) {
+        if (properties.getValidationReportThrottleWaitSeconds() == 0) {
             return new ValidationReportThrottlerNone();
         }
         return new RequestBasedValidationReportThrottler(properties.getValidationReportThrottleWaitSeconds());
@@ -117,7 +116,8 @@ public OpenApiRequestValidator openApiRequestValidator(
             validationReportHandler,
             metricsReporter,
             new OpenApiInteractionValidatorFactory()
-                .build(properties.getSpecificationFilePath(), validatorConfiguration)
+                .build(properties.getSpecificationFilePath(), validatorConfiguration),
+            properties.toOpenApiRequestValidationConfiguration()
         );
     }
 }