Skip to content

Commit

Permalink
[exporter/clickhouse] Update Trace SpanKind and StatusCode strings (
Browse files Browse the repository at this point in the history
open-telemetry#34799)

**Description:**

Trace `SpanKind` and `StatusCode` are exporting [old enum
values](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/04b3b9898b242c0b3b707bc043c025eb9f6f73ba/internal/coreinternal/traceutil/traceutil.go#L13-L47).
This change will make these fields consistent with the specification.

I have marked this as a breaking change since it may affect queries that
filter by these strings. There should be no change to exporter
deployments, only to the read queries.

See above/below links for more information as well as a sample of the
old vs new values.

Example: `STATUS_CODE_ERROR` -> `Error`

**Link to tracking Issue:** 

- open-telemetry/opentelemetry-collector#6250
- open-telemetry/opentelemetry-collector#6251

**Testing:**

- Updated integration tests
  • Loading branch information
SpencerTorres authored and f7o committed Sep 12, 2024
1 parent a037179 commit ef7df4e
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 4 deletions.
34 changes: 34 additions & 0 deletions .chloggen/clickhouse-upgrade-statuscode-kind.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Use this changelog template to create an entry for release notes.

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

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Upgrade trace SpanKind and StatusCode string values

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

# (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: |
This change updates the output of the trace SpanKind and StatusCode fields to be consistent
with the specification's enum values. While this change will not break any deployments, it may affect
queries dependent on the old enum names.
For more details on old->new values, see this related PR:
https://github.com/open-telemetry/opentelemetry-collector/pull/6250
# 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: []
4 changes: 2 additions & 2 deletions exporter/clickhouseexporter/exporter_traces.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,14 @@ func (e *tracesExporter) pushTraceData(ctx context.Context, td ptrace.Traces) er
traceutil.SpanIDToHexOrEmptyString(r.ParentSpanID()),
r.TraceState().AsRaw(),
r.Name(),
traceutil.SpanKindStr(r.Kind()),
r.Kind().String(),
serviceName,
resAttr,
scopeName,
scopeVersion,
spanAttr,
r.EndTimestamp().AsTime().Sub(r.StartTimestamp().AsTime()).Nanoseconds(),
traceutil.StatusCodeStr(status.Code()),
status.Code().String(),
status.Message(),
eventTimes,
eventNames,
Expand Down
4 changes: 2 additions & 2 deletions exporter/clickhouseexporter/integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ func verifyExporterTrace(t *testing.T, traceExporter *tracesExporter) {
ParentSpanID: "0102040000000000",
TraceState: "trace state",
SpanName: "call db",
SpanKind: "SPAN_KIND_INTERNAL",
SpanKind: "Internal",
ServiceName: "test-service",
ResourceAttributes: map[string]string{
"service.name": "test-service",
Expand All @@ -194,7 +194,7 @@ func verifyExporterTrace(t *testing.T, traceExporter *tracesExporter) {
"service.name": "v",
},
Duration: 60000000000,
StatusCode: "STATUS_CODE_ERROR",
StatusCode: "Error",
StatusMessage: "error",
EventsTimestamp: []time.Time{
time.Unix(1703498029, 0).UTC(),
Expand Down

0 comments on commit ef7df4e

Please sign in to comment.