Merge pull request #797 from prometheus/keep-common

Deprecate `keeping_extra`, rename it to `keep_common`.

promql/lex.go

@@ -145,7 +145,7 @@ const (
 	itemWith
 	itemSummary
 	itemDescription
-	itemKeepingExtra
+	itemKeepCommon
 	itemOffset
 	itemBy
 	itemOn
@@ -177,7 +177,8 @@ var key = map[string]itemType{
 	"description":   itemDescription,
 	"offset":        itemOffset,
 	"by":            itemBy,
-	"keeping_extra": itemKeepingExtra,
+	"keeping_extra": itemKeepCommon,
+	"keep_common":   itemKeepCommon,
 	"on":            itemOn,
 	"group_left":    itemGroupLeft,
 	"group_right":   itemGroupRight,

promql/lex_test.go

@@ -222,7 +222,10 @@ var tests = []struct {
 		expected: []item{{itemAlert, 0, "alert"}},
 	}, {
 		input:    "keeping_extra",
-		expected: []item{{itemKeepingExtra, 0, "keeping_extra"}},
+		expected: []item{{itemKeepCommon, 0, "keeping_extra"}},
+	}, {
+		input:    "keep_common",
+		expected: []item{{itemKeepCommon, 0, "keep_common"}},
 	}, {
 		input:    "if",
 		expected: []item{{itemIf, 0, "if"}},

promql/parse.go

@@ -651,8 +651,8 @@ func (p *parser) labels() clientmodel.LabelNames {
 
 // aggrExpr parses an aggregation expression.
 //
-//		<aggr_op> (<vector_expr>) [by <labels>] [keeping_extra]
-//		<aggr_op> [by <labels>] [keeping_extra] (<vector_expr>)
+//		<aggr_op> (<vector_expr>) [by <labels>] [keep_common]
+//		<aggr_op> [by <labels>] [keep_common] (<vector_expr>)
 //
 func (p *parser) aggrExpr() *AggregateExpr {
 	const ctx = "aggregation"
@@ -671,7 +671,7 @@ func (p *parser) aggrExpr() *AggregateExpr {
 		grouping = p.labels()
 		modifiersFirst = true
 	}
-	if p.peek().typ == itemKeepingExtra {
+	if p.peek().typ == itemKeepCommon {
 		p.next()
 		keepExtra = true
 		modifiersFirst = true
@@ -689,7 +689,7 @@ func (p *parser) aggrExpr() *AggregateExpr {
 			p.next()
 			grouping = p.labels()
 		}
-		if p.peek().typ == itemKeepingExtra {
+		if p.peek().typ == itemKeepCommon {
 			p.next()
 			keepExtra = true
 		}

promql/parse_test.go

@@ -716,7 +716,7 @@ var testExpr = []struct {
 			Grouping: clientmodel.LabelNames{"foo"},
 		},
 	}, {
-		input: "sum by (foo) keeping_extra (some_metric)",
+		input: "sum by (foo) keep_common (some_metric)",
 		expected: &AggregateExpr{
 			Op:              itemSum,
 			KeepExtraLabels: true,
@@ -729,7 +729,7 @@ var testExpr = []struct {
 			Grouping: clientmodel.LabelNames{"foo"},
 		},
 	}, {
-		input: "sum (some_metric) by (foo,bar) keeping_extra",
+		input: "sum (some_metric) by (foo,bar) keep_common",
 		expected: &AggregateExpr{
 			Op:              itemSum,
 			KeepExtraLabels: true,
@@ -754,7 +754,7 @@ var testExpr = []struct {
 			Grouping: clientmodel.LabelNames{"foo"},
 		},
 	}, {
-		input: "COUNT by (foo) keeping_extra (some_metric)",
+		input: "COUNT by (foo) keep_common (some_metric)",
 		expected: &AggregateExpr{
 			Op: itemCount,
 			Expr: &VectorSelector{
@@ -767,7 +767,7 @@ var testExpr = []struct {
 			KeepExtraLabels: true,
 		},
 	}, {
-		input: "MIN (some_metric) by (foo) keeping_extra",
+		input: "MIN (some_metric) by (foo) keep_common",
 		expected: &AggregateExpr{
 			Op: itemMin,
 			Expr: &VectorSelector{
@@ -839,13 +839,13 @@ var testExpr = []struct {
 		fail:   true,
 		errMsg: "no valid expression found",
 	}, {
-		input:  "MIN keeping_extra (some_metric) by (foo)",
+		input:  "MIN keep_common (some_metric) by (foo)",
 		fail:   true,
 		errMsg: "could not parse remaining input \"by (foo)\"...",
 	}, {
-		input:  "MIN by(test) (some_metric) keeping_extra",
+		input:  "MIN by(test) (some_metric) keep_common",
 		fail:   true,
-		errMsg: "could not parse remaining input \"keeping_extra\"...",
+		errMsg: "could not parse remaining input \"keep_common\"...",
 	},
 	// Test function calls.
 	{

promql/printer.go

@@ -179,7 +179,7 @@ func (node *AggregateExpr) String() string {
 	if len(node.Grouping) > 0 {
 		format := "%s BY (%s)"
 		if node.KeepExtraLabels {
-			format += " KEEPING_EXTRA"
+			format += " KEEP_COMMON"
 		}
 		return fmt.Sprintf(format, aggrString, node.Grouping)
 	}

promql/printer_test.go

@@ -28,7 +28,7 @@ func TestExprString(t *testing.T) {
 			in: `sum(task:errors:rate10s{job="s"}) BY (code)`,
 		},
 		{
-			in: `sum(task:errors:rate10s{job="s"}) BY (code) KEEPING_EXTRA`,
+			in: `sum(task:errors:rate10s{job="s"}) BY (code) KEEP_COMMON`,
 		},
 	}
 

promql/testdata/legacy.test

@@ -37,7 +37,7 @@ eval instant at 50m SUM(http_requests{instance="0"}) BY(job)
 	{job="api-server"} 400
 	{job="app-server"} 1200
 
-eval instant at 50m SUM(http_requests{instance="0"}) BY(job) KEEPING_EXTRA
+eval instant at 50m SUM(http_requests{instance="0"}) BY(job) KEEP_COMMON
 	{instance="0", job="api-server"} 400
 	{instance="0", job="app-server"} 1200
 
@@ -411,15 +411,15 @@ eval instant at 50m sum by (group) (http_requests{job="api-server"})
 	{group="canary"} 700 
 	{group="production"} 300 
 
-# Test alternative "by"-clause order with "keeping_extra".
-eval instant at 50m sum by (group) keeping_extra (http_requests{job="api-server"})
+# Test alternative "by"-clause order with "keep_common".
+eval instant at 50m sum by (group) keep_common (http_requests{job="api-server"})
 	{group="canary", job="api-server"} 700 
 	{group="production", job="api-server"} 300 
 
 # Test both alternative "by"-clause orders in one expression.
 # Public health warning: stick to one form within an expression (or even
 # in an organization), or risk serious user confusion.
-eval instant at 50m sum(sum by (group) keeping_extra (http_requests{job="api-server"})) by (job)
+eval instant at 50m sum(sum by (group) keep_common (http_requests{job="api-server"})) by (job)
 	{job="api-server"} 1000 
 
 eval instant at 50m http_requests{group="canary"} and http_requests{instance="0"}
@@ -657,10 +657,10 @@ load 1h
 	testmetric{testlabel="1"} 1 1
 	testmetric{testlabel="2"} 2 _
 
-eval instant at 0h sum(testmetric) keeping_extra
+eval instant at 0h sum(testmetric) keep_common
 	{} 3
 
-eval instant at 1h sum(testmetric) keeping_extra
+eval instant at 1h sum(testmetric) keep_common
 	{testlabel="1"} 1
 
 clear