Feature: Send metric on startup with info if validation is enabled (#12)

Author: pboos

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

@@ -16,10 +16,20 @@ public class DefaultMetricsReporter implements MetricsReporter {
 
     @Override
     public void reportViolation(OpenApiViolation violation) {
-        var violationMetricName = configuration.getMetricName() + ".error";
+        String violationMetricName = buildMetricName(".error");
         metricsClient.increment(violationMetricName, createTagsForViolation(violation));
     }
 
+    @Override
+    public void reportStartup(boolean isValidationEnabled) {
+        String startupMetricName = buildMetricName(".startup");
+        metricsClient.increment(startupMetricName, createTagsForStartup(isValidationEnabled));
+    }
+
+    private String buildMetricName(String suffix) {
+        return configuration.getMetricName() + suffix;
+    }
+
     private MetricTag[] createTagsForViolation(OpenApiViolation violation) {
         var tags = new ArrayList<MetricTag>();
 
@@ -29,11 +39,24 @@ private MetricTag[] createTagsForViolation(OpenApiViolation violation) {
         violation.getResponseStatus()
             .ifPresent(responseStatus -> tags.add(new MetricTag("status", responseStatus.toString())));
 
+        addAdditionalTags(tags);
+
+        return tags.toArray(MetricTag[]::new);
+    }
+
+    private MetricTag[] createTagsForStartup(boolean isValidationEnabled) {
+        var tags = new ArrayList<MetricTag>();
+
+        tags.add(new MetricTag("validation_enabled", String.valueOf(isValidationEnabled)));
+        addAdditionalTags(tags);
+
+        return tags.toArray(MetricTag[]::new);
+    }
+
+    private void addAdditionalTags(ArrayList<MetricTag> tags) {
         if (configuration.getMetricAdditionalTags() != null) {
             tags.addAll(configuration.getMetricAdditionalTags());
         }
-
-        return tags.toArray(MetricTag[]::new);
     }
 
     @Builder

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

@@ -4,4 +4,6 @@
 
 public interface MetricsReporter {
     void reportViolation(OpenApiViolation violation);
+
+    void reportStartup(boolean isValidationEnabled);
 }

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

@@ -4,6 +4,7 @@
 import com.atlassian.oai.validator.model.SimpleRequest;
 import com.atlassian.oai.validator.model.SimpleResponse;
 import com.atlassian.oai.validator.report.ValidationReport;
+import com.getyourguide.openapi.validation.api.metrics.MetricsReporter;
 import com.getyourguide.openapi.validation.api.model.Direction;
 import com.getyourguide.openapi.validation.api.model.RequestMetaData;
 import com.getyourguide.openapi.validation.api.model.ResponseMetaData;
@@ -24,9 +25,16 @@ public class OpenApiRequestValidator {
     private final OpenApiInteractionValidatorWrapper validator;
     private final ValidationReportHandler validationReportHandler;
 
-    public OpenApiRequestValidator(ValidationReportHandler validationReportHandler, String specificationFilePath, ValidatorConfiguration configuration) {
+    public OpenApiRequestValidator(
+        ValidationReportHandler validationReportHandler,
+        MetricsReporter metricsReporter,
+        String specificationFilePath,
+        ValidatorConfiguration configuration
+    ) {
         this.validator = new OpenApiInteractionValidatorFactory().build(specificationFilePath, configuration);
         this.validationReportHandler = validationReportHandler;
+
+        metricsReporter.reportStartup(validator != null);
     }
 
     public boolean isReady() {

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

@@ -93,9 +93,14 @@ public ValidatorConfiguration validatorConfiguration() {
     @Bean
     public OpenApiRequestValidator openApiRequestValidator(
         ValidationReportHandler validationReportHandler,
+        MetricsReporter metricsReporter,
         ValidatorConfiguration validatorConfiguration
     ) {
-        return new OpenApiRequestValidator(validationReportHandler, properties.getSpecificationFilePath(),
-            validatorConfiguration);
+        return new OpenApiRequestValidator(
+            validationReportHandler,
+            metricsReporter,
+            properties.getSpecificationFilePath(),
+            validatorConfiguration
+        );
     }
 }