[TraceQL] Add support for querying by instrumentation scope #3967
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -596,7 +596,7 @@ func callSearchTagsV2AndAssert(t *testing.T, svc *e2e.HTTPService, scope, query | |
| if scope == "none" || scope == "" || scope == "intrinsic" { | ||
| expected.Scopes = append(expected.Scopes, &tempopb.SearchTagsV2Scope{ | ||
| Name: "intrinsic", | ||
| Tags: []string{"duration", "event:name", "event:timeSinceStart", "kind", "name", "rootName", "rootServiceName", "scope:name", "scope:version", "span:duration", "span:kind", "span:name", "span:status", "span:statusMessage", "status", "statusMessage", "trace:duration", "trace:rootName", "trace:rootService", "traceDuration"}, | ||
| }) | ||
| } | ||
| sort.Slice(expected.Scopes, func(i, j int) bool { return expected.Scopes[i].Name < expected.Scopes[j].Name }) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -134,7 +134,7 @@ func testSearch(t *testing.T, tenant string, tenantSize int) { | |
|
|
||
| tagsV2Resp, err := apiClient.SearchTagsV2() | ||
| require.NoError(t, err) | ||
| require.Equal(t, 4, len(tagsV2Resp.GetScopes())) // resource, span, event, link, scope intrinsics | ||
| for _, s := range tagsV2Resp.Scopes { | ||
| require.NotEmpty(t, s.Tags) | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -407,6 +407,24 @@ func testSearchTagsAndValuesV2( | |
| sort.Strings(expectedLinkTagValues) | ||
| assert.Contains(t, tagsResp.TagNames, tagName) | ||
| assert.Equal(t, expectedLinkTagValues, tagValues) | ||
|
|
||
| // scope scope attr | ||
|
|
||
| tagValuesResp, err = i.SearchTagValuesV2(ctx, &tempopb.SearchTagValuesRequest{ | ||
| TagName: fmt.Sprintf("scope.%s", tagName), | ||
| Query: query, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| tagValues = make([]string, 0, len(tagValuesResp.TagValues)) | ||
| for _, v := range tagValuesResp.TagValues { | ||
| tagValues = append(tagValues, v.Value) | ||
| } | ||
|
|
||
| sort.Strings(tagValues) | ||
| sort.Strings(expectedTagValues) | ||
| assert.Contains(t, tagsResp.TagNames, tagName) | ||
| assert.Equal(t, expectedTagValues, tagValues) | ||
| } | ||
|
|
||
| // TestInstanceSearchTagsSpecialCases tess that SearchTags errors on an unknown scope and | ||
|
|
@@ -425,6 +443,7 @@ func TestInstanceSearchTagsSpecialCases(t *testing.T) { | |
| t, | ||
| []string{ | ||
| "duration", "event:name", "event:timeSinceStart", "kind", "name", "rootName", "rootServiceName", | ||
| "scope:name", "scope:version", | ||
| "span:duration", "span:kind", "span:name", "span:status", "span:statusMessage", "status", "statusMessage", | ||
| "trace:duration", "trace:rootName", "trace:rootService", "traceDuration", | ||
| }, | ||
|
|
@@ -562,6 +581,11 @@ func writeTracesForSearch(t *testing.T, i *instance, spanName, tagKey, tagValue | |
| // add the time | ||
| for _, batch := range testTrace.ResourceSpans { | ||
| for _, ils := range batch.ScopeSpans { | ||
| ils.Scope = &v1.InstrumentationScope{ | ||
| Name: "scope-name", | ||
| Version: "scope-version", | ||
| Attributes: []*v1.KeyValue{kv}, | ||
| } | ||
| for _, span := range ils.Spans { | ||
| span.Name = spanName | ||
| span.StartTimeUnixNano = uint64(now.UnixNano()) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -74,6 +74,8 @@ func GetVirtualIntrinsicValues() []string { | |
| traceql.ScopedIntrinsicTraceDuration.String(), | ||
| traceql.IntrinsicEventName.String(), | ||
| traceql.IntrinsicEventTimeSinceStart.String(), | ||
| traceql.IntrinsicScopeName.String(), | ||
| traceql.IntrinsicScopeVersion.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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,7 @@ const ( | |
| AttributeScopeSpan | ||
| AttributeScopeEvent | ||
| AttributeScopeLink | ||
| AttributeScopeInstrumentation | ||
| AttributeScopeUnknown | ||
|
|
||
| none = "none" | ||
|
|
@@ -32,6 +33,8 @@ func (s AttributeScope) String() string { | |
| return "event" | ||
| case AttributeScopeLink: | ||
| return "link" | ||
| case AttributeScopeInstrumentation: | ||
| return "scope" | ||
| } | ||
|
|
||
| return fmt.Sprintf("att(%d).", s) | ||
|
|
@@ -47,6 +50,8 @@ func AttributeScopeFromString(s string) AttributeScope { | |
| return AttributeScopeEvent | ||
| case "link": | ||
| return AttributeScopeLink | ||
| case "scope": | ||
| return AttributeScopeInstrumentation | ||
| case "": | ||
| fallthrough | ||
| case none: | ||
|
|
@@ -76,6 +81,8 @@ const ( | |
| IntrinsicEventTimeSinceStart | ||
| IntrinsicLinkSpanID | ||
| IntrinsicLinkTraceID | ||
| IntrinsicScopeName | ||
| IntrinsicScopeVersion | ||
|
|
||
| // not yet implemented in traceql but will be | ||
| IntrinsicParent | ||
|
|
@@ -128,6 +135,8 @@ var ( | |
| IntrinsicLinkSpanIDAttribute = NewIntrinsic(IntrinsicLinkSpanID) | ||
| IntrinsicEventNameAttribute = NewIntrinsic(IntrinsicEventName) | ||
| IntrinsicEventTimeSinceStartAttribute = NewIntrinsic(IntrinsicEventTimeSinceStart) | ||
| IntrinsicScopeNameAttribute = NewIntrinsic(IntrinsicScopeName) | ||
| IntrinsicScopeVersionAttribute = NewIntrinsic(IntrinsicScopeVersion) | ||
| ) | ||
|
|
||
| func (i Intrinsic) String() string { | ||
|
|
@@ -184,6 +193,10 @@ func (i Intrinsic) String() string { | |
| return "trace:duration" | ||
| case IntrinsicSpanID: | ||
| return "span:id" | ||
| case IntrinsicScopeName: | ||
| return "scope:name" | ||
| case IntrinsicScopeVersion: | ||
| return "scope:version" | ||
| // below is unimplemented | ||
| case IntrinsicSpanStartTime: | ||
| return "spanStartTime" | ||
|
|
@@ -251,6 +264,10 @@ func intrinsicFromString(s string) Intrinsic { | |
| return IntrinsicTraceRootService | ||
| case "trace:duration": | ||
| return IntrinsicTraceDuration | ||
| case "scope:name": | ||
| return IntrinsicScopeName | ||
| case "scope:version": | ||
| return IntrinsicScopeVersion | ||
| // unimplemented | ||
| case "spanStartTime": | ||
| return IntrinsicSpanStartTime | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -93,9 +93,10 @@ import ( | |
| 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 | ||
| ROOTSERVICE TRACEDURATION NESTEDSETLEFT NESTEDSETRIGHT NESTEDSETPARENT ID | ||
| TRACE_ID SPAN_ID TIMESINCESTART VERSION | ||
| PARENT_DOT RESOURCE_DOT SPAN_DOT TRACE_COLON SPAN_COLON | ||
| EVENT_COLON EVENT_DOT LINK_COLON LINK_DOT SCOPE_COLON SCOPE_DOT | ||
| COUNT AVG MAX MIN SUM | ||
| BY COALESCE SELECT | ||
| END_ATTRIBUTE | ||
|
|
@@ -411,15 +412,19 @@ scopedIntrinsicField: | |
| // link: | ||
| | LINK_COLON TRACE_ID { $$ = NewIntrinsic(IntrinsicLinkTraceID) } | ||
| | LINK_COLON SPAN_ID { $$ = NewIntrinsic(IntrinsicLinkSpanID) } | ||
| // scope: | ||
| | SCOPE_COLON NAME { $$ = NewIntrinsic(IntrinsicScopeName) } | ||
| | SCOPE_COLON VERSION { $$ = NewIntrinsic(IntrinsicScopeVersion) } | ||
| ; | ||
|
|
||
| attributeField: | ||
| DOT IDENTIFIER END_ATTRIBUTE { $$ = NewAttribute($2) } | ||
| | RESOURCE_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeResource, false, $2) } | ||
| | SPAN_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeSpan, false, $2) } | ||
| | PARENT_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeNone, true, $2) } | ||
| | PARENT_DOT RESOURCE_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeResource, true, $3) } | ||
| | PARENT_DOT SPAN_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeSpan, true, $3) } | ||
| | EVENT_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeEvent, false, $2) } | ||
| | LINK_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeLink, false, $2) } | ||
| | SCOPE_DOT IDENTIFIER END_ATTRIBUTE { $$ = NewScopedAttribute(AttributeScopeInstrumentation, false, $2) } | ||
| ; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought the thing at the left of
:was a scope , i.e.linkis a possible value for scope.So is very confusing for me that this is called
scope, shouldn't it be calledinstrumentation?instrumentation:nameinstrumentation:versionmore clearly define what this points at IMHOUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a good call out. we have discussed this with our internal team and they believe that otel does not see this as an instrumentation only field. it just happens to be used that way and they intend for it to be used as a more generic "scope" long term.
agree that scope scope is strange. let me summon @jpkrohling. he may have more insight.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are end-users exposed to "scope scope"? As an OTel user, I immediately thought of InstrumentationScope when I saw "scope:name" here. Unless there's an explicit source of confusion, I'd keep "scope:name".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not directly although there may be some awkward wording in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally
scope:nameis a generic term that says nothing to me.I can imagine for people better versed in opentelemetry parlance it is very obvious.
I am very sure that around here I will need to tell people that "scope:name means the name of the instrumentation/area that created the span". or such explanation as I do not think it is clear to more casual users of observability tools.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it help to have these differences called out in the doc to avoid confusion? Or would that just create more confusion?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs will definitely need to be there.
When someone reads a query or an autocomplete with
span:duration, that person needs to know almost nothing about tracing to understand what that would mean, without resorting to reading documentation.I think when someone reads
scope:namethat person will definitely need to go to documentation to know what would that mean.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the number of keyboard touches, I have no strong preferences for
scopevs.instrumentation. They are both technically correct. Ifinstrumentationis more intuitive to the audience, that certainly wins overscope.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jcarres-mdsol thank you for pointing this out. I've changed the syntax to
instrumentation:nameandinstrumentation:version🚀