feat: configure OTEL logger (#57)

Signed-off-by: Mateusz Urbanek <mateusz.urbanek.98@gmail.com>

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 ## What this PR does / why we need it:
 <!--
-What code changes are made? 
-What problem does this PR addresses, or what what feature this PR adds?
+What code changes are made?
+What problem does this PR addresses, or what feature this PR adds?
 -->
 <!-- REPLACE WITH CONTENT -->
 

cmd/bootstrap/template/main.go.tpl

@@ -47,7 +47,7 @@ func main() {
 	gocosi.SetLogger(log)
 
 	if err := realMain(context.Background()); err != nil {
-		log.Error(err, "critical failure")
+		log.Error(err, "Critical failure.")
 		os.Exit(1)
 	}
 }

endpoint.go

@@ -133,11 +133,11 @@ func (e *Endpoint) getCOSIEndpoint() {
 
 	u, err := url.Parse(env)
 	if err != nil {
-		log.Error(err, "failed to parse COSI Endpoint from environment")
+		log.Error(err, "Failed to parse COSI Endpoint from environment.")
 		return
 	}
 
-	log.V(8).Info("replacing default", EnvCOSIEndpoint, env)
+	log.V(8).Info("Replacing default.", EnvCOSIEndpoint, env)
 
 	e.address = u
 }
@@ -160,11 +160,11 @@ func (e *Endpoint) getCOSIEndpointUser() {
 	}
 
 	if err != nil {
-		log.Error(err, "failed to parse COSI Endpoint Permissions from environment")
+		log.Error(err, "Failed to parse COSI Endpoint Permissions from environment.")
 		return
 	}
 
-	log.V(8).Info("replacing default", EnvCOSIEndpointUser, env)
+	log.V(8).Info("Replacing default.", EnvCOSIEndpointUser, env)
 
 	e.user = newUser
 }
@@ -187,11 +187,11 @@ func (e *Endpoint) getCOSIEndpointGroup() {
 	}
 
 	if err != nil {
-		log.Error(err, "failed to parse COSI Endpoint Permissions from environment")
+		log.Error(err, "Failed to parse COSI Endpoint Permissions from environment.")
 		return
 	}
 
-	log.V(8).Info("replacing default", EnvCOSIEndpointGroup, env)
+	log.V(8).Info("Replacing default.", EnvCOSIEndpointGroup, env)
 
 	e.group = newGroup
 }
@@ -204,11 +204,11 @@ func (e *Endpoint) getCOSIEndpointPermissions() {
 
 	perms, err := strconv.ParseInt(env, 0, 0)
 	if err != nil {
-		log.Error(err, "failed to parse COSI Endpoint Permissions from environment")
+		log.Error(err, "Failed to parse COSI Endpoint Permissions from environment.")
 		return
 	}
 
-	log.V(8).Info("replacing default", EnvCOSIEndpointPerms, env)
+	log.V(8).Info("Replacing default.", EnvCOSIEndpointPerms, env)
 
 	e.permissions = os.FileMode(perms)
 }

gocosi.go

@@ -22,9 +22,11 @@ import (
 	"net/url"
 	"time"
 
+	ilog "github.com/doomshrine/gocosi/internal/log"
 	"github.com/doomshrine/must"
 	"github.com/go-logr/logr"
 	"github.com/hellofresh/health-go/v5"
+	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/sdk/resource"
 	"google.golang.org/grpc"
 	cosi "sigs.k8s.io/container-object-storage-interface-spec"
@@ -96,6 +98,9 @@ func New(identity cosi.IdentityServer, provisioner cosi.ProvisionerServer, res *
 // SetLogger is used to set the default global logger for the gocosi library.
 func SetLogger(l logr.Logger) {
 	log = l
+
+	otel.SetLogger(l)
+	otel.SetErrorHandler(&ilog.Logger{LoggerImpl: log})
 }
 
 // Run starts the COSI driver and serves requests.
@@ -115,7 +120,7 @@ func (d *Driver) Run(ctx context.Context) error {
 
 	go shutdown(ctx, srv, d.server)
 
-	log.V(4).Info("starting driver", "address", lis.Addr())
+	log.V(4).Info("Starting driver.", "address", lis.Addr())
 
 	err = srv.Serve(lis)
 	if err != nil {
@@ -126,9 +131,9 @@ func (d *Driver) Run(ctx context.Context) error {
 }
 
 func shutdown(ctx context.Context, g *grpc.Server, h *http.Server) {
-	log.V(8).Info("shutdown watcher started")
+	log.V(8).Info("Shutdown watcher started.")
 	<-ctx.Done()
-	log.Info("starting shutdown")
+	log.Info("Starting shutdown.")
 
 	if g != nil {
 		go g.GracefulStop()
@@ -141,18 +146,18 @@ func shutdown(ctx context.Context, g *grpc.Server, h *http.Server) {
 		go func() {
 			err := h.Shutdown(shutdownCtx)
 			if err != nil {
-				log.Error(err, "error during HTTP server shutdown")
+				log.Error(err, "Error during HTTP server shutdown.")
 			}
 		}()
 	}
 }
 
 func (d *Driver) serveHTTP() {
-	log.V(8).Info("http server started", "address", d.server.Addr)
+	log.V(8).Info("HTTP server started.", "address", d.server.Addr)
 
 	err := d.server.ListenAndServe()
 	if err != nil && !errors.Is(err, http.ErrServerClosed) {
-		log.Error(err, "failed to serve HTTP server", "address", d.server.Addr)
+		log.Error(err, "Failed to serve HTTP server.", "address", d.server.Addr)
 	}
 }
 

grpc/handlers/handlers.go

@@ -19,7 +19,7 @@ import (
 	"context"
 	"runtime/debug"
 
-	"github.com/doomshrine/gocosi/grpc/log"
+	"github.com/doomshrine/gocosi/internal/log"
 	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/recovery"
 )
 
@@ -35,7 +35,7 @@ func PanicRecovery(logger *log.Logger, callbacks ...func(context.Context)) recov
 
 		if logger != nil {
 			logger.Log(ctx, 0,
-				"recovered from panic",
+				"Recovered from panic.",
 				"panic", p,
 				"stack", debug.Stack())
 		}

healthz.go

@@ -37,7 +37,7 @@ func HealthcheckFunc(ctx context.Context, addr string) error {
 		return fmt.Errorf("unable to decode healthcheck response: %w", err)
 	}
 
-	log.Info("healthcheck finished",
+	log.Info("Healthcheck finished.",
 		"status", c.Status,
 		"system", c.System,
 		"failures", c.Failures,

grpc/log/log.go → internal/log/log.go

@@ -19,15 +19,23 @@ import (
 
 	"github.com/go-logr/logr"
 	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
+	"go.opentelemetry.io/otel"
 )
 
 type Logger struct {
 	LoggerImpl logr.Logger
 }
 
-// Interface guard.
-var _ logging.Logger = (*Logger)(nil)
+// Interface guards.
+var (
+	_ logging.Logger    = (*Logger)(nil)
+	_ otel.ErrorHandler = (*Logger)(nil)
+)
 
 func (l *Logger) Log(_ context.Context, level logging.Level, msg string, keysAndValues ...any) {
 	l.LoggerImpl.V(int(level)).Info(msg, keysAndValues...)
 }
+
+func (l *Logger) Handle(err error) {
+	l.LoggerImpl.Error(err, "Caught error.")
+}

options.go

@@ -23,7 +23,7 @@ import (
 	"os/user"
 
 	grpchandlers "github.com/doomshrine/gocosi/grpc/handlers"
-	grpclog "github.com/doomshrine/gocosi/grpc/log"
+	grpclog "github.com/doomshrine/gocosi/internal/log"
 	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
 	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/recovery"
 	"github.com/hellofresh/health-go/v5"