add support for iso8601 timestamps

doc/user/logging.md

@@ -40,6 +40,7 @@ By default, `zap.Logger()` will return a logger that is ready for production use
 * `--zap-encoder` string - Sets the zap log encoding (`json` or `console`)
 * `--zap-level` string or integer - Sets the zap log level (`debug`, `info`, `error`, or an integer value greater than 0). If 4 or greater the verbosity of client-go will be set to this level.
 * `--zap-sample` - Enables zap's sampling mode. Sampling will be disabled for integer log levels greater than 1.
+* `--zap-timeformat` string - Sets the zap time format ('epoch', 'millis', 'nano', or 'iso8601')
 
 
 ## Creating a structured log statement

pkg/log/zap/flags.go

@@ -29,10 +29,11 @@ import (
 var (
 	zapFlagSet *pflag.FlagSet
 
-	development bool
-	encoderVal  encoderValue
-	levelVal    levelValue
-	sampleVal   sampleValue
+	development   bool
+	encoderVal    encoderValue
+	levelVal      levelValue
+	sampleVal     sampleValue
+	timeformatVal timeformatValue
 )
 
 func init() {
@@ -41,26 +42,29 @@ func init() {
 	zapFlagSet.Var(&encoderVal, "zap-encoder", "Zap log encoding ('json' or 'console')")
 	zapFlagSet.Var(&levelVal, "zap-level", "Zap log level (one of 'debug', 'info', 'error' or any integer value > 0)")
 	zapFlagSet.Var(&sampleVal, "zap-sample", "Enable zap log sampling. Sampling will be disabled for integer log levels > 1")
+	zapFlagSet.Var(&timeformatVal, "zap-timeformat", "Sets the zap time format ('epoch', 'millis', 'nano', or 'iso8601')")
 }
 
 // FlagSet - The zap logging flagset.
 func FlagSet() *pflag.FlagSet {
 	return zapFlagSet
 }
 
+type encoderConfigFunc func(*zapcore.EncoderConfig)
+
 type encoderValue struct {
-	set     bool
-	encoder zapcore.Encoder
-	str     string
+	set        bool
+	newEncoder func(...encoderConfigFunc) zapcore.Encoder
+	str        string
 }
 
 func (v *encoderValue) Set(e string) error {
 	v.set = true
 	switch e {
 	case "json":
-		v.encoder = jsonEncoder()
+		v.newEncoder = newJSONEncoder
 	case "console":
-		v.encoder = consoleEncoder()
+		v.newEncoder = newConsoleEncoder
 	default:
 		return fmt.Errorf("unknown encoder \"%s\"", e)
 	}
@@ -76,13 +80,19 @@ func (v encoderValue) Type() string {
 	return "encoder"
 }
 
-func jsonEncoder() zapcore.Encoder {
+func newJSONEncoder(ecfs ...encoderConfigFunc) zapcore.Encoder {
 	encoderConfig := zap.NewProductionEncoderConfig()
+	for _, f := range ecfs {
+		f(&encoderConfig)
+	}
 	return zapcore.NewJSONEncoder(encoderConfig)
 }
 
-func consoleEncoder() zapcore.Encoder {
-	encoderConfig := zap.NewDevelopmentEncoderConfig()
+func newConsoleEncoder(ecfs ...encoderConfigFunc) zapcore.Encoder {
+	encoderConfig := zap.NewProductionEncoderConfig()
+	for _, f := range ecfs {
+		f(&encoderConfig)
+	}
 	return zapcore.NewConsoleEncoder(encoderConfig)
 }
 
@@ -158,3 +168,44 @@ func (v sampleValue) IsBoolFlag() bool {
 func (v sampleValue) Type() string {
 	return "sample"
 }
+
+type timeformatValue struct {
+	set         bool
+	timeEncoder zapcore.TimeEncoder
+	str         string
+}
+
+func (v *timeformatValue) Set(s string) error {
+	v.set = true
+
+	switch string(s) {
+	case "iso8601", "ISO8601":
+		v.timeEncoder = zapcore.ISO8601TimeEncoder
+	case "millis":
+		v.timeEncoder = zapcore.EpochMillisTimeEncoder
+	case "nanos":
+		v.timeEncoder = zapcore.EpochNanosTimeEncoder
+	default:
+		v.timeEncoder = zapcore.EpochTimeEncoder
+	}
+
+	return nil
+}
+
+func (v timeformatValue) String() string {
+	return v.str
+}
+
+func (v timeformatValue) IsBoolFlag() bool {
+	return false
+}
+
+func (v timeformatValue) Type() string {
+	return "string"
+}
+
+func withTimeFormat(te zapcore.TimeEncoder) encoderConfigFunc {
+	return func(ec *zapcore.EncoderConfig) {
+		ec.EncodeTime = te
+	}
+}

pkg/log/zap/flags_test.go

@@ -167,14 +167,14 @@ func TestEncoder(t *testing.T) {
 			input:      "json",
 			expStr:     "json",
 			expSet:     true,
-			expEncoder: jsonEncoder(),
+			expEncoder: newJSONEncoder(),
 		},
 		{
 			name:       "console encoder",
 			input:      "console",
 			expStr:     "console",
 			expSet:     true,
-			expEncoder: consoleEncoder(),
+			expEncoder: newConsoleEncoder(),
 		},
 		{
 			name:       "unknown encoder",
@@ -196,7 +196,7 @@ func TestEncoder(t *testing.T) {
 			assert.Equal(t, tc.expSet, encoder.set)
 			assert.Equal(t, "encoder", encoder.Type())
 			assert.Equal(t, tc.expStr, encoder.String())
-			assert.ObjectsAreEqual(tc.expEncoder, encoder.encoder)
+			assert.ObjectsAreEqual(tc.expEncoder, encoder.newEncoder)
 		})
 	}
 }

pkg/log/zap/logger.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/go-logr/logr"
 	"github.com/go-logr/zapr"
+
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
@@ -56,23 +57,32 @@ type config struct {
 func getConfig() config {
 	var c config
 
+	var newEncoder func(...encoderConfigFunc) zapcore.Encoder
+
 	// Set the defaults depending on the log mode (development vs. production)
 	if development {
-		c.encoder = consoleEncoder()
+		newEncoder = newConsoleEncoder
 		c.level = zap.NewAtomicLevelAt(zap.DebugLevel)
 		c.opts = append(c.opts, zap.Development(), zap.AddStacktrace(zap.ErrorLevel))
 		c.sample = false
 	} else {
-		c.encoder = jsonEncoder()
+		newEncoder = newJSONEncoder
 		c.level = zap.NewAtomicLevelAt(zap.InfoLevel)
 		c.opts = append(c.opts, zap.AddStacktrace(zap.WarnLevel))
 		c.sample = true
 	}
 
 	// Override the defaults if the flags were set explicitly on the command line
-	if encoderVal.set {
-		c.encoder = encoderVal.encoder
+	var ecfs []encoderConfigFunc
+	if encoderVal.String() == "console" {
+		newEncoder = newConsoleEncoder
+	}
+	if timeformatVal.set {
+		ecfs = append(ecfs, withTimeFormat(timeformatVal.timeEncoder))
 	}
+
+	c.encoder = newEncoder(ecfs...)
+
 	if levelVal.set {
 		c.level = zap.NewAtomicLevelAt(levelVal.level)
 	}

pkg/log/zap/logger_test.go

@@ -52,7 +52,7 @@ func TestGetConfig(t *testing.T) {
 				set: false,
 			},
 			expected: config{
-				encoder: consoleEncoder(),
+				encoder: newConsoleEncoder(),
 				level:   zap.NewAtomicLevelAt(zap.DebugLevel),
 				opts:    append(opts, zap.Development(), zap.AddStacktrace(zap.ErrorLevel)),
 				sample:  false,
@@ -71,7 +71,7 @@ func TestGetConfig(t *testing.T) {
 				set: false,
 			},
 			expected: config{
-				encoder: jsonEncoder(),
+				encoder: newJSONEncoder(),
 				level:   zap.NewAtomicLevelAt(zap.InfoLevel),
 				opts:    append(opts, zap.AddStacktrace(zap.WarnLevel)),
 				sample:  true,
@@ -81,8 +81,8 @@ func TestGetConfig(t *testing.T) {
 			name:    "set encoder",
 			inDevel: false,
 			inEncoder: encoderValue{
-				set:     true,
-				encoder: consoleEncoder(),
+				set:        true,
+				newEncoder: newConsoleEncoder,
 			},
 			inLevel: levelValue{
 				set: false,
@@ -91,7 +91,7 @@ func TestGetConfig(t *testing.T) {
 				set: false,
 			},
 			expected: config{
-				encoder: jsonEncoder(),
+				encoder: newJSONEncoder(),
 				level:   zap.NewAtomicLevelAt(zap.InfoLevel),
 				opts:    append(opts, zap.AddStacktrace(zap.WarnLevel)),
 				sample:  true,
@@ -111,7 +111,7 @@ func TestGetConfig(t *testing.T) {
 				set: false,
 			},
 			expected: config{
-				encoder: jsonEncoder(),
+				encoder: newJSONEncoder(),
 				level:   zap.NewAtomicLevelAt(zap.ErrorLevel),
 				opts:    append(opts, zap.AddStacktrace(zap.WarnLevel)),
 				sample:  true,
@@ -131,7 +131,7 @@ func TestGetConfig(t *testing.T) {
 				set: false,
 			},
 			expected: config{
-				encoder: jsonEncoder(),
+				encoder: newJSONEncoder(),
 				level:   zap.NewAtomicLevelAt(zapcore.Level(-10)),
 				opts:    append(opts, zap.AddStacktrace(zap.WarnLevel)),
 				sample:  false,
@@ -152,7 +152,7 @@ func TestGetConfig(t *testing.T) {
 				sample: true,
 			},
 			expected: config{
-				encoder: jsonEncoder(),
+				encoder: newJSONEncoder(),
 				level:   zap.NewAtomicLevelAt(zapcore.Level(-10)),
 				opts:    append(opts, zap.AddStacktrace(zap.WarnLevel)),
 				sample:  false,