From 482a20d9c970c7ba99181290586ca1c9122a5478 Mon Sep 17 00:00:00 2001 From: Nikolay Dubina Date: Tue, 25 Mar 2025 15:28:25 +0800 Subject: [PATCH] Feature more prominently how to enable OpenTelemetry instrumentation (#3316) --- .github/wordlist.txt | 1 + README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/.github/wordlist.txt b/.github/wordlist.txt index 1fc34f73..578616b9 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -29,6 +29,7 @@ Lua MSSQL namespace NoSQL +OpenTelemetry ORM Packagist PhpRedis diff --git a/README.md b/README.md index 335d32da..fc64e8dd 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,24 @@ func ExampleClient() *redis.Client { ``` +### Instrument with OpenTelemetry + +```go +import ( + "github.com/redis/go-redis/v9" + "github.com/redis/go-redis/extra/redisotel/v9" + "errors" +) + +func main() { + ... + rdb := redis.NewClient(&redis.Options{...}) + + if err := errors.Join(redisotel.InstrumentTracing(rdb), redisotel.InstrumentMetrics(rdb)); err != nil { + log.Fatal(err) + } +``` + ### Advanced Configuration