Merge pull request #1882 from go-redis/chore/otel-example

chore: cleanup OpenTelemetry example

Author: vmihailenco

Makefile

@@ -19,8 +19,6 @@ testdata/redis:
 testdata/redis/src/redis-server: testdata/redis
 	cd $< && make all
 
-tag:
-	git tag $(VERSION)
-	git tag extra/rediscmd/$(VERSION)
-	git tag extra/redisotel/$(VERSION)
-	git tag extra/rediscensus/$(VERSION)
+fmt:
+	gofmt -w -s ./
+	goimports -w  -local github.com/go-redis/redis ./

cluster_test.go

@@ -9,11 +9,11 @@ import (
 	"sync"
 	"time"
 
-	"github.com/go-redis/redis/v8"
-	"github.com/go-redis/redis/v8/internal/hashtag"
-
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
+	"github.com/go-redis/redis/v8"
+	"github.com/go-redis/redis/v8/internal/hashtag"
 )
 
 type clusterScenario struct {

command_test.go

@@ -4,10 +4,10 @@ import (
 	"errors"
 	"time"
 
-	redis "github.com/go-redis/redis/v8"
-
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
+	redis "github.com/go-redis/redis/v8"
 )
 
 var _ = Describe("Cmd", func() {
@@ -72,7 +72,7 @@ var _ = Describe("Cmd", func() {
 	})
 
 	It("supports time.Time", func() {
-		tm := time.Date(2019, 01, 01, 9, 45, 10, 222125, time.UTC)
+		tm := time.Date(2019, 1, 1, 9, 45, 10, 222125, time.UTC)
 
 		err := client.Set(ctx, "time_key", tm, 0).Err()
 		Expect(err).NotTo(HaveOccurred())

commands_test.go

@@ -472,11 +472,11 @@ var _ = Describe("Commands", func() {
 			idleTime := client.ObjectIdleTime(ctx, "key")
 			Expect(idleTime.Err()).NotTo(HaveOccurred())
 
-			//Redis returned milliseconds/1000, which may cause ObjectIdleTime to be at a critical value,
-			//should be +1s to deal with the critical value problem.
-			//if too much time (>1s) is used during command execution, it may also cause the test to fail.
-			//so the ObjectIdleTime result should be <=now-start+1s
-			//link: https://github.com/redis/redis/blob/5b48d900498c85bbf4772c1d466c214439888115/src/object.c#L1265-L1272
+			// Redis returned milliseconds/1000, which may cause ObjectIdleTime to be at a critical value,
+			// should be +1s to deal with the critical value problem.
+			// if too much time (>1s) is used during command execution, it may also cause the test to fail.
+			// so the ObjectIdleTime result should be <=now-start+1s
+			// link: https://github.com/redis/redis/blob/5b48d900498c85bbf4772c1d466c214439888115/src/object.c#L1265-L1272
 			Expect(idleTime.Val()).To(BeNumerically("<=", time.Now().Sub(start)+time.Second))
 		})
 

example/otel/README.md

@@ -1,9 +1,16 @@
-### OpenTelemetry Example 
-Prints spans and metrics to the console.
-#### To Run:
-- `docker-compose up -d`
-- `go run .`
+# Example for go-redis OpenTelemetry instrumentation
 
-When you're finished, be sure to run `docker-compose down` to shutdown
-the redis server.
+This example requires running Redis Server. You can start Redis Server using Docker:
 
+```shell
+docker-compose up -d
+```
+
+To run this example:
+
+```shell
+go run .
+```
+
+See [Monitoring performance and errors](https://redis.uptrace.dev/guide/tracing.html) for more
+details.

example/otel/docker-compose.yml

@@ -1,8 +1,9 @@
 version: '3'
+
 services:
   redis-server:
     image: redis
     ports:
-      - "6379:6379"
+      - '6379:6379'
   redis-cli:
     image: redis

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

@@ -2,35 +2,46 @@ package main
 
 import (
 	"context"
-	"log"
 	"sync"
-	"time"
 
-	"github.com/go-redis/redis/extra/redisotel/v8"
-	"github.com/go-redis/redis/v8"
 	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
+
+	"github.com/go-redis/redis/extra/redisotel/v8"
+	"github.com/go-redis/redis/v8"
 )
 
+var tracer = otel.Tracer("redisexample")
+
 func main() {
 	ctx := context.Background()
 
-	stop := runExporter(ctx)
-	defer stop(ctx)
+	stop := configureOpentelemetry(ctx)
+	defer stop()
 
 	rdb := redis.NewClient(&redis.Options{
 		Addr: ":6379",
 	})
-
 	rdb.AddHook(redisotel.TracingHook{})
 
-	tracer := otel.Tracer("Example tracer")
-	ctx, span := tracer.Start(ctx, "start-test-span")
+	ctx, span := tracer.Start(ctx, "handleRequest")
+	defer span.End()
 
-	rdb.Set(ctx, "First value", "value_1", 0)
+	if err := handleRequest(ctx); err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+	}
+}
 
-	rdb.Set(ctx, "Second value", "value_2", 0)
+func handleRequest(ctx context.Context) error {
+	if err := rdb.Set(ctx, "First value", "value_1", 0).Err(); err != nil {
+		return err
+	}
+	if err := rdb.Set(ctx, "Second value", "value_2", 0).Err(); err != nil {
+		return err
+	}
 
 	var group sync.WaitGroup
 
@@ -40,35 +51,38 @@ func main() {
 			defer group.Done()
 			val := rdb.Get(ctx, "Second value").Val()
 			if val != "value_2" {
-				log.Fatalf("val was not set. expected: %s but got: %s", "value_2", val)
+				panic(err)
 			}
 		}()
 	}
+
 	group.Wait()
 
-	rdb.Del(ctx, "First value")
-	rdb.Del(ctx, "Second value")
+	if err := rdb.Del(ctx, "First value").Err(); err != nil {
+		return err
+	}
+	if err := rdb.Del(ctx, "Second value").Err(); err != nil {
+		return err
+	}
 
-	// Wait some time to allow spans to export
-	<-time.After(5 * time.Second)
-	span.End()
+	return nil
 }
 
-func runExporter(ctx context.Context) func(context.Context) {
+func configureOpentelemetry(ctx context.Context) func() {
 	provider := sdktrace.NewTracerProvider()
 	otel.SetTracerProvider(provider)
 
 	exp, err := stdouttrace.New(stdouttrace.WithPrettyPrint())
 	if err != nil {
-		log.Fatal(err)
+		panic(err)
 	}
 
 	bsp := sdktrace.NewBatchSpanProcessor(exp)
 	provider.RegisterSpanProcessor(bsp)
 
 	return func(ctx context.Context) {
 		if err := provider.Shutdown(ctx); err != nil {
-			log.Printf("Shutdown failed: %s", err)
+			panic(err)
 		}
 	}
 }

example/scan-struct/main.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/davecgh/go-spew/spew"
+
 	"github.com/go-redis/redis/v8"
 )
 

extra/rediscensus/rediscensus.go

@@ -3,9 +3,10 @@ package rediscensus
 import (
 	"context"
 
+	"go.opencensus.io/trace"
+
 	"github.com/go-redis/redis/extra/rediscmd/v8"
 	"github.com/go-redis/redis/v8"
-	"go.opencensus.io/trace"
 )
 
 type TracingHook struct{}

extra/rediscmd/safe.go

@@ -1,3 +1,4 @@
+//go:build appengine
 // +build appengine
 
 package rediscmd