chore: add rich logging and middlewares

Author: Aldiwildan77

.env.example

@@ -16,6 +16,17 @@ APP_CORS_ALLOW_CREDENTIALS
 
 APP_FALLBACK_REDIRECT
 
+CONSOLE_LOG_ENABLED=true
+
+FILE_LOG_ENABLED=false
+FILE_LOG_DIRECTORY=logs
+FILE_LOG_NAME=server.log
+FILE_LOG_MAX_SIZE=1
+FILE_LOG_MAX_BACKUPS=100
+FILE_LOG_MAX_AGE=7
+FILE_LOG_LOCALTIME=false
+FILE_LOG_COMPRESSED=true
+
 DB_HOST
 DB_PORT
 DB_USERNAME

cmd/http.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"log"
 	"net/http"
 	"os"
 	"os/signal"
@@ -15,6 +14,7 @@ import (
 	"github.com/mocha-bot/mochus/core/module"
 	http_handler "github.com/mocha-bot/mochus/handler/http"
 	http_middleware "github.com/mocha-bot/mochus/handler/http/middleware"
+	infrastructure_logger "github.com/mocha-bot/mochus/infrastructure/logger"
 	discord_repository "github.com/mocha-bot/mochus/repository/discord"
 	zLog "github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
@@ -35,8 +35,16 @@ func serveHTTP(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	zLog.Logger = infrastructure_logger.NewLogger(
+		infrastructure_logger.WithConsole(cfg.Logger.ConsoleLogEnabled),
+		infrastructure_logger.WithFile(cfg.Logger.FileLogEnabled),
+		infrastructure_logger.WithLoggerConfig(&cfg.Logger),
+	)
+
 	e := echo.New()
-	e.Logger.SetLevel(log.LstdFlags)
+	e.HideBanner = true
+	e.HidePort = true
+	e.Logger.SetOutput(zLog.Logger)
 
 	CORS := http_middleware.CORS(
 		http_middleware.WithAllowOrigins(cfg.App.CORSAllowOrigins),
@@ -45,9 +53,12 @@ func serveHTTP(cmd *cobra.Command, args []string) error {
 	)
 
 	e.Use(
+		middleware.Recover(),
+		middleware.RequestID(),
+		middleware.Secure(),
+		middleware.RequestLoggerWithConfig(http_middleware.RequestLoggerWithZerolog()),
 		CORS,
 		http_middleware.FallbackRedirect(cfg.App.FallbackRedirect),
-		middleware.RequestID(),
 	)
 
 	discordRepository := discord_repository.NewDiscordRepository(cfg.Discord)
@@ -84,7 +95,7 @@ func serveHTTP(cmd *cobra.Command, args []string) error {
 			err = e.Start(cfg.App.GetAddress())
 		}
 
-		if err != nil {
+		if err != nil && err != http.ErrServerClosed {
 			zLog.Fatal().Err(err).Msg("error starting server")
 		}
 	}()
@@ -97,5 +108,7 @@ func serveHTTP(cmd *cobra.Command, args []string) error {
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()
 
+	zLog.Info().Msg("Shutting down server")
+
 	return e.Shutdown(ctx)
 }

config/config.go

@@ -6,6 +6,7 @@ type Config struct {
 	Database DatabaseConfig
 	Discord  DiscordConfig
 	Redis    RedisConfig
+	Logger   LoggerConfig
 	App      AppConfig
 }
 

config/logger.go

@@ -0,0 +1,55 @@
+package config
+
+import "path"
+
+type LoggerConfig struct {
+	// Log level for zerolog
+	LogLevel string `env:"LOG_LEVEL" envDefault:"info"`
+
+	// FileLogEnabled to log using stdout or stderr console
+	ConsoleLogEnabled bool `env:"CONSOLE_LOG_ENABLED" envDefault:"true"`
+
+	// FileLogEnabled to log using file
+	FileLogEnabled bool `env:"FILE_LOG_ENABLED" envDefault:"false"`
+
+	// Directory to log to to when filelogging is enabled
+	Directory string `env:"FILE_LOG_DIRECTORY" envDefault:"logs"`
+
+	// Filename is the name of the logfile which will be placed inside the directory
+	Filename string `env:"FILE_LOG_NAME" envDefault:"server.log"`
+
+	// MaxSize the max size in MB of the logfile before it's rolled
+	MaxSize int `env:"FILE_LOG_MAX_SIZE" envDefault:"100"`
+
+	// MaxBackups the max number of rolled files to keep
+	MaxBackups int `env:"FILE_LOG_MAX_BACKUPS" envDefault:"0"`
+
+	// MaxAge the max age in days to keep a logfile
+	MaxAge int `env:"FILE_LOG_MAX_AGE" envDefault:"7"`
+
+	// LocalTime choose the log time format locally or not
+	LocalTime bool `env:"FILE_LOG_LOCALTIME"`
+
+	// Compress the log file
+	Compress bool `env:"FILE_LOG_COMPRESSED"`
+}
+
+func (l LoggerConfig) ToLumberjackFileConfig() LumberjackFileConfig {
+	return LumberjackFileConfig{
+		Filename:   path.Join(l.Directory, l.Filename),
+		MaxBackups: l.MaxBackups,
+		MaxSize:    l.MaxSize,
+		MaxAge:     l.MaxAge,
+		LocalTime:  l.LocalTime,
+		Compress:   l.Compress,
+	}
+}
+
+type LumberjackFileConfig struct {
+	Filename   string
+	MaxBackups int
+	MaxSize    int
+	MaxAge     int
+	LocalTime  bool
+	Compress   bool
+}

go.mod

@@ -21,7 +21,9 @@ require (
 	github.com/go-playground/validator/v10 v10.25.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
+	gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
 )
 
 require (

go.sum

@@ -67,6 +67,7 @@ github.com/onsi/ginkgo/v2 v2.22.0 h1:Yed107/8DjTr0lKCNt7Dn8yQ6ybuDRQoMGrNFKzMfHg
 github.com/onsi/ginkgo/v2 v2.22.0/go.mod h1:7Du3c42kxCUegi0IImZ1wUQzMBVecgIHjR1C+NkhLQo=
 github.com/onsi/gomega v1.34.2 h1:pNCwDkzrsv7MS9kpaQvVb1aVLahQXyJ/Tv5oAZMI3i8=
 github.com/onsi/gomega v1.34.2/go.mod h1:v1xfxRgk0KIsG+QOdm7p8UosrOzPYRo60fd3B/1Dukc=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
@@ -127,6 +128,8 @@ golang.org/x/tools v0.28.0/go.mod h1:dcIOrVd3mfQKTgrDVQHqCPMWy6lnhfhtX3hLXYVLfRw
 google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg=
 google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

handler/http/middleware/logger.go

@@ -0,0 +1,40 @@
+package http_middleware
+
+import (
+	"github.com/labstack/echo/v4"
+	"github.com/labstack/echo/v4/middleware"
+	zLog "github.com/rs/zerolog/log"
+)
+
+func RequestLoggerWithZerolog() middleware.RequestLoggerConfig {
+	return middleware.RequestLoggerConfig{
+		LogURI:           true,
+		LogStatus:        true,
+		LogMethod:        true,
+		LogUserAgent:     true,
+		LogLatency:       true,
+		LogError:         true,
+		LogRemoteIP:      true,
+		LogProtocol:      true,
+		LogHost:          true,
+		LogRequestID:     true,
+		LogReferer:       true,
+		LogContentLength: true,
+		LogValuesFunc: func(c echo.Context, v middleware.RequestLoggerValues) error {
+			zLog.Info().
+				Str("method", v.Method).
+				Int("status", v.Status).
+				Str("host", v.Host).
+				Str("uri", v.URI).
+				Str("referer", v.Referer).
+				Str("user_agent", v.UserAgent).
+				Dur("latency", v.Latency).
+				Str("remote_ip", v.RemoteIP).
+				Str("protocol", v.Protocol).
+				Str("request_id", v.RequestID).
+				Str("content_length", v.ContentLength).
+				Msg("Request received")
+			return nil
+		},
+	}
+}

infrastructure/logger/log.go

@@ -0,0 +1,102 @@
+package infrastructure_logger
+
+import (
+	"io"
+	"os"
+	"sync"
+	"time"
+
+	"github.com/mocha-bot/mochus/config"
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/pkgerrors"
+	lumberjack "gopkg.in/natefinch/lumberjack.v2"
+)
+
+type LoggerOptions struct {
+	WithConsole  bool
+	WithFile     bool
+	LoggerConfig *config.LoggerConfig
+}
+
+type LoggerOption func(*LoggerOptions)
+
+func WithConsole(isEnabled bool) LoggerOption {
+	return func(o *LoggerOptions) {
+		o.WithConsole = isEnabled
+	}
+}
+
+func WithFile(isEnabled bool) LoggerOption {
+	return func(o *LoggerOptions) {
+		o.WithFile = isEnabled
+	}
+}
+
+func WithLoggerConfig(conf *config.LoggerConfig) LoggerOption {
+	return func(o *LoggerOptions) {
+		o.LoggerConfig = conf
+	}
+}
+
+func DefaultLoggerOptions() *LoggerOptions {
+	return &LoggerOptions{
+		WithConsole:  true,
+		WithFile:     false,
+		LoggerConfig: nil,
+	}
+}
+
+var once = new(sync.Once)
+
+func NewLogger(opts ...LoggerOption) zerolog.Logger {
+	options := DefaultLoggerOptions()
+	for _, opt := range opts {
+		opt(options)
+	}
+
+	var log zerolog.Logger
+
+	once.Do(func() {
+		logWriters := make([]io.Writer, 0)
+
+		if options.WithConsole {
+			logWriters = append(logWriters, NewConsoleLogger())
+		}
+
+		if options.WithFile && options.LoggerConfig != nil {
+			logWriters = append(logWriters, NewLumberjackFileLogger(options.LoggerConfig.ToLumberjackFileConfig()))
+		}
+
+		zerolog.TimestampFunc = time.Now
+		zerolog.ErrorStackMarshaler = pkgerrors.MarshalStack
+
+		mw := zerolog.MultiLevelWriter(logWriters...)
+
+		log = zerolog.
+			New(mw).
+			With().
+			Timestamp().
+			Logger()
+	})
+
+	return log
+}
+
+func NewConsoleLogger() io.Writer {
+	return zerolog.ConsoleWriter{
+		Out:        os.Stdout,
+		NoColor:    true,
+		TimeFormat: time.RFC3339,
+	}
+}
+
+func NewLumberjackFileLogger(conf config.LumberjackFileConfig) io.Writer {
+	return &lumberjack.Logger{
+		Filename:   conf.Filename,
+		MaxBackups: conf.MaxBackups, // files
+		MaxSize:    conf.MaxSize,    // megabytes
+		MaxAge:     conf.MaxAge,     // days
+		LocalTime:  conf.LocalTime,
+		Compress:   conf.Compress,
+	}
+}