redisotel

README

goredisotel

A fork of go-redis/extra/redisotel/v9 that follows Semantic Conventions v1.30.

Installation

go get github.com/wzy9607/goredisotel

Usage

Tracing is enabled by adding a hook:

import (
"github.com/redis/go-redis/v9"
"github.com/wzy9607/goredisotel"
)

rdb := rdb.NewClient(&rdb.Options{...})

// Enable tracing and metrics instrumentation.
if err := goredisotel.InstrumentClientWithHooks(rdb); err != nil {
panic(err)
}

// Enable tracing instrumentation only.
if err := goredisotel.InstrumentClientWithHooks(rdb, goredisotel.DisableMetrics()); err != nil {
panic(err)
}

// Enable pool statistics metrics instrumentation.
if err := goredisotel.InstrumentPoolStatsMetrics(rdb); err != nil {
panic(err)
}

See example for details.

Documentation

Index

• func InstrumentClientWithHooks(rdb redis.UniversalClient, opts ...Option) error
• func InstrumentPoolStatsMetrics(rdb redis.UniversalClient, opts ...Option) error
• func SetBuckets(b []float64)
• type Option
  • func DisableMetrics() Option
  • func EnableDBQueryText() Option
  • func WithAttributes(attrs ...attribute.KeyValue) Option
  • func WithMeterProvider(mp metric.MeterProvider) Option
  • func WithPoolName(poolName string) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option

Functions

func InstrumentClientWithHooks

func InstrumentClientWithHooks(rdb redis.UniversalClient, opts ...Option) error

InstrumentClientWithHooks starts reporting OpenTelemetry Tracing and Metrics.

Based on https://opentelemetry.io/docs/specs/semconv/database/.

func InstrumentPoolStatsMetrics

func InstrumentPoolStatsMetrics(rdb redis.UniversalClient, opts ...Option) error

InstrumentPoolStatsMetrics starts reporting OpenTelemetry Metrics for the connection pool.

func SetBuckets

func SetBuckets(b []float64)

SetBuckets sets the buckets used for OpenTelemetry metrics. The default buckets of .001, .005, .01, .025, .05, .075, .1, .25, .5, .75, 1, 2.5, 5, 7.5, 10 are used if SetBuckets is not called. The default buckets are finer than the one in the Semantic Conventions.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures the instrumentation.

func DisableMetrics

func DisableMetrics() Option

DisableMetrics tells the hook not to record metrics.

func EnableDBQueryText

func EnableDBQueryText() Option

EnableDBQueryText tells the tracing hook to log raw redis commands.

func WithAttributes

func WithAttributes(attrs ...attribute.KeyValue) Option

WithAttributes specifies additional attributes to be added to the span.

func WithMeterProvider

func WithMeterProvider(mp metric.MeterProvider) Option

WithMeterProvider configures a metric.Meter used to create instruments.

func WithPoolName

func WithPoolName(poolName string) Option

WithPoolName specifies the pool name to use in the attributes.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.