Skip to content
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.

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

fix: temporary root issue when parent is missing #3384

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 9 additions & 15 deletions server/traces/trace_entities.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,17 @@ func MergeTraces(traces ...*Trace) *Trace {
}

func NewTrace(traceID string, spans []Span) Trace {
var temporaryRootSpan *Span
spanMap := make(map[string]*Span, 0)
// remove all temporary root spans
sanitizedSpans := make([]Span, 0)
for _, span := range spans {
if span.Name == TemporaryRootSpanName {
if temporaryRootSpan != nil {
// It should never have more than one temporary root span
// so if that happens, clean them up.
continue
}

// Make sure that removing extra temporary spans don't leave any orphan spans
temporaryRootSpan = &span
for _, child := range span.Children {
temporaryRootSpan.Children = append(temporaryRootSpan.Children, child)
child.Parent = temporaryRootSpan
}
if span.Name != TemporaryRootSpanName {
sanitizedSpans = append(sanitizedSpans, span)
}
}
spans = sanitizedSpans

spanMap := make(map[string]*Span, 0)
for _, span := range spans {
spanCopy := span.setMetadataAttributes()
spanID := span.ID.String()
spanMap[spanID] = &spanCopy
Expand Down
29 changes: 26 additions & 3 deletions server/traces/traces_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,29 @@ func TestTraceWithMultipleTemporaryRoots(t *testing.T) {
assert.Equal(t, "Child from root 3", trace.RootSpan.Children[2].Name)
}

func TestTraceAssemble(t *testing.T) {
rootSpan := newSpan("Root")
childSpan1 := newSpan("child 1", withParent(&rootSpan))
childSpan2 := newSpan("child 2", withParent(&rootSpan))
grandchildSpan := newSpan("grandchild", withParent(&childSpan2))

spans := []traces.Span{rootSpan, childSpan1, grandchildSpan}
trace := traces.NewTrace("trace", spans)

assert.Len(t, trace.Flat, 4)
assert.Equal(t, "Temporary Tracetest root span", trace.RootSpan.Name)
assert.Equal(t, "Root", trace.RootSpan.Children[0].Name)
assert.Equal(t, "child 1", trace.RootSpan.Children[0].Children[0].Name)
assert.Equal(t, "grandchild", trace.RootSpan.Children[1].Name)

trace = traces.NewTrace(trace.ID.String(), append(trace.Spans(), childSpan2))
assert.Len(t, trace.Flat, 4)
assert.Equal(t, "Root", trace.RootSpan.Name)
assert.Equal(t, "child 1", trace.RootSpan.Children[0].Name)
assert.Equal(t, "child 2", trace.RootSpan.Children[1].Name)
assert.Equal(t, "grandchild", trace.RootSpan.Children[1].Children[0].Name)
}

func TestTraceWithMultipleRootsFromOtel(t *testing.T) {
root1 := newOtelSpan("Root 1", nil)
root1Child := newOtelSpan("Child from root 1", root1)
Expand Down Expand Up @@ -168,7 +191,7 @@ func TestNoTemporaryRootIfTracetestRootExists(t *testing.T) {
assert.Equal(t, root2.Name, trace.RootSpan.Name)
}

func TestNoTemporaryRootIfATemporaryRootExists(t *testing.T) {
func TestNewTemporaryRootIfATemporaryRootExists(t *testing.T) {
root1 := newSpan("Root 1")
root1Child := newSpan("Child from root 1", withParent(&root1))
root2 := newSpan(traces.TemporaryRootSpanName)
Expand All @@ -179,8 +202,8 @@ func TestNoTemporaryRootIfATemporaryRootExists(t *testing.T) {
spans := []traces.Span{root1, root1Child, root2, root2Child, root3, root3Child}
trace := traces.NewTrace("trace", spans)

assert.Equal(t, root2.ID, trace.RootSpan.ID)
assert.Equal(t, root2.Name, trace.RootSpan.Name)
assert.NotEqual(t, root2.ID, trace.RootSpan.ID)
assert.Equal(t, traces.TemporaryRootSpanName, root2.Name)
}

func TestTriggerSpanShouldBeRootWhenTemporaryRootExistsToo(t *testing.T) {
Expand Down