Merge pull request #671 from slok/slok/contrib-plugins-sync

slok · web-flow · commit ac9e4a40e41b · 2025-09-22T13:49:22.000+02:00
Add rule intervals SLO plugin
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -7,3 +7,4 @@
 # Specific contrib SLO owners.
 /internal/plugin/slo/contrib/info_labels_v1/                @cxdy @slok @wbollock
 /internal/plugin/slo/contrib/validate_victoria_metrics_v1/  @slok
+/internal/plugin/slo/contrib/rule_intervals_v1/             @cxdy @slok @wbollock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 - Contrib plugin: `/internal/plugin/slo/contrib/info_labels_v1/`.
 - Allow `github.com/VictoriaMetrics/metricsql` module in SLO plugins.
 - Contrib plugin: `sloth.dev/contrib/validate_victoria_metrics/v1`.
+- Contrib plugin: `sloth.dev/contrib/rule_intervals/v1`.
 
 ## [v0.13.0] - 2025-09-10
 
diff --git a/examples/_gen/contrib-slo-plugins.yml b/examples/_gen/contrib-slo-plugins.yml
@@ -250,3 +250,249 @@ groups:
       summary: High error rate on 'myservice' requests responses
       title: (ticket) {{$labels.sloth_service}} {{$labels.sloth_slo}} SLO error budget
         burn rate is too fast.
+- name: sloth-slo-sli-recordings-myservice-requests-availability-contrib-plugin-rule-intervals-v1
+  interval: 5m
+  rules:
+  - record: slo:sli_error:ratio_rate5m
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[5m])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[5m])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 5m
+      tier: "2"
+  - record: slo:sli_error:ratio_rate30m
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[30m])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[30m])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 30m
+      tier: "2"
+  - record: slo:sli_error:ratio_rate1h
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[1h])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[1h])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 1h
+      tier: "2"
+  - record: slo:sli_error:ratio_rate2h
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[2h])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[2h])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 2h
+      tier: "2"
+  - record: slo:sli_error:ratio_rate6h
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[6h])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[6h])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 6h
+      tier: "2"
+  - record: slo:sli_error:ratio_rate1d
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[1d])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[1d])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 1d
+      tier: "2"
+  - record: slo:sli_error:ratio_rate3d
+    expr: |
+      (sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[3d])))
+      /
+      (sum(rate(http_request_duration_seconds_count{job="myservice"}[3d])))
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 3d
+      tier: "2"
+  - record: slo:sli_error:ratio_rate30d
+    expr: |
+      sum_over_time(slo:sli_error:ratio_rate5m{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}[30d])
+      / ignoring (sloth_window)
+      count_over_time(slo:sli_error:ratio_rate5m{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}[30d])
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_window: 30d
+      tier: "2"
+- name: sloth-slo-meta-recordings-myservice-requests-availability-contrib-plugin-rule-intervals-v1
+  interval: 5m
+  rules:
+  - record: slo:objective:ratio
+    expr: vector(0.9990000000000001)
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: slo:error_budget:ratio
+    expr: vector(1-0.9990000000000001)
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: slo:time_period:days
+    expr: vector(30)
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: slo:current_burn_rate:ratio
+    expr: |
+      slo:sli_error:ratio_rate5m{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}
+      / on(sloth_id, sloth_slo, sloth_service) group_left
+      slo:error_budget:ratio{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: slo:period_burn_rate:ratio
+    expr: |
+      slo:sli_error:ratio_rate30d{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}
+      / on(sloth_id, sloth_slo, sloth_service) group_left
+      slo:error_budget:ratio{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: slo:period_error_budget_remaining:ratio
+    expr: 1 - slo:period_burn_rate:ratio{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1",
+      sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"}
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      tier: "2"
+  - record: sloth_slo_info
+    expr: vector(1)
+    labels:
+      cmd: examplesgen.sh
+      owner: myteam
+      repo: myorg/myservice
+      sloth_id: myservice-requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_mode: cli-gen-prom
+      sloth_objective: "99.9"
+      sloth_service: myservice
+      sloth_slo: requests-availability-contrib-plugin-rule-intervals-v1
+      sloth_spec: prometheus/v1
+      sloth_version: dev
+      tier: "2"
+- name: sloth-slo-alerts-myservice-requests-availability-contrib-plugin-rule-intervals-v1
+  interval: 5m
+  rules:
+  - alert: MyServiceHighErrorRate
+    expr: |
+      (
+          max(slo:sli_error:ratio_rate5m{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (14.4 * 0.0009999999999999432)) without (sloth_window)
+          and
+          max(slo:sli_error:ratio_rate1h{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (14.4 * 0.0009999999999999432)) without (sloth_window)
+      )
+      or
+      (
+          max(slo:sli_error:ratio_rate30m{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (6 * 0.0009999999999999432)) without (sloth_window)
+          and
+          max(slo:sli_error:ratio_rate6h{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (6 * 0.0009999999999999432)) without (sloth_window)
+      )
+    labels:
+      category: availability
+      routing_key: myteam
+      severity: pageteam
+      sloth_severity: page
+    annotations:
+      summary: High error rate on 'myservice' requests responses
+      title: (page) {{$labels.sloth_service}} {{$labels.sloth_slo}} SLO error budget
+        burn rate is too fast.
+  - alert: MyServiceHighErrorRate
+    expr: |
+      (
+          max(slo:sli_error:ratio_rate2h{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (3 * 0.0009999999999999432)) without (sloth_window)
+          and
+          max(slo:sli_error:ratio_rate1d{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (3 * 0.0009999999999999432)) without (sloth_window)
+      )
+      or
+      (
+          max(slo:sli_error:ratio_rate6h{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (1 * 0.0009999999999999432)) without (sloth_window)
+          and
+          max(slo:sli_error:ratio_rate3d{sloth_id="myservice-requests-availability-contrib-plugin-rule-intervals-v1", sloth_service="myservice", sloth_slo="requests-availability-contrib-plugin-rule-intervals-v1"} > (1 * 0.0009999999999999432)) without (sloth_window)
+      )
+    labels:
+      category: availability
+      severity: slack
+      slack_channel: '#alerts-myteam'
+      sloth_severity: ticket
+    annotations:
+      summary: High error rate on 'myservice' requests responses
+      title: (ticket) {{$labels.sloth_service}} {{$labels.sloth_slo}} SLO error budget
+        burn rate is too fast.
diff --git a/examples/contrib-slo-plugins.yml b/examples/contrib-slo-plugins.yml
@@ -36,3 +36,32 @@ slos:
         labels:
           severity: "slack"
           slack_channel: "#alerts-myteam"
+
+  - name: "requests-availability-contrib-plugin-rule-intervals-v1"
+    objective: 99.9
+    description: "Common SLO based on availability for HTTP request responses."
+    plugins:
+      chain:
+        - id: "sloth.dev/contrib/rule_intervals/v1"
+          config:
+            interval:
+              default: 5m
+    sli:
+      events:
+        error_query: sum(rate(http_request_duration_seconds_count{job="myservice",code=~"(5..|429)"}[{{.window}}]))
+        total_query: sum(rate(http_request_duration_seconds_count{job="myservice"}[{{.window}}]))
+    alerting:
+      name: MyServiceHighErrorRate
+      labels:
+        category: "availability"
+      annotations:
+        # Overwrite default Sloth SLO alert summmary on ticket and page alerts.
+        summary: "High error rate on 'myservice' requests responses"
+      page_alert:
+        labels:
+          severity: pageteam
+          routing_key: myteam
+      ticket_alert:
+        labels:
+          severity: "slack"
+          slack_channel: "#alerts-myteam"
diff --git a/internal/plugin/slo/contrib/rule_intervals_v1/README.md b/internal/plugin/slo/contrib/rule_intervals_v1/README.md
@@ -0,0 +1,46 @@
+# sloth.dev/contrib/rule_intervals/v1
+
+This plugin sets Prom rule evaluation intervals to the Prometheus generated rules. The intervals can be different depending on the type of rules, SLI, metadata and alerts. A default interval can be set for all rules.
+
+## Config
+
+| Field             | Type                     | Required | Default | Description                                                       |
+|-------------------|--------------------------|----------|---------|-------------------------------------------------------------------|
+| `interval.default` | Prom time duration string  | Yes      | —       | Fallback interval to use if no other interval is set.             |
+| `interval.sliError`| Prom time duration string  | No       | —       | Evaluation rule interval for generated SLI error rules.           |
+| `interval.metadata`| Prom time duration string  | No       | —       | Evaluation rule interval for generated metadata rules.            |
+| `interval.alert`   | Prom time duration string  | No       | —       | Evaluation rule interval for generated alert rules.               |
+
+## Env var
+
+None
+
+## Order requirement
+
+This plugin must be placed **after** all rule generation.
+
+## Usage examples
+
+### Specific settings in an SLO group
+
+```yaml
+slo_plugins:
+  chain:
+    - id: sloth.dev/contrib/rule_intervals/v1
+      config:
+        interval:
+          default: 1m
+          sliError: 42s
+          metadata: 55s
+          alert: 11s
+```
+
+### Add a custom default interval to all rules and SLOs
+
+By adding a default interval at app level, all generated rules by sloth will have that interval
+
+```bash
+sloth generate \
+  -i ./examples/getting-started.yml \
+  -s '{"id": "sloth.dev/contrib/rule_intervals/v1","config":{"interval": {"default":"2m"}}}'
+```
diff --git a/internal/plugin/slo/contrib/rule_intervals_v1/plugin.go b/internal/plugin/slo/contrib/rule_intervals_v1/plugin.go
diff --git a/internal/plugin/slo/contrib/rule_intervals_v1/plugin_test.go b/internal/plugin/slo/contrib/rule_intervals_v1/plugin_test.go
