feat: robust logging (#289)

* feat: robust logging

On-behalf-of: @SAP [email protected]
Signed-off-by: Artem Shcherbatiuk <[email protected]>

Author: vertex451

.testcoverage.yml

@@ -6,6 +6,8 @@ exclude:
     - common/config/config.go
     - mocks
     - common/apis/*
+    - export_test.go
+    - export_test_integration.go
     # remove it later:
     - listener/reconciler/clusteraccess/subroutines.go
-    - listener/reconciler/singlecluster
+

cmd/gateway.go

@@ -8,55 +8,50 @@ import (
 	"time"
 
 	openmfpcontext "github.com/openmfp/golang-commons/context"
+	"github.com/openmfp/golang-commons/logger"
 	"github.com/openmfp/golang-commons/sentry"
 	"github.com/openmfp/golang-commons/traces"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/spf13/cobra"
 	ctrl "sigs.k8s.io/controller-runtime"
 
-	"github.com/openmfp/golang-commons/logger"
-
 	"github.com/openmfp/kubernetes-graphql-gateway/gateway/manager"
 )
 
 var gatewayCmd = &cobra.Command{
 	Use:     "gateway",
 	Short:   "Run the GQL Gateway",
 	Example: "go run main.go gateway",
-	RunE: func(_ *cobra.Command, _ []string) error {
-		log, err := setupLogger(defaultCfg.Log.Level)
-		if err != nil {
-			return fmt.Errorf("failed to setup logger: %w", err)
-		}
-
-		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting gateway server...")
+	Run: func(_ *cobra.Command, _ []string) {
+		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting the Gateway...")
 
 		ctx, _, shutdown := openmfpcontext.StartContext(log, appCfg, 1*time.Second)
 		defer shutdown()
 
 		if err := initializeSentry(ctx, log); err != nil {
-			return err
+			log.Fatal().Err(err).Msg("Failed to initialize Sentry")
 		}
 
 		ctrl.SetLogger(log.Logr())
 
 		gatewayInstance, err := manager.NewGateway(ctx, log, appCfg)
 		if err != nil {
-			log.Error().Err(err).Msg("Error creating gateway")
-			return fmt.Errorf("failed to create gateway: %w", err)
+			log.Fatal().Err(err).Msg("Failed to create gateway")
 		}
 
 		tracingShutdown, err := initializeTracing(ctx, log)
 		if err != nil {
-			return err
+			log.Fatal().Err(err).Msg("Failed to initialize tracing")
 		}
 		defer func() {
 			if err := tracingShutdown(ctx); err != nil {
 				log.Error().Err(err).Msg("failed to shutdown TracerProvider")
 			}
 		}()
 
-		return runServers(ctx, log, gatewayInstance)
+		if err := runServers(ctx, log, gatewayInstance); err != nil {
+			log.Fatal().Err(err).Msg("Failed to run servers")
+		}
 	},
 }
 
@@ -71,7 +66,6 @@ func initializeSentry(ctx context.Context, log *logger.Logger) error {
 	)
 	if err != nil {
 		log.Fatal().Err(err).Msg("Sentry init failed")
-		return err
 	}
 
 	defer openmfpcontext.Recover(log)
@@ -83,15 +77,13 @@ func initializeTracing(ctx context.Context, log *logger.Logger) (func(ctx contex
 		shutdown, err := traces.InitProvider(ctx, defaultCfg.Tracing.Collector)
 		if err != nil {
 			log.Fatal().Err(err).Msg("unable to start gRPC-Sidecar TracerProvider")
-			return nil, err
 		}
 		return shutdown, nil
 	}
 
 	shutdown, err := traces.InitLocalProvider(ctx, defaultCfg.Tracing.Collector, false)
 	if err != nil {
 		log.Fatal().Err(err).Msg("unable to start local TracerProvider")
-		return nil, err
 	}
 	return shutdown, nil
 }
@@ -189,11 +181,3 @@ func runServers(ctx context.Context, log *logger.Logger, gatewayInstance http.Ha
 	log.Info().Msg("Server shut down successfully")
 	return nil
 }
-
-// setupLogger initializes the logger with the given log level
-func setupLogger(logLevel string) (*logger.Logger, error) {
-	loggerCfg := logger.DefaultConfig()
-	loggerCfg.Name = "crdGateway"
-	loggerCfg.Level = logLevel
-	return logger.New(loggerCfg)
-}

cmd/listener.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"context"
 	"crypto/tls"
-	"os"
 
 	kcpapis "github.com/kcp-dev/kcp/sdk/apis/apis/v1alpha1"
 	kcpcore "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
@@ -21,6 +20,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
 	gatewayv1alpha1 "github.com/openmfp/kubernetes-graphql-gateway/common/apis/v1alpha1"
+	"github.com/openmfp/kubernetes-graphql-gateway/listener/pkg/apischema"
+	"github.com/openmfp/kubernetes-graphql-gateway/listener/pkg/workspacefile"
 	"github.com/openmfp/kubernetes-graphql-gateway/listener/reconciler"
 	"github.com/openmfp/kubernetes-graphql-gateway/listener/reconciler/clusteraccess"
 	"github.com/openmfp/kubernetes-graphql-gateway/listener/reconciler/kcp"
@@ -74,6 +75,8 @@ var listenCmd = &cobra.Command{
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
+		log.Info().Str("LogLevel", log.GetLevel().String()).Msg("Starting the Listener...")
+
 		ctx := ctrl.SetupSignalHandler()
 		restCfg := ctrl.GetConfigOrDie()
 
@@ -90,8 +93,7 @@ var listenCmd = &cobra.Command{
 			Scheme: scheme,
 		})
 		if err != nil {
-			log.Error().Err(err).Msg("failed to create client from config")
-			os.Exit(1)
+			log.Fatal().Err(err).Msg("failed to create client from config")
 		}
 
 		reconcilerOpts := reconciler.ReconcilerOpts{
@@ -107,32 +109,34 @@ var listenCmd = &cobra.Command{
 		if appCfg.EnableKcp {
 			kcpReconciler, err := kcp.NewKCPReconciler(appCfg, reconcilerOpts, log)
 			if err != nil {
-				log.Error().Err(err).Msg("unable to create KCP reconciler")
-				os.Exit(1)
+				log.Fatal().Err(err).Msg("unable to create KCP reconciler")
 			}
 
 			// Start virtual workspace watching if path is configured
 			if appCfg.Listener.VirtualWorkspacesConfigPath != "" {
 				go func() {
 					if err := kcpReconciler.StartVirtualWorkspaceWatching(ctx, appCfg.Listener.VirtualWorkspacesConfigPath); err != nil {
-						log.Error().Err(err).Msg("failed to start virtual workspace watching")
-						os.Exit(1)
+						log.Fatal().Err(err).Msg("failed to start virtual workspace watching")
 					}
 				}()
 			}
 
 			reconcilerInstance = kcpReconciler
 		} else {
-			reconcilerInstance, err = clusteraccess.CreateMultiClusterReconciler(appCfg, reconcilerOpts, log)
+			ioHandler, err := workspacefile.NewIOHandler(appCfg.OpenApiDefinitionsPath)
+			if err != nil {
+				log.Fatal().Err(err).Msg("unable to create IO handler")
+			}
+
+			reconcilerInstance, err = clusteraccess.NewClusterAccessReconciler(ctx, appCfg, reconcilerOpts, ioHandler, apischema.NewResolver(log), log)
 			if err != nil {
-				log.Error().Err(err).Msg("unable to create cluster access reconciler")
-				os.Exit(1)
+				log.Fatal().Err(err).Msg("unable to create cluster access reconciler")
 			}
 		}
 
 		// Setup reconciler with its own manager and start everything
 		if err := startManagerWithReconciler(ctx, reconcilerInstance); err != nil {
-			os.Exit(1)
+			log.Fatal().Err(err).Msg("failed to start manager with reconciler")
 		}
 	},
 }

cmd/root.go

@@ -81,6 +81,14 @@ func initConfig() {
 	v.SetDefault("gateway-url-graphql-suffix", "graphql")
 }
 
+// setupLogger initializes the logger with the given log level
+func setupLogger(logLevel string) (*logger.Logger, error) {
+	loggerCfg := logger.DefaultConfig()
+	loggerCfg.Name = "crdGateway"
+	loggerCfg.Level = logLevel
+	return logger.New(loggerCfg)
+}
+
 func Execute() {
 	cobra.CheckErr(rootCmd.Execute())
 }