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

[pkg/pdatatest] Ignore trace ID for ptracetest #27829

Merged
merged 1 commit into from
Oct 19, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
[pkg/pdatatest] Ignore trace ID for ptracetest
  • Loading branch information
sakulali committed Oct 18, 2023
commit 96cf9eac4e09edab25a16c6164e3da29ac21ff8c
27 changes: 27 additions & 0 deletions .chloggen/ptracetest-ignore-traceid.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: pkg/pdatatest

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "support ignore trace ID in span comparisons for ptracetest"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [27687]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
22 changes: 22 additions & 0 deletions pkg/pdatatest/ptracetest/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,25 @@ func maskEndTimestamp(traces ptrace.Traces, ts pcommon.Timestamp) {
}
}
}

// IgnoreTraceID is a CompareTracesOption that clears TraceID fields on all spans.
func IgnoreTraceID() CompareTracesOption {
return compareTracesOptionFunc(func(expected, actual ptrace.Traces) {
traceID := pcommon.NewTraceIDEmpty()
maskTraceID(expected, traceID)
maskTraceID(actual, traceID)
})
}

func maskTraceID(traces ptrace.Traces, traceID pcommon.TraceID) {
for i := 0; i < traces.ResourceSpans().Len(); i++ {
rs := traces.ResourceSpans().At(i)
for j := 0; j < rs.ScopeSpans().Len(); j++ {
ss := rs.ScopeSpans().At(j)
for k := 0; k < ss.Spans().Len(); k++ {
span := ss.Spans().At(k)
span.SetTraceID(traceID)
}
}
}
}
21 changes: 21 additions & 0 deletions pkg/pdatatest/ptracetest/testdata/ignore-traceid/actual.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
resourceSpans:
- resource:
attributes:
- key: host.name
value:
stringValue: node1
scopeSpans:
- scope:
name: collector
version: v0.1.0
spans:
- attributes:
- key: key1
value:
stringValue: value1
name: span1
parentSpanId: ""
spanId: fd0da883bb27cd6b
status: {}
traceId: 8c8b1765a7b0acf0b66aa4623fcb7bd5

19 changes: 19 additions & 0 deletions pkg/pdatatest/ptracetest/testdata/ignore-traceid/expected.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
resourceSpans:
- resource:
attributes:
- key: host.name
value:
stringValue: node1
scopeSpans:
- scope:
name: collector
version: v0.1.0
spans:
- attributes:
- key: key1
value:
stringValue: value1
name: span1
parentSpanId: ""
spanId: fd0da883bb27cd6b
status: {}
10 changes: 10 additions & 0 deletions pkg/pdatatest/ptracetest/traces_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ func TestCompareTraces(t *testing.T) {
),
withOptions: nil,
},
{
name: "ignore-traceid",
compareOptions: []CompareTracesOption{
IgnoreTraceID(),
},
withoutOptions: multierr.Combine(
errors.New("resource \"map[host.name:node1]\": scope \"collector\": span \"span1\": trace ID doesn't match expected: 8c8b1765a7b0acf0b66aa4623fcb7bd5, actual: "),
),
withOptions: nil,
},
{
name: "resourcespans-amount-unequal",
withoutOptions: multierr.Combine(
Expand Down