redis/extra/redisotel
Kason Braley 74389af269
docs: Update redisotel example for v9 (#2425)
* docs: Update redisotel docs for v9

Update the redisotel example for v9 to match the example at
https://redis.uptrace.dev/guide/go-redis-monitoring.html#what-is-opentelemetry.

* docs: Point to correct otel example
2023-02-07 08:40:00 +02:00
..
README.md docs: Update redisotel example for v9 (#2425) 2023-02-07 08:40:00 +02:00
config.go chore: add more metrics to redisotel 2022-11-17 16:24:16 +02:00
go.mod chore: release v9.0.2 (release.sh) (#2412) 2023-02-01 10:13:41 +02:00
go.sum feat: upgrade OpenTelemetry, use the new metrics API. (#2410) 2023-02-01 16:04:33 +08:00
metrics.go feat: upgrade OpenTelemetry, use the new metrics API. (#2410) 2023-02-01 16:04:33 +08:00
redisotel_test.go chore: fix test 2023-01-30 10:19:36 +02:00
tracing.go chore: update import path 2023-01-23 08:48:54 +02:00

README.md

OpenTelemetry instrumentation for go-redis

Installation

go get github.com/redis/go-redis/extra/redisotel/v9

Usage

Tracing is enabled by adding a hook:

import (
    "github.com/redis/go-redis/v9"
    "github.com/redis/go-redis/extra/redisotel/v9"
)

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

// Enable tracing instrumentation.
if err := redisotel.InstrumentTracing(rdb); err != nil {
	panic(err)
}

// Enable metrics instrumentation.
if err := redisotel.InstrumentMetrics(rdb); err != nil {
	panic(err)
}

See example and Monitoring Go Redis Performance and Errors for details.