resolve comments

* reformat on and ignoring keywords doc * add sharding unit test for on and ignoring keywords
grafana · Oct 2, 2021 · 48314f3 · 48314f3
1 parent 8f2e0b5
commit 48314f3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 5 deletions.
diff --git a/docs/sources/logql/_index.md b/docs/sources/logql/_index.md
@@ -143,16 +143,23 @@ More details can be found in the [Golang language documentation](https://golang.
 
 `2 * 3 % 2` is evaluated as `(2 * 3) % 2`.
 
-### On and Ignoring keywords
-
-The `ignoring` keyword allows ignoring certain labels when matching, while the `on` keyword allows reducing the set of considered labels to a provided list:
+### Keywords on and ignoring
+The `ignoring` keyword causes specified labels to be ignored during matching.
+The syntax:
 ```logql
-<vector expr> <bin-op> ignoring/on(<labels>) <vector expr>
+<vector expr> <bin-op> ignoring(<labels>) <vector expr>
 ```
 Example:
 ```logql
 sum by(machine) (count_over_time({app="foo"}[1m])) > bool ignoring(machine) sum(count_over_time({app="bar"}[1m]))
-
+```
+The on keyword reduces the set of considered labels to a specified list.
+The syntax:
+```logql
+<vector expr> <bin-op> on(<labels>) <vector expr>
+```
+Example:
+```logql
 sum by(app,machine) (count_over_time({app="foo"}[1m])) + on(app) sum by (app) (count_over_time({app="bar"}[1m]))
 ```
 

diff --git a/pkg/logql/shardmapper_test.go b/pkg/logql/shardmapper_test.go
@@ -192,6 +192,14 @@ func TestMappingStrings(t *testing.T) {
 			in:  `sum(count_over_time({foo="bar"} | logfmt | label_format bar=baz | bar="buz" [5m]))`,
 			out: `sum(count_over_time({foo="bar"} | logfmt | label_format bar=baz | bar="buz" [5m]))`,
 		},
+		{
+			in:  `sum by (cluster) (rate({foo="bar"} [5m])) + ignoring(machine) sum by (cluster,machine) (rate({foo="bar"} [5m]))`,
+			out: `(sumby(cluster)(downstream<sumby(cluster)(rate({foo="bar"}[5m])),shard=0_of_2>++downstream<sumby(cluster)(rate({foo="bar"}[5m])),shard=1_of_2>)+ignoring(machine)sumby(cluster,machine)(downstream<sumby(cluster,machine)(rate({foo="bar"}[5m])),shard=0_of_2>++downstream<sumby(cluster,machine)(rate({foo="bar"}[5m])),shard=1_of_2>))`,
+		},
+		{
+			in:  `sum by (cluster) (sum by (cluster) (rate({foo="bar"} [5m])) + ignoring(machine) sum by (cluster,machine) (rate({foo="bar"} [5m])))`,
+			out: `sumby(cluster)((sumby(cluster)(downstream<sumby(cluster)(rate({foo="bar"}[5m])),shard=0_of_2>++downstream<sumby(cluster)(rate({foo="bar"}[5m])),shard=1_of_2>)+ignoring(machine)sumby(cluster,machine)(downstream<sumby(cluster,machine)(rate({foo="bar"}[5m])),shard=0_of_2>++downstream<sumby(cluster,machine)(rate({foo="bar"}[5m])),shard=1_of_2>)))`,
+		},
 	} {
 		t.Run(tc.in, func(t *testing.T) {
 			ast, err := ParseExpr(tc.in)