forked from DataDog/dd-trace-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sarama.go
264 lines (243 loc) · 7.84 KB
/
sarama.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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
// Package sarama provides functions to trace the Shopify/sarama package (https://github.com/Shopify/sarama).
package sarama // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/Shopify/sarama"
import (
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
sarama "gopkg.in/Shopify/sarama.v1"
)
type partitionConsumer struct {
sarama.PartitionConsumer
messages chan *sarama.ConsumerMessage
}
// Messages returns the read channel for the messages that are returned by
// the broker.
func (pc *partitionConsumer) Messages() <-chan *sarama.ConsumerMessage {
return pc.messages
}
// WrapPartitionConsumer wraps a sarama.PartitionConsumer causing each received
// message to be traced.
func WrapPartitionConsumer(pc sarama.PartitionConsumer, opts ...Option) sarama.PartitionConsumer {
cfg := new(config)
defaults(cfg)
for _, opt := range opts {
opt(cfg)
}
wrapped := &partitionConsumer{
PartitionConsumer: pc,
messages: make(chan *sarama.ConsumerMessage),
}
go func() {
msgs := pc.Messages()
var prev ddtrace.Span
for msg := range msgs {
// create the next span from the message
opts := []tracer.StartSpanOption{
tracer.ServiceName(cfg.serviceName),
tracer.ResourceName("Consume Topic " + msg.Topic),
tracer.SpanType(ext.SpanTypeMessageConsumer),
tracer.Tag("partition", msg.Partition),
tracer.Tag("offset", msg.Offset),
}
if cfg.analyticsRate > 0 {
opts = append(opts, tracer.Tag(ext.EventSampleRate, cfg.analyticsRate))
}
// kafka supports headers, so try to extract a span context
carrier := NewConsumerMessageCarrier(msg)
if spanctx, err := tracer.Extract(carrier); err == nil {
opts = append(opts, tracer.ChildOf(spanctx))
}
next := tracer.StartSpan("kafka.consume", opts...)
// reinject the span context so consumers can pick it up
tracer.Inject(next.Context(), carrier)
wrapped.messages <- msg
// if the next message was received, finish the previous span
if prev != nil {
prev.Finish()
}
prev = next
}
// finish any remaining span
if prev != nil {
prev.Finish()
}
close(wrapped.messages)
}()
return wrapped
}
type consumer struct {
sarama.Consumer
opts []Option
}
// ConsumePartition invokes Consumer.ConsumePartition and wraps the resulting
// PartitionConsumer.
func (c *consumer) ConsumePartition(topic string, partition int32, offset int64) (sarama.PartitionConsumer, error) {
pc, err := c.Consumer.ConsumePartition(topic, partition, offset)
if err != nil {
return pc, err
}
return WrapPartitionConsumer(pc, c.opts...), nil
}
// WrapConsumer wraps a sarama.Consumer wrapping any PartitionConsumer created
// via Consumer.ConsumePartition.
func WrapConsumer(c sarama.Consumer, opts ...Option) sarama.Consumer {
return &consumer{
Consumer: c,
opts: opts,
}
}
type syncProducer struct {
sarama.SyncProducer
version sarama.KafkaVersion
cfg *config
}
// SendMessage calls sarama.SyncProducer.SendMessage and traces the request.
func (p *syncProducer) SendMessage(msg *sarama.ProducerMessage) (partition int32, offset int64, err error) {
span := startProducerSpan(p.cfg, p.version, msg)
partition, offset, err = p.SyncProducer.SendMessage(msg)
finishProducerSpan(span, partition, offset, err)
return partition, offset, err
}
// SendMessages calls sarama.SyncProducer.SendMessages and traces the requests.
func (p *syncProducer) SendMessages(msgs []*sarama.ProducerMessage) error {
// although there's only one call made to the SyncProducer, the messages are
// treated individually, so we create a span for each one
spans := make([]ddtrace.Span, len(msgs))
for i, msg := range msgs {
spans[i] = startProducerSpan(p.cfg, p.version, msg)
}
err := p.SyncProducer.SendMessages(msgs)
for i, span := range spans {
finishProducerSpan(span, msgs[i].Partition, msgs[i].Offset, err)
}
return err
}
// WrapSyncProducer wraps a sarama.SyncProducer so that all produced messages
// are traced.
func WrapSyncProducer(saramaConfig *sarama.Config, producer sarama.SyncProducer, opts ...Option) sarama.SyncProducer {
cfg := new(config)
defaults(cfg)
for _, opt := range opts {
opt(cfg)
}
if saramaConfig == nil {
saramaConfig = sarama.NewConfig()
}
return &syncProducer{
SyncProducer: producer,
version: saramaConfig.Version,
cfg: cfg,
}
}
type asyncProducer struct {
sarama.AsyncProducer
input chan *sarama.ProducerMessage
successes chan *sarama.ProducerMessage
errors chan *sarama.ProducerError
}
// Input returns the input channel.
func (p *asyncProducer) Input() chan<- *sarama.ProducerMessage {
return p.input
}
// Successes returns the successes channel.
func (p *asyncProducer) Successes() <-chan *sarama.ProducerMessage {
return p.successes
}
// Errors returns the errors channel.
func (p *asyncProducer) Errors() <-chan *sarama.ProducerError {
return p.errors
}
// WrapAsyncProducer wraps a sarama.AsyncProducer so that all produced messages
// are traced. It requires the underlying sarama Config so we can know whether
// or not sucesses will be returned.
func WrapAsyncProducer(saramaConfig *sarama.Config, p sarama.AsyncProducer, opts ...Option) sarama.AsyncProducer {
cfg := new(config)
defaults(cfg)
for _, opt := range opts {
opt(cfg)
}
if saramaConfig == nil {
saramaConfig = sarama.NewConfig()
}
wrapped := &asyncProducer{
AsyncProducer: p,
input: make(chan *sarama.ProducerMessage),
successes: make(chan *sarama.ProducerMessage),
errors: make(chan *sarama.ProducerError),
}
go func() {
type spanKey struct {
topic string
partition int32
offset int64
}
spans := make(map[spanKey]ddtrace.Span)
defer close(wrapped.successes)
defer close(wrapped.errors)
for {
select {
case msg := <-wrapped.input:
key := spanKey{msg.Topic, msg.Partition, msg.Offset}
span := startProducerSpan(cfg, saramaConfig.Version, msg)
p.Input() <- msg
if saramaConfig.Producer.Return.Successes {
spans[key] = span
} else {
// if returning successes isn't enabled, we just finish the
// span right away because there's no way to know when it will
// be done
finishProducerSpan(span, key.partition, key.offset, nil)
}
case msg, ok := <-p.Successes():
if !ok {
// producer was closed, so exit
return
}
key := spanKey{msg.Topic, msg.Partition, msg.Offset}
if span, ok := spans[key]; ok {
delete(spans, key)
finishProducerSpan(span, msg.Partition, msg.Offset, nil)
}
wrapped.successes <- msg
case err, ok := <-p.Errors():
if !ok {
// producer was closed
return
}
key := spanKey{err.Msg.Topic, err.Msg.Partition, err.Msg.Offset}
if span, ok := spans[key]; ok {
delete(spans, key)
finishProducerSpan(span, err.Msg.Partition, err.Msg.Offset, err.Err)
}
wrapped.errors <- err
}
}
}()
return wrapped
}
func startProducerSpan(cfg *config, version sarama.KafkaVersion, msg *sarama.ProducerMessage) ddtrace.Span {
carrier := NewProducerMessageCarrier(msg)
opts := []tracer.StartSpanOption{
tracer.ServiceName(cfg.serviceName),
tracer.ResourceName("Produce Topic " + msg.Topic),
tracer.SpanType(ext.SpanTypeMessageProducer),
}
if cfg.analyticsRate > 0 {
opts = append(opts, tracer.Tag(ext.EventSampleRate, cfg.analyticsRate))
}
// if there's a span context in the headers, use that as the parent
if spanctx, err := tracer.Extract(carrier); err == nil {
opts = append(opts, tracer.ChildOf(spanctx))
}
span := tracer.StartSpan("kafka.produce", opts...)
if version.IsAtLeast(sarama.V0_11_0_0) {
// re-inject the span context so consumers can pick it up
tracer.Inject(span.Context(), carrier)
}
return span
}
func finishProducerSpan(span ddtrace.Span, partition int32, offset int64, err error) {
span.SetTag("partition", partition)
span.SetTag("offset", offset)
span.Finish(tracer.WithError(err))
}