Rename query/series to promql/series

linode-obs · Feb 9, 2022 · a0dc818 · a0dc818
1 parent 7eee024
commit a0dc818
Show file tree

Hide file tree

Showing 8 changed files with 138 additions and 131 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.10.0
+
+### Changed
+
+- `query/series` check was renamed to `promql/series`.
+
+
 ## v0.9.0
 
 ### Changed

diff --git a/cmd/pint/tests/0023_enabled_checks.txt b/cmd/pint/tests/0023_enabled_checks.txt
@@ -1,9 +1,9 @@
 pint.error -l debug --no-color lint rules
 ! stdout .
-stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","query/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/1.yaml rule=one'
-stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","query/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/1.yaml rule=two'
-stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","query/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/2.yaml rule=one'
-stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","query/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/2.yaml rule=two'
+stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","promql/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/1.yaml rule=one'
+stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","promql/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/1.yaml rule=two'
+stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","promql/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/2.yaml rule=one'
+stderr 'level=debug msg="Configured checks for rule" enabled=\["promql/syntax","alerts/for","promql/comparison","alerts/template","promql/fragile","promql/rate\(prom\)","promql/series\(prom\)","promql/vector_matching\(prom\)"\] path=rules/2.yaml rule=two'
 
 -- rules/1.yaml --
 - record: one

diff --git a/cmd/pint/tests/0025_config.txt b/cmd/pint/tests/0025_config.txt
@@ -29,7 +29,7 @@ level=info msg="Loading configuration file" path=.pint.hcl
       "promql/syntax",
       "promql/vector_matching",
       "query/cost",
-      "query/series",
+      "promql/series",
       "rule/label",
       "rule/reject"
     ]

diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -518,7 +518,7 @@ like memory pressure, Go version, GOGC settings etc.
 }
 ```
 
-## query/series
+## promql/series
 
 This check will also query Prometheus servers, it is used to warn about queries
 that are using metrics not currently present in Prometheus.
@@ -880,21 +880,21 @@ groups:
 
 Some checks allow to specify extra parameters.
 
-### query/series
+### promql/series
 
-You can disable `query/series` for specific metric using `# pint disable query/series(selector)`
+You can disable `promql/series` for specific metric using `# pint disable promql/series(selector)`
 comment.
 Just like with PromQL if a selector doesn't have any labels then it will match all instances,
 if you pass any labels it will only pass time series with those labels.
 
 Disable warnings about missing `my_metric_name`:
 
 ```YAML
-# pint disable query/series(my_metric_name)
+# pint disable promql/series(my_metric_name)
 ```
 
 Disable it only for `my_metric_name{cluster="dev"}` but still warn about `my_metric_name{cluster="prod"}`:
 
 ```YAML
-# pint disable query/series(my_metric_name{cluster="dev"})
+# pint disable promql/series(my_metric_name{cluster="dev"})
 ```
diff --git a/internal/checks/query_series.go → internal/checks/promql_series.go b/internal/checks/query_series.go → internal/checks/promql_series.go
@@ -12,7 +12,7 @@ import (
 )
 
 const (
-	SeriesCheckName = "query/series"
+	SeriesCheckName = "promql/series"
 )
 
 func NewSeriesCheck(prom *promapi.Prometheus) SeriesCheck {

diff --git a/internal/checks/query_series_test.go → internal/checks/promql_series_test.go b/internal/checks/query_series_test.go → internal/checks/promql_series_test.go
@@ -119,7 +119,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: "foo",
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     "query using prom failed with: bad_data: unhandled query",
 					Severity: checks.Bug,
 				},
@@ -133,7 +133,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: "notfound",
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     "query using prom completed without any results for notfound",
 					Severity: checks.Warning,
 				},
@@ -147,7 +147,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: "notfound",
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     "query using prom completed without any results for notfound",
 					Severity: checks.Warning,
 				},
@@ -161,7 +161,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: "notfound",
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     "query using prom completed without any results for notfound",
 					Severity: checks.Warning,
 				},
@@ -210,7 +210,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: `found{job="notfound"}`,
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     `query using prom completed without any results for found{job="notfound"}`,
 					Severity: checks.Warning,
 				},
@@ -224,7 +224,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: "notfound",
 					Lines:    []int{2},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     "query using prom completed without any results for notfound",
 					Severity: checks.Warning,
 				},
@@ -241,7 +241,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: `{__name__="notfound",job="bar"}`,
 					Lines:    []int{3},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     `query using prom completed without any results for {__name__="notfound",job="bar"}`,
 					Severity: checks.Warning,
 				},
@@ -250,7 +250,7 @@ func TestSeriesCheck(t *testing.T) {
 		{
 			description: "series missing but check disabled",
 			content: `
-# pint disable query/series(notfound)
+# pint disable promql/series(notfound)
 - record: foo
   expr: count(notfound) == 0
 `,
@@ -259,7 +259,7 @@ func TestSeriesCheck(t *testing.T) {
 		{
 			description: "series missing but check disabled, labels",
 			content: `
-# pint disable query/series(notfound)
+# pint disable promql/series(notfound)
 - record: foo
   expr: count(notfound{job="foo"}) == 0
 `,
@@ -268,7 +268,7 @@ func TestSeriesCheck(t *testing.T) {
 		{
 			description: "series missing but check disabled, negative labels",
 			content: `
-# pint disable query/series(notfound)
+# pint disable promql/series(notfound)
 - record: foo
   expr: count(notfound{job!="foo"}) == 0
 `,
@@ -277,7 +277,7 @@ func TestSeriesCheck(t *testing.T) {
 		{
 			description: "series missing, disabled comment for labels",
 			content: `
-# pint disable query/series(notfound{job="foo"})
+# pint disable promql/series(notfound{job="foo"})
 - record: foo
   expr: count(notfound) == 0
 `,
@@ -286,7 +286,7 @@ func TestSeriesCheck(t *testing.T) {
 				{
 					Fragment: `notfound`,
 					Lines:    []int{4},
-					Reporter: "query/series",
+					Reporter: "promql/series",
 					Text:     `query using prom completed without any results for notfound`,
 					Severity: checks.Warning,
 				},