Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 7 commits into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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>();

Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

public interface MetricsReporter {
void reportViolation(OpenApiViolation violation);

void reportStartup(boolean isValidationEnabled);
}
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
);
}
}