Skip to content

[feat][backend]: add not_query_annotation option to list spans request #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kidkidkid wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[feat][backend]: add not_query_annotation option to list spans request #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e5297e
feat: add not_query_annotation option to list spans request
kidkidkid Apr 21, 2026
3b4f50a
perf: narrow annotation query time range based on actual span times
kidkidkid Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions backend/modules/observability/domain/trace/service/trace_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ type ListSpansReq struct {
SelectColumns []string
OmitColumns []string
Scene entity.ProcessorScene
NotQueryAnnotation bool
}

type ListSpansResp struct {
Expand Down Expand Up @@ -1116,16 +1117,17 @@ func (r *TraceServiceImpl) ListSpans(ctx context.Context, req *ListSpansReq) (*L
}
st := time.Now()
tRes, err := r.traceRepo.ListSpans(ctx, &repo.ListSpansParam{
WorkSpaceID: strconv.FormatInt(req.WorkspaceID, 10),
Tenants: tenants,
Filters: filters,
StartAt: req.StartTime,
EndAt: req.EndTime,
Limit: req.Limit,
DescByStartTime: req.DescByStartTime,
PageToken: req.PageToken,
SelectColumns: req.SelectColumns,
OmitColumns: req.OmitColumns,
WorkSpaceID: strconv.FormatInt(req.WorkspaceID, 10),
Tenants: tenants,
Filters: filters,
StartAt: req.StartTime,
EndAt: req.EndTime,
Limit: req.Limit,
DescByStartTime: req.DescByStartTime,
PageToken: req.PageToken,
SelectColumns: req.SelectColumns,
OmitColumns: req.OmitColumns,
NotQueryAnnotation: req.NotQueryAnnotation,
})
r.metrics.EmitListSpans(req.WorkspaceID, string(req.SpanListType), st, err != nil)
if err != nil {
Expand Down Expand Up @@ -1499,7 +1501,8 @@ func (r *TraceServiceImpl) ListMetadata(ctx context.Context, req *ListMetadataRe
"input",
"output",
},
DescByStartTime: true,
DescByStartTime: true,
NotQueryAnnotation: true,
})
if err != nil {
return nil, err
Expand Down
20 changes: 20 additions & 0 deletions backend/modules/observability/domain/trace/service/trace_service_metadata_annotation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,26 @@ func TestTraceServiceImpl_ListMetadata(t *testing.T) {
PlatformType: loop_span.PlatformCozeLoop,
}

t.Run("ListMetadata passes NotQueryAnnotation true to repo", func(t *testing.T) {
buildHelperMock.EXPECT().BuildPlatformRelatedFilter(gomock.Any(), req.PlatformType).Return(filterMock, nil)
filterMock.EXPECT().BuildBasicSpanFilter(gomock.Any(), gomock.Any()).Return(nil, true, nil)
tenantProviderMock.EXPECT().GetTenantsByPlatformType(gomock.Any(), req.PlatformType).Return([]string{"tenant1"}, nil)

traceRepoMock.EXPECT().ListSpans(gomock.Any(), gomock.Any()).DoAndReturn(
func(ctx context.Context, param *repo.ListSpansParam) (*repo.ListSpansResult, error) {
assert.True(t, param.NotQueryAnnotation)
return &repo.ListSpansResult{
Spans: loop_span.SpanList{{SpanID: "span1"}},
}, nil
})
metricsMock.EXPECT().EmitListSpans(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any())
buildHelperMock.EXPECT().BuildListSpansProcessors(gomock.Any(), gomock.Any()).Return([]span_processor.Processor{}, nil)

resp, err := svc.ListMetadata(ctx, req)
assert.NoError(t, err)
assert.NotNil(t, resp)
})

t.Run("dedup by key and sort by frequency desc", func(t *testing.T) {
buildHelperMock.EXPECT().BuildPlatformRelatedFilter(gomock.Any(), req.PlatformType).Return(filterMock, nil)
filterMock.EXPECT().BuildBasicSpanFilter(gomock.Any(), gomock.Any()).Return(nil, true, nil)
Expand Down
97 changes: 97 additions & 0 deletions backend/modules/observability/domain/trace/service/trace_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1487,6 +1487,103 @@ func TestTraceServiceImpl_ListSpans(t *testing.T) {
},
wantErr: true,
},
{
name: "list spans with NotQueryAnnotation passes flag to repo",
fieldsGetter: func(ctrl *gomock.Controller) fields {
repoMock := repomocks.NewMockITraceRepo(ctrl)
repoMock.EXPECT().ListSpans(gomock.Any(), gomock.Any()).DoAndReturn(
func(ctx context.Context, param *repo.ListSpansParam) (*repo.ListSpansResult, error) {
assert.True(t, param.NotQueryAnnotation)
return &repo.ListSpansResult{
Spans: loop_span.SpanList{{
TraceID: "123",
SpanID: "234",
}},
}, nil
})
confMock := confmocks.NewMockITraceConfig(ctrl)
tenantProviderMock := tenantmocks.NewMockITenantProvider(ctrl)
tenantProviderMock.EXPECT().GetTenantsByPlatformType(gomock.Any(), gomock.Any()).Return([]string{"spans"}, nil).AnyTimes()
filterMock := filtermocks.NewMockFilter(ctrl)
filterMock.EXPECT().BuildBasicSpanFilter(gomock.Any(), gomock.Any()).Return([]*loop_span.FilterField{{}}, false, nil)
filterMock.EXPECT().BuildALLSpanFilter(gomock.Any(), gomock.Any()).Return(nil, nil)
filterFactoryMock := filtermocks.NewMockPlatformFilterFactory(ctrl)
filterFactoryMock.EXPECT().GetFilter(gomock.Any(), gomock.Any()).Return(filterMock, nil)
buildHelper := NewTraceFilterProcessorBuilder(filterFactoryMock, map[entity.ProcessorScene][]span_processor.Factory{entity.SceneGetTrace: {}, entity.SceneListSpans: {}, entity.SceneAdvanceInfo: {}, entity.SceneIngestTrace: {}, entity.SceneSearchTraceOApi: {}, entity.SceneListSpansOApi: {}})
metricsMock := metricmocks.NewMockITraceMetrics(ctrl)
metricsMock.EXPECT().EmitListSpans(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return()
return fields{
traceRepo: repoMock,
traceConfig: confMock,
buildHelper: buildHelper,
metrics: metricsMock,
tenantProvider: tenantProviderMock,
}
},
args: args{
ctx: context.Background(),
req: &ListSpansReq{
PlatformType: loop_span.PlatformCozeLoop,
Limit: 10,
SpanListType: loop_span.SpanListTypeAllSpan,
NotQueryAnnotation: true,
},
},
want: &ListSpansResp{
Spans: loop_span.SpanList{{
TraceID: "123",
SpanID: "234",
}},
},
},
{
name: "list spans without NotQueryAnnotation defaults to false",
fieldsGetter: func(ctrl *gomock.Controller) fields {
repoMock := repomocks.NewMockITraceRepo(ctrl)
repoMock.EXPECT().ListSpans(gomock.Any(), gomock.Any()).DoAndReturn(
func(ctx context.Context, param *repo.ListSpansParam) (*repo.ListSpansResult, error) {
assert.False(t, param.NotQueryAnnotation)
return &repo.ListSpansResult{
Spans: loop_span.SpanList{{
TraceID: "456",
SpanID: "789",
}},
}, nil
})
confMock := confmocks.NewMockITraceConfig(ctrl)
tenantProviderMock := tenantmocks.NewMockITenantProvider(ctrl)
tenantProviderMock.EXPECT().GetTenantsByPlatformType(gomock.Any(), gomock.Any()).Return([]string{"spans"}, nil).AnyTimes()
filterMock := filtermocks.NewMockFilter(ctrl)
filterMock.EXPECT().BuildBasicSpanFilter(gomock.Any(), gomock.Any()).Return([]*loop_span.FilterField{{}}, false, nil)
filterMock.EXPECT().BuildALLSpanFilter(gomock.Any(), gomock.Any()).Return(nil, nil)
filterFactoryMock := filtermocks.NewMockPlatformFilterFactory(ctrl)
filterFactoryMock.EXPECT().GetFilter(gomock.Any(), gomock.Any()).Return(filterMock, nil)
buildHelper := NewTraceFilterProcessorBuilder(filterFactoryMock, map[entity.ProcessorScene][]span_processor.Factory{entity.SceneGetTrace: {}, entity.SceneListSpans: {}, entity.SceneAdvanceInfo: {}, entity.SceneIngestTrace: {}, entity.SceneSearchTraceOApi: {}, entity.SceneListSpansOApi: {}})
metricsMock := metricmocks.NewMockITraceMetrics(ctrl)
metricsMock.EXPECT().EmitListSpans(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return()
return fields{
traceRepo: repoMock,
traceConfig: confMock,
buildHelper: buildHelper,
metrics: metricsMock,
tenantProvider: tenantProviderMock,
}
},
args: args{
ctx: context.Background(),
req: &ListSpansReq{
PlatformType: loop_span.PlatformCozeLoop,
Limit: 10,
SpanListType: loop_span.SpanListTypeAllSpan,
},
},
want: &ListSpansResp{
Spans: loop_span.SpanList{{
TraceID: "456",
SpanID: "789",
}},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
28 changes: 22 additions & 6 deletions backend/modules/observability/infra/repo/trace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,16 +243,17 @@ func (t *TraceRepoImpl) ListSpans(ctx context.Context, req *repo.ListSpansParam)
}
logs.CtxInfo(ctx, "list spans successfully, spans count %d, cost %v", len(spans), time.Since(st))
spanDOList := converter.SpanListPO2DO(spans)
if tableCfg.NeedQueryAnno && !req.NotQueryAnnotation {
if tableCfg.NeedQueryAnno && !req.NotQueryAnnotation && len(spans) > 0 {
spanIDs := lo.UniqMap(spans, func(item *dao.Span, _ int) string {
return item.SpanID
})
annoStartTime, annoEndTime := spanTimeRange(spans)
st = time.Now()
annotations, err := annoDao.List(ctx, &dao.ListAnnotationsParam{
Tables: tableCfg.AnnoTables,
SpanIDs: spanIDs,
StartTime: time_util.MillSec2MicroSec(req.StartAt),
EndTime: time_util.MillSec2MicroSec(req.EndAt),
StartTime: annoStartTime,
EndTime: annoEndTime,
Limit: int32(min(len(spanIDs)*100, 10000)),
Extra: spanStorage.StorageConfig,
})
Expand Down Expand Up @@ -391,16 +392,17 @@ func (t *TraceRepoImpl) GetTrace(ctx context.Context, req *repo.GetTraceParam) (
logs.CtxInfo(ctx, "get trace %s successfully, spans count %d, cost %v",
req.TraceID, len(spans), time.Since(st))
spanDOList := converter.SpanListPO2DO(spans)
if tableCfg.NeedQueryAnno && !req.NotQueryAnnotation {
if tableCfg.NeedQueryAnno && !req.NotQueryAnnotation && len(spans) > 0 {
spanIDs := lo.UniqMap(spans, func(item *dao.Span, _ int) string {
return item.SpanID
})
annoStartTime, annoEndTime := spanTimeRange(spans)
st = time.Now()
annotations, err := annoDao.List(ctx, &dao.ListAnnotationsParam{
Tables: tableCfg.AnnoTables,
SpanIDs: spanIDs,
StartTime: time_util.MillSec2MicroSec(req.StartAt),
EndTime: time_util.MillSec2MicroSec(req.EndAt),
StartTime: annoStartTime,
EndTime: annoEndTime,
Limit: int32(min(len(spanIDs)*100, 10000)),
Extra: spanStorage.StorageConfig,
})
Expand Down Expand Up @@ -733,3 +735,17 @@ func parsePageToken(pageToken string) (*PageToken, error) {
}
return pt, nil
}

func spanTimeRange(spans []*dao.Span) (int64, int64) {
minStart := spans[0].StartTime
maxStart := spans[0].StartTime
for _, s := range spans[1:] {
if s.StartTime < minStart {
minStart = s.StartTime
}
if s.StartTime > maxStart {
maxStart = s.StartTime
}
}
return minStart, maxStart
}
Loading
Loading