mirror of https://github.com/go-redis/redis.git
154 lines
3.6 KiB
Go
154 lines
3.6 KiB
Go
package redisotel
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/codes"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
|
|
"go.opentelemetry.io/otel/trace"
|
|
|
|
"github.com/go-redis/redis/extra/rediscmd/v9"
|
|
"github.com/go-redis/redis/v9"
|
|
)
|
|
|
|
const (
|
|
defaultTracerName = "github.com/go-redis/redis/extra/redisotel"
|
|
)
|
|
|
|
type TracingHook struct {
|
|
tracer trace.Tracer
|
|
attrs []attribute.KeyValue
|
|
dbStmtEnabled bool
|
|
}
|
|
|
|
func NewTracingHook(opts ...Option) *TracingHook {
|
|
cfg := &config{
|
|
tp: otel.GetTracerProvider(),
|
|
attrs: []attribute.KeyValue{
|
|
semconv.DBSystemRedis,
|
|
},
|
|
dbStmtEnabled: true,
|
|
}
|
|
for _, opt := range opts {
|
|
opt.apply(cfg)
|
|
}
|
|
|
|
tracer := cfg.tp.Tracer(
|
|
defaultTracerName,
|
|
trace.WithInstrumentationVersion("semver:"+redis.Version()),
|
|
)
|
|
return &TracingHook{tracer: tracer, attrs: cfg.attrs, dbStmtEnabled: cfg.dbStmtEnabled}
|
|
}
|
|
|
|
func (th *TracingHook) BeforeProcess(ctx context.Context, cmd redis.Cmder) (context.Context, error) {
|
|
if !trace.SpanFromContext(ctx).IsRecording() {
|
|
return ctx, nil
|
|
}
|
|
|
|
opts := []trace.SpanStartOption{
|
|
trace.WithSpanKind(trace.SpanKindClient),
|
|
trace.WithAttributes(th.attrs...),
|
|
}
|
|
|
|
if th.dbStmtEnabled {
|
|
opts = append(opts, trace.WithAttributes(semconv.DBStatementKey.String(rediscmd.CmdString(cmd))))
|
|
}
|
|
|
|
ctx, _ = th.tracer.Start(ctx, cmd.FullName(), opts...)
|
|
|
|
return ctx, nil
|
|
}
|
|
|
|
func (th *TracingHook) AfterProcess(ctx context.Context, cmd redis.Cmder) error {
|
|
span := trace.SpanFromContext(ctx)
|
|
if err := cmd.Err(); err != nil {
|
|
recordError(ctx, span, err)
|
|
}
|
|
span.End()
|
|
return nil
|
|
}
|
|
|
|
func (th *TracingHook) BeforeProcessPipeline(
|
|
ctx context.Context, cmds []redis.Cmder,
|
|
) (context.Context, error) {
|
|
if !trace.SpanFromContext(ctx).IsRecording() {
|
|
return ctx, nil
|
|
}
|
|
|
|
opts := []trace.SpanStartOption{
|
|
trace.WithSpanKind(trace.SpanKindClient),
|
|
trace.WithAttributes(th.attrs...),
|
|
trace.WithAttributes(
|
|
attribute.Int("db.redis.num_cmd", len(cmds)),
|
|
),
|
|
}
|
|
|
|
summary, cmdsString := rediscmd.CmdsString(cmds)
|
|
if th.dbStmtEnabled {
|
|
opts = append(opts, trace.WithAttributes(semconv.DBStatementKey.String(cmdsString)))
|
|
}
|
|
|
|
ctx, _ = th.tracer.Start(ctx, "pipeline "+summary, opts...)
|
|
|
|
return ctx, nil
|
|
}
|
|
|
|
func (th *TracingHook) AfterProcessPipeline(ctx context.Context, cmds []redis.Cmder) error {
|
|
span := trace.SpanFromContext(ctx)
|
|
if err := cmds[0].Err(); err != nil {
|
|
recordError(ctx, span, err)
|
|
}
|
|
span.End()
|
|
return nil
|
|
}
|
|
|
|
func recordError(ctx context.Context, span trace.Span, err error) {
|
|
if err != redis.Nil {
|
|
span.RecordError(err)
|
|
span.SetStatus(codes.Error, err.Error())
|
|
}
|
|
}
|
|
|
|
type config struct {
|
|
tp trace.TracerProvider
|
|
attrs []attribute.KeyValue
|
|
dbStmtEnabled bool
|
|
}
|
|
|
|
// Option specifies instrumentation configuration options.
|
|
type Option interface {
|
|
apply(*config)
|
|
}
|
|
|
|
type optionFunc func(*config)
|
|
|
|
func (o optionFunc) apply(c *config) {
|
|
o(c)
|
|
}
|
|
|
|
// WithTracerProvider specifies a tracer provider to use for creating a tracer.
|
|
// If none is specified, the global provider is used.
|
|
func WithTracerProvider(provider trace.TracerProvider) Option {
|
|
return optionFunc(func(cfg *config) {
|
|
if provider != nil {
|
|
cfg.tp = provider
|
|
}
|
|
})
|
|
}
|
|
|
|
// WithAttributes specifies additional attributes to be added to the span.
|
|
func WithAttributes(attrs ...attribute.KeyValue) Option {
|
|
return optionFunc(func(cfg *config) {
|
|
cfg.attrs = append(cfg.attrs, attrs...)
|
|
})
|
|
}
|
|
|
|
// WithDBStatement tells the tracing hook not to log raw redis commands.
|
|
func WithDBStatement(on bool) Option {
|
|
return optionFunc(func(cfg *config) {
|
|
cfg.dbStmtEnabled = on
|
|
})
|
|
}
|