1 // Copyright 2018 Google LLC
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
20 "go.opencensus.io/trace"
21 "google.golang.org/api/googleapi"
22 "google.golang.org/genproto/googleapis/rpc/code"
23 "google.golang.org/grpc/status"
26 // StartSpan adds a span to the trace with the given name.
27 func StartSpan(ctx context.Context, name string) context.Context {
28 ctx, _ = trace.StartSpan(ctx, name)
32 // EndSpan ends a span with the given error.
33 func EndSpan(ctx context.Context, err error) {
34 span := trace.FromContext(ctx)
36 span.SetStatus(toStatus(err))
41 // ToStatus interrogates an error and converts it to an appropriate
43 func toStatus(err error) trace.Status {
44 if err2, ok := err.(*googleapi.Error); ok {
45 return trace.Status{Code: httpStatusCodeToOCCode(err2.Code), Message: err2.Message}
46 } else if s, ok := status.FromError(err); ok {
47 return trace.Status{Code: int32(s.Code()), Message: s.Message()}
49 return trace.Status{Code: int32(code.Code_UNKNOWN), Message: err.Error()}
53 // TODO (deklerk): switch to using OpenCensus function when it becomes available.
54 // Reference: https://github.com/googleapis/googleapis/blob/26b634d2724ac5dd30ae0b0cbfb01f07f2e4050e/google/rpc/code.proto
55 func httpStatusCodeToOCCode(httpStatusCode int) int32 {
56 switch httpStatusCode {
58 return int32(code.Code_OK)
60 return int32(code.Code_CANCELLED)
62 return int32(code.Code_UNKNOWN) // Could also be Code_INTERNAL, Code_DATA_LOSS
64 return int32(code.Code_INVALID_ARGUMENT) // Could also be Code_OUT_OF_RANGE
66 return int32(code.Code_DEADLINE_EXCEEDED)
68 return int32(code.Code_NOT_FOUND)
70 return int32(code.Code_ALREADY_EXISTS) // Could also be Code_ABORTED
72 return int32(code.Code_PERMISSION_DENIED)
74 return int32(code.Code_UNAUTHENTICATED)
76 return int32(code.Code_RESOURCE_EXHAUSTED)
78 return int32(code.Code_UNIMPLEMENTED)
80 return int32(code.Code_UNAVAILABLE)
82 return int32(code.Code_UNKNOWN)