chore: improve OpenTelemetry example

Author: vmihailenco

example/otel/README.md

@@ -1,40 +1,47 @@
 # Example for go-redis OpenTelemetry instrumentation
 
+This example demonstrates how to monitor Redis using OpenTelemetry and
+[Uptrace](https://github.com/uptrace/uptrace). It requires Docker to start Redis Server and Uptrace.
+
 See
 [Monitoring Go Redis Performance and Errors](https://redis.uptrace.dev/guide/go-redis-monitoring.html)
 for details.
 
-This example requires Redis Server on port `:6379`. You can start Redis Server using Docker:
+**Step 1**. Download the example using Git:
 
 ```shell
-docker-compose up -d
+git clone https://github.com/go-redis/redis.git
+cd example/otel
 ```
 
-You can run this example with different OpenTelemetry exporters by providing environment variables.
-
-**Stdout** exporter (default):
+**Step 2**. Start the services using Docker:
 
 ```shell
-go run .
+docker-compose pull
+docker-compose up -d
 ```
 
-[Uptrace](https://github.com/uptrace/uptrace) exporter:
+**Step 3**. Make sure Uptrace is running:
 
 ```shell
-UPTRACE_DSN="https://<token>@uptrace.dev/<project_id>" go run .
+docker-compose logs uptrace
 ```
 
-**Jaeger** exporter:
+**Step 4**. Run the Redis client example:
 
 ```shell
-OTEL_EXPORTER_JAEGER_ENDPOINT=http://localhost:14268/api/traces go run .
+UPTRACE_DSN=http://project2_secret_token@localhost:14317/2 go run client.go
 ```
 
-To instrument Redis Cluster client, see
-[go-redis-cluster](https://github.com/uptrace/opentelemetry-go-extra/tree/main/example/go-redis-cluster)
-example.
+**Step 5**. Follow the link from the CLI to view the trace:
+
+```shell
+UPTRACE_DSN=http://project2_secret_token@localhost:14317/2 go run client.go
+trace: http://localhost:14318/traces/ee029d8782242c8ed38b16d961093b35
+```
 
 ## Links
 
+- [Uptrace open-source APM](https://uptrace.dev/get/open-source-apm.html)
 - [OpenTelemetry Go instrumentations](https://uptrace.dev/opentelemetry/instrumentations/?lang=go)
 - [OpenTelemetry Go Tracing API](https://uptrace.dev/opentelemetry/go-tracing.html)

example/otel/main.go renamed to example/otel/client.go

@@ -2,41 +2,59 @@ package main
 
 import (
 	"context"
+	"fmt"
 	"log"
 	"sync"
+	"time"
 
-	"github.com/uptrace/opentelemetry-go-extra/otelplay"
+	"github.com/uptrace/uptrace-go/uptrace"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/codes"
 
 	"github.com/go-redis/redis/extra/redisotel/v9"
 	"github.com/go-redis/redis/v9"
 )
 
-var tracer = otel.Tracer("redisexample")
+var tracer = otel.Tracer("github.com/go-redis/redis/example/otel")
 
 func main() {
 	ctx := context.Background()
 
-	shutdown := otelplay.ConfigureOpentelemetry(ctx)
-	defer shutdown()
+	uptrace.ConfigureOpentelemetry(
+		// copy your project DSN here or use UPTRACE_DSN env var
+		// uptrace.WithDSN("https://[email protected]/1"),
+
+		uptrace.WithServiceName("myservice"),
+		uptrace.WithServiceVersion("v1.0.0"),
+	)
+	defer uptrace.Shutdown(ctx)
 
 	rdb := redis.NewClient(&redis.Options{
 		Addr: ":6379",
 	})
 	if err := redisotel.InstrumentTracing(rdb); err != nil {
 		panic(err)
 	}
+	if err := redisotel.InstrumentMetrics(rdb); err != nil {
+		panic(err)
+	}
 
-	ctx, span := tracer.Start(ctx, "handleRequest")
-	defer span.End()
+	for i := 0; i < 1e6; i++ {
+		ctx, rootSpan := tracer.Start(ctx, "handleRequest")
 
-	if err := handleRequest(ctx, rdb); err != nil {
-		span.RecordError(err)
-		span.SetStatus(codes.Error, err.Error())
-	}
+		if err := handleRequest(ctx, rdb); err != nil {
+			rootSpan.RecordError(err)
+			rootSpan.SetStatus(codes.Error, err.Error())
+		}
 
-	otelplay.PrintTraceID(ctx)
+		rootSpan.End()
+
+		if i == 0 {
+			fmt.Printf("view trace: %s\n", uptrace.TraceURL(rootSpan))
+		}
+
+		time.Sleep(time.Second)
+	}
 }
 
 func handleRequest(ctx context.Context, rdb *redis.Client) error {

example/otel/docker-compose.yml

@@ -1,9 +1,65 @@
 version: '3'
 
 services:
+  clickhouse:
+    image: clickhouse/clickhouse-server:22.7
+    restart: on-failure
+    environment:
+      CLICKHOUSE_DB: uptrace
+    healthcheck:
+      test: ['CMD', 'wget', '--spider', '-q', 'localhost:8123/ping']
+      interval: 1s
+      timeout: 1s
+      retries: 30
+    volumes:
+      - ch_data:/var/lib/clickhouse
+    ports:
+      - '8123:8123'
+      - '9000:9000'
+
+  uptrace:
+    image: 'uptrace/uptrace:latest'
+    #image: 'uptrace/uptrace-dev:latest'
+    volumes:
+      - uptrace_data:/var/lib/uptrace
+      - ./uptrace.yml:/etc/uptrace/uptrace.yml
+    #environment:
+    #  - DEBUG=2
+    ports:
+      - '14317:14317'
+      - '14318:14318'
+    depends_on:
+      clickhouse:
+        condition: service_healthy
+
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:0.58.0
+    restart: on-failure
+    user: '0:0' # required for logs
+    volumes:
+      - ./otel-collector.yaml:/etc/otelcol-contrib/config.yaml
+      - /var/lib/docker/containers:/var/lib/docker/containers:ro
+      - /var/log:/var/log:ro
+    ports:
+      - '4317:4317'
+      - '4318:4318'
+
+  vector:
+    image: timberio/vector:0.24.X-alpine
+    volumes:
+      - ./vector.toml:/etc/vector/vector.toml:ro
+
   redis-server:
     image: redis
     ports:
       - '6379:6379'
   redis-cli:
     image: redis
+
+volumes:
+  uptrace_data:
+    driver: local
+  ch_data:
+    driver: local
+  alertmanager_data:
+    driver: local

example/otel/otel-collector.yaml

@@ -0,0 +1,68 @@
+extensions:
+  health_check:
+  pprof:
+    endpoint: 0.0.0.0:1777
+  zpages:
+    endpoint: 0.0.0.0:55679
+
+receivers:
+  otlp:
+    protocols:
+      grpc:
+      http:
+  hostmetrics:
+    collection_interval: 10s
+    scrapers:
+      cpu:
+      disk:
+      load:
+      filesystem:
+      memory:
+      network:
+      paging:
+  redis:
+    endpoint: 'redis-server:6379'
+    collection_interval: 10s
+  jaeger:
+    protocols:
+      grpc:
+
+processors:
+  resourcedetection:
+    detectors: ['system']
+  batch:
+    send_batch_size: 10000
+    timeout: 10s
+
+exporters:
+  logging:
+    logLevel: debug
+  otlp:
+    endpoint: uptrace:14317
+    tls:
+      insecure: true
+    headers: { 'uptrace-dsn': 'http://project2_secret_token@localhost:14317/2' }
+
+service:
+  # telemetry:
+  #   logs:
+  #     level: DEBUG
+  pipelines:
+    traces:
+      receivers: [otlp, jaeger]
+      processors: [batch]
+      exporters: [otlp, logging]
+    metrics:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp]
+    metrics/hostmetrics:
+      receivers: [hostmetrics, redis]
+      processors: [batch, resourcedetection]
+      exporters: [otlp]
+    logs:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp]
+
+  extensions: [health_check, pprof, zpages]