Skip to content

Commit

Permalink
[pdata] Update values returned by all String methods of enum types
Browse files Browse the repository at this point in the history
Update values returned by all String methods of enum types to a consistent short form representing the enum identifier
  • Loading branch information
dmitryax committed Nov 1, 2022
1 parent df8deb4 commit aa32267
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 9 deletions.
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 ""
}
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 ""
}

0 comments on commit aa32267

Please sign in to comment.