Tracer implementation

client/client.go

@@ -1,6 +1,7 @@
 package client
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"io"
@@ -10,7 +11,11 @@ import (
 	"time"
 
 	"github.com/hashicorp/go-hclog"
+	realmtrace "github.com/steviebps/realm/trace"
 	"github.com/steviebps/realm/utils"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/propagation"
+	"go.opentelemetry.io/otel/trace"
 )
 
 const DefaultClientTimeout = 15 * time.Second
@@ -25,9 +30,13 @@ type Client struct {
 	underlying *http.Client
 	logger     hclog.Logger
 	address    *url.URL
+	tracer     trace.Tracer
+	propagator propagation.TextMapPropagator
+	closeFn    func(ctx context.Context) error
 }
 
 func NewClient(c *ClientConfig) (*Client, error) {
+	ctx := context.Background()
 	if c.Address == "" {
 		return nil, errors.New("address must not be empty")
 	}
@@ -44,10 +53,20 @@ func NewClient(c *ClientConfig) (*Client, error) {
 		c.Timeout = DefaultClientTimeout
 	}
 
+	shutdownTracerProvider, err := realmtrace.SetupOtelInstrumentation(ctx, false)
+	if err != nil {
+		return nil, err
+	}
+
+	tracer := otel.Tracer("github.com/steviebps/realm")
+
 	return &Client{
 		underlying: &http.Client{Timeout: c.Timeout},
 		address:    u,
 		logger:     logger,
+		tracer:     tracer,
+		propagator: otel.GetTextMapPropagator(),
+		closeFn:    shutdownTracerProvider,
 	}, nil
 }
 
@@ -58,6 +77,10 @@ func (c *Client) NewRequest(method string, path string, body io.Reader) (*http.R
 
 func (c *Client) Do(r *http.Request) (*http.Response, error) {
 	c.logger.Debug("executing request", "method", r.Method, "path", r.URL.Path, "host", r.URL.Host)
+	ctx, span := c.tracer.Start(r.Context(), "realm/client Do")
+	defer span.End()
+
+	c.propagator.Inject(ctx, propagation.HeaderCarrier(r.Header))
 	return c.underlying.Do(r)
 }
 
@@ -69,3 +92,9 @@ func (c *Client) PerformRequest(method string, path string, body io.Reader) (*ht
 	}
 	return c.Do(req)
 }
+
+func (c *Client) Close() {
+	if err := c.closeFn(context.Background()); err != nil {
+		c.logger.Error("failed to shutdown TracerProvider: %s", err)
+	}
+}

cmd/client_delete.go

@@ -62,6 +62,7 @@ var clientDelete = &cobra.Command{
 			logger.Error(err.Error())
 			os.Exit(1)
 		}
+		defer c.Close()
 
 		res, err := c.PerformRequest("DELETE", "chambers/"+strings.TrimPrefix(args[0], "/"), nil)
 		if err != nil {

cmd/client_get.go

@@ -62,6 +62,7 @@ var clientGet = &cobra.Command{
 			logger.Error(err.Error())
 			os.Exit(1)
 		}
+		defer c.Close()
 
 		res, err := c.PerformRequest("GET", "chambers/"+strings.TrimPrefix(args[0], "/"), nil)
 		if err != nil {

cmd/server.go

@@ -1,16 +1,24 @@
 package cmd
 
 import (
+	"context"
+	"errors"
 	"fmt"
 	"net/http"
 	"os"
+	"os/signal"
 	"strconv"
+	"syscall"
 	"time"
 
 	"github.com/hashicorp/go-hclog"
 	"github.com/spf13/cobra"
 	realmhttp "github.com/steviebps/realm/http"
 	storage "github.com/steviebps/realm/pkg/storage"
+	realmtrace "github.com/steviebps/realm/trace"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 var serverCmd = &cobra.Command{
@@ -24,6 +32,7 @@ var serverCmd = &cobra.Command{
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
+		ctx := context.Background()
 		flags := cmd.Flags()
 		debug, _ := flags.GetBool("debug")
 
@@ -41,6 +50,21 @@ var serverCmd = &cobra.Command{
 			Color:                hclog.AutoColor,
 		})
 
+		shutdownTracerProvider, err := realmtrace.SetupOtelInstrumentation(ctx, false)
+		if err != nil {
+			logger.Error(err.Error())
+			os.Exit(1)
+		}
+		defer func() {
+			if err := shutdownTracerProvider(ctx); err != nil {
+				logger.Error("failed to shutdown TracerProvider: %s", err)
+			}
+		}()
+
+		tracer := otel.Tracer("github.com/steviebps/realm")
+		ctx, span := tracer.Start(ctx, "server life")
+		defer span.End()
+
 		configPath, err := flags.GetString("config")
 		if err != nil {
 			logger.Error(err.Error())
@@ -122,23 +146,36 @@ var serverCmd = &cobra.Command{
 			}
 		}
 
-		handler, err := realmhttp.NewHandler(realmhttp.HandlerConfig{Storage: stg, Logger: logger})
+		handler, err := realmhttp.NewHandler(realmhttp.HandlerConfig{Storage: stg, Logger: logger, RequestTimeout: realmhttp.DefaultHandlerTimeout})
 		if err != nil {
 			logger.Error(err.Error())
 			os.Exit(1)
 		}
 
-		if certFileEmpty {
+		server := &http.Server{Addr: fmt.Sprintf(":%d", port), Handler: handler}
+
+		go func() {
 			logger.Info("Listening on", "port", portStr)
-			if err := http.ListenAndServe(fmt.Sprintf(":%d", port), handler); err != nil {
+			span.AddEvent("started server", trace.WithAttributes(attribute.String("port", portStr)))
+			if certFileEmpty {
+				if err := server.ListenAndServe(); !errors.Is(err, http.ErrServerClosed) {
+					logger.Error(err.Error())
+					os.Exit(1)
+				}
+				return
+			}
+
+			if err := server.ListenAndServeTLS(certFile, keyFile); !errors.Is(err, http.ErrServerClosed) {
 				logger.Error(err.Error())
 				os.Exit(1)
 			}
-			return
-		}
+		}()
+
+		sigChan := make(chan os.Signal, 1)
+		signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
+		<-sigChan
 
-		logger.Info("Listening on", "port", portStr)
-		if err := http.ListenAndServeTLS(fmt.Sprintf(":%d", port), certFile, keyFile, handler); err != nil {
+		if err := server.Shutdown(ctx); err != nil {
 			logger.Error(err.Error())
 			os.Exit(1)
 		}

examples/go/main.go

@@ -24,6 +24,8 @@ func main() {
 	if err != nil {
 		log.Fatal(err)
 	}
+	defer client.Close()
+
 	rlm, err := realm.NewRealm(realm.RealmOptions{Client: client, ApplicationVersion: "v1.0.0", Path: "root", RefreshInterval: 1 * time.Minute})
 	if err != nil {
 		log.Fatal(err)

go.mod

@@ -1,57 +1,68 @@
 module github.com/steviebps/realm
 
-go 1.19
+go 1.22.0
+
+toolchain go1.23.1
 
 require (
-	cloud.google.com/go/storage v1.38.0
+	cloud.google.com/go/storage v1.43.0
 	github.com/NYTimes/gziphandler v1.1.1
 	github.com/allegro/bigcache/v3 v3.1.0
 	github.com/google/uuid v1.6.0
-	github.com/spf13/cobra v1.8.0
-	golang.org/x/mod v0.15.0
-	google.golang.org/api v0.165.0
+	github.com/spf13/cobra v1.8.1
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0
+	go.opentelemetry.io/otel v1.30.0
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.30.0
+	go.opentelemetry.io/otel/exporters/stdout/stdoutlog v0.6.0
+	go.opentelemetry.io/otel/sdk/log v0.6.0
+	go.opentelemetry.io/otel/trace v1.30.0
+	golang.org/x/mod v0.21.0
+	google.golang.org/api v0.199.0
 )
 
 require (
-	cloud.google.com/go v0.112.0 // indirect
-	cloud.google.com/go/compute v1.24.0 // indirect
-	cloud.google.com/go/compute/metadata v0.2.3 // indirect
-	cloud.google.com/go/iam v1.1.6 // indirect
-	github.com/fatih/color v1.16.0 // indirect
+	cloud.google.com/go v0.115.1 // indirect
+	cloud.google.com/go/auth v0.9.7 // indirect
+	cloud.google.com/go/auth/oauth2adapt v0.2.4 // indirect
+	cloud.google.com/go/compute/metadata v0.5.2 // indirect
+	cloud.google.com/go/iam v1.2.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
+	github.com/fatih/color v1.17.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
-	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.3 // indirect
-	github.com/google/s2a-go v0.1.7 // indirect
-	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
-	github.com/googleapis/gax-go/v2 v2.12.1 // indirect
+	github.com/google/s2a-go v0.1.8 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.3.4 // indirect
+	github.com/googleapis/gax-go/v2 v2.13.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.22.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	go.opencensus.io v0.24.0 // indirect
-	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.48.0 // indirect
-	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.48.0 // indirect
-	go.opentelemetry.io/otel v1.23.1 // indirect
-	go.opentelemetry.io/otel/metric v1.23.1 // indirect
-	go.opentelemetry.io/otel/trace v1.23.1 // indirect
-	golang.org/x/crypto v0.21.0 // indirect
-	golang.org/x/net v0.23.0 // indirect
-	golang.org/x/oauth2 v0.17.0 // indirect
-	golang.org/x/sync v0.6.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
-	golang.org/x/time v0.5.0 // indirect
-	google.golang.org/appengine v1.6.8 // indirect
-	google.golang.org/genproto v0.0.0-20240213162025-012b6fc9bca9 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20240213162025-012b6fc9bca9 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240213162025-012b6fc9bca9 // indirect
-	google.golang.org/grpc v1.61.1 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.55.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.30.0 // indirect
+	go.opentelemetry.io/otel/log v0.6.0 // indirect
+	go.opentelemetry.io/otel/metric v1.30.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
+	golang.org/x/crypto v0.27.0 // indirect
+	golang.org/x/net v0.29.0 // indirect
+	golang.org/x/oauth2 v0.23.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
+	golang.org/x/time v0.6.0 // indirect
+	google.golang.org/genproto v0.0.0-20240930140551-af27646dc61f // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240930140551-af27646dc61f // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240930140551-af27646dc61f // indirect
+	google.golang.org/grpc v1.67.1 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
 )
 
 require (
-	github.com/hashicorp/go-hclog v1.6.2
+	github.com/hashicorp/go-hclog v1.6.3
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.30.0
+	go.opentelemetry.io/otel/sdk v1.30.0
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d
-	golang.org/x/sys v0.18.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
 )