UPSTREAM: <drop>: server: add support for log rotation (etcd-io#12774)

This reverts commit 490e5c6.

bill-of-materials.json

@@ -431,15 +431,6 @@
 			}
 		]
 	},
-	{
-		"project": "gopkg.in/natefinch/lumberjack.v2",
-		"licenses": [
-			{
-				"type": "MIT License",
-				"confidence": 1
-			}
-		]
-	},
 	{
 		"project": "gopkg.in/yaml.v2",
 		"licenses": [

embed/config.go

@@ -67,15 +67,6 @@ const (
 	StdErrLogOutput  = "stderr"
 	StdOutLogOutput  = "stdout"
 
-	// DefaultLogRotationConfig is the default configuration used for log rotation.
-	// Log rotation is disabled by default.
-	// MaxSize    = 100 // MB
-	// MaxAge     = 0 // days (no limit)
-	// MaxBackups = 0 // no limit
-	// LocalTime  = false // use computers local time, UTC by default
-	// Compress   = false // compress the rotated log in gzip format
-	DefaultLogRotationConfig = `{"maxsize": 100, "maxage": 0, "maxbackups": 0, "localtime": false, "compress": false}`
-
 	// DefaultStrictReconfigCheck is the default value for "--strict-reconfig-check" flag.
 	// It's enabled by default.
 	DefaultStrictReconfigCheck = true
@@ -94,7 +85,6 @@ var (
 	ErrConflictBootstrapFlags = fmt.Errorf("multiple discovery or bootstrap flags are set. " +
 		"Choose one of \"initial-cluster\", \"discovery\" or \"discovery-srv\"")
 	ErrUnsetAdvertiseClientURLsFlag = fmt.Errorf("--advertise-client-urls is required when --listen-client-urls is set explicitly")
-	ErrLogRotationInvalidLogOutput  = fmt.Errorf("--log-outputs requires a single file path when --log-rotate-config-json is defined")
 
 	DefaultInitialAdvertisePeerURLs = "http://localhost:2380"
 	DefaultAdvertiseClientURLs      = "http://localhost:2379"
@@ -320,10 +310,7 @@ type Config struct {
 	//  - file path to append server logs to.
 	// It can be multiple when "Logger" is zap.
 	LogOutputs []string `json:"log-outputs"`
-	// EnableLogRotation enables log rotation of a single LogOutputs file target.
-	EnableLogRotation bool `json:"enable-log-rotation"`
-	// LogRotationConfigJSON is a passthrough allowing a log rotation JSON config to be passed directly.
-	LogRotationConfigJSON string `json:"log-rotation-config-json"`
+
 	// ZapLoggerBuilder is used to build the zap logger.
 	ZapLoggerBuilder func(*Config) error
 
@@ -438,16 +425,14 @@ func NewConfig() *Config {
 
 		PreVote: false, // TODO: enable by default in v3.5
 
-		loggerMu:              new(sync.RWMutex),
-		logger:                nil,
-		Logger:                "capnslog",
-		DeprecatedLogOutput:   []string{DefaultLogOutput},
-		LogOutputs:            []string{DefaultLogOutput},
-		Debug:                 false,
-		LogLevel:              logutil.DefaultLogLevel,
-		LogPkgLevels:          "",
-		EnableLogRotation:     false,
-		LogRotationConfigJSON: DefaultLogRotationConfig,
+		loggerMu:            new(sync.RWMutex),
+		logger:              nil,
+		Logger:              "capnslog",
+		DeprecatedLogOutput: []string{DefaultLogOutput},
+		LogOutputs:          []string{DefaultLogOutput},
+		Debug:               false,
+		LogLevel:            logutil.DefaultLogLevel,
+		LogPkgLevels:        "",
 	}
 	cfg.InitialCluster = cfg.InitialClusterFromName(cfg.Name)
 	return cfg

embed/config_logging.go

@@ -16,11 +16,9 @@ package embed
 
 import (
 	"crypto/tls"
-	"encoding/json"
 	"errors"
 	"fmt"
 	"io/ioutil"
-	"net/url"
 	"os"
 	"reflect"
 	"sync"
@@ -32,7 +30,6 @@ import (
 	"go.uber.org/zap/zapcore"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/grpclog"
-	"gopkg.in/natefinch/lumberjack.v2"
 )
 
 // GetLogger returns the logger.
@@ -146,11 +143,6 @@ func (cfg *Config) setupLogging() error {
 				}
 			}
 		}
-		if cfg.EnableLogRotation {
-			if err := setupLogRotation(cfg.LogOutputs, cfg.LogRotationConfigJSON); err != nil {
-				return err
-			}
-		}
 
 		outputPaths, errOutputPaths := make([]string, 0), make([]string, 0)
 		isJournal := false
@@ -172,15 +164,8 @@ func (cfg *Config) setupLogging() error {
 				errOutputPaths = append(errOutputPaths, StdOutLogOutput)
 
 			default:
-				var path string
-				if cfg.EnableLogRotation {
-					// append rotate scheme to logs managed by lumberjack log rotation
-					path = fmt.Sprintf("rotate:%s", v)
-				} else {
-					path = v
-				}
-				outputPaths = append(outputPaths, path)
-				errOutputPaths = append(errOutputPaths, path)
+				outputPaths = append(outputPaths, v)
+				errOutputPaths = append(errOutputPaths, v)
 			}
 		}
 
@@ -325,46 +310,3 @@ func NewZapCoreLoggerBuilder(lg *zap.Logger, cr zapcore.Core, syncer zapcore.Wri
 		return nil
 	}
 }
-
-type logRotationConfig struct {
-	*lumberjack.Logger
-}
-
-// Sync implements zap.Sink
-func (logRotationConfig) Sync() error { return nil }
-
-// setupLogRotation initializes log rotation for a single file path target.
-func setupLogRotation(logOutputs []string, logRotateConfigJSON string) error {
-	var logRotationConfig logRotationConfig
-	outputFilePaths := 0
-	for _, v := range logOutputs {
-		switch v {
-		case DefaultLogOutput, StdErrLogOutput, StdOutLogOutput:
-			continue
-		default:
-			outputFilePaths++
-		}
-	}
-	// log rotation requires file target
-	if len(logOutputs) == 1 && outputFilePaths == 0 {
-		return ErrLogRotationInvalidLogOutput
-	}
-	// support max 1 file target for log rotation
-	if outputFilePaths > 1 {
-		return ErrLogRotationInvalidLogOutput
-	}
-
-	if err := json.Unmarshal([]byte(logRotateConfigJSON), &logRotationConfig); err != nil {
-		switch err.(type) {
-		case *json.SyntaxError:
-			return fmt.Errorf("improperly formatted log rotation config: %w", err)
-		case *json.UnmarshalTypeError:
-			return fmt.Errorf("invalid log rotation config: %w", err)
-		}
-	}
-	zap.RegisterSink("rotate", func(u *url.URL) (zap.Sink, error) {
-		logRotationConfig.Filename = u.Path
-		return &logRotationConfig, nil
-	})
-	return nil
-}

embed/config_test.go

@@ -15,7 +15,6 @@
 package embed
 
 import (
-	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/url"
@@ -203,77 +202,3 @@ func TestAutoCompactionModeParse(t *testing.T) {
 		}
 	}
 }
-
-func TestLogRotation(t *testing.T) {
-	tests := []struct {
-		name              string
-		logOutputs        []string
-		logRotationConfig string
-		wantErr           bool
-		wantErrMsg        error
-	}{
-		{
-			name:              "mixed log output targets",
-			logOutputs:        []string{"stderr", "/tmp/path"},
-			logRotationConfig: `{"maxsize": 1}`,
-		},
-		{
-			name:              "no file targets",
-			logOutputs:        []string{"stderr"},
-			logRotationConfig: `{"maxsize": 1}`,
-			wantErr:           true,
-			wantErrMsg:        ErrLogRotationInvalidLogOutput,
-		},
-		{
-			name:              "multiple file targets",
-			logOutputs:        []string{"/tmp/path1", "/tmp/path2"},
-			logRotationConfig: DefaultLogRotationConfig,
-			wantErr:           true,
-			wantErrMsg:        ErrLogRotationInvalidLogOutput,
-		},
-		{
-			name:              "default output",
-			logRotationConfig: `{"maxsize": 1}`,
-			wantErr:           true,
-			wantErrMsg:        ErrLogRotationInvalidLogOutput,
-		},
-		{
-			name:              "default log rotation config",
-			logOutputs:        []string{"/tmp/path"},
-			logRotationConfig: DefaultLogRotationConfig,
-		},
-		{
-			name:              "invalid logger config",
-			logOutputs:        []string{"/tmp/path"},
-			logRotationConfig: `{"maxsize": true}`,
-			wantErr:           true,
-			wantErrMsg:        errors.New("invalid log rotation config: json: cannot unmarshal bool into Go struct field logRotationConfig.maxsize of type int"),
-		},
-		{
-			name:              "improperly formatted logger config",
-			logOutputs:        []string{"/tmp/path"},
-			logRotationConfig: `{"maxsize": true`,
-			wantErr:           true,
-			wantErrMsg:        errors.New("improperly formatted log rotation config: unexpected end of JSON input"),
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			cfg := NewConfig()
-			cfg.Logger = "zap"
-			cfg.LogOutputs = tt.logOutputs
-			cfg.EnableLogRotation = true
-			cfg.LogRotationConfigJSON = tt.logRotationConfig
-			err := cfg.Validate()
-			if err != nil && !tt.wantErr {
-				t.Errorf("test %q, unexpected error %v", tt.name, err)
-			}
-			if err != nil && tt.wantErr && tt.wantErrMsg.Error() != err.Error() {
-				t.Errorf("test %q, expected error: %+v, got: %+v", tt.name, tt.wantErrMsg, err)
-			}
-			if err == nil && tt.wantErr {
-				t.Errorf("test %q, expected error, got nil", tt.name)
-			}
-		})
-	}
-}

etcdmain/help.go

@@ -180,10 +180,6 @@ Logging:
     Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
   --log-level 'info'
     Configures log level. Only supports debug, info, warn, error, panic, or fatal.
-  --enable-log-rotation 'false'
-    Enable log rotation of a single log-outputs file target.
-  --log-rotation-config-json '{"maxsize": 100, "maxage": 0, "maxbackups": 0, "localtime": false, "compress": false}'
-    Configures log rotation if enabled with a JSON logger config. MaxSize(MB), MaxAge(days,0=no limit), MaxBackups(0=no limit), LocalTime(use computers local time), Compress(gzip)".
 
 v2 Proxy (to be deprecated in v4):
   --proxy 'off'

go.mod

@@ -44,6 +44,7 @@ require (
 	golang.org/x/net v0.0.0-20201021035429-f5854403a974
 	golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4
 	golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2
+	golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135 // indirect
 	google.golang.org/grpc v1.26.0
 	gopkg.in/cheggaaa/pb.v1 v1.0.25
 	gopkg.in/natefinch/lumberjack.v2 v2.0.0

go.sum

@@ -1,5 +1,4 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
@@ -220,9 +219,6 @@ gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/cheggaaa/pb.v1 v1.0.25 h1:Ev7yu1/f6+d+b3pi5vPdRPc6nNtP1umSfcWiEfRqv6I=
 gopkg.in/cheggaaa/pb.v1 v1.0.25/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw=
-gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
-gopkg.in/natefinch/lumberjack.v2 v2.0.0 h1:1Lc07Kr7qY4U2YPouBjpCLxpiyxIVoxqXgkXLknAOE8=
-gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
 gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
 gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=