Merge pull request #1340 from cloudflare/comments2

Use collapsible blocks for comments

Author: prymitive

.github/pint/rules/1.yml

@@ -10,7 +10,11 @@ groups:
 
   - alert: Service Is Missing
     expr: absent({job="myjob"})
-    for: 0m
+    for: 0s
 
   - alert: Everything Is Down
     expr: up:sum == 0
+
+  - alert: Dead Code
+    expr: |
+      sum(foo or vector(0)) by(name) > 0

cmd/pint/tests/0001_match_path.txt

@@ -9,8 +9,8 @@ level=INFO msg="Checking Prometheus rules" entries=2 workers=10 online=true
 Bug: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0002.yml:2 -> `colo:test2`
 2 |   expr: sum(foo) without(job)
-  |                  ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
-  |                          `job` label is required and should be preserved when aggregating all rules.
+                     ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
+                             `job` label is required and should be preserved when aggregating all rules.
 
 level=INFO msg="Problems found" Bug=1
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0003_lint_workdir.txt

@@ -10,60 +10,60 @@ level=INFO msg="Checking Prometheus rules" entries=17 workers=10 online=true
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0001.yml:2 -> `colo_job:fl_cf_html_bytes_in:rate10m`
 2 |   expr: sum(rate(fl_cf_html_bytes_in[10m])) WITHOUT (colo_id, instance, node_type, region, node_status, job, colo_name)
-  |                                             ^^^^^^^^ Query is using aggregation with `without(colo_id, instance, node_type, region, node_status, job, colo_name)`, all labels included inside `without(...)` will be removed from the results.
-  |                                                      `job` label is required and should be preserved when aggregating all rules.
+                                                ^^^^^^^^ Query is using aggregation with `without(colo_id, instance, node_type, region, node_status, job, colo_name)`, all labels included inside `without(...)` will be removed from the results.
+                                                         `job` label is required and should be preserved when aggregating all rules.
 
 Warning: label must be removed in aggregations (promql/aggregate)
   ---> rules/0001.yml:6 -> `colo_job:foo:irate3m`
 6 |   expr: sum(irate(foo[3m])) WITHOUT (colo_id)
-  |                             ^^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
+                                ^^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
 
 Warning: redundant regexp (promql/regexp)
   ---> rules/0002.yaml:2 -> `colo_job:down:count`
 2 |   expr: up{job=~"foo"} == 0
-  |            ^^^^^^^^^^ Unnecessary regexp match on static string `job=~"foo"`, use `job="foo"` instead.
+               ^^^^^^^^^^ Unnecessary regexp match on static string `job=~"foo"`, use `job="foo"` instead.
 
 Warning: redundant regexp (promql/regexp)
   ---> rules/0002.yaml:5 -> `colo_job:down:count`
 5 |   expr: up{job!~"foo"} == 0
-  |            ^^^^^^^^^^ Unnecessary regexp match on static string `job!~"foo"`, use `job!="foo"` instead.
+               ^^^^^^^^^^ Unnecessary regexp match on static string `job!~"foo"`, use `job!="foo"` instead.
 
 Warning: label must be removed in aggregations (promql/aggregate)
   ---> rules/0003.yaml:11 -> `colo_job:up:count`
 11 |   expr: sum(foo) without(job)
-   |                  ^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
+                      ^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0003.yaml:11 -> `colo_job:up:count`
 11 |   expr: sum(foo) without(job)
-   |                  ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
-   |                          `job` label is required and should be preserved when aggregating all rules.
+                      ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
+                              `job` label is required and should be preserved when aggregating all rules.
 
 Fatal: PromQL syntax error (promql/syntax)
   ---> rules/0003.yaml:14 -> `invalid`
 14 |   expr: sum(foo) by ())
-   |                       ^ unexpected right parenthesis ')'
+                           ^ unexpected right parenthesis ')'
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0003.yaml:23-25 -> `colo:multiline`
 23 |     sum(
 24 |       multiline
 25 |     ) without(job, instance)
-   |       ^^^^^^^ Query is using aggregation with `without(job, instance)`, all labels included inside `without(...)` will be removed from the results.
-   |               `job` label is required and should be preserved when aggregating all rules.
+           ^^^^^^^ Query is using aggregation with `without(job, instance)`, all labels included inside `without(...)` will be removed from the results.
+                   `job` label is required and should be preserved when aggregating all rules.
 
 Warning: label must be removed in aggregations (promql/aggregate)
   ---> rules/0003.yaml:29-31 -> `colo:multiline:sum`
 29 |     sum(sum) without(job)
-   |              ^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
+                  ^^^^^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
 30 |     +
 31 |     sum(sum) without(job)
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0003.yaml:29-31 -> `colo:multiline:sum`
 29 |     sum(sum) without(job)
-   |              ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
-   |                      `job` label is required and should be preserved when aggregating all rules.
+                  ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
+                          `job` label is required and should be preserved when aggregating all rules.
 30 |     +
 31 |     sum(sum) without(job)
 
@@ -72,27 +72,27 @@ Warning: required label is being removed via aggregation (promql/aggregate)
 35 |     sum(
 36 |       multiline2
 37 |     ) without(job, instance)
-   |       ^^^^^^^ Query is using aggregation with `without(job, instance)`, all labels included inside `without(...)` will be removed from the results.
-   |               `job` label is required and should be preserved when aggregating all rules.
+           ^^^^^^^ Query is using aggregation with `without(job, instance)`, all labels included inside `without(...)` will be removed from the results.
+                   `job` label is required and should be preserved when aggregating all rules.
 
 Warning: label must be removed in aggregations (promql/aggregate)
   ---> rules/0003.yaml:40 -> `colo_job:up:byinstance`
 40 |   expr: sum(byinstance) by(instance)
-   |                         ^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
+                             ^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0003.yaml:40 -> `colo_job:up:byinstance`
 40 |   expr: sum(byinstance) by(instance)
-   |                         ^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
-   |                            `job` label is required and should be preserved when aggregating all rules.
+                             ^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
+                                `job` label is required and should be preserved when aggregating all rules.
 
 Information: use humanize filters for the results (alerts/template)
   ---> rules/0003.yaml:58-61 -> `Error Rate`
 58 |   expr: sum(rate(errors[5m])) > 0.5
-   |             ^^^^^^^^^^^^^^^^ `rate()` will produce results that are hard to read for humans.
+                 ^^^^^^^^^^^^^^^^ `rate()` will produce results that are hard to read for humans.
    | [...]
 61 |     summary: 'error rate: {{ $value }}'
-   |               ^^^^^^^^^^^^^^^^^^^^^^^^ Use one of humanize template functions to make the result more readable.
+                   ^^^^^^^^^^^^^^^^^^^^^^^^ Use one of humanize template functions to make the result more readable.
 
 level=INFO msg="Problems found" Fatal=1 Warning=12 Information=1
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0004_fail_invalid_yaml.txt

@@ -15,7 +15,7 @@ Fatal: did not find expected key (yaml/parse)
 Fatal: PromQL syntax error (promql/syntax)
   ---> rules/ok.yml:5 -> `sum:missing`
 5 |     expr: sum(foo[5m)
-  |                     ^ unclosed left bracket
+                        ^ unclosed left bracket
 
 level=INFO msg="Problems found" Fatal=2
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0007_alerts.txt

@@ -9,67 +9,67 @@ level=INFO msg="Checking Prometheus rules" entries=6 workers=10 online=true
 Warning: required label not set (rule/label)
   ---> rules/0001.yml:1-2 -> `Always`
 2 |   expr: up
-  |         ^^ `severity` label is required.
+            ^^ `severity` label is required.
 
 Bug: required annotation not set (alerts/annotation)
   ---> rules/0001.yml:1-2 -> `Always`
 2 |   expr: up
-  |         ^^ `url` annotation is required.
+            ^^ `url` annotation is required.
 
 Warning: always firing alert (alerts/comparison)
   ---> rules/0001.yml:2 -> `Always`
 2 |   expr: up
-  |         ^^ Alert query doesn't have any condition, it will always fire if the metric exists.
+            ^^ Alert query doesn't have any condition, it will always fire if the metric exists.
 
 Warning: required label not set (rule/label)
   ---> rules/0001.yml:9-10 -> `ServiceIsDown`
 10 |   expr: up == 0
-   |         ^^^ `severity` label is required.
+             ^^^ `severity` label is required.
 
 Bug: required annotation not set (alerts/annotation)
   ---> rules/0001.yml:9-10 -> `ServiceIsDown`
 10 |   expr: up == 0
-   |         ^^^ `url` annotation is required.
+             ^^^ `url` annotation is required.
 
 Warning: invalid label value (rule/label)
   ---> rules/0001.yml:14 -> `ServiceIsDown`
 14 |     severity: bad
-   |               ^^^ `severity` label value must match `^critical|warning|info$`.
+                   ^^^ `severity` label value must match `^critical|warning|info$`.
 
 Bug: invalid annotation value (alerts/annotation)
   ---> rules/0001.yml:16 -> `ServiceIsDown`
 16 |     url: bad
-   |          ^^^ `url` annotation value must match `^https://wiki.example.com/page/(.+).html$`.
+              ^^^ `url` annotation value must match `^https://wiki.example.com/page/(.+).html$`.
 
 Fatal: template syntax error (alerts/template)
   ---> rules/0002.yml:5 -> `Foo Is Down`
 5 |     summary: 'Instance {{ $label.instance }} down'
-  |               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$label"`.
+                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$label"`.
 
 Fatal: template syntax error (alerts/template)
   ---> rules/0002.yml:6 -> `Foo Is Down`
 6 |     func: '{{ $valuexx | xxx }}'
-  |            ^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$valuexx"`.
+               ^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$valuexx"`.
 
 Fatal: template syntax error (alerts/template)
   ---> rules/0002.yml:9 -> `Foo Is Down`
 9 |     summary: 'Instance {{ $label.instance }} down'
-  |               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$label"`.
+                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `undefined variable "$label"`.
 
 Fatal: template syntax error (alerts/template)
   ---> rules/0002.yml:10 -> `Foo Is Down`
 10 |     func: '{{ $value | xxx }}'
-   |            ^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `function "xxx" not defined`.
+                ^^^^^^^^^^^^^^^^^^ Template failed to parse with this error: `function "xxx" not defined`.
 
 Bug: value used in labels (alerts/template)
   ---> rules/0002.yml:11 -> `Foo Is Down`
 11 |     bar: 'Some {{$value}} value'
-   |           ^^^^^^^^^^^^^^^^^^^^^ Using `$value` in labels will generate a new alert on every value change, move it to annotations.
+               ^^^^^^^^^^^^^^^^^^^^^ Using `$value` in labels will generate a new alert on every value change, move it to annotations.
 
 Bug: value used in labels (alerts/template)
   ---> rules/0002.yml:12 -> `Foo Is Down`
 12 |     val: '{{ .Value|humanizeDuration }}'
-   |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Using `.Value` in labels will generate a new alert on every value change, move it to annotations.
+               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Using `.Value` in labels will generate a new alert on every value change, move it to annotations.
 
 level=INFO msg="Problems found" Fatal=4 Bug=5 Warning=4
 level=ERROR msg="Execution completed with error(s)" err="found 2 problem(s) with severity Bug or higher"

cmd/pint/tests/0008_recording_rule_prometheus.txt

@@ -9,13 +9,13 @@ level=INFO msg="Checking Prometheus rules" entries=1 workers=10 online=true
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0001.yml:5 -> `colo:http_inprogress_requests:sum`
 5 |       expr: sum by (instance) (http_inprogress_requests)
-  |                 ^^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
-  |                     `job` label is required and should be preserved when aggregating all rules.
+                    ^^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
+                        `job` label is required and should be preserved when aggregating all rules.
 
 Bug: label must be removed in aggregations (promql/aggregate)
   ---> rules/0001.yml:5 -> `colo:http_inprogress_requests:sum`
 5 |       expr: sum by (instance) (http_inprogress_requests)
-  |                 ^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
+                    ^^^ `instance` label should be removed when aggregating `^colo(?:_.+)?:.+$` rules.
 
 level=INFO msg="Problems found" Bug=1 Warning=1
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0009_alerting_rule_prometheus.txt

@@ -9,18 +9,18 @@ level=INFO msg="Checking Prometheus rules" entries=2 workers=10 online=true
 Bug: required annotation not set (alerts/annotation)
   ---> rules/0001.yml:6-13 -> `InstanceDown`
 13 |       description: "{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 5 minutes."
-   |       ^^^ `link` annotation is required.
+           ^^^ `link` annotation is required.
 
 Bug: required annotation not set (alerts/annotation)
   ---> rules/0001.yml:16-21 -> `APIHighRequestLatency`
 21 |       description: "{{ $labels.instance }} has a median request latency above 1s (current value: {{ $value }}s)"
-   |       ^^^ `link` annotation is required.
+           ^^^ `link` annotation is required.
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/0001.yml:17 -> `APIHighRequestLatency`
 17 |     expr: sum by (instance) (http_inprogress_requests) > 0
-   |               ^^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
-   |                   `job` label is required and should be preserved when aggregating all rules.
+                   ^^^ Query is using aggregation with `by(instance)`, only labels included inside `by(...)` will be present on the results.
+                       `job` label is required and should be preserved when aggregating all rules.
 
 level=INFO msg="Problems found" Bug=2 Warning=1
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0011_ignore_rules.txt

@@ -9,29 +9,29 @@ level=INFO msg="Checking Prometheus rules" entries=10 workers=10 online=true
 Fatal: PromQL syntax error (promql/syntax)
   ---> rules/1.yaml:5 -> `active`
 5 |   expr: sum(errors_total) by )
-  |                              ^ unexpected right parenthesis ')'
+                                 ^ unexpected right parenthesis ')'
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/1.yaml:16 -> `active`
 16 |   expr: sum(errors_total) without(job)
-   |                           ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
-   |                                   `job` label is required and should be preserved when aggregating all rules.
+                               ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
+                                       `job` label is required and should be preserved when aggregating all rules.
 
 Fatal: PromQL syntax error (promql/syntax)
   ---> rules/1.yaml:22 -> `active`
 22 |   expr: sum(errors_total) by )
-   |                              ^ unexpected right parenthesis ')'
+                                  ^ unexpected right parenthesis ')'
 
 Warning: always firing alert (alerts/comparison)
   ---> rules/1.yaml:33 -> `active`
 33 |   expr: sum(errors_total) without(job)
-   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Alert query doesn't have any condition, it will always fire if the metric exists.
+             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Alert query doesn't have any condition, it will always fire if the metric exists.
 
 Warning: required label is being removed via aggregation (promql/aggregate)
   ---> rules/1.yaml:33 -> `active`
 33 |   expr: sum(errors_total) without(job)
-   |                           ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
-   |                                   `job` label is required and should be preserved when aggregating all rules.
+                               ^^^^^^^ Query is using aggregation with `without(job)`, all labels included inside `without(...)` will be removed from the results.
+                                       `job` label is required and should be preserved when aggregating all rules.
 
 level=INFO msg="Problems found" Fatal=2 Warning=3
 level=ERROR msg="Execution completed with error(s)" err="found 1 problem(s) with severity Bug or higher"

cmd/pint/tests/0012_issue_20.txt

@@ -9,7 +9,7 @@ level=INFO msg="Checking Prometheus rules" entries=1 workers=10 online=true
 Warning: required annotation not set (alerts/annotation)
   ---> rules/1.yaml:4-11 -> `HaproxyServerHealthcheckFailure`
 11 |           description: "Some server healthcheck are failing on {{ $labels.server }}\n  VALUE = {{ $value }}\n  LABELS: {{ $labels }}"
-   |           ^^^ `runbook_url` annotation is required.
+               ^^^ `runbook_url` annotation is required.
 
 level=INFO msg="Problems found" Warning=1
 -- rules/1.yaml --