-
Notifications
You must be signed in to change notification settings - Fork 323
/
traces.go
476 lines (405 loc) · 16.1 KB
/
traces.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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
package clickhouse
import (
"context"
"fmt"
"strings"
"time"
"github.com/openlyinc/pointy"
"github.com/highlight-run/highlight/backend/parser/listener"
"github.com/highlight/highlight/sdk/highlight-go"
"golang.org/x/exp/slices"
"github.com/highlight-run/highlight/backend/model"
"github.com/huandu/go-sqlbuilder"
e "github.com/pkg/errors"
"github.com/ClickHouse/clickhouse-go/v2/lib/driver"
modelInputs "github.com/highlight-run/highlight/backend/private-graph/graph/model"
"github.com/highlight-run/highlight/backend/util"
)
const TracesTable = "traces"
const TracesSamplingTable = "traces_sampling"
const TraceKeysTable = "trace_keys"
const TraceKeyValuesTable = "trace_key_values"
const TracesByIdTable = "traces_by_id"
var traceKeysToColumns = map[modelInputs.ReservedTraceKey]string{
modelInputs.ReservedTraceKeySecureSessionID: "SecureSessionId",
modelInputs.ReservedTraceKeySpanID: "SpanId",
modelInputs.ReservedTraceKeyTraceID: "TraceId",
modelInputs.ReservedTraceKeyParentSpanID: "ParentSpanId",
modelInputs.ReservedTraceKeyTraceState: "TraceState",
modelInputs.ReservedTraceKeySpanName: "SpanName",
modelInputs.ReservedTraceKeySpanKind: "SpanKind",
modelInputs.ReservedTraceKeyDuration: "Duration",
modelInputs.ReservedTraceKeyServiceName: "ServiceName",
modelInputs.ReservedTraceKeyServiceVersion: "ServiceVersion",
modelInputs.ReservedTraceKeyMetricName: "MetricName",
modelInputs.ReservedTraceKeyMetricValue: "MetricValue",
modelInputs.ReservedTraceKeyEnvironment: "Environment",
modelInputs.ReservedTraceKeyHasErrors: "HasErrors",
modelInputs.ReservedTraceKeyTimestamp: "Timestamp",
modelInputs.ReservedTraceKeyHighlightType: "HighlightType",
}
var traceColumns = []string{
"Timestamp",
"UUID",
"TraceId",
"SpanId",
"ParentSpanId",
"ProjectId",
"SecureSessionId",
"TraceState",
"SpanName",
"SpanKind",
"Duration",
"ServiceName",
"ServiceVersion",
"TraceAttributes",
"StatusCode",
"StatusMessage",
"Environment",
"HasErrors",
}
// These keys show up as recommendations, but with no recommended values due to high cardinality
var defaultTraceKeys = []*modelInputs.QueryKey{
{Name: string(modelInputs.ReservedTraceKeyTraceID), Type: modelInputs.KeyTypeString},
{Name: string(modelInputs.ReservedTraceKeySpanName), Type: modelInputs.KeyTypeString},
{Name: string(modelInputs.ReservedTraceKeySpanID), Type: modelInputs.KeyTypeString},
{Name: string(modelInputs.ReservedTraceKeyDuration), Type: modelInputs.KeyTypeNumeric},
{Name: string(modelInputs.ReservedTraceKeyParentSpanID), Type: modelInputs.KeyTypeString},
{Name: string(modelInputs.ReservedTraceKeySecureSessionID), Type: modelInputs.KeyTypeString},
}
var TracesTableNoDefaultConfig = model.TableConfig[modelInputs.ReservedTraceKey]{
TableName: TracesTable,
KeysToColumns: traceKeysToColumns,
ReservedKeys: modelInputs.AllReservedTraceKey,
BodyColumn: "SpanName",
AttributesColumn: "TraceAttributes",
SelectColumns: traceColumns,
}
var TracesTableConfig = model.TableConfig[modelInputs.ReservedTraceKey]{
TableName: TracesTableNoDefaultConfig.TableName,
KeysToColumns: TracesTableNoDefaultConfig.KeysToColumns,
ReservedKeys: TracesTableNoDefaultConfig.ReservedKeys,
BodyColumn: TracesTableNoDefaultConfig.BodyColumn,
AttributesColumn: TracesTableNoDefaultConfig.AttributesColumn,
SelectColumns: TracesTableNoDefaultConfig.SelectColumns,
DefaultFilter: fmt.Sprintf("%s!=%s %s!=%s", modelInputs.ReservedTraceKeySpanName, highlight.MetricSpanName, modelInputs.ReservedTraceKeyHighlightType, highlight.TraceTypeHighlightInternal),
}
var tracesSamplingTableConfig = model.TableConfig[modelInputs.ReservedTraceKey]{
TableName: fmt.Sprintf("%s SAMPLE %d", TracesSamplingTable, SamplingRows),
BodyColumn: "SpanName",
KeysToColumns: traceKeysToColumns,
ReservedKeys: modelInputs.AllReservedTraceKey,
AttributesColumn: "TraceAttributes",
SelectColumns: traceColumns,
DefaultFilter: fmt.Sprintf("%s!=%s %s!=%s", modelInputs.ReservedTraceKeySpanName, highlight.MetricSpanName, modelInputs.ReservedTraceKeyHighlightType, highlight.TraceTypeHighlightInternal),
}
var tracesSampleableTableConfig = sampleableTableConfig[modelInputs.ReservedTraceKey]{
tableConfig: TracesTableConfig,
samplingTableConfig: tracesSamplingTableConfig,
useSampling: func(d time.Duration) bool {
return d >= time.Hour
},
}
type ClickhouseTraceRow struct {
Timestamp time.Time
UUID string
TraceId string
SpanId string
ParentSpanId string
ProjectId uint32
SecureSessionId string
TraceState string
SpanName string
SpanKind string
Duration int64
ServiceName string
ServiceVersion string
TraceAttributes map[string]string
StatusCode string
StatusMessage string
Environment string
HasErrors bool
EventsTimestamp []time.Time `json:"Events.Timestamp" ch:"Events.Timestamp"`
EventsName []string `json:"Events.Name" ch:"Events.Name"`
EventsAttributes []map[string]string `json:"Events.Attributes" ch:"Events.Attributes"`
LinksTraceId []string `json:"Links.TraceId" ch:"Links.TraceId"`
LinksSpanId []string `json:"Links.SpanId" ch:"Links.SpanId"`
LinksTraceState []string `json:"Links.TraceState" ch:"Links.TraceState"`
LinksAttributes []map[string]string `json:"Links.Attributes" ch:"Links.Attributes"`
}
func ConvertTraceRow(traceRow *TraceRow) *ClickhouseTraceRow {
traceTimes, traceNames, traceAttrs := convertEvents(traceRow)
linkTraceIds, linkSpanIds, linkStates, linkAttrs := convertLinks(traceRow)
return &ClickhouseTraceRow{
Timestamp: traceRow.Timestamp,
UUID: traceRow.UUID,
TraceId: traceRow.TraceId,
SpanId: traceRow.SpanId,
ParentSpanId: traceRow.ParentSpanId,
ProjectId: traceRow.ProjectId,
SecureSessionId: traceRow.SecureSessionId,
TraceState: traceRow.TraceState,
SpanName: traceRow.SpanName,
SpanKind: traceRow.SpanKind,
Duration: traceRow.Duration,
ServiceName: traceRow.ServiceName,
ServiceVersion: traceRow.ServiceVersion,
TraceAttributes: traceRow.TraceAttributes,
StatusCode: traceRow.StatusCode,
StatusMessage: traceRow.StatusMessage,
Environment: traceRow.Environment,
HasErrors: traceRow.HasErrors,
EventsTimestamp: traceTimes,
EventsName: traceNames,
EventsAttributes: traceAttrs,
LinksTraceId: linkTraceIds,
LinksSpanId: linkSpanIds,
LinksTraceState: linkStates,
LinksAttributes: linkAttrs,
}
}
func (client *Client) BatchWriteTraceRows(ctx context.Context, traceRows []*ClickhouseTraceRow) error {
if len(traceRows) == 0 {
return nil
}
span, _ := util.StartSpanFromContext(ctx, util.KafkaBatchWorkerOp, util.ResourceName("worker.kafka.batched.flushTraces.prepareRows"))
span.SetAttribute("BatchSize", len(traceRows))
batch, err := client.conn.PrepareBatch(ctx, fmt.Sprintf("INSERT INTO %s", TracesTable))
if err != nil {
span.Finish(err)
return e.Wrap(err, "failed to create traces batch")
}
for _, traceRow := range traceRows {
err = batch.AppendStruct(traceRow)
if err != nil {
span.Finish(err)
return err
}
}
span.Finish()
return batch.Send()
}
func convertEvents(traceRow *TraceRow) ([]time.Time, []string, []map[string]string) {
var (
times []time.Time
names []string
attrs []map[string]string
)
events := traceRow.Events
for _, event := range events {
times = append(times, event.Timestamp)
names = append(names, event.Name)
attrs = append(attrs, event.Attributes)
}
return times, names, attrs
}
func convertLinks(traceRow *TraceRow) ([]string, []string, []string, []map[string]string) {
var (
traceIDs []string
spanIDs []string
states []string
attrs []map[string]string
)
links := traceRow.Links
for _, link := range links {
traceIDs = append(traceIDs, link.TraceId)
spanIDs = append(spanIDs, link.SpanId)
states = append(states, link.TraceState)
attrs = append(attrs, link.Attributes)
}
return traceIDs, spanIDs, states, attrs
}
func (client *Client) ReadTraces(ctx context.Context, projectID int, params modelInputs.QueryInput, pagination Pagination) (*modelInputs.TraceConnection, error) {
scanTrace := func(rows driver.Rows) (*Edge[modelInputs.Trace], error) {
var result ClickhouseTraceRow
if err := rows.ScanStruct(&result); err != nil {
return nil, err
}
return &Edge[modelInputs.Trace]{
Cursor: encodeCursor(result.Timestamp, result.UUID),
Node: &modelInputs.Trace{
Timestamp: result.Timestamp,
TraceID: result.TraceId,
SpanID: result.SpanId,
ParentSpanID: result.ParentSpanId,
ProjectID: int(result.ProjectId),
SecureSessionID: result.SecureSessionId,
TraceState: result.TraceState,
SpanName: result.SpanName,
SpanKind: result.SpanKind,
Duration: int(result.Duration),
ServiceName: result.ServiceName,
ServiceVersion: result.ServiceVersion,
Environment: result.Environment,
HasErrors: result.HasErrors,
TraceAttributes: expandJSON(result.TraceAttributes),
StatusCode: result.StatusCode,
StatusMessage: result.StatusMessage,
},
}, nil
}
conn, err := readObjects(ctx, client, TracesTableConfig, tracesSamplingTableConfig, projectID, params, pagination, scanTrace)
if err != nil {
return nil, err
}
mappedEdges := []*modelInputs.TraceEdge{}
for _, edge := range conn.Edges {
mappedEdges = append(mappedEdges, &modelInputs.TraceEdge{
Cursor: edge.Cursor,
Node: edge.Node,
})
}
return &modelInputs.TraceConnection{
Edges: mappedEdges,
PageInfo: conn.PageInfo,
}, nil
}
func (client *Client) ExistingTraceIds(ctx context.Context, projectID int, traceIDs []string, startDate time.Time, endDate time.Time) ([]string, error) {
sb := sqlbuilder.NewSelectBuilder()
var err error
var args []interface{}
sb.From(TracesTable).
Select("DISTINCT TraceId").
Where(sb.Equal("ProjectId", projectID)).
Where(sb.In("TraceId", traceIDs)).
Where(sb.GreaterThan("Timestamp", startDate)).
Where(sb.LessThan("Timestamp", endDate))
sql, args := sb.BuildWithFlavor(sqlbuilder.ClickHouse)
span, _ := util.StartSpanFromContext(ctx, "traces", util.ResourceName("ReadTracesByIDs"))
rows, err := client.conn.Query(ctx, sql, args...)
if err != nil {
span.Finish(err)
return nil, err
}
existingTraceIds := []string{}
for rows.Next() {
var result struct{ TraceId string }
if err := rows.ScanStruct(&result); err != nil {
return nil, err
}
existingTraceIds = append(existingTraceIds, result.TraceId)
}
span.Finish(rows.Err())
return existingTraceIds, rows.Err()
}
func getTracesFromRows(rows driver.Rows) ([]*modelInputs.Trace, error) {
var seenUUIDs = map[string]struct{}{}
var traces []*modelInputs.Trace
for rows.Next() {
var result ClickhouseTraceRow
if err := rows.ScanStruct(&result); err != nil {
return nil, err
}
// Skip already-seen UUIDs to remove duplicate traces
if _, ok := seenUUIDs[result.UUID]; ok {
continue
}
seenUUIDs[result.UUID] = struct{}{}
traces = append(traces, &modelInputs.Trace{
Timestamp: result.Timestamp,
TraceID: result.TraceId,
SpanID: result.SpanId,
ParentSpanID: result.ParentSpanId,
ProjectID: int(result.ProjectId),
SecureSessionID: result.SecureSessionId,
TraceState: result.TraceState,
SpanName: result.SpanName,
SpanKind: result.SpanKind,
Duration: int(result.Duration),
ServiceName: result.ServiceName,
ServiceVersion: result.ServiceVersion,
Environment: result.Environment,
HasErrors: result.HasErrors,
TraceAttributes: expandJSON(result.TraceAttributes),
StatusCode: result.StatusCode,
StatusMessage: result.StatusMessage,
})
}
// Order by timestamp
// Doing this in code rather than Clickhouse so Clickhouse will use the `traceId` projection
slices.SortFunc(traces, func(a *modelInputs.Trace, b *modelInputs.Trace) int {
return a.Timestamp.Compare(b.Timestamp)
})
if rows.Err() != nil {
return nil, rows.Err()
}
return traces, nil
}
func (client *Client) ReadTrace(ctx context.Context, projectID int, traceID string) ([]*modelInputs.Trace, error) {
sb := sqlbuilder.NewSelectBuilder()
var err error
var args []interface{}
sb.From(TracesByIdTable).
Select("Timestamp, UUID, TraceId, SpanId, ParentSpanId, ProjectId, SecureSessionId, TraceState, SpanName, SpanKind, Duration, ServiceName, ServiceVersion, Environment, HasErrors, TraceAttributes, StatusCode, StatusMessage").
Where(sb.Equal("ProjectId", projectID)).
Where(sb.Equal("TraceId", traceID))
sql, args := sb.BuildWithFlavor(sqlbuilder.ClickHouse)
span, _ := util.StartSpanFromContext(ctx, "traces", util.ResourceName("ReadTrace"))
rows, err := client.conn.Query(ctx, sql, args...)
if err != nil {
span.Finish(err)
return nil, err
}
traces, err := getTracesFromRows(rows)
if err != nil {
span.Finish(err)
return nil, err
}
span.Finish()
if len(traces) > 0 {
return traces, nil
}
span, _ = util.StartSpanFromContext(ctx, "traces", util.ResourceName("ReadTraceFallback"))
sb.From(TracesTable).
Select("Timestamp, UUID, TraceId, SpanId, ParentSpanId, ProjectId, SecureSessionId, TraceState, SpanName, SpanKind, Duration, ServiceName, ServiceVersion, Environment, HasErrors, TraceAttributes, StatusCode, StatusMessage").
Where(sb.Equal("ProjectId", projectID)).
Where(sb.Equal("TraceId", traceID)).
Where(sb.GE("Timestamp", time.Now().Add(-5*time.Minute))).
Where(sb.LE("Timestamp", time.Now()))
sql, args = sb.BuildWithFlavor(sqlbuilder.ClickHouse)
rows, err = client.conn.Query(ctx, sql, args...)
if err != nil {
span.Finish(err)
return nil, err
}
traces, err = getTracesFromRows(rows)
if err != nil {
span.Finish(err)
return nil, err
}
span.Finish()
return traces, nil
}
func (client *Client) ReadTracesMetrics(ctx context.Context, projectID int, params modelInputs.QueryInput, column string, metricTypes []modelInputs.MetricAggregator, groupBy []string, nBuckets *int, bucketBy string, limit *int, limitAggregator *modelInputs.MetricAggregator, limitColumn *string) (*modelInputs.MetricsBuckets, error) {
return readMetrics(ctx, client, tracesSampleableTableConfig, projectID, params, column, metricTypes, groupBy, nBuckets, bucketBy, limit, limitAggregator, limitColumn)
}
func (client *Client) ReadWorkspaceTraceCounts(ctx context.Context, projectIDs []int, params modelInputs.QueryInput) (*modelInputs.MetricsBuckets, error) {
// 12 buckets - 12 months in a year, or 12 weeks in a quarter
return readWorkspaceMetrics(ctx, client, tracesSampleableTableConfig, projectIDs, params, "", []modelInputs.MetricAggregator{modelInputs.MetricAggregatorCount}, nil, pointy.Int(12), modelInputs.MetricBucketByTimestamp.String(), nil, nil, nil)
}
func (client *Client) TracesKeys(ctx context.Context, projectID int, startDate time.Time, endDate time.Time, query *string, typeArg *modelInputs.KeyType) ([]*modelInputs.QueryKey, error) {
traceKeys, err := KeysAggregated(ctx, client, TraceKeysTable, projectID, startDate, endDate, query, typeArg)
if err != nil {
return nil, err
}
if query == nil || *query == "" {
traceKeys = append(traceKeys, defaultTraceKeys...)
} else {
queryLower := strings.ToLower(*query)
for _, key := range defaultTraceKeys {
if strings.Contains(key.Name, queryLower) {
traceKeys = append(traceKeys, key)
}
}
}
return traceKeys, nil
}
func (client *Client) TracesKeyValues(ctx context.Context, projectID int, keyName string, startDate time.Time, endDate time.Time) ([]string, error) {
return KeyValuesAggregated(ctx, client, TraceKeyValuesTable, projectID, keyName, startDate, endDate)
}
func TraceMatchesQuery(trace *TraceRow, filters listener.Filters) bool {
return matchesQuery(trace, TracesTableConfig, filters, listener.OperatorAnd)
}
func (client *Client) TracesLogLines(ctx context.Context, projectID int, params modelInputs.QueryInput) ([]*modelInputs.LogLine, error) {
return logLines(ctx, client, TracesTableConfig, projectID, params)
}