@@ -16,35 +16,73 @@ package trace
1616
1717import (
1818 "context"
19+ "errors"
1920 "fmt"
21+ "os"
22+ "strings"
2023
2124 "go.opencensus.io/trace"
22- "golang.org/x/xerrors"
25+ "go.opentelemetry.io/otel"
26+ "go.opentelemetry.io/otel/attribute"
27+ "go.opentelemetry.io/otel/codes"
28+ ottrace "go.opentelemetry.io/otel/trace"
2329 "google.golang.org/api/googleapi"
2430 "google.golang.org/genproto/googleapis/rpc/code"
2531 "google.golang.org/grpc/status"
2632)
2733
34+ const (
35+ telemetryPlatformTracing = "GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING"
36+ telemetryPlatformTracingOpenCensus = "opencensus"
37+ telemetryPlatformTracingOpenTelemetry = "opentelemetry"
38+ )
39+
40+ var (
41+ // TODO(chrisdsmith): What is the correct name for the OpenTelemetry tracer?
42+ OpenTelemetryTracerName string = "cloud.google.com/go/internal/trace"
43+ )
44+
45+ func IsOpenCensusTracingEnabled () bool {
46+ return ! IsOpenTelemetryTracingEnabled ()
47+ }
48+
49+ func IsOpenTelemetryTracingEnabled () bool {
50+ env := strings .TrimSpace (os .Getenv (telemetryPlatformTracing ))
51+ return strings .ToLower (env ) == telemetryPlatformTracingOpenTelemetry
52+ }
53+
2854// StartSpan adds a span to the trace with the given name.
2955func StartSpan (ctx context.Context , name string ) context.Context {
30- ctx , _ = trace .StartSpan (ctx , name )
56+ if IsOpenTelemetryTracingEnabled () {
57+ ctx , _ = otel .GetTracerProvider ().Tracer (OpenTelemetryTracerName ).Start (ctx , name )
58+ } else {
59+ ctx , _ = trace .StartSpan (ctx , name )
60+ }
3161 return ctx
3262}
3363
3464// EndSpan ends a span with the given error.
3565func EndSpan (ctx context.Context , err error ) {
36- span := trace .FromContext (ctx )
37- if err != nil {
38- span .SetStatus (toStatus (err ))
66+ if IsOpenTelemetryTracingEnabled () {
67+ span := ottrace .SpanFromContext (ctx )
68+ if err != nil {
69+ span .SetStatus (codes .Error , toOpenTelemetryStatusDescription (err ))
70+ span .RecordError (err )
71+ }
72+ span .End ()
73+ } else {
74+ span := trace .FromContext (ctx )
75+ if err != nil {
76+ span .SetStatus (toStatus (err ))
77+ }
78+ span .End ()
3979 }
40- span .End ()
4180}
4281
43- // toStatus interrogates an error and converts it to an appropriate
44- // OpenCensus status.
82+ // toStatus converts an error to an equivalent OpenCensus status.
4583func toStatus (err error ) trace.Status {
4684 var err2 * googleapi.Error
47- if ok := xerrors .As (err , & err2 ); ok {
85+ if ok := errors .As (err , & err2 ); ok {
4886 return trace.Status {Code : httpStatusCodeToOCCode (err2 .Code ), Message : err2 .Message }
4987 } else if s , ok := status .FromError (err ); ok {
5088 return trace.Status {Code : int32 (s .Code ()), Message : s .Message ()}
@@ -53,6 +91,18 @@ func toStatus(err error) trace.Status {
5391 }
5492}
5593
94+ // toOpenTelemetryStatus converts an error to an equivalent OpenTelemetry status description.
95+ func toOpenTelemetryStatusDescription (err error ) string {
96+ var err2 * googleapi.Error
97+ if ok := errors .As (err , & err2 ); ok {
98+ return err2 .Message
99+ } else if s , ok := status .FromError (err ); ok {
100+ return s .Message ()
101+ } else {
102+ return err .Error ()
103+ }
104+ }
105+
56106// TODO(deklerk): switch to using OpenCensus function when it becomes available.
57107// Reference: https://github.com/googleapis/googleapis/blob/26b634d2724ac5dd30ae0b0cbfb01f07f2e4050e/google/rpc/code.proto
58108func httpStatusCodeToOCCode (httpStatusCode int ) int32 {
@@ -86,10 +136,25 @@ func httpStatusCodeToOCCode(httpStatusCode int) int32 {
86136 }
87137}
88138
139+ // TracePrintf retrieves the current OpenCensus or OpenTelemetry span from context, then:
140+ // * calls Span.Annotatef if OpenCensus is enabled; or
141+ // * calls Span.AddEvent if OpenTelemetry is enabled.
142+ //
89143// TODO: (odeke-em): perhaps just pass around spans due to the cost
90144// incurred from using trace.FromContext(ctx) yet we could avoid
91145// throwing away the work done by ctx, span := trace.StartSpan.
92146func TracePrintf (ctx context.Context , attrMap map [string ]interface {}, format string , args ... interface {}) {
147+ if IsOpenTelemetryTracingEnabled () {
148+ attrs := otAttrs (attrMap )
149+ ottrace .SpanFromContext (ctx ).AddEvent (fmt .Sprintf (format , args ... ), ottrace .WithAttributes (attrs ... ))
150+ } else {
151+ attrs := ocAttrs (attrMap )
152+ trace .FromContext (ctx ).Annotatef (attrs , format , args ... )
153+ }
154+ }
155+
156+ // ocAttrs converts a generic map to OpenCensus attributes.
157+ func ocAttrs (attrMap map [string ]interface {}) []trace.Attribute {
93158 var attrs []trace.Attribute
94159 for k , v := range attrMap {
95160 var a trace.Attribute
@@ -107,5 +172,27 @@ func TracePrintf(ctx context.Context, attrMap map[string]interface{}, format str
107172 }
108173 attrs = append (attrs , a )
109174 }
110- trace .FromContext (ctx ).Annotatef (attrs , format , args ... )
175+ return attrs
176+ }
177+
178+ // otAttrs converts a generic map to OpenTelemetry attributes.
179+ func otAttrs (attrMap map [string ]interface {}) []attribute.KeyValue {
180+ var attrs []attribute.KeyValue
181+ for k , v := range attrMap {
182+ var a attribute.KeyValue
183+ switch v := v .(type ) {
184+ case string :
185+ a = attribute .Key (k ).String (v )
186+ case bool :
187+ a = attribute .Key (k ).Bool (v )
188+ case int :
189+ a = attribute .Key (k ).Int (v )
190+ case int64 :
191+ a = attribute .Key (k ).Int64 (v )
192+ default :
193+ a = attribute .Key (k ).String (fmt .Sprintf ("%#v" , v ))
194+ }
195+ attrs = append (attrs , a )
196+ }
197+ return attrs
111198}
0 commit comments