Merge branch 'task-open-telemetry' into 'main'

Add open telemetry

See merge request networkteam/go-apibackend-boilerplate!6

backend/.env.development

@@ -0,0 +1,2 @@
+# Enable OpenTelemetry for development by setting this to 1
+OPEN_TELEMETRY_ENABLED=0

backend/.golangci.yml

@@ -6,7 +6,8 @@ run:
   tests: true
 
 output:
-  format: line-number
+  formats:
+    - format: line-number
 
 linters:
   # Disable all linters, so we enable linters explicitly

backend/api/graph/resolver.go

@@ -2,9 +2,27 @@ package graph
 
 import (
 	"myvendor.mytld/myproject/backend/api"
+	"myvendor.mytld/myproject/backend/finder"
+	"myvendor.mytld/myproject/backend/handler"
 )
 
 type Resolver struct {
 	api.ResolverDependencies
 	api.ResolverConfig
+
+	handler *handler.Handler
+	finder  *finder.Finder
+}
+
+func NewResolver(deps api.ResolverDependencies, config api.ResolverConfig) *Resolver {
+	return &Resolver{
+		ResolverDependencies: deps,
+		ResolverConfig:       config,
+		handler: handler.NewHandler(deps.DB, deps.Config, handler.Deps{
+			TimeSource:    deps.TimeSource,
+			Mailer:        deps.Mailer,
+			MeterProvider: deps.MeterProvider,
+		}),
+		finder: finder.NewFinder(deps.DB, deps.TimeSource),
+	}
 }

backend/api/graph/tests/authentication/mutation_login_test.go

@@ -11,6 +11,7 @@ import (
 	"myvendor.mytld/myproject/backend/test"
 	test_db "myvendor.mytld/myproject/backend/test/db"
 	test_graphql "myvendor.mytld/myproject/backend/test/graphql"
+	test_telemetry "myvendor.mytld/myproject/backend/test/telemetry"
 )
 
 const loginGQL = `
@@ -71,8 +72,10 @@ func TestMutationResolver_Login_WithSystemAdministrator_Valid(t *testing.T) {
 
 	var result loginResult
 
+	metricsReader, meterProvider := test_telemetry.SetupTestMeter(t)
+
 	req := test_graphql.NewRequest(t, query)
-	resp := test_graphql.Handle(t, api.ResolverDependencies{DB: db, TimeSource: timeSource}, req, &result)
+	resp := test_graphql.Handle(t, api.ResolverDependencies{DB: db, TimeSource: timeSource, MeterProvider: meterProvider}, req, &result)
 	test_graphql.RequireNoErrors(t, result.GraphqlErrors)
 
 	require.Nil(t, result.Data.Result.Error)
@@ -85,6 +88,8 @@ func TestMutationResolver_Login_WithSystemAdministrator_Valid(t *testing.T) {
 	setCookieHeader := resp.Header().Get("Set-Cookie")
 	assert.NotEmpty(t, setCookieHeader, "Set-Cookie header is set")
 
+	test_telemetry.AssertMeterCounter(t, metricsReader, "myvendor.mytld/myproject/backend/handler", "login.success.counter", 1)
+
 	// Test we can use a restricted field after authentication
 
 	var loginStatusResult struct {
@@ -123,12 +128,16 @@ func TestMutationResolver_Login_WithSystemAdministrator_InvalidPassword(t *testi
 
 	var result loginResult
 
+	metricsReader, meterProvider := test_telemetry.SetupTestMeter(t)
+
 	req := test_graphql.NewRequest(t, query)
-	test_graphql.Handle(t, api.ResolverDependencies{DB: db, TimeSource: timeSource}, req, &result)
+	test_graphql.Handle(t, api.ResolverDependencies{DB: db, TimeSource: timeSource, MeterProvider: meterProvider}, req, &result)
 	test_graphql.RequireNoErrors(t, result.GraphqlErrors)
 
 	require.NotNil(t, result.Data.Result.Error, "result.error")
 	assert.Equal(t, "invalidCredentials", result.Data.Result.Error.Code, "result.error.code")
+
+	test_telemetry.AssertMeterCounter(t, metricsReader, "myvendor.mytld/myproject/backend/handler", "login.failed.counter", 1)
 }
 
 func TestMutationResolver_Login_WithOrganisationAdministrator_Valid(t *testing.T) {

backend/api/handler/graphql_handler.go

@@ -2,6 +2,7 @@ package handler
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 	"time"
 
@@ -12,6 +13,8 @@ import (
 	"github.com/99designs/gqlgen/graphql/handler/lru"
 	"github.com/99designs/gqlgen/graphql/handler/transport"
 	"github.com/gorilla/websocket"
+	"github.com/ravilushqa/otelgqlgen"
+	"go.opentelemetry.io/otel/attribute"
 
 	"myvendor.mytld/myproject/backend/api"
 	"myvendor.mytld/myproject/backend/api/graph"
@@ -23,23 +26,25 @@ import (
 type Config struct {
 	EnableTracing        bool
 	EnableLogging        bool
+	EnableOpenTelemetry  bool
 	DisableRecover       bool
 	WebsocketAllowOrigin string
 	// Constant time duration for sensitive operations (e.g. login / request password reset / perform password reset / registration)
 	SensitiveOperationConstantTime time.Duration
 }
 
+const (
+	requestVariablesPrefix = "gql.request.variables"
+)
+
 func NewGraphqlHandler(deps api.ResolverDependencies, handlerConfig Config) http.Handler {
 	config := generated.Config{
-		Resolvers: &graph.Resolver{
-			ResolverDependencies: deps,
-			ResolverConfig: api.ResolverConfig{
-				SensitiveOperationConstantTime: handlerConfig.SensitiveOperationConstantTime,
-			},
-		},
+		Resolvers: graph.NewResolver(deps, api.ResolverConfig{
+			SensitiveOperationConstantTime: handlerConfig.SensitiveOperationConstantTime,
+		}),
 		Directives: generated.DirectiveRoot{
 			// No op implementation, will be checked in middleware
-			BypassAuthentication: func(ctx context.Context, obj any, next graphql.Resolver) (res any, err error) {
+			BypassAuthentication: func(ctx context.Context, _ any, next graphql.Resolver) (res any, err error) {
 				return next(ctx)
 			},
 		},
@@ -48,6 +53,26 @@ func NewGraphqlHandler(deps api.ResolverDependencies, handlerConfig Config) http
 	srv := newDefaultServer(exec, handlerConfig)
 	srv.SetErrorPresenter(ErrorPresenter)
 
+	if handlerConfig.EnableOpenTelemetry {
+		srv.Use(otelgqlgen.Middleware(
+			otelgqlgen.WithRequestVariablesAttributesBuilder(
+				func(requestVariables map[string]any) []attribute.KeyValue {
+					variables := make([]attribute.KeyValue, 0, len(requestVariables))
+					for k, v := range requestVariables {
+						switch k {
+						case "password":
+							v = "********"
+						}
+						variables = append(variables,
+							attribute.String(fmt.Sprintf("%s.%s", requestVariablesPrefix, k), fmt.Sprintf("%+v", v)),
+						)
+					}
+					return variables
+				},
+			),
+		))
+	}
+
 	if handlerConfig.EnableLogging {
 		srv.AroundFields(graphql_middleware.LoggerFieldMiddleware)
 	}

backend/api/resolver_dependencies.go

@@ -3,27 +3,17 @@ package api
 import (
 	"database/sql"
 
+	"go.opentelemetry.io/otel/metric"
+
 	"myvendor.mytld/myproject/backend/domain"
-	"myvendor.mytld/myproject/backend/finder"
-	"myvendor.mytld/myproject/backend/handler"
 	"myvendor.mytld/myproject/backend/mail"
 )
 
 // ResolverDependencies provides common dependencies for api resolvers
 type ResolverDependencies struct {
-	DB         *sql.DB
-	TimeSource domain.TimeSource
-	Mailer     *mail.Mailer
-	Config     domain.Config
-}
-
-func (r ResolverDependencies) Handler() *handler.Handler {
-	return handler.NewHandler(r.DB, r.Config, handler.Deps{
-		TimeSource: r.TimeSource,
-		Mailer:     r.Mailer,
-	})
-}
-
-func (r ResolverDependencies) Finder() *finder.Finder {
-	return finder.NewFinder(r.DB, r.TimeSource)
+	Config        domain.Config
+	DB            *sql.DB
+	TimeSource    domain.TimeSource
+	MeterProvider metric.MeterProvider
+	Mailer        *mail.Mailer
 }