TraceQL: Nested set intrinsics (#3497)

* add nested set Signed-off-by: Joe Elliott <[email protected]> * only return nested set params if explicitly requested Signed-off-by: Joe Elliott <[email protected]> * tests, tests, tests ! Signed-off-by: Joe Elliott <[email protected]> * lint Signed-off-by: Joe Elliott <[email protected]> * changelog Signed-off-by: Joe Elliott <[email protected]> * added/fixed tests Signed-off-by: Joe Elliott <[email protected]> * fix predicate adding Signed-off-by: Joe Elliott <[email protected]> --------- Signed-off-by: Joe Elliott <[email protected]>
grafana · Mar 21, 2024 · 3d2850d · 3d2850d
1 parent c61bd1b
commit 3d2850d
Show file tree

Hide file tree

Showing 14 changed files with 640 additions and 228 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 * [CHANGE] Align metrics query time ranges to the step parameter [#3490](https://github.com/grafana/tempo/pull/3490) (@mdisibio)
 * [ENHANCEMENT] Add string interning to TraceQL queries [#3411](https://github.com/grafana/tempo/pull/3411) (@mapno)
 * [ENHANCEMENT] Add new (unsafe) query hints for metrics queries [#3396](https://github.com/grafana/tempo/pull/3396) (@mdisibio)
+* [ENHANCEMENT] Add nestedSetLeft/Right/Parent instrinsics to TraceQL. [#3497](https://github.com/grafana/tempo/pull/3497) (@joe-elliott)
 * [BUGFIX] Fix metrics query results when filtering and rating on the same attribute [#3428](https://github.com/grafana/tempo/issues/3428) (@mdisibio)
 * [BUGFIX] Fix metrics query results when series contain empty strings or nil values [#3429](https://github.com/grafana/tempo/issues/3429) (@mdisibio)
 * [BUGFIX] Fix metrics query duration check, add per-tenant override for max metrics query duration [#3479](https://github.com/grafana/tempo/issues/3479) (@mdisibio)

diff --git a/pkg/search/util.go b/pkg/search/util.go
@@ -64,5 +64,11 @@ func GetVirtualIntrinsicValues() []string {
 		traceql.IntrinsicTraceDuration.String(),
 		traceql.IntrinsicTraceRootService.String(),
 		traceql.IntrinsicTraceRootSpan.String(),
+		/* these are technically intrinsics that can be requested, but they are not generally of interest to a user
+		   typing a query. for simplicity and clarity we are leaving them out of autocomplete
+			IntrinsicNestedSetLeft
+			IntrinsicNestedSetRight
+			IntrinsicNestedSetParent
+		*/
 	}
 }
diff --git a/pkg/traceql/ast.go b/pkg/traceql/ast.go
@@ -702,6 +702,12 @@ func (a Attribute) impliedType() StaticType {
 		return TypeString
 	case IntrinsicTraceRootSpan:
 		return TypeString
+	case IntrinsicNestedSetLeft:
+		return TypeInt
+	case IntrinsicNestedSetRight:
+		return TypeInt
+	case IntrinsicNestedSetParent:
+		return TypeInt
 	}
 
 	return TypeAttribute

diff --git a/pkg/traceql/ast_conditions_test.go b/pkg/traceql/ast_conditions_test.go
@@ -150,6 +150,55 @@ func TestScalarFilter_extractConditions(t *testing.T) {
 	}
 }
 
+func TestStructuralNestedSet_extractConditions(t *testing.T) {
+	tests := []struct {
+		query         string
+		conditions    []Condition
+		allConditions bool
+	}{
+		{
+			query: `{} >> {}`,
+			conditions: []Condition{
+				newCondition(NewIntrinsic(IntrinsicStructuralDescendant), OpNone),
+			},
+			allConditions: false,
+		},
+		{
+			query: `{ nestedSetRight = 2 }`,
+			conditions: []Condition{
+				newCondition(NewIntrinsic(IntrinsicNestedSetRight), OpEqual, NewStaticInt(2)),
+			},
+			allConditions: true,
+		},
+
+		{
+			query: `{ nestedSetParent = 1 } > { nestedSetLeft < 3 }`,
+			conditions: []Condition{
+				newCondition(NewIntrinsic(IntrinsicStructuralChild), OpNone),
+				newCondition(NewIntrinsic(IntrinsicNestedSetParent), OpEqual, NewStaticInt(1)),
+				newCondition(NewIntrinsic(IntrinsicNestedSetLeft), OpLess, NewStaticInt(3)),
+			},
+			allConditions: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.query, func(t *testing.T) {
+			expr, err := Parse(tt.query)
+			require.NoError(t, err)
+
+			req := &FetchSpansRequest{
+				Conditions:    []Condition{},
+				AllConditions: true,
+			}
+			expr.Pipeline.extractConditions(req)
+
+			assert.Equal(t, tt.conditions, req.Conditions)
+			assert.Nil(t, req.SecondPassConditions)
+			assert.Equal(t, tt.allConditions, req.AllConditions, "FetchSpansRequest.AllConditions")
+		})
+	}
+}
+
 func TestSelect_extractConditions(t *testing.T) {
 	tests := []struct {
 		query                string

diff --git a/pkg/traceql/enum_attributes.go b/pkg/traceql/enum_attributes.go
@@ -59,6 +59,9 @@ const (
 	IntrinsicTraceRootService
 	IntrinsicTraceRootSpan
 	IntrinsicTraceDuration
+	IntrinsicNestedSetLeft
+	IntrinsicNestedSetRight
+	IntrinsicNestedSetParent
 
 	// not yet implemented in traceql but will be
 	IntrinsicParent
@@ -91,6 +94,9 @@ var (
 	IntrinsicTraceRootSpanAttribute    = NewIntrinsic(IntrinsicTraceRootSpan)
 	IntrinsicTraceDurationAttribute    = NewIntrinsic(IntrinsicTraceDuration)
 	IntrinsicSpanStartTimeAttribute    = NewIntrinsic(IntrinsicSpanStartTime)
+	IntrinsicNestedSetLeftAttribute    = NewIntrinsic(IntrinsicNestedSetLeft)
+	IntrinsicNestedSetRightAttribute   = NewIntrinsic(IntrinsicNestedSetRight)
+	IntrinsicNestedSetParentAttribute  = NewIntrinsic(IntrinsicNestedSetParent)
 )
 
 func (i Intrinsic) String() string {
@@ -126,6 +132,12 @@ func (i Intrinsic) String() string {
 		return "spanID"
 	case IntrinsicSpanStartTime:
 		return "spanStartTime"
+	case IntrinsicNestedSetLeft:
+		return "nestedSetLeft"
+	case IntrinsicNestedSetRight:
+		return "nestedSetRight"
+	case IntrinsicNestedSetParent:
+		return "nestedSetParent"
 	}
 
 	return fmt.Sprintf("intrinsic(%d)", i)
@@ -163,6 +175,12 @@ func intrinsicFromString(s string) Intrinsic {
 		return IntrinsicSpanID
 	case "spanStartTime":
 		return IntrinsicSpanStartTime
+	case "nestedSetLeft":
+		return IntrinsicNestedSetLeft
+	case "nestedSetRight":
+		return IntrinsicNestedSetRight
+	case "nestedSetParent":
+		return IntrinsicNestedSetParent
 	}
 
 	return IntrinsicNone

diff --git a/pkg/traceql/expr.y b/pkg/traceql/expr.y
@@ -85,7 +85,7 @@ import (
 %token <val>            DOT OPEN_BRACE CLOSE_BRACE OPEN_PARENS CLOSE_PARENS COMMA
                         NIL TRUE FALSE STATUS_ERROR STATUS_OK STATUS_UNSET
                         KIND_UNSPECIFIED KIND_INTERNAL KIND_SERVER KIND_CLIENT KIND_PRODUCER KIND_CONSUMER
-                        IDURATION CHILDCOUNT NAME STATUS STATUS_MESSAGE PARENT KIND ROOTNAME ROOTSERVICENAME TRACEDURATION
+                        IDURATION CHILDCOUNT NAME STATUS STATUS_MESSAGE PARENT KIND ROOTNAME ROOTSERVICENAME TRACEDURATION NESTEDSETLEFT NESTEDSETRIGHT NESTEDSETPARENT
                         PARENT_DOT RESOURCE_DOT SPAN_DOT
                         COUNT AVG MAX MIN SUM
                         BY COALESCE SELECT
@@ -345,6 +345,9 @@ intrinsicField:
   | ROOTNAME        { $$ = NewIntrinsic(IntrinsicTraceRootSpan)    }
   | ROOTSERVICENAME { $$ = NewIntrinsic(IntrinsicTraceRootService) }
   | TRACEDURATION   { $$ = NewIntrinsic(IntrinsicTraceDuration)    }
+  | NESTEDSETLEFT   { $$ = NewIntrinsic(IntrinsicNestedSetLeft)    }
+  | NESTEDSETRIGHT  { $$ = NewIntrinsic(IntrinsicNestedSetRight)   }
+  | NESTEDSETPARENT { $$ = NewIntrinsic(IntrinsicNestedSetParent)  }
   ;
 
 attributeField: