forked from jaegertracing/jaeger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
writer.go
246 lines (217 loc) · 8.58 KB
/
writer.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package spanstore
import (
"encoding/json"
"strings"
"sync/atomic"
"time"
"unicode/utf8"
"github.com/pkg/errors"
"github.com/uber/jaeger-lib/metrics"
"go.uber.org/zap"
"github.com/uber/jaeger/model"
"github.com/uber/jaeger/pkg/cassandra"
casMetrics "github.com/uber/jaeger/pkg/cassandra/metrics"
"github.com/uber/jaeger/plugin/storage/cassandra/spanstore/dbmodel"
)
const (
insertSpan = `
INSERT
INTO traces(trace_id, span_id, span_hash, parent_id, operation_name, flags,
start_time, duration, tags, logs, refs, process)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`
insertTag = `
INSERT
INTO tag_index(trace_id, span_id, service_name, start_time, tag_key, tag_value)
VALUES (?, ?, ?, ?, ?, ?)`
serviceNameIndex = `
INSERT
INTO service_name_index(service_name, bucket, start_time, trace_id)
VALUES (?, ?, ?, ?)`
serviceOperationIndex = `
INSERT
INTO
service_operation_index(service_name, operation_name, start_time, trace_id)
VALUES (?, ?, ?, ?)`
durationIndex = `
INSERT
INTO duration_index(service_name, operation_name, bucket, duration, start_time, trace_id)
VALUES (?, ?, ?, ?, ?, ?)`
maximumTagKeyOrValueSize = 256
// DefaultNumBuckets Number of buckets for bucketed keys
defaultNumBuckets = 10
durationBucketSize = time.Hour
)
type serviceNamesWriter func(serviceName string) error
type operationNamesWriter func(serviceName, operationName string) error
type spanWriterMetrics struct {
traces *casMetrics.Table
tagIndex *casMetrics.Table
serviceNameIndex *casMetrics.Table
serviceOperationIndex *casMetrics.Table
durationIndex *casMetrics.Table
}
// SpanWriter handles all writes to Cassandra for the Jaeger data model
type SpanWriter struct {
session cassandra.Session
serviceNamesWriter serviceNamesWriter
operationNamesWriter operationNamesWriter
writerMetrics spanWriterMetrics
logger *zap.Logger
tagIndexSkipped metrics.Counter
bucketCounter uint32
}
// NewSpanWriter returns a SpanWriter
func NewSpanWriter(
session cassandra.Session,
writeCacheTTL time.Duration,
metricsFactory metrics.Factory,
logger *zap.Logger,
) *SpanWriter {
serviceNamesStorage := NewServiceNamesStorage(session, writeCacheTTL, metricsFactory, logger)
operationNamesStorage := NewOperationNamesStorage(session, writeCacheTTL, metricsFactory, logger)
tagIndexSkipped := metricsFactory.Counter("tagIndexSkipped", nil)
return &SpanWriter{
session: session,
serviceNamesWriter: serviceNamesStorage.Write,
operationNamesWriter: operationNamesStorage.Write,
writerMetrics: spanWriterMetrics{
traces: casMetrics.NewTable(metricsFactory, "Traces"),
tagIndex: casMetrics.NewTable(metricsFactory, "TagIndex"),
serviceNameIndex: casMetrics.NewTable(metricsFactory, "ServiceNameIndex"),
serviceOperationIndex: casMetrics.NewTable(metricsFactory, "ServiceOperationIndex"),
durationIndex: casMetrics.NewTable(metricsFactory, "DurationIndex"),
},
logger: logger,
tagIndexSkipped: tagIndexSkipped,
}
}
// WriteSpan saves the span into Cassandra
func (s *SpanWriter) WriteSpan(span *model.Span) error {
ds := dbmodel.FromDomain(span)
mainQuery := s.session.Query(
insertSpan,
ds.TraceID,
ds.SpanID,
ds.SpanHash,
ds.ParentID,
ds.OperationName,
ds.Flags,
ds.StartTime,
ds.Duration,
ds.Tags,
ds.Logs,
ds.Refs,
ds.Process,
)
if err := s.writerMetrics.traces.Exec(mainQuery, s.logger); err != nil {
return s.logError(ds, err, "Failed to insert span", s.logger)
}
if err := s.saveServiceNameAndOperationName(ds.ServiceName, ds.OperationName); err != nil {
// should this be a soft failure?
return s.logError(ds, err, "Failed to insert service name and operation name", s.logger)
}
if err := s.indexByTags(span, ds); err != nil {
return s.logError(ds, err, "Failed to index tags", s.logger)
}
if err := s.indexBySerice(span.TraceID, ds); err != nil {
return s.logError(ds, err, "Failed to index service name", s.logger)
}
if err := s.indexByOperation(span.TraceID, ds); err != nil {
return s.logError(ds, err, "Failed to index operation name", s.logger)
}
if err := s.indexByDuration(ds, span.StartTime); err != nil {
return s.logError(ds, err, "Failed to index duration", s.logger)
}
return nil
}
func (s *SpanWriter) indexByTags(span *model.Span, ds *dbmodel.Span) error {
for _, v := range dbmodel.GetAllUniqueTags(span) {
// we should introduce retries or just ignore failures imo, retrying each individual tag insertion might be better
// we should consider bucketing.
if s.shouldIndexTag(v) {
insertTagQuery := s.session.Query(insertTag, ds.TraceID, ds.SpanID, v.ServiceName, ds.StartTime, v.TagKey, v.TagValue)
if err := s.writerMetrics.tagIndex.Exec(insertTagQuery, s.logger); err != nil {
withTagInfo := s.logger.
With(zap.String("tag_key", v.TagKey)).
With(zap.String("tag_value", v.TagValue)).
With(zap.String("service_name", v.ServiceName))
return s.logError(ds, err, "Failed to index tag", withTagInfo)
}
} else {
s.tagIndexSkipped.Inc(1)
}
}
return nil
}
func (s *SpanWriter) indexByDuration(span *dbmodel.Span, startTime time.Time) error {
query := s.session.Query(durationIndex)
timeBucket := startTime.Round(durationBucketSize)
var err error
indexByOperationName := func(operationName string) {
q1 := query.Bind(span.Process.ServiceName, operationName, timeBucket, span.Duration, span.StartTime, span.TraceID)
if err2 := s.writerMetrics.durationIndex.Exec(q1, s.logger); err2 != nil {
s.logError(span, err2, "Cannot index duration", s.logger)
err = err2
}
}
indexByOperationName("") // index by service name alone
indexByOperationName(span.OperationName) // index by service name and operation name
return err
}
func (s *SpanWriter) indexBySerice(traceID model.TraceID, span *dbmodel.Span) error {
bucketNo := atomic.AddUint32(&s.bucketCounter, 1) % defaultNumBuckets
query := s.session.Query(serviceNameIndex)
q := query.Bind(span.Process.ServiceName, bucketNo, span.StartTime, span.TraceID)
return s.writerMetrics.serviceNameIndex.Exec(q, s.logger)
}
func (s *SpanWriter) indexByOperation(traceID model.TraceID, span *dbmodel.Span) error {
query := s.session.Query(serviceOperationIndex)
q := query.Bind(span.Process.ServiceName, span.OperationName, span.StartTime, span.TraceID)
return s.writerMetrics.serviceOperationIndex.Exec(q, s.logger)
}
// shouldIndexTag checks to see if the tag is json or not, if it's UTF8 valid and it's not too large
func (s *SpanWriter) shouldIndexTag(tag dbmodel.TagInsertion) bool {
isJSON := func(s string) bool {
var js map[string]interface{}
// poor man's string-is-a-json check shortcircuits full unmarshalling
return strings.HasPrefix(s, "{") && json.Unmarshal([]byte(s), &js) == nil
}
return len(tag.TagKey) < maximumTagKeyOrValueSize &&
len(tag.TagValue) < maximumTagKeyOrValueSize &&
utf8.ValidString(tag.TagValue) &&
utf8.ValidString(tag.TagKey) &&
!isJSON(tag.TagValue)
}
func (s *SpanWriter) logError(span *dbmodel.Span, err error, msg string, logger *zap.Logger) error {
logger.
With(zap.String("trace_id", span.TraceID.String())).
With(zap.Int64("span_id", span.SpanID)).
With(zap.Error(err)).
Error(msg)
return errors.Wrap(err, msg)
}
func (s *SpanWriter) saveServiceNameAndOperationName(serviceName, operationName string) error {
if err := s.serviceNamesWriter(serviceName); err != nil {
return err
}
return s.operationNamesWriter(serviceName, operationName)
}