-
Notifications
You must be signed in to change notification settings - Fork 19
/
tracer.go
394 lines (325 loc) · 10.6 KB
/
tracer.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
package otelpgx
import (
"context"
"database/sql"
"errors"
"fmt"
"runtime/debug"
"strings"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgconn"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
"go.opentelemetry.io/otel/trace"
)
const (
tracerName = "github.com/exaring/otelpgx"
sqlOperationUnknown = "UNKNOWN"
)
const (
// RowsAffectedKey represents the number of rows affected.
RowsAffectedKey = attribute.Key("pgx.rows_affected")
// QueryParametersKey represents the query parameters.
QueryParametersKey = attribute.Key("pgx.query.parameters")
// BatchSizeKey represents the batch size.
BatchSizeKey = attribute.Key("pgx.batch.size")
// PrepareStmtNameKey represents the prepared statement name.
PrepareStmtNameKey = attribute.Key("pgx.prepare_stmt.name")
// SQLStateKey represents PostgreSQL error code,
// see https://www.postgresql.org/docs/current/errcodes-appendix.html.
SQLStateKey = attribute.Key("pgx.sql_state")
)
// Tracer is a wrapper around the pgx tracer interfaces which instrument
// queries.
type Tracer struct {
tracer trace.Tracer
attrs []attribute.KeyValue
trimQuerySpanName bool
spanNameFunc SpanNameFunc
prefixQuerySpanName bool
logSQLStatement bool
includeParams bool
}
type tracerConfig struct {
tp trace.TracerProvider
attrs []attribute.KeyValue
trimQuerySpanName bool
spanNameFunc SpanNameFunc
prefixQuerySpanName bool
logSQLStatement bool
includeParams bool
}
// NewTracer returns a new Tracer.
func NewTracer(opts ...Option) *Tracer {
cfg := &tracerConfig{
tp: otel.GetTracerProvider(),
attrs: []attribute.KeyValue{
semconv.DBSystemPostgreSQL,
},
trimQuerySpanName: false,
spanNameFunc: nil,
prefixQuerySpanName: true,
logSQLStatement: true,
includeParams: false,
}
for _, opt := range opts {
opt.apply(cfg)
}
return &Tracer{
tracer: cfg.tp.Tracer(tracerName, trace.WithInstrumentationVersion(findOwnImportedVersion())),
attrs: cfg.attrs,
trimQuerySpanName: cfg.trimQuerySpanName,
spanNameFunc: cfg.spanNameFunc,
prefixQuerySpanName: cfg.prefixQuerySpanName,
logSQLStatement: cfg.logSQLStatement,
includeParams: cfg.includeParams,
}
}
func recordError(span trace.Span, err error) {
if err != nil && !errors.Is(err, sql.ErrNoRows) {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
var pgErr *pgconn.PgError
if errors.As(err, &pgErr) {
span.SetAttributes(SQLStateKey.String(pgErr.Code))
}
}
}
// sqlOperationName attempts to get the first 'word' from a given SQL query, which usually
// is the operation name (e.g. 'SELECT').
func (t *Tracer) sqlOperationName(stmt string) string {
// If a custom function is provided, use that. Otherwise, fall back to the
// default implementation. This allows users to override the default
// behavior without having to reimplement it.
if t.spanNameFunc != nil {
return t.spanNameFunc(stmt)
}
parts := strings.Fields(stmt)
if len(parts) == 0 {
// Fall back to a fixed value to prevent creating lots of tracing operations
// differing only by the amount of whitespace in them (in case we'd fall back
// to the full query or a cut-off version).
return sqlOperationUnknown
}
return strings.ToUpper(parts[0])
}
// connectionAttributesFromConfig returns a slice of SpanStartOptions that contain
// attributes from the given connection config.
func connectionAttributesFromConfig(config *pgx.ConnConfig) []trace.SpanStartOption {
if config != nil {
return []trace.SpanStartOption{
trace.WithAttributes(
semconv.NetPeerName(config.Host),
semconv.NetPeerPort(int(config.Port)),
semconv.DBUser(config.User),
),
}
}
return nil
}
// TraceQueryStart is called at the beginning of Query, QueryRow, and Exec calls.
// The returned context is used for the rest of the call and will be passed to TraceQueryEnd.
func (t *Tracer) TraceQueryStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryStartData) context.Context {
if !trace.SpanFromContext(ctx).IsRecording() {
return ctx
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
}
if conn != nil {
opts = append(opts, connectionAttributesFromConfig(conn.Config())...)
}
if t.logSQLStatement {
opts = append(opts, trace.WithAttributes(semconv.DBStatement(data.SQL)))
if t.includeParams {
opts = append(opts, trace.WithAttributes(makeParamsAttribute(data.Args)))
}
}
spanName := data.SQL
if t.trimQuerySpanName {
spanName = t.sqlOperationName(data.SQL)
}
if t.prefixQuerySpanName {
spanName = "query " + spanName
}
ctx, _ = t.tracer.Start(ctx, spanName, opts...)
return ctx
}
// TraceQueryEnd is called at the end of Query, QueryRow, and Exec calls.
func (t *Tracer) TraceQueryEnd(ctx context.Context, _ *pgx.Conn, data pgx.TraceQueryEndData) {
span := trace.SpanFromContext(ctx)
recordError(span, data.Err)
if data.Err == nil {
span.SetAttributes(RowsAffectedKey.Int64(data.CommandTag.RowsAffected()))
}
span.End()
}
// TraceCopyFromStart is called at the beginning of CopyFrom calls. The
// returned context is used for the rest of the call and will be passed to
// TraceCopyFromEnd.
func (t *Tracer) TraceCopyFromStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceCopyFromStartData) context.Context {
if !trace.SpanFromContext(ctx).IsRecording() {
return ctx
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
trace.WithAttributes(semconv.DBSQLTable(data.TableName.Sanitize())),
}
if conn != nil {
opts = append(opts, connectionAttributesFromConfig(conn.Config())...)
}
ctx, _ = t.tracer.Start(ctx, "copy_from "+data.TableName.Sanitize(), opts...)
return ctx
}
// TraceCopyFromEnd is called at the end of CopyFrom calls.
func (t *Tracer) TraceCopyFromEnd(ctx context.Context, _ *pgx.Conn, data pgx.TraceCopyFromEndData) {
span := trace.SpanFromContext(ctx)
recordError(span, data.Err)
if data.Err == nil {
span.SetAttributes(RowsAffectedKey.Int64(data.CommandTag.RowsAffected()))
}
span.End()
}
// TraceBatchStart is called at the beginning of SendBatch calls. The returned
// context is used for the rest of the call and will be passed to
// TraceBatchQuery and TraceBatchEnd.
func (t *Tracer) TraceBatchStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchStartData) context.Context {
if !trace.SpanFromContext(ctx).IsRecording() {
return ctx
}
var size int
if b := data.Batch; b != nil {
size = b.Len()
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
trace.WithAttributes(BatchSizeKey.Int(size)),
}
if conn != nil {
opts = append(opts, connectionAttributesFromConfig(conn.Config())...)
}
ctx, _ = t.tracer.Start(ctx, "batch start", opts...)
return ctx
}
// TraceBatchQuery is called at the after each query in a batch.
func (t *Tracer) TraceBatchQuery(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchQueryData) {
if !trace.SpanFromContext(ctx).IsRecording() {
return
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
}
if conn != nil {
opts = append(opts, connectionAttributesFromConfig(conn.Config())...)
}
if t.logSQLStatement {
opts = append(opts, trace.WithAttributes(semconv.DBStatement(data.SQL)))
if t.includeParams {
opts = append(opts, trace.WithAttributes(makeParamsAttribute(data.Args)))
}
}
var spanName string
if t.trimQuerySpanName {
spanName = t.sqlOperationName(data.SQL)
if t.prefixQuerySpanName {
spanName = "query " + spanName
}
} else {
spanName = data.SQL
if t.prefixQuerySpanName {
spanName = "batch query " + spanName
}
}
_, span := t.tracer.Start(ctx, spanName, opts...)
recordError(span, data.Err)
span.End()
}
// TraceBatchEnd is called at the end of SendBatch calls.
func (t *Tracer) TraceBatchEnd(ctx context.Context, _ *pgx.Conn, data pgx.TraceBatchEndData) {
span := trace.SpanFromContext(ctx)
recordError(span, data.Err)
span.End()
}
// TraceConnectStart is called at the beginning of Connect and ConnectConfig
// calls. The returned context is used for the rest of the call and will be
// passed to TraceConnectEnd.
func (t *Tracer) TraceConnectStart(ctx context.Context, data pgx.TraceConnectStartData) context.Context {
if !trace.SpanFromContext(ctx).IsRecording() {
return ctx
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
}
if data.ConnConfig != nil {
opts = append(opts, connectionAttributesFromConfig(data.ConnConfig)...)
}
ctx, _ = t.tracer.Start(ctx, "connect", opts...)
return ctx
}
// TraceConnectEnd is called at the end of Connect and ConnectConfig calls.
func (t *Tracer) TraceConnectEnd(ctx context.Context, data pgx.TraceConnectEndData) {
span := trace.SpanFromContext(ctx)
recordError(span, data.Err)
span.End()
}
// TracePrepareStart is called at the beginning of Prepare calls. The returned
// context is used for the rest of the call and will be passed to
// TracePrepareEnd.
func (t *Tracer) TracePrepareStart(ctx context.Context, conn *pgx.Conn, data pgx.TracePrepareStartData) context.Context {
if !trace.SpanFromContext(ctx).IsRecording() {
return ctx
}
opts := []trace.SpanStartOption{
trace.WithSpanKind(trace.SpanKindClient),
trace.WithAttributes(t.attrs...),
}
if data.Name != "" {
trace.WithAttributes(PrepareStmtNameKey.String(data.Name))
}
if conn != nil {
opts = append(opts, connectionAttributesFromConfig(conn.Config())...)
}
if t.logSQLStatement {
opts = append(opts, trace.WithAttributes(semconv.DBStatement(data.SQL)))
}
spanName := data.SQL
if t.trimQuerySpanName {
spanName = t.sqlOperationName(data.SQL)
}
if t.prefixQuerySpanName {
spanName = "prepare " + spanName
}
ctx, _ = t.tracer.Start(ctx, spanName, opts...)
return ctx
}
// TracePrepareEnd is called at the end of Prepare calls.
func (t *Tracer) TracePrepareEnd(ctx context.Context, _ *pgx.Conn, data pgx.TracePrepareEndData) {
span := trace.SpanFromContext(ctx)
recordError(span, data.Err)
span.End()
}
func makeParamsAttribute(args []any) attribute.KeyValue {
ss := make([]string, len(args))
for i := range args {
ss[i] = fmt.Sprintf("%+v", args[i])
}
return QueryParametersKey.StringSlice(ss)
}
func findOwnImportedVersion() string {
buildInfo, ok := debug.ReadBuildInfo()
if ok {
for _, dep := range buildInfo.Deps {
if dep.Path == tracerName {
return dep.Version
}
}
}
return "unknown"
}