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

Ocd 3402 verifications baseline #558

Merged
merged 6 commits into from
Dec 5, 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
13 changes: 13 additions & 0 deletions api/services/ocean/cd/schemas/oceanCDRolloutBaseline.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
type: object
title: Ocean CD Verification Baseline
description: Represents object of Verification Baseline
properties:
baselineResult:
type: number
format: double
example: 2.453
description: describe the baseline metric result
metric:
type: object
$ref: "./oceanCDRolloutBaselineMetric.yaml"
description: describe the baseline metric
13 changes: 13 additions & 0 deletions api/services/ocean/cd/schemas/oceanCDRolloutBaselineMetric.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
type: object
title: Ocean CD Verification Baseline Metric
description: Represents object of Verification Baseline Metric
properties:
threshold:
type: string
example: "<"
description: represent the baseline threshold
enum: [ "<", "<=", ">", ">=", "=", "range" ]
provider:
description: represent the baseline provider.
type: object
$ref: "./oceanCDRolloutBaselineMetricProvider.yaml"
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
type: object
title: Ocean CD Verification Baseline Metric Provider
description: Represents object of Verification Baseline Metric Provider
properties:
prometheus:
type: object
$ref: "./verificationTemplate/oceanCDVerificationTemplateMetricPrometheus.yaml"
newRelic:
type: object
$ref: "./verificationTemplate/oceanCDVerificationTemplateMetricNewRelic.yaml"
datadog:
type: object
$ref: "./verificationTemplate/oceanCDVerificationTemplateMetricDatadog.yaml"
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ properties:
type: string
description: The step where the failure/success comes from
example: "1"
baseline:
type: object
description: Describe baseline metric such as metric, threshold and result
$ref: "./oceanCDRolloutBaseline.yaml"
providerDetails:
type: object
description: The chosen for the metric monitoring tool's details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,6 @@ properties:
provider:
type: object
$ref: "oceanCDVerificationTemplateMetricProvider.yaml"
baseline:
type: objet
$ref: "oceanCDVerificationTemplateMetricBaseline.yaml"
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
type: object
required:
- threshold
- provider
title: Ocean CD Verification Metric Baseline
properties:
threshold:
type: string
enum: ["<", ">", "<=", ">=", "=", "range"]
description: A mathematical expression needed for the comparison
example: ">"
minRange:
type: integer
example: 45
description: Number in percent we allow the new version’s data result to be under baseline data result
maxRange:
type: integer
example: 55
description: Number in percent we allow the new version’s data result to be under baseline data result
provider:
type: object
$ref: "oceanCDVerificationTemplateMetricBaselineProvider.yaml"
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
type: object
title: Ocean CD Verification Metric Baseline Provider, only one provider type can be defined and it must be equal to the metric provider
description: The name of the monitoring tool chosen for the metric
properties:
prometheus:
type: object
$ref: "oceanCDVerificationTemplateMetricPrometheus.yaml"
newRelic:
type: object
$ref: "oceanCDVerificationTemplateMetricNewRelic.yaml"
datadog:
type: object
$ref: "oceanCDVerificationTemplateMetricDatadog.yaml"
Loading