-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
queued_processor.go
297 lines (255 loc) · 9.83 KB
/
queued_processor.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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
// Copyright The OpenTelemetry 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 queuedprocessor
import (
"context"
"sync"
"time"
"github.com/jaegertracing/jaeger/pkg/queue"
"go.opencensus.io/stats"
"go.opencensus.io/stats/view"
"go.opencensus.io/tag"
"go.uber.org/zap"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/consumer/consumererror"
"go.opentelemetry.io/collector/consumer/pdata"
"go.opentelemetry.io/collector/internal/collector/telemetry"
"go.opentelemetry.io/collector/obsreport"
"go.opentelemetry.io/collector/processor"
)
type queuedSpanProcessor struct {
name string
queue *queue.BoundedQueue
logger *zap.Logger
sender consumer.TraceConsumer
numWorkers int
retryOnProcessingFailure bool
backoffDelay time.Duration
stopCh chan struct{}
stopOnce sync.Once
}
var _ consumer.TraceConsumer = (*queuedSpanProcessor)(nil)
type queueItem struct {
queuedTime time.Time
td pdata.Traces
ctx context.Context
}
func newQueuedSpanProcessor(
params component.ProcessorCreateParams,
sender consumer.TraceConsumer,
cfg *Config,
) *queuedSpanProcessor {
boundedQueue := queue.NewBoundedQueue(cfg.QueueSize, func(item interface{}) {})
return &queuedSpanProcessor{
name: cfg.Name(),
queue: boundedQueue,
logger: params.Logger,
numWorkers: cfg.NumWorkers,
sender: sender,
retryOnProcessingFailure: cfg.RetryOnFailure,
backoffDelay: cfg.BackoffDelay,
stopCh: make(chan struct{}),
}
}
// Start is invoked during service startup.
func (sp *queuedSpanProcessor) Start(_ context.Context, _ component.Host) error {
// emit 0's so that the metric is present and reported, rather than absent
ctx := obsreport.ProcessorContext(context.Background(), sp.name)
stats.Record(
ctx,
processor.StatTraceBatchesDroppedCount.M(int64(0)),
processor.StatDroppedSpanCount.M(int64(0)))
sp.queue.StartConsumers(sp.numWorkers, func(item interface{}) {
value := item.(*queueItem)
sp.processItemFromQueue(value)
})
// Start a timer to report the queue length.
ticker := time.NewTicker(1 * time.Second)
go func() {
defer ticker.Stop()
for {
select {
case <-sp.stopCh:
return
case <-ticker.C:
length := int64(sp.queue.Size())
stats.Record(ctx, statQueueLength.M(length))
}
}
}()
return nil
}
// Stop halts the span processor and all its goroutines.
func (sp *queuedSpanProcessor) Stop() {
sp.stopOnce.Do(func() {
close(sp.stopCh)
sp.queue.Stop()
})
}
// ConsumeTraces implements the SpanProcessor interface
func (sp *queuedSpanProcessor) ConsumeTraces(ctx context.Context, td pdata.Traces) error {
ctx = obsreport.ProcessorContext(ctx, sp.name)
item := &queueItem{
queuedTime: time.Now(),
td: td,
ctx: ctx,
}
spanCountStats := processor.NewSpanCountStats(td, sp.name)
processor.RecordsSpanCountMetrics(ctx, spanCountStats, processor.StatReceivedSpanCount)
addedToQueue := sp.queue.Produce(item)
if !addedToQueue {
// TODO: in principle this may not end in data loss because this can be
// in the same call stack as the receiver, ie.: the call from the receiver
// to here is synchronous. This means that actually it could be proper to
// record this as "refused" instead of "dropped".
sp.onItemDropped(item, spanCountStats)
} else {
obsreport.ProcessorTraceDataAccepted(ctx, spanCountStats.GetAllSpansCount())
}
return nil
}
func (sp *queuedSpanProcessor) GetCapabilities() component.ProcessorCapabilities {
return component.ProcessorCapabilities{MutatesConsumedData: false}
}
// Shutdown is invoked during service shutdown.
func (sp *queuedSpanProcessor) Shutdown(context.Context) error {
// TODO: flush the queue.
return nil
}
func (sp *queuedSpanProcessor) processItemFromQueue(item *queueItem) {
startTime := time.Now()
err := sp.sender.ConsumeTraces(item.ctx, item.td)
processorStatsTags := []tag.Mutator{tag.Insert(processor.TagProcessorNameKey, sp.name)}
if err == nil {
// Record latency metrics and return
sendLatencyMs := int64(time.Since(startTime) / time.Millisecond)
inQueueLatencyMs := int64(time.Since(item.queuedTime) / time.Millisecond)
stats.RecordWithTags(context.Background(),
processorStatsTags,
statSuccessSendOps.M(1),
statSendLatencyMs.M(sendLatencyMs),
statInQueueLatencyMs.M(inQueueLatencyMs))
return
}
spanCountStats := processor.NewSpanCountStats(item.td, sp.name)
allSpansCount := spanCountStats.GetAllSpansCount()
// There was an error
// Immediately drop data on permanent errors. In this context permanent
// errors indicate some kind of bad pdata.
if consumererror.IsPermanent(err) {
sp.logger.Warn(
"Unrecoverable bad data error",
zap.Int("#spans", spanCountStats.GetAllSpansCount()),
zap.Error(err))
processor.RecordsSpanCountMetrics(
context.Background(),
spanCountStats,
processor.StatBadBatchDroppedSpanCount)
return
}
stats.RecordWithTags(context.Background(), processorStatsTags, statFailedSendOps.M(1))
sp.logger.Warn("Sender failed", zap.Error(err))
if !sp.retryOnProcessingFailure {
// throw away the batch
sp.logger.Error("Failed to process batch, discarding", zap.Int("batch-size", allSpansCount))
sp.onItemDropped(item, spanCountStats)
} else {
// TODO: (@pjanotti) do not put it back on the end of the queue, retry with it directly.
// This will have the benefit of keeping the batch closer to related ones in time.
if !sp.queue.Produce(item) {
sp.logger.Error("Failed to process batch and failed to re-enqueue", zap.Int("batch-size", allSpansCount))
sp.onItemDropped(item, spanCountStats)
} else {
sp.logger.Warn("Failed to process batch, re-enqueued", zap.Int("batch-size", allSpansCount))
}
}
// back-off for configured delay, but get interrupted when shutting down
if sp.backoffDelay > 0 {
sp.logger.Warn("Backing off before next attempt", zap.Duration("backoff_delay", sp.backoffDelay))
select {
case <-sp.stopCh:
sp.logger.Info("Interrupted due to shutdown")
break
case <-time.After(sp.backoffDelay):
sp.logger.Info("Resume processing")
break
}
}
}
func (sp *queuedSpanProcessor) onItemDropped(item *queueItem, spanCountStats *processor.SpanCountStats) {
stats.RecordWithTags(item.ctx,
[]tag.Mutator{tag.Insert(processor.TagProcessorNameKey, sp.name)},
processor.StatTraceBatchesDroppedCount.M(int64(1)))
processor.RecordsSpanCountMetrics(item.ctx, spanCountStats, processor.StatDroppedSpanCount)
obsreport.ProcessorTraceDataDropped(item.ctx, spanCountStats.GetAllSpansCount())
sp.logger.Warn("Span batch dropped", zap.Int("#spans", spanCountStats.GetAllSpansCount()))
}
// Variables related to metrics specific to queued processor.
var (
statInQueueLatencyMs = stats.Int64("queue_latency", "Latency (in milliseconds) that a batch stayed in queue", stats.UnitMilliseconds)
statSendLatencyMs = stats.Int64("send_latency", "Latency (in milliseconds) to send a batch", stats.UnitMilliseconds)
statSuccessSendOps = stats.Int64("success_send", "Number of successful send operations", stats.UnitDimensionless)
statFailedSendOps = stats.Int64("fail_send", "Number of failed send operations", stats.UnitDimensionless)
statQueueLength = stats.Int64("queue_length", "Current length of the queue (in batches)", stats.UnitDimensionless)
)
// MetricViews return the metrics views according to given telemetry level.
func MetricViews(level telemetry.Level) []*view.View {
if level == telemetry.None {
return nil
}
tagKeys := processor.MetricTagKeys(level)
if tagKeys == nil {
return nil
}
processorTagKeys := []tag.Key{processor.TagProcessorNameKey}
queueLengthView := &view.View{
Name: statQueueLength.Name(),
Measure: statQueueLength,
Description: "Current number of batches in the queue",
TagKeys: processorTagKeys,
Aggregation: view.LastValue(),
}
countSuccessSendView := &view.View{
Name: statSuccessSendOps.Name(),
Measure: statSuccessSendOps,
Description: "The number of successful send operations performed by queued_retry processor",
TagKeys: tagKeys,
Aggregation: view.Sum(),
}
countFailuresSendView := &view.View{
Name: statFailedSendOps.Name(),
Measure: statFailedSendOps,
Description: "The number of failed send operations performed by queued_retry processor",
TagKeys: tagKeys,
Aggregation: view.Sum(),
}
latencyDistributionAggregation := view.Distribution(10, 25, 50, 75, 100, 250, 500, 750, 1000, 2000, 3000, 4000, 5000, 10000, 20000, 30000, 50000)
sendLatencyView := &view.View{
Name: statSendLatencyMs.Name(),
Measure: statSendLatencyMs,
Description: "The latency of the successful send operations.",
TagKeys: processorTagKeys,
Aggregation: latencyDistributionAggregation,
}
inQueueLatencyView := &view.View{
Name: statInQueueLatencyMs.Name(),
Measure: statInQueueLatencyMs,
Description: "The \"in queue\" latency of the successful send operations.",
TagKeys: processorTagKeys,
Aggregation: latencyDistributionAggregation,
}
legacyViews := []*view.View{queueLengthView, countSuccessSendView, countFailuresSendView, sendLatencyView, inQueueLatencyView}
return obsreport.ProcessorMetricViews(typeStr, legacyViews)
}