go.temporal.io/server/common/telemetry/grpc.go
197 LOC · 98 covered · 99 uncovered · 24 ranges · 77 concepts · 11 introducers · 17 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
package telemetry
2
3
import (
4
"context"
5
"time"
6
7
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
8
"go.opentelemetry.io/otel/attribute"
9
"go.opentelemetry.io/otel/propagation"
10
"go.opentelemetry.io/otel/trace"
11
otelnoop "go.opentelemetry.io/otel/trace/noop"
12
"go.temporal.io/server/common/log"
13
"go.temporal.io/server/common/log/tag"
14
"go.temporal.io/server/common/rpc/interceptor/logtags"
15
"go.temporal.io/server/common/tasktoken"
16
"google.golang.org/grpc/stats"
17
"google.golang.org/grpc/status"
18
"google.golang.org/protobuf/encoding/protojson"
19
"google.golang.org/protobuf/proto"
20
)
21
22
type methodNameKey struct{}
23
24
type (
25
// ServerStatsHandler gives a named type to the stats.Handler implementation provided by otelgrpc.
26
ServerStatsHandler stats.Handler
27
28
// ClientStatsHandler gives a named type to the grpc.UnaryClientInterceptor implementation provided by otelgrpc.
29
ClientStatsHandler stats.Handler
30
31
customServerStatsHandler struct {
32
isDebug bool
33
wrapped stats.Handler
34
tags *logtags.WorkflowTags
35
}
36
)
37
38
// NewServerStatsHandler creates a new gRPC stats handler that tracks each request with an encapsulating span
39
// using the provided TracerProvider and TextMapPropagator.
40
//
41
// NOTE: If the TracerProvider is `noop.TracerProvider`, it returns `nil`.
42
func NewServerStatsHandler(
43
tp trace.TracerProvider,
44
tmp propagation.TextMapPropagator,
45
logger log.Logger,
47
>
if !isEnabled(tp) {
49
>
}
50
52
>
otelgrpc.NewServerHandler(
53
>
otelgrpc.WithPropagators(tmp),
54
>
otelgrpc.WithTracerProvider(tp),
55
>
),
56
>
logger)
57
}
58
59
// NewClientStatsHandler creates a new gRPC stats handler that tracks each request with an encapsulating span
60
// using the provided TracerProvider and TextMapPropagator.
61
//
62
// NOTE: If the TracerProvider is `noop.TracerProvider`, it returns `nil`.
63
func NewClientStatsHandler(
64
tp trace.TracerProvider,
65
tmp propagation.TextMapPropagator,
67
>
if !isEnabled(tp) {
69
>
}
70
72
>
otelgrpc.WithPropagators(tmp),
73
>
otelgrpc.WithTracerProvider(tp),
74
>
)
75
}
76
77
func newCustomServerStatsHandler(
78
handler stats.Handler,
79
logger log.Logger,
81
>
return &customServerStatsHandler{
82
>
wrapped: handler,
83
>
isDebug: DebugMode(),
84
>
tags: logtags.NewWorkflowTags(tasktoken.NewSerializer(), logger),
85
>
}
86
>
}
87
88
>
func (c *customServerStatsHandler) TagRPC(ctx context.Context, info *stats.RPCTagInfo) context.Context {
grpc.go ×9
89
>
return c.wrapped.TagRPC(
90
>
context.WithValue(ctx, methodNameKey{}, info.FullMethodName),
91
>
info)
92
>
}
93
94
>
func (c *customServerStatsHandler) HandleRPC(ctx context.Context, stat stats.RPCStats) {
grpc.go ×9
95
>
// handling `End` before wrapped stats.Handler since it closes the span
96
>
switch s := stat.(type) {
97
>
case *stats.End:
98
>
// annotate with gRPC error payload
99
>
if c.isDebug {
101
>
102
>
//revive:disable-next-line:unchecked-type-assertion
103
>
statusErr, ok := status.FromError(s.Error)
104
>
if ok && statusErr != nil {
106
>
span.SetAttributes(attribute.Key("rpc.response.error").String(string(payload)))
107
>
}
108
}
109
}
110
112
>
113
>
switch s := stat.(type) {
115
>
if c.isDebug {
116
span := trace.SpanFromContext(ctx)
117
for key, values := range s.Header {
118
span.SetAttributes(attribute.StringSlice("rpc.request.headers."+key, values))
119
}
120
if deadline, ok := ctx.Deadline(); ok {
121
span.SetAttributes(attribute.String("rpc.request.deadline", deadline.Format(time.RFC3339Nano)))
122
span.SetAttributes(attribute.String("rpc.request.timeout", time.Until(deadline).String()))
123
}
124
}
126
>
span := trace.SpanFromContext(ctx)
127
>
c.annotateTags(ctx, span, s.Payload)
128
>
129
>
// annotate with gRPC request payload
130
>
if c.isDebug {
132
>
reqMsg := s.Payload.(proto.Message)
133
>
payload, _ := protojson.Marshal(reqMsg)
134
>
msgType := string(proto.MessageName(reqMsg).Name())
135
>
span.SetAttributes(attribute.Key("rpc.request.payload").String(string(payload)))
136
>
span.SetAttributes(attribute.Key("rpc.request.type").String(msgType))
137
>
}
139
>
if c.isDebug {
140
span := trace.SpanFromContext(ctx)
141
for key, values := range s.Header {
142
span.SetAttributes(attribute.StringSlice("rpc.response.headers."+key, values))
143
}
144
}
146
>
span := trace.SpanFromContext(ctx)
147
>
c.annotateTags(ctx, span, s.Payload)
148
>
149
>
// annotate with gRPC response payload
150
>
if c.isDebug {
152
>
respMsg := s.Payload.(proto.Message)
153
>
payload, _ := protojson.Marshal(respMsg)
154
>
msgType := string(proto.MessageName(respMsg).Name())
155
>
span.SetAttributes(attribute.Key("rpc.response.payload").String(string(payload)))
156
>
span.SetAttributes(attribute.Key("rpc.response.type").String(msgType))
157
>
}
158
}
159
}
160
161
func (c *customServerStatsHandler) annotateTags(
162
ctx context.Context,
163
span trace.Span,
164
payload any,
166
>
methodName, ok := ctx.Value(methodNameKey{}).(string)
167
>
if !ok {
168
methodName = "unknown"
169
}
170
171
// annotate span with workflow tags (same ones the Temporal SDKs use)
173
>
var k string
174
>
switch logTag.Key() {
175
>
case tag.WorkflowIDKey:
176
>
k = WorkflowIDKey
177
>
case tag.WorkflowRunIDKey:
178
>
k = RunIDKey
179
default:
180
continue
181
}
183
}
184
}
185
186
>
func (c *customServerStatsHandler) TagConn(ctx context.Context, info *stats.ConnTagInfo) context.Context {
data_store_factory.go ×29
187
>
return c.wrapped.TagConn(ctx, info)
188
>
}
189
190
>
func (c *customServerStatsHandler) HandleConn(ctx context.Context, stat stats.ConnStats) {
data_store_factory.go ×29
191
>
c.wrapped.HandleConn(ctx, stat)
192
>
}
193
195
>
_, isNoop := tp.(otelnoop.TracerProvider)
196
>
return !isNoop
197
>
}