From 51b80812b9425bacba3d493a841e61ddee944cc5 Mon Sep 17 00:00:00 2001 From: sakulali Date: Thu, 19 Oct 2023 08:54:58 +0800 Subject: [PATCH] [pkg/pdatatest] Ignore trace ID for ptracetest (#27829) **Description:** Support ignore trace ID in span comparisons for ptracetest. **Link to tracking Issue:** https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27687 --- .chloggen/ptracetest-ignore-traceid.yaml | 27 +++++++++++++++++++ pkg/pdatatest/ptracetest/options.go | 22 +++++++++++++++ .../testdata/ignore-traceid/actual.yaml | 21 +++++++++++++++ .../testdata/ignore-traceid/expected.yaml | 19 +++++++++++++ pkg/pdatatest/ptracetest/traces_test.go | 10 +++++++ 5 files changed, 99 insertions(+) create mode 100755 .chloggen/ptracetest-ignore-traceid.yaml create mode 100644 pkg/pdatatest/ptracetest/testdata/ignore-traceid/actual.yaml create mode 100644 pkg/pdatatest/ptracetest/testdata/ignore-traceid/expected.yaml diff --git a/.chloggen/ptracetest-ignore-traceid.yaml b/.chloggen/ptracetest-ignore-traceid.yaml new file mode 100755 index 000000000000..4e9b7449b45e --- /dev/null +++ b/.chloggen/ptracetest-ignore-traceid.yaml @@ -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: [] diff --git a/pkg/pdatatest/ptracetest/options.go b/pkg/pdatatest/ptracetest/options.go index 57a278ec4dda..5a6c318dbcdb 100644 --- a/pkg/pdatatest/ptracetest/options.go +++ b/pkg/pdatatest/ptracetest/options.go @@ -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) + } + } + } +} diff --git a/pkg/pdatatest/ptracetest/testdata/ignore-traceid/actual.yaml b/pkg/pdatatest/ptracetest/testdata/ignore-traceid/actual.yaml new file mode 100644 index 000000000000..817c4fc938d1 --- /dev/null +++ b/pkg/pdatatest/ptracetest/testdata/ignore-traceid/actual.yaml @@ -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 + diff --git a/pkg/pdatatest/ptracetest/testdata/ignore-traceid/expected.yaml b/pkg/pdatatest/ptracetest/testdata/ignore-traceid/expected.yaml new file mode 100644 index 000000000000..f01f0307bac4 --- /dev/null +++ b/pkg/pdatatest/ptracetest/testdata/ignore-traceid/expected.yaml @@ -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: {} diff --git a/pkg/pdatatest/ptracetest/traces_test.go b/pkg/pdatatest/ptracetest/traces_test.go index f088d8889bbe..ca8b8d128a3b 100644 --- a/pkg/pdatatest/ptracetest/traces_test.go +++ b/pkg/pdatatest/ptracetest/traces_test.go @@ -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(