forked from go-kit/kit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
grpc.go
214 lines (185 loc) · 5.76 KB
/
grpc.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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
package zipkin
import (
"context"
"strconv"
zipkin "github.com/openzipkin/zipkin-go"
"github.com/openzipkin/zipkin-go/model"
"github.com/openzipkin/zipkin-go/propagation/b3"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
"github.com/go-kit/kit/log"
kitgrpc "github.com/go-kit/kit/transport/grpc"
)
// GRPCClientTrace enables native Zipkin tracing of a Go kit gRPC transport
// Client.
//
// Go kit creates gRPC transport clients per remote endpoint. This middleware
// can be set-up individually by adding the endpoint name for each of the Go kit
// transport clients using the Name() TracerOption.
// If wanting to use the gRPC FullMethod (/service/method) as Span name you can
// create a global client tracer omitting the Name() TracerOption, which you can
// then feed to each Go kit gRPC transport client.
// If instrumenting a client to an external (not on your platform) service, you
// will probably want to disallow propagation of SpanContext using the
// AllowPropagation TracerOption and setting it to false.
func GRPCClientTrace(tracer *zipkin.Tracer, options ...TracerOption) kitgrpc.ClientOption {
config := tracerOptions{
tags: make(map[string]string),
name: "",
logger: log.NewNopLogger(),
propagate: true,
}
for _, option := range options {
option(&config)
}
clientBefore := kitgrpc.ClientBefore(
func(ctx context.Context, md *metadata.MD) context.Context {
var (
spanContext model.SpanContext
name string
)
if config.name != "" {
name = config.name
} else {
name = ctx.Value(kitgrpc.ContextKeyRequestMethod).(string)
}
if parent := zipkin.SpanFromContext(ctx); parent != nil {
spanContext = parent.Context()
}
span := tracer.StartSpan(
name,
zipkin.Kind(model.Client),
zipkin.Tags(config.tags),
zipkin.Parent(spanContext),
zipkin.FlushOnFinish(false),
)
if config.propagate {
if err := b3.InjectGRPC(md)(span.Context()); err != nil {
config.logger.Log("err", err)
}
}
return zipkin.NewContext(ctx, span)
},
)
clientAfter := kitgrpc.ClientAfter(
func(ctx context.Context, _ metadata.MD, _ metadata.MD) context.Context {
if span := zipkin.SpanFromContext(ctx); span != nil {
span.Finish()
}
return ctx
},
)
clientFinalizer := kitgrpc.ClientFinalizer(
func(ctx context.Context, err error) {
if span := zipkin.SpanFromContext(ctx); span != nil {
if err != nil {
zipkin.TagError.Set(span, err.Error())
}
// calling span.Finish() a second time is a noop, if we didn't get to
// ClientAfter we can at least time the early bail out by calling it
// here.
span.Finish()
// send span to the Reporter
span.Flush()
}
},
)
return func(c *kitgrpc.Client) {
clientBefore(c)
clientAfter(c)
clientFinalizer(c)
}
}
// GRPCServerTrace enables native Zipkin tracing of a Go kit gRPC transport
// Server.
//
// Go kit creates gRPC transport servers per gRPC method. This middleware can be
// set-up individually by adding the method name for each of the Go kit method
// servers using the Name() TracerOption.
// If wanting to use the gRPC FullMethod (/service/method) as Span name you can
// create a global server tracer omitting the Name() TracerOption, which you can
// then feed to each Go kit method server. For this to work you will need to
// wire the Go kit gRPC Interceptor too.
// If instrumenting a service to external (not on your platform) clients, you
// will probably want to disallow propagation of a client SpanContext using
// the AllowPropagation TracerOption and setting it to false.
func GRPCServerTrace(tracer *zipkin.Tracer, options ...TracerOption) kitgrpc.ServerOption {
config := tracerOptions{
tags: make(map[string]string),
name: "",
logger: log.NewNopLogger(),
propagate: true,
}
for _, option := range options {
option(&config)
}
serverBefore := kitgrpc.ServerBefore(
func(ctx context.Context, md metadata.MD) context.Context {
var (
spanContext model.SpanContext
name string
tags = make(map[string]string)
)
rpcMethod, ok := ctx.Value(kitgrpc.ContextKeyRequestMethod).(string)
if !ok {
config.logger.Log("err", "unable to retrieve method name: missing gRPC interceptor hook")
} else {
tags["grpc.method"] = rpcMethod
}
if config.name != "" {
name = config.name
} else {
name = rpcMethod
}
if config.propagate {
spanContext = tracer.Extract(b3.ExtractGRPC(&md))
if spanContext.Err != nil {
config.logger.Log("err", spanContext.Err)
}
}
span := tracer.StartSpan(
name,
zipkin.Kind(model.Server),
zipkin.Tags(config.tags),
zipkin.Tags(tags),
zipkin.Parent(spanContext),
zipkin.FlushOnFinish(false),
)
return zipkin.NewContext(ctx, span)
},
)
serverAfter := kitgrpc.ServerAfter(
func(ctx context.Context, _ *metadata.MD, _ *metadata.MD) context.Context {
if span := zipkin.SpanFromContext(ctx); span != nil {
span.Finish()
}
return ctx
},
)
serverFinalizer := kitgrpc.ServerFinalizer(
func(ctx context.Context, err error) {
if span := zipkin.SpanFromContext(ctx); span != nil {
if err != nil {
if status, ok := status.FromError(err); ok {
statusCode := strconv.FormatUint(uint64(status.Code()), 10)
zipkin.TagGRPCStatusCode.Set(span, statusCode)
zipkin.TagError.Set(span, status.Message())
} else {
zipkin.TagError.Set(span, err.Error())
}
}
// calling span.Finish() a second time is a noop, if we didn't get to
// ServerAfter we can at least time the early bail out by calling it
// here.
span.Finish()
// send span to the Reporter
span.Flush()
}
},
)
return func(s *kitgrpc.Server) {
serverBefore(s)
serverAfter(s)
serverFinalizer(s)
}
}