mirror of
https://github.com/redis/go-redis.git
synced 2025-07-16 13:21:51 +03:00
fa475cbc99
* feat(redisotel): add WithCaller option Allow the disabling the collection of the `code.function`, `code.filepath` and `code.lineno` tracing attributes. When setting `WithCaller(false)` overall performance is increased as the "expensive" `runtime.Callers` and `runtime.(*Frames).Next` calls are no longer needed. * chore(redisotel): improve docblock language * chore(redisotel): rename `WithCaller` to `WithCallerEnabled` --------- Co-authored-by: Nedyalko Dyakov <1547186+ndyakov@users.noreply.github.com>
148 lines
3.0 KiB
Go
148 lines
3.0 KiB
Go
package redisotel
|
|
|
|
import (
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/metric"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
type config struct {
|
|
// Common options.
|
|
|
|
dbSystem string
|
|
attrs []attribute.KeyValue
|
|
|
|
// Tracing options.
|
|
|
|
tp trace.TracerProvider
|
|
tracer trace.Tracer
|
|
|
|
dbStmtEnabled bool
|
|
callerEnabled bool
|
|
|
|
// Metrics options.
|
|
|
|
mp metric.MeterProvider
|
|
meter metric.Meter
|
|
|
|
poolName string
|
|
}
|
|
|
|
type baseOption interface {
|
|
apply(conf *config)
|
|
}
|
|
|
|
type Option interface {
|
|
baseOption
|
|
tracing()
|
|
metrics()
|
|
}
|
|
|
|
type option func(conf *config)
|
|
|
|
func (fn option) apply(conf *config) {
|
|
fn(conf)
|
|
}
|
|
|
|
func (fn option) tracing() {}
|
|
|
|
func (fn option) metrics() {}
|
|
|
|
func newConfig(opts ...baseOption) *config {
|
|
conf := &config{
|
|
dbSystem: "redis",
|
|
attrs: []attribute.KeyValue{},
|
|
|
|
tp: otel.GetTracerProvider(),
|
|
mp: otel.GetMeterProvider(),
|
|
dbStmtEnabled: true,
|
|
callerEnabled: true,
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
opt.apply(conf)
|
|
}
|
|
|
|
conf.attrs = append(conf.attrs, semconv.DBSystemKey.String(conf.dbSystem))
|
|
|
|
return conf
|
|
}
|
|
|
|
func WithDBSystem(dbSystem string) Option {
|
|
return option(func(conf *config) {
|
|
conf.dbSystem = dbSystem
|
|
})
|
|
}
|
|
|
|
// WithAttributes specifies additional attributes to be added to the span.
|
|
func WithAttributes(attrs ...attribute.KeyValue) Option {
|
|
return option(func(conf *config) {
|
|
conf.attrs = append(conf.attrs, attrs...)
|
|
})
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
type TracingOption interface {
|
|
baseOption
|
|
tracing()
|
|
}
|
|
|
|
type tracingOption func(conf *config)
|
|
|
|
var _ TracingOption = (*tracingOption)(nil)
|
|
|
|
func (fn tracingOption) apply(conf *config) {
|
|
fn(conf)
|
|
}
|
|
|
|
func (fn tracingOption) tracing() {}
|
|
|
|
// 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) TracingOption {
|
|
return tracingOption(func(conf *config) {
|
|
conf.tp = provider
|
|
})
|
|
}
|
|
|
|
// WithDBStatement tells the tracing hook to log raw redis commands.
|
|
func WithDBStatement(on bool) TracingOption {
|
|
return tracingOption(func(conf *config) {
|
|
conf.dbStmtEnabled = on
|
|
})
|
|
}
|
|
|
|
// WithCallerEnabled tells the tracing hook to log the calling function, file and line.
|
|
func WithCallerEnabled(on bool) TracingOption {
|
|
return tracingOption(func(conf *config) {
|
|
conf.callerEnabled = on
|
|
})
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
type MetricsOption interface {
|
|
baseOption
|
|
metrics()
|
|
}
|
|
|
|
type metricsOption func(conf *config)
|
|
|
|
var _ MetricsOption = (*metricsOption)(nil)
|
|
|
|
func (fn metricsOption) apply(conf *config) {
|
|
fn(conf)
|
|
}
|
|
|
|
func (fn metricsOption) metrics() {}
|
|
|
|
// WithMeterProvider configures a metric.Meter used to create instruments.
|
|
func WithMeterProvider(mp metric.MeterProvider) MetricsOption {
|
|
return metricsOption(func(conf *config) {
|
|
conf.mp = mp
|
|
})
|
|
}
|