feat: configuration for log rotation

Author: sergey3bv

cmd/peerswaplnd/config.go

@@ -44,6 +44,8 @@ type PeerSwapConfig struct {
 	DataDir    string   `long:"datadir" description:"peerswap datadir"`
 	LogLevel   LogLevel `long:"loglevel" description:"loglevel (1=Info, 2=Debug)"`
 
+	LogRotation LogRotationConfig `group:"Log rotation" namespace:"logrotation"`
+
 	LndConfig      *LndConfig     `group:"Lnd Grpc config" namespace:"lnd"`
 	ElementsConfig *OnchainConfig `group:"Elements Rpc Config" namespace:"elementsd"`
 	LWKConfig      *lwk.Conf
@@ -75,6 +77,9 @@ func (p *PeerSwapConfig) String() string {
 }
 
 func (p *PeerSwapConfig) Validate() error {
+	if err := p.LogRotation.Validate(); err != nil {
+		return err
+	}
 	if p.ElementsConfig.RpcHost != "" && p.ElementsConfig.LiquidSwaps != false {
 		err := p.ElementsConfig.Validate()
 		if err != nil {
@@ -139,6 +144,28 @@ type LndConfig struct {
 	MacaroonPath string `long:"macaroonpath" description:"path to the macaroon (admin.macaroon or custom baked one)"`
 }
 
+type LogRotationConfig struct {
+	// In megabytes
+	MaxSize    int `long:"maxsize" description:"maximum size in megabytes of the log file before rotation."`
+	MaxBackups int `long:"maxbackups" description:"maximum number of old log files to retain."`
+	// In days
+	MaxAge   int  `long:"maxage" description:"maximum number of days to retain old log files."`
+	Compress bool `long:"compress" description:"whether to compress log files using gzip"`
+}
+
+func (l LogRotationConfig) Validate() error {
+	if l.MaxSize <= 0 {
+		return fmt.Errorf("logrotation.maxsize must be > 0, got %d", l.MaxSize)
+	}
+	if l.MaxBackups < 0 {
+		return fmt.Errorf("logrotation.maxbackups must be >= 0, got %d", l.MaxBackups)
+	}
+	if l.MaxAge < 0 {
+		return fmt.Errorf("logrotation.maxage must be >= 0, got %d", l.MaxAge)
+	}
+	return nil
+}
+
 func DefaultConfig() *PeerSwapConfig {
 	return &PeerSwapConfig{
 		Host:       DefaultPeerswapHost,
@@ -154,6 +181,7 @@ func DefaultConfig() *PeerSwapConfig {
 		BitcoinEnabled: DefaultBitcoinEnabled,
 		ElementsConfig: defaultLiquidConfig(),
 		LogLevel:       DefaultLogLevel,
+		LogRotation:    defaultLogRotationConfig(),
 	}
 }
 
@@ -170,6 +198,15 @@ func defaultLiquidConfig() *OnchainConfig {
 	}
 }
 
+func defaultLogRotationConfig() LogRotationConfig {
+	return LogRotationConfig{
+		MaxSize:    10,
+		MaxBackups: 5,
+		MaxAge:     28,
+		Compress:   true,
+	}
+}
+
 func LWKFromIniFileConfig(filePath string) (*lwk.Conf, error) {
 	type LWK struct {
 		SignerName       string `long:"signername" description:"name of the signer"`

cmd/peerswaplnd/config_test.go

@@ -11,6 +11,77 @@ import (
 	"github.com/vulpemventures/go-elements/network"
 )
 
+func TestLogRotationConfigValidate(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name    string
+		cfg     peerswaplnd.LogRotationConfig
+		wantErr bool
+	}{
+		{
+			name: "valid values",
+			cfg: peerswaplnd.LogRotationConfig{
+				MaxSize:    10,
+				MaxBackups: 5,
+				MaxAge:     28,
+				Compress:   true,
+			},
+			wantErr: false,
+		},
+		{
+			name: "maxsize zero",
+			cfg: peerswaplnd.LogRotationConfig{
+				MaxSize:    0,
+				MaxBackups: 5,
+				MaxAge:     28,
+			},
+			wantErr: true,
+		},
+		{
+			name: "maxsize negative",
+			cfg: peerswaplnd.LogRotationConfig{
+				MaxSize:    -1,
+				MaxBackups: 5,
+				MaxAge:     28,
+			},
+			wantErr: true,
+		},
+		{
+			name: "maxbackups negative",
+			cfg: peerswaplnd.LogRotationConfig{
+				MaxSize:    10,
+				MaxBackups: -1,
+				MaxAge:     28,
+			},
+			wantErr: true,
+		},
+		{
+			name: "maxage negative",
+			cfg: peerswaplnd.LogRotationConfig{
+				MaxSize:    10,
+				MaxBackups: 5,
+				MaxAge:     -1,
+			},
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			err := tt.cfg.Validate()
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+			}
+		})
+	}
+}
+
 func TestLWKFromIniFileConfig(t *testing.T) {
 	t.Parallel()
 	t.Run("valid ini config", func(t *testing.T) {

cmd/peerswaplnd/peerswapd/main.go

@@ -608,10 +608,10 @@ func NewLndLogger(cfg *peerswaplnd.PeerSwapConfig) (*LndLogger, error) {
 
 	w := io.MultiWriter(os.Stdout, &lumberjack.Logger{
 		Filename:   logFile,
-		MaxSize:    10, // megabytes
-		MaxBackups: 5,
-		MaxAge:     28, // days
-		Compress:   true,
+		MaxSize:    cfg.LogRotation.MaxSize,
+		MaxBackups: cfg.LogRotation.MaxBackups,
+		MaxAge:     cfg.LogRotation.MaxAge,
+		Compress:   cfg.LogRotation.Compress,
 	})
 	core_log.SetOutput(w)