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

[pdata] Update values returned by all String methods of enum types #6250

Merged
merged 1 commit into from Nov 4, 2022
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
8 changes: 8 additions & 0 deletions .chloggen/rename-severy-numer-and-state-string-output.yaml
@@ -0,0 +1,8 @@
change_type: breaking
component: pdata
note: "Change output of String() method of the following enum types to more a concise form:"
subtext: |
- plog.SeverityNumber
- ptrace.SpanKind
- ptrace.StatusCode
issues: [6251]
Expand Up @@ -7,7 +7,7 @@ LogRecord #0
ObservedTimestamp: 1970-01-01 00:00:00 +0000 UTC
Timestamp: 2020-02-11 20:26:13.000000789 +0000 UTC
SeverityText: INFO
SeverityNumber: SEVERITY_NUMBER_INFO(9)
SeverityNumber: Info(9)
Body: Map({"key1":"val1","key2":{"key21":"val21","key22":"val22"}})
Attributes:
-> key1: Map({"key11":"val11","key12":"val12","key13":{"key131":"val131"}})
Expand Down
Expand Up @@ -9,7 +9,7 @@ LogRecord #0
ObservedTimestamp: 1970-01-01 00:00:00 +0000 UTC
Timestamp: 2020-02-11 20:26:13.000000789 +0000 UTC
SeverityText: Info
SeverityNumber: SEVERITY_NUMBER_INFO(9)
SeverityNumber: Info(9)
Body: Str(This is a log message)
Attributes:
-> app: Str(server)
Expand Down
Expand Up @@ -9,7 +9,7 @@ LogRecord #0
ObservedTimestamp: 1970-01-01 00:00:00 +0000 UTC
Timestamp: 2020-02-11 20:26:13.000000789 +0000 UTC
SeverityText: Info
SeverityNumber: SEVERITY_NUMBER_INFO(9)
SeverityNumber: Info(9)
Body: Str(This is a log message)
Attributes:
-> app: Str(server)
Expand All @@ -21,7 +21,7 @@ LogRecord #1
ObservedTimestamp: 1970-01-01 00:00:00 +0000 UTC
Timestamp: 2020-02-11 20:26:13.000000789 +0000 UTC
SeverityText: Info
SeverityNumber: SEVERITY_NUMBER_INFO(9)
SeverityNumber: Info(9)
Body: Str(something happened)
Attributes:
-> customer: Str(acme)
Expand Down
56 changes: 55 additions & 1 deletion pdata/plog/logs.go
Expand Up @@ -101,4 +101,58 @@ const (
)

// String returns the string representation of the SeverityNumber.
func (sn SeverityNumber) String() string { return otlplogs.SeverityNumber(sn).String() }
func (sn SeverityNumber) String() string {
switch sn {
case SeverityNumberUnspecified:
return "Unspecified"
case SeverityNumberTrace:
return "Trace"
case SeverityNumberTrace2:
return "Trace2"
case SeverityNumberTrace3:
return "Trace3"
case SeverityNumberTrace4:
return "Trace4"
case SeverityNumberDebug:
return "Debug"
case SeverityNumberDebug2:
return "Debug2"
case SeverityNumberDebug3:
return "Debug3"
case SeverityNumberDebug4:
return "Debug4"
case SeverityNumberInfo:
return "Info"
case SeverityNumberInfo2:
return "Info2"
case SeverityNumberInfo3:
return "Info3"
case SeverityNumberInfo4:
return "Info4"
case SeverityNumberWarn:
return "Warn"
case SeverityNumberWarn2:
return "Warn2"
case SeverityNumberWarn3:
return "Warn3"
case SeverityNumberWarn4:
return "Warn4"
case SeverityNumberError:
return "Error"
case SeverityNumberError2:
return "Error2"
case SeverityNumberError3:
return "Error3"
case SeverityNumberError4:
return "Error4"
case SeverityNumberFatal:
return "Fatal"
case SeverityNumberFatal2:
return "Fatal2"
case SeverityNumberFatal3:
return "Fatal3"
case SeverityNumberFatal4:
return "Fatal4"
}
return ""
}
29 changes: 29 additions & 0 deletions pdata/plog/logs_test.go
Expand Up @@ -133,3 +133,32 @@ func TestLogsCopyTo(t *testing.T) {
logs.CopyTo(logsCopy)
assert.EqualValues(t, logs, logsCopy)
}

func TestSeverityNumberString(t *testing.T) {
assert.EqualValues(t, "Unspecified", SeverityNumberUnspecified.String())
assert.EqualValues(t, "Trace", SeverityNumberTrace.String())
assert.EqualValues(t, "Trace2", SeverityNumberTrace2.String())
assert.EqualValues(t, "Trace3", SeverityNumberTrace3.String())
assert.EqualValues(t, "Trace4", SeverityNumberTrace4.String())
assert.EqualValues(t, "Debug", SeverityNumberDebug.String())
assert.EqualValues(t, "Debug2", SeverityNumberDebug2.String())
assert.EqualValues(t, "Debug3", SeverityNumberDebug3.String())
assert.EqualValues(t, "Debug4", SeverityNumberDebug4.String())
assert.EqualValues(t, "Info", SeverityNumberInfo.String())
assert.EqualValues(t, "Info2", SeverityNumberInfo2.String())
assert.EqualValues(t, "Info3", SeverityNumberInfo3.String())
assert.EqualValues(t, "Info4", SeverityNumberInfo4.String())
assert.EqualValues(t, "Warn", SeverityNumberWarn.String())
assert.EqualValues(t, "Warn2", SeverityNumberWarn2.String())
assert.EqualValues(t, "Warn3", SeverityNumberWarn3.String())
assert.EqualValues(t, "Warn4", SeverityNumberWarn4.String())
assert.EqualValues(t, "Error", SeverityNumberError.String())
assert.EqualValues(t, "Error2", SeverityNumberError2.String())
assert.EqualValues(t, "Error3", SeverityNumberError3.String())
assert.EqualValues(t, "Error4", SeverityNumberError4.String())
assert.EqualValues(t, "Fatal", SeverityNumberFatal.String())
assert.EqualValues(t, "Fatal2", SeverityNumberFatal2.String())
assert.EqualValues(t, "Fatal3", SeverityNumberFatal3.String())
assert.EqualValues(t, "Fatal4", SeverityNumberFatal4.String())
assert.EqualValues(t, "", SeverityNumber(100).String())
}
34 changes: 30 additions & 4 deletions pdata/ptrace/traces.go
Expand Up @@ -72,9 +72,6 @@ func (ms Traces) ResourceSpans() ResourceSpansSlice {
// in addition to a parent/child relationship.
type SpanKind int32

// String returns the string representation of the SpanKind.
func (sk SpanKind) String() string { return otlptrace.Span_SpanKind(sk).String() }

const (
// SpanKindUnspecified represents that the SpanKind is unspecified, it MUST NOT be used.
SpanKindUnspecified = SpanKind(otlptrace.Span_SPAN_KIND_UNSPECIFIED)
Expand All @@ -98,6 +95,25 @@ const (
SpanKindConsumer = SpanKind(otlptrace.Span_SPAN_KIND_CONSUMER)
)

// String returns the string representation of the SpanKind.
func (sk SpanKind) String() string {
switch sk {
case SpanKindUnspecified:
return "Unspecified"
case SpanKindInternal:
return "Internal"
case SpanKindServer:
return "Server"
case SpanKindClient:
return "Client"
case SpanKindProducer:
return "Producer"
case SpanKindConsumer:
return "Consumer"
}
return ""
}

// StatusCode mirrors the codes defined at
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status
type StatusCode int32
Expand All @@ -109,4 +125,14 @@ const (
)

// String returns the string representation of the StatusCode.
func (sc StatusCode) String() string { return otlptrace.Status_StatusCode(sc).String() }
func (sc StatusCode) String() string {
switch sc {
case StatusCodeUnset:
return "Unset"
case StatusCodeOk:
return "Ok"
case StatusCodeError:
return "Error"
}
return ""
}
17 changes: 17 additions & 0 deletions pdata/ptrace/traces_test.go
Expand Up @@ -134,3 +134,20 @@ func TestTracesCopyTo(t *testing.T) {
traces.CopyTo(tracesCopy)
assert.EqualValues(t, traces, tracesCopy)
}

func TestSpanKindString(t *testing.T) {
assert.EqualValues(t, "Unspecified", SpanKindUnspecified.String())
assert.EqualValues(t, "Internal", SpanKindInternal.String())
assert.EqualValues(t, "Server", SpanKindServer.String())
assert.EqualValues(t, "Client", SpanKindClient.String())
assert.EqualValues(t, "Producer", SpanKindProducer.String())
assert.EqualValues(t, "Consumer", SpanKindConsumer.String())
assert.EqualValues(t, "", SpanKind(100).String())
}

func TestStatusCodeString(t *testing.T) {
assert.EqualValues(t, "Unset", StatusCodeUnset.String())
assert.EqualValues(t, "Ok", StatusCodeOk.String())
assert.EqualValues(t, "Error", StatusCodeError.String())
assert.EqualValues(t, "", StatusCode(100).String())
}