Allow configuring log level (#26)

Author: pboos

README.md

@@ -88,6 +88,10 @@ openapi.validation.specification-file-path=/tmp/openapi-spec/openapi.json
 # If it is within src/main/resources/folder/my-spec.json use
 openapi.validation.specification-file-path=folder/my-spec.json
 
+# Custom log level for violations (ignore, info, warn, error)
+# Default: info
+openapi.validation.violation-log-level=error
+
 # Comma separated list of paths to be excluded from validation. Default is no excluded paths
 openapi.validation.excluded-paths=/_readiness,/_liveness,/_metrics
 # Allows to exclude requests based on headers. Default is no excluded headers.

examples/example-spring-boot-starter-web/src/main/resources/application.properties

@@ -1,5 +1,6 @@
 openapi.validation.sample-rate=1
 openapi.validation.specification-file-path=openapi.yaml
+openapi.validation.violation-log-level=
 openapi.validation.excluded-paths=/_readiness,/_liveness,/_metrics
 openapi.validation.validation-report-throttle-wait-seconds=10
 openapi.validation.validation-report-metric-name=openapi_error

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

@@ -1,5 +1,6 @@
 package com.getyourguide.openapi.validation.api.metrics;
 
+import com.getyourguide.openapi.validation.api.log.LogLevel;
 import com.getyourguide.openapi.validation.api.metrics.client.MetricsClient;
 import com.getyourguide.openapi.validation.api.model.OpenApiViolation;
 import java.util.ArrayList;
@@ -16,6 +17,10 @@ public class DefaultMetricsReporter implements MetricsReporter {
 
     @Override
     public void reportViolation(OpenApiViolation violation) {
+        if (violation.getLevel() == LogLevel.IGNORE) {
+            return;
+        }
+
         metricsClient.increment(buildMetricName(".error"), createTagsForViolation(violation));
     }
 

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

@@ -22,8 +22,6 @@ public void log(OpenApiViolation violation) {
                 case INFO -> log.info(violation.getLogMessage());
                 case WARN -> log.warn(violation.getLogMessage());
                 case ERROR -> log.error(violation.getLogMessage());
-                // keeping ignored as debug for now
-                case IGNORE -> log.debug(violation.getLogMessage());
                 default -> { /* do nothing */ }
             }
         } catch (IOException e) {

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

@@ -145,7 +145,9 @@ private LevelResolver buildLevelResolver(
         Map<String, LogLevel> levelResolverLevels,
         LogLevel levelResolverDefaultLevel
     ) {
-        var builder = LevelResolver.create();
+        var builder = LevelResolver.create()
+            // This is needed if your spec uses composition via allOf, anyOf or oneOf.
+            .withLevel("validation.schema.additionalProperties", ValidationReport.Level.IGNORE);
         if (levelResolverLevels != null && !levelResolverLevels.isEmpty()) {
             builder.withLevels(
                 levelResolverLevels.entrySet().stream()
@@ -154,10 +156,10 @@ private LevelResolver buildLevelResolver(
                     )
             );
         }
-        return builder
-            // this will cause all messages to be warn by default
-            .withDefaultLevel(mapLevel(levelResolverDefaultLevel).orElse(ValidationReport.Level.INFO))
-            .build();
+
+        mapLevel(levelResolverDefaultLevel).ifPresent(builder::withDefaultLevel);
+
+        return builder.build();
     }
 
     private Optional<ValidationReport.Level> mapLevel(LogLevel level) {

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

@@ -3,6 +3,7 @@
 import static com.getyourguide.openapi.validation.OpenApiValidationApplicationProperties.PROPERTY_PREFIX;
 
 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.util.CommaSeparatedStringsUtil;
 import java.util.Arrays;
@@ -27,6 +28,7 @@ public class OpenApiValidationApplicationProperties {
 
     private Double sampleRate;
     private String specificationFilePath;
+    private LogLevel violationLogLevel;
     private Integer validationReportThrottleWaitSeconds;
     private String validationReportMetricName;
     private String validationReportMetricAdditionalTags;

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

@@ -91,7 +91,9 @@ public ValidationReportHandler validationReportHandler(
     public ValidatorConfiguration validatorConfiguration() {
         return new ValidatorConfigurationBuilder()
             // .levelResolverLevel("validation.request.body.schema.additionalProperties", LogLevel.IGNORE)
-            .levelResolverDefaultLevel(LogLevel.INFO)
+            .levelResolverDefaultLevel(
+                properties.getViolationLogLevel() != null ? properties.getViolationLogLevel() : LogLevel.INFO
+            )
             .build();
     }
 

spring-boot-starter/spring-boot-starter-core/src/main/resources/META-INF/spring-configuration-metadata.json

@@ -10,6 +10,11 @@
       "type": "java.lang.String",
       "description": "Path to the OpenAPI specification file. If set, the system will search for this file within resources and also as a path based on the current (working) directory. The property defaults to null. If null, the program searches for either an 'openapi.yaml/json' or a 'spec.yaml/json' file under resources."
     },
+    {
+      "name": "openapi.validation.violation-log-level",
+      "type": "com.getyourguide.openapi.validation.api.log.LogLevel",
+      "description": "Log level to be used for all violations. Default: info\nNote: This has no effect if a custom ValidatorConfiguration is provided, then it needs to be configured there."
+    },
     {
       "name": "openapi.validation.excluded-paths",
       "type": "java.lang.String",

spring-boot-starter/spring-boot-starter-core/src/test/java/com/getyourguide/openapi/validation/OpenApiValidationApplicationPropertiesTest.java

@@ -5,6 +5,7 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 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 java.util.List;
 import java.util.Set;
@@ -14,6 +15,7 @@ class OpenApiValidationApplicationPropertiesTest {
 
     private static final Double SAMPLE_RATE = 0.001;
     private static final String SPECIFICATION_FILE_PATH = "/tmp/openapi.yaml";
+    private static final LogLevel LOG_LEVEL = LogLevel.ERROR;
     private static final Integer VALIDATION_REPORT_THROTTLE_WAIT_SECONDS = 10;
     private static final String VALIDATION_REPORT_METRIC_NAME = "openapi_validation";
     private static final String VALIDATION_REPORT_METRIC_ADDITONAL_TAGS_STRING = "service=payment,team=chk";
@@ -25,6 +27,7 @@ void getters() {
         var loggingConfiguration = new OpenApiValidationApplicationProperties(
             SAMPLE_RATE,
             SPECIFICATION_FILE_PATH,
+            LOG_LEVEL,
             VALIDATION_REPORT_THROTTLE_WAIT_SECONDS,
             VALIDATION_REPORT_METRIC_NAME,
             VALIDATION_REPORT_METRIC_ADDITONAL_TAGS_STRING,
@@ -36,6 +39,7 @@ void getters() {
 
         assertEquals(SAMPLE_RATE, loggingConfiguration.getSampleRate());
         assertEquals(SPECIFICATION_FILE_PATH, loggingConfiguration.getSpecificationFilePath());
+        assertEquals(LOG_LEVEL, loggingConfiguration.getViolationLogLevel());
         assertEquals(VALIDATION_REPORT_THROTTLE_WAIT_SECONDS,
             loggingConfiguration.getValidationReportThrottleWaitSeconds());
         assertEquals(VALIDATION_REPORT_METRIC_NAME, loggingConfiguration.getValidationReportMetricName());