-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
tracing.go
193 lines (163 loc) · 5.38 KB
/
tracing.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
Copyright 2021 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package diagnostics
import (
"context"
"encoding/hex"
"fmt"
"strings"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"github.com/dapr/dapr/pkg/config"
diagConsts "github.com/dapr/dapr/pkg/diagnostics/consts"
diagUtils "github.com/dapr/dapr/pkg/diagnostics/utils"
)
const (
daprHeaderPrefix = "dapr-"
daprHeaderBinSuffix = "-bin"
tracerName = "dapr-diagnostics"
)
var tracer trace.Tracer = otel.Tracer(tracerName)
// SpanContextToW3CString returns the SpanContext string representation.
func SpanContextToW3CString(sc trace.SpanContext) string {
traceID := sc.TraceID()
spanID := sc.SpanID()
traceFlags := sc.TraceFlags()
return fmt.Sprintf("%x-%x-%x-%x",
[]byte{supportedVersion},
traceID[:],
spanID[:],
[]byte{byte(traceFlags)})
}
// TraceStateToW3CString extracts the TraceState from given SpanContext and returns its string representation.
func TraceStateToW3CString(sc trace.SpanContext) string {
return sc.TraceState().String()
}
// SpanContextFromW3CString extracts a span context from given string which got earlier from SpanContextToW3CString format.
func SpanContextFromW3CString(h string) (sc trace.SpanContext, ok bool) {
if h == "" {
return trace.SpanContext{}, false
}
sections := strings.Split(h, "-")
if len(sections) < 4 {
return trace.SpanContext{}, false
}
if len(sections[0]) != 2 {
return trace.SpanContext{}, false
}
ver, err := hex.DecodeString(sections[0])
if err != nil {
return trace.SpanContext{}, false
}
version := int(ver[0])
if version > maxVersion {
return trace.SpanContext{}, false
}
if version == 0 && len(sections) != 4 {
return trace.SpanContext{}, false
}
if len(sections[1]) != 32 {
return trace.SpanContext{}, false
}
tid, err := trace.TraceIDFromHex(sections[1])
if err != nil {
return trace.SpanContext{}, false
}
sc = sc.WithTraceID(tid)
if len(sections[2]) != 16 {
return trace.SpanContext{}, false
}
sid, err := trace.SpanIDFromHex(sections[2])
if err != nil {
return trace.SpanContext{}, false
}
sc = sc.WithSpanID(sid)
opts, err := hex.DecodeString(sections[3])
if err != nil || len(opts) < 1 {
return trace.SpanContext{}, false
}
sc = sc.WithTraceFlags(trace.TraceFlags(opts[0]))
// Don't allow all zero trace or span ID.
if sc.TraceID() == [16]byte{} || sc.SpanID() == [8]byte{} {
return trace.SpanContext{}, false
}
return sc, true
}
// TraceStateFromW3CString extracts a span tracestate from given string which got earlier from TraceStateFromW3CString format.
func TraceStateFromW3CString(h string) *trace.TraceState {
if h == "" {
ts := trace.TraceState{}
return &ts
}
ts, err := trace.ParseTraceState(h)
if err != nil {
ts = trace.TraceState{}
return &ts
}
return &ts
}
// AddAttributesToSpan adds the given attributes in the span.
func AddAttributesToSpan(span trace.Span, attributes map[string]string) {
if span == nil {
return
}
var attrs []attribute.KeyValue
for k, v := range attributes {
// Skip if key is for internal use.
if !strings.HasPrefix(k, diagConsts.DaprInternalSpanAttrPrefix) && v != "" {
attrs = append(attrs, attribute.String(k, v))
}
}
if len(attrs) > 0 {
span.SetAttributes(attrs...)
}
}
// ConstructInputBindingSpanAttributes creates span attributes for InputBindings.
func ConstructInputBindingSpanAttributes(bindingName, url string) map[string]string {
return map[string]string{
diagConsts.DBNameSpanAttributeKey: bindingName,
diagConsts.GrpcServiceSpanAttributeKey: diagConsts.DaprGRPCDaprService,
diagConsts.DBSystemSpanAttributeKey: diagConsts.BindingBuildingBlockType,
diagConsts.DBConnectionStringSpanAttributeKey: url,
}
}
// ConstructSubscriptionSpanAttributes creates span attributes for Pubsub subscription.
func ConstructSubscriptionSpanAttributes(topic string) map[string]string {
return map[string]string{
diagConsts.MessagingSystemSpanAttributeKey: diagConsts.PubsubBuildingBlockType,
diagConsts.MessagingDestinationSpanAttributeKey: topic,
}
}
// StartInternalCallbackSpan starts trace span for internal callback such as input bindings and pubsub subscription.
func StartInternalCallbackSpan(ctx context.Context, spanName string, parent trace.SpanContext, spec *config.TracingSpec) (context.Context, trace.Span) {
if spec == nil || !diagUtils.IsTracingEnabled(spec.SamplingRate) {
return ctx, nil
}
ctx = trace.ContextWithRemoteSpanContext(ctx, parent)
ctx, span := tracer.Start(ctx, spanName, trace.WithSpanKind(trace.SpanKindClient))
return ctx, span
}
func TraceIDAndStateFromSpan(span trace.Span) (string, string) {
var corID, traceState string
if span != nil {
sc := span.SpanContext()
if !sc.Equal(trace.SpanContext{}) {
corID = SpanContextToW3CString(sc)
}
if sc.TraceState().Len() > 0 {
traceState = TraceStateToW3CString(sc)
}
}
return corID, traceState
}