cloudflare/pint

Public

v0.42.0

Find a branch or tag

HTTPS

docs/checks/promql/syntax.md

48lines · modecode

unknown

1	`---`
2	`layout: default`
3	`parent: Checks`
4	`grand_parent: Documentation`
5	`---`
6
7	`# promql/syntax`
8
9	`This is the most basic check that will report any syntax errors in a PromQL`
10	`query on any rule.`
11
12	`## Configuration`
13
14	`This check doesn't have any configuration options.`
15
16	`## How to enable it`
17
18	`This check is enabled by default.`
19
20	`## How to disable it`
21
22	`You can disable this check globally by adding this config block:`
23
24	```js
25	`checks {`
26	`disabled = ["promql/syntax"]`
27	`}`
28	```
29
30	`You can also disable it for all rules inside given file by adding`
31	`a comment anywhere in that file. Example:`
32
33	`# pint file/disable promql/syntax`
34
35	`Or you can disable it per rule by adding a comment to it. Example:`
36
37	`# pint disable promql/syntax`
38
39	`## How to snooze it`
40
41	`You can disable this check until given time by adding a comment to it. Example:`
42
43	`# pint snooze $TIMESTAMP promql/syntax`
44
45	Where `$TIMESTAMP` is either use [RFC3339](https://www.rfc-editor.org/rfc/rfc3339)
46	formatted or `YYYY-MM-DD`.
47	Adding this comment will disable `promql/syntax` until `$TIMESTAMP`, after that
48	`check will be re-enabled.`
49