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

feat: add new sli-value library for cwsynth #634

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
16 changes: 16 additions & 0 deletions monitoring-as-code/mixin-defs/testing-mixin.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,22 @@ local sliSpecList = {
},
},
},
SLI23: {
title: 'cw synth success',
sliDescription: 'cw synth success',
period: '30d',
metricType: 'aws_cwsynthetics_success_check',
evalInterval: '5m',
selectors: {
product: 'test',
},
sloTarget: 90,
sliTypes: {
availability: {
counterIntegerTarget: 100,
},
},
},
},
};

Expand Down
25 changes: 25 additions & 0 deletions monitoring-as-code/src/metric-types.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -776,4 +776,29 @@
targetMetrics: {},
},
},
aws_cwsynthetics_success_check: {
metricTypeConfig: {
selectorLabels: {
environment: 'environment',
product: 'job',
},
metrics: {
averageSuccess: 'aws_cloudwatchsynthetics_success_percent_average',
},
},
sliTypesConfig: {
availability: {
library: (import 'sli-value-libraries/availability-gauge-with-success-metric-and-integer-target.libsonnet'),
description: 'Error rate for %(sliDescription)s should be below %(metric_target_percent)0.1f%%',
targetMetrics: {
target: 'averageSuccess',
},
},
},
detailDashboardConfig: {
standardTemplates: [],
elements: [],
targetMetrics: {},
},
},
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
// Divides the count of target metric samples above availability target by the overall count of samples
// target metric samples taken from average-using-single-metric

// Target metrics:
// target - Metric to get the average value of over evaluation interval

// Additional config:
// counterIntegerTarget in SLI spec

// MaC imports
local sliValueLibraryFunctions = import '../util/sli-value-library-functions.libsonnet';

// Grafana imports
local grafana = import 'grafonnet/grafana.libsonnet';
local prometheus = grafana.prometheus;
local graphPanel = grafana.graphPanel;

// Creates the custom SLI value rule
// @param sliSpec The spec for the SLI having its recording rules created
// @param sliMetadata Metadata about the type and category of the SLI
// @param config The config for the service defined in the mixin file
// @returns JSON defining the recording rule
local createSliValueRule(sliSpec, sliMetadata, config) =
local metricConfig = sliValueLibraryFunctions.getMetricConfig(sliSpec);
local ruleSelectors = sliValueLibraryFunctions.createRuleSelectors(metricConfig, sliSpec, config);
local targetMetrics = sliValueLibraryFunctions.getTargetMetrics(metricConfig, sliSpec);
local selectorLabels = sliValueLibraryFunctions.getSelectorLabels(metricConfig);

[
{
record: 'sli_value',
expr: |||
sum without (%(selectorLabels)s) (label_replace(label_replace(
(
sum by(%(selectorLabels)s) (avg_over_time((%(targetMetric)s{%(selectors)s} < bool %(counterIntegerTarget)s)[%(evalInterval)s:%(evalInterval)s]))
/
count by(%(selectorLabels)s) (count_over_time(%(targetMetric)s{%(selectors)s}[%(evalInterval)s]))
),
"sli_environment", "$1", "%(environmentSelectorLabel)s", "(.*)"), "sli_product", "$1", "%(productSelectorLabel)s", "(.*)"))
||| % {
targetMetric: targetMetrics.target,
counterIntegerTarget: sliSpec.counterIntegerTarget,
selectorLabels: std.join(', ', std.objectValues(selectorLabels)),
environmentSelectorLabel: selectorLabels.environment,
productSelectorLabel: selectorLabels.product,
selectors: std.join(', ', ruleSelectors),
evalInterval: sliSpec.evalInterval,
},
labels: sliSpec.sliLabels + sliMetadata,
},
];

// Creates Grafana dashboard graph panel
// @param sliSpec The spec for the SLI having its dashboard created
// @returns Grafana graph panel object
local createGraphPanel(sliSpec) =
local metricConfig = sliValueLibraryFunctions.getMetricConfig(sliSpec);
local dashboardSelectors = sliValueLibraryFunctions.createDashboardSelectors(metricConfig, sliSpec);
local targetMetrics = sliValueLibraryFunctions.getTargetMetrics(metricConfig, sliSpec);

graphPanel.new(
title='%s' % sliSpec.sliDescription,
datasource='prometheus',
description=|||
* Sample interval is %(evalInterval)s
* Selectors are %(selectors)s
||| % {
selectors: std.strReplace(std.join(', ', sliValueLibraryFunctions.getSelectors(metricConfig, sliSpec)), '~', '\\~'),
evalInterval: sliSpec.evalInterval,
},
min=0,
fill=4,
).addTarget(
prometheus.target(
|||
sum(avg_over_time(%(targetMetric)s{%(selectors)s}[%(evalInterval)s]) == %(counterIntegerTarget)s or vector(0))
||| % {
targetMetric: targetMetrics.target,
counterIntegerTarget: sliSpec.counterIntegerTarget,
selectors: std.join(',', dashboardSelectors),
evalInterval: sliSpec.evalInterval,
},
legendFormat='avg success',
),
).addTarget(
prometheus.target(
|||
sum(avg_over_time((%(targetMetric)s{%(selectors)s} < bool %(counterIntegerTarget)s)[%(evalInterval)s:%(evalInterval)s]) or vector(0))
/
count(count_over_time(%(targetMetric)s{%(selectors)s}[%(evalInterval)s]))
||| % {
targetMetric: targetMetrics.target,
counterIntegerTarget: sliSpec.counterIntegerTarget,
selectors: std.join(',', dashboardSelectors),
evalInterval: sliSpec.evalInterval,
},
legendFormat='avg period where status failures > %s' % sliSpec.counterIntegerTarget,
)
).addSeriesOverride(
{
alias: '/avg period where status failures > %s/' % sliSpec.counterIntegerTarget,
color: 'red',
},
).addSeriesOverride(
{
alias: '/avg success/',
color: 'green',
},
);

// File exports
{
createSliValueRule(sliSpec, sliMetadata, config): createSliValueRule(sliSpec, sliMetadata, config),
createGraphPanel(sliSpec): createGraphPanel(sliSpec),
}
Loading