redis/example/otel
Vladimir Mihailenco f9e60f214b chore: update example 2022-11-09 15:51:59 +02:00
..
config chore: update otel example 2022-11-09 15:16:13 +02:00
image chore: update otel example 2022-11-09 15:16:13 +02:00
README.md chore: update otel example 2022-11-09 15:16:13 +02:00
client.go chore: update example 2022-10-19 15:30:35 +03:00
docker-compose.yml chore: update otel example 2022-11-09 15:16:13 +02:00
go.mod chore: update example 2022-11-09 15:51:59 +02:00
go.sum chore: update example 2022-11-09 15:51:59 +02:00
uptrace.yml chore: update otel example 2022-11-09 15:16:13 +02:00

README.md

Example for go-redis OpenTelemetry instrumentation

This example demonstrates how to monitor Redis using OpenTelemetry and Uptrace. It requires Docker to start Redis Server and Uptrace.

See Monitoring Go Redis Performance and Errors for details.

Step 1. Download the example using Git:

git clone https://github.com/go-redis/redis.git
cd example/otel

Step 2. Start the services using Docker:

docker-compose pull
docker-compose up -d

Step 3. Make sure Uptrace is running:

docker-compose logs uptrace

Step 4. Run the Redis client example:

UPTRACE_DSN=http://project2_secret_token@localhost:14317/2 go run client.go

Step 5. Follow the link from the CLI to view the trace:

UPTRACE_DSN=http://project2_secret_token@localhost:14317/2 go run client.go
trace: http://localhost:14318/traces/ee029d8782242c8ed38b16d961093b35

Redis trace

You can also open Uptrace UI at http://localhost:14318 to view available spans, logs, and metrics.

Redis monitoring

You can also monitor Redis performance metrics By installing OpenTelemetry Collector.

OpenTelemetry Collector is an agent that pulls telemetry data from systems you want to monitor and sends it to APM tools using the OpenTelemetry protocol (OTLP).

When telemetry data reaches Uptrace, it automatically generates a Redis dashboard from a pre-defined template.

Redis dashboard