Update OTLP to 0.6.0 and use the new Span Status code

Contributes to open-telemetry#1841 TODO: need to use deprecated_code as specified in the OTLP spec. Add sender-side handling of deprecated Span status code Add receiver-side handling of deprecated Span status code
tigrannajaryan · Nov 3, 2020 · 88190ba · 88190ba
1 parent 77c4d29
commit 88190ba
Show file tree

Hide file tree

Showing 24 changed files with 643 additions and 395 deletions.
diff --git a/cmd/pdatagen/internal/base_fields.go b/cmd/pdatagen/internal/base_fields.go
@@ -92,6 +92,13 @@ func (ms ${structName}) Set${fieldName}(v ${returnType}) {
 	(*ms.orig).${originFieldName} = ${rawType}(v)
 }`
 
+const accessorsPrimitiveWithoutSetterTypedTemplate = `// ${fieldName} returns the ${lowerFieldName} associated with this ${structName}.
+//
+// Important: This causes a runtime error if IsNil() returns "true".
+func (ms ${structName}) ${fieldName}() ${returnType} {
+	return ${returnType}((*ms.orig).${originFieldName})
+}`
+
 type baseField interface {
 	generateAccessors(ms *messageStruct, sb *strings.Builder)
 
@@ -265,10 +272,17 @@ type primitiveTypedField struct {
 	defaultVal      string
 	testVal         string
 	rawType         string
+	manualSetter    bool
 }
 
 func (ptf *primitiveTypedField) generateAccessors(ms *messageStruct, sb *strings.Builder) {
-	sb.WriteString(os.Expand(accessorsPrimitiveTypedTemplate, func(name string) string {
+	template := accessorsPrimitiveTypedTemplate
+	if ptf.manualSetter {
+		// Generate code without setter. Setter will be manually coded.
+		template = accessorsPrimitiveWithoutSetterTypedTemplate
+	}
+
+	sb.WriteString(os.Expand(template, func(name string) string {
 		switch name {
 		case "structName":
 			return ms.structName

diff --git a/cmd/pdatagen/internal/trace_structs.go b/cmd/pdatagen/internal/trace_structs.go
@@ -190,6 +190,18 @@ var spanStatus = &messageStruct{
 			rawType:         "otlptrace.Status_StatusCode",
 			defaultVal:      "StatusCode(0)",
 			testVal:         "StatusCode(1)",
+			// Generate code without setter. Setter will be manually coded since we
+			// need to also change DeprecatedCode when Code is changed according
+			// to OTLP spec https://github.com/open-telemetry/opentelemetry-proto/blob/59c488bfb8fb6d0458ad6425758b70259ff4a2bd/opentelemetry/proto/trace/v1/trace.proto#L231
+			manualSetter: true,
+		},
+		&primitiveTypedField{
+			fieldName:       "DeprecatedCode",
+			originFieldName: "DeprecatedCode",
+			returnType:      "DeprecatedStatusCode",
+			rawType:         "otlptrace.Status_DeprecatedStatusCode",
+			defaultVal:      "DeprecatedStatusCode(0)",
+			testVal:         "DeprecatedStatusCode(1)",
 		},
 		&primitiveField{
 			fieldName:       "Message",

diff --git a/consumer/pdata/generated_trace.go b/consumer/pdata/generated_trace.go
diff --git a/consumer/pdata/generated_trace_test.go b/consumer/pdata/generated_trace_test.go
diff --git a/consumer/pdata/trace.go b/consumer/pdata/trace.go
@@ -130,29 +130,69 @@ const (
 	SpanKindCONSUMER    = SpanKind(otlptrace.Span_SPAN_KIND_CONSUMER)
 )
 
+// DeprecatedStatusCode is the deprecated status code used previously.
+// https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#set-status
+type DeprecatedStatusCode otlptrace.Status_DeprecatedStatusCode
+
+const (
+	DeprecatedStatusCodeOk                 = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_OK)
+	DeprecatedStatusCodeCancelled          = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_CANCELLED)
+	DeprecatedStatusCodeUnknownError       = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_UNKNOWN_ERROR)
+	DeprecatedStatusCodeInvalidArgument    = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_INVALID_ARGUMENT)
+	DeprecatedStatusCodeDeadlineExceeded   = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_DEADLINE_EXCEEDED)
+	DeprecatedStatusCodeNotFound           = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_NOT_FOUND)
+	DeprecatedStatusCodeAlreadyExists      = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_ALREADY_EXISTS)
+	DeprecatedStatusCodePermissionDenied   = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_PERMISSION_DENIED)
+	DeprecatedStatusCodeResourceExhausted  = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_RESOURCE_EXHAUSTED)
+	DeprecatedStatusCodeFailedPrecondition = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_FAILED_PRECONDITION)
+	DeprecatedStatusCodeAborted            = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_ABORTED)
+	DeprecatedStatusCodeOutOfRange         = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_OUT_OF_RANGE)
+	DeprecatedStatusCodeUnimplemented      = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_UNIMPLEMENTED)
+	DeprecatedStatusCodeInternalError      = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_INTERNAL_ERROR)
+	DeprecatedStatusCodeUnavailable        = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_UNAVAILABLE)
+	DeprecatedStatusCodeDataLoss           = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_DATA_LOSS)
+	DeprecatedStatusCodeUnauthenticated    = DeprecatedStatusCode(otlptrace.Status_DEPRECATED_STATUS_CODE_UNAUTHENTICATED)
+)
+
+func (sc DeprecatedStatusCode) String() string {
+	return otlptrace.Status_DeprecatedStatusCode(sc).String()
+}
+
 // StatusCode mirrors the codes defined at
-// https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#statuscanonicalcode
-// and is numerically equal to Standard GRPC codes https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+// https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#set-status
 type StatusCode otlptrace.Status_StatusCode
 
 const (
-	StatusCodeOk                 = StatusCode(otlptrace.Status_STATUS_CODE_OK)
-	StatusCodeCancelled          = StatusCode(otlptrace.Status_STATUS_CODE_CANCELLED)
-	StatusCodeUnknownError       = StatusCode(otlptrace.Status_STATUS_CODE_UNKNOWN_ERROR)
-	StatusCodeInvalidArgument    = StatusCode(otlptrace.Status_STATUS_CODE_INVALID_ARGUMENT)
-	StatusCodeDeadlineExceeded   = StatusCode(otlptrace.Status_STATUS_CODE_DEADLINE_EXCEEDED)
-	StatusCodeNotFound           = StatusCode(otlptrace.Status_STATUS_CODE_NOT_FOUND)
-	StatusCodeAlreadyExists      = StatusCode(otlptrace.Status_STATUS_CODE_ALREADY_EXISTS)
-	StatusCodePermissionDenied   = StatusCode(otlptrace.Status_STATUS_CODE_PERMISSION_DENIED)
-	StatusCodeResourceExhausted  = StatusCode(otlptrace.Status_STATUS_CODE_RESOURCE_EXHAUSTED)
-	StatusCodeFailedPrecondition = StatusCode(otlptrace.Status_STATUS_CODE_FAILED_PRECONDITION)
-	StatusCodeAborted            = StatusCode(otlptrace.Status_STATUS_CODE_ABORTED)
-	StatusCodeOutOfRange         = StatusCode(otlptrace.Status_STATUS_CODE_OUT_OF_RANGE)
-	StatusCodeUnimplemented      = StatusCode(otlptrace.Status_STATUS_CODE_UNIMPLEMENTED)
-	StatusCodeInternalError      = StatusCode(otlptrace.Status_STATUS_CODE_INTERNAL_ERROR)
-	StatusCodeUnavailable        = StatusCode(otlptrace.Status_STATUS_CODE_UNAVAILABLE)
-	StatusCodeDataLoss           = StatusCode(otlptrace.Status_STATUS_CODE_DATA_LOSS)
-	StatusCodeUnauthenticated    = StatusCode(otlptrace.Status_STATUS_CODE_UNAUTHENTICATED)
+	StatusCodeUnset = StatusCode(otlptrace.Status_STATUS_CODE_UNSET)
+	StatusCodeOk    = StatusCode(otlptrace.Status_STATUS_CODE_OK)
+	StatusCodeError = StatusCode(otlptrace.Status_STATUS_CODE_ERROR)
 )
 
 func (sc StatusCode) String() string { return otlptrace.Status_StatusCode(sc).String() }
+
+// SetCode replaces the code associated with this SpanStatus.
+//
+// Important: This causes a runtime error if IsNil() returns "true".
+func (ms SpanStatus) SetCode(v StatusCode) {
+	(*ms.orig).Code = otlptrace.Status_StatusCode(v)
+
+	// According to OTLP spec we also need to set the deprecated_code field.
+	// See https://github.com/open-telemetry/opentelemetry-proto/blob/59c488bfb8fb6d0458ad6425758b70259ff4a2bd/opentelemetry/proto/trace/v1/trace.proto#L231
+	//
+	//   if code==STATUS_CODE_UNSET then `deprecated_code` MUST be
+	//   set to DEPRECATED_STATUS_CODE_OK.
+	//
+	//   if code==STATUS_CODE_OK then `deprecated_code` MUST be
+	//   set to DEPRECATED_STATUS_CODE_OK.
+	//
+	//   if code==STATUS_CODE_ERROR then `deprecated_code` MUST be
+	//   set to DEPRECATED_STATUS_CODE_UNKNOWN_ERROR.
+	switch v {
+	case StatusCodeUnset:
+		fallthrough
+	case StatusCodeOk:
+		ms.SetDeprecatedCode(DeprecatedStatusCodeOk)
+	case StatusCodeError:
+		ms.SetDeprecatedCode(DeprecatedStatusCodeUnknownError)
+	}
+}
diff --git a/internal/data/opentelemetry-proto b/internal/data/opentelemetry-proto
+8 −0		README.md
+81 −27		opentelemetry/proto/trace/v1/trace.proto
+6 −6		opentelemetry/proto/trace/v1/trace_config.proto