Added TimeEncoder flag and helper funcs

Author: bharathi-tenneti

hack/tools/go.sum

@@ -307,6 +307,7 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
 golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20191002192127-34f69633bfdc/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 h1:ObdrDkeb4kJdCP557AjRjq69pTHfNouLtWZG7j9rPN8=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20191002040644-a1355ae1e2c3 h1:n9HxLrNxWWtEb1cA950nuEEj3QnKbtsCJ6KjcgisNUs=

pkg/log/zap/flags.go

@@ -41,6 +41,10 @@ var levelStrings = map[string]zapcore.Level{
 	"fatal":  zap.FatalLevel,
 }
 
+type encoderConfigFunc func(*zapcore.EncoderConfig)
+
+var ecfs []encoderConfigFunc
+
 type encoderFlag struct {
 	setFunc func(zapcore.Encoder)
 	value   string
@@ -60,26 +64,69 @@ func (ev *encoderFlag) Set(flagValue string) error {
 	val := strings.ToLower(flagValue)
 	switch val {
 	case "json":
-		ev.setFunc(newJSONEncoder())
+		ev.setFunc(newJSONEncoder(ecfs))
 	case "console":
-		ev.setFunc(newConsoleEncoder())
+		ev.setFunc(newConsoleEncoder(ecfs))
 	default:
 		return fmt.Errorf("invalid encoder value \"%s\"", flagValue)
 	}
 	ev.value = flagValue
 	return nil
 }
 
-func newJSONEncoder() zapcore.Encoder {
+func newJSONEncoder(ecfs []encoderConfigFunc) zapcore.Encoder {
 	encoderConfig := zap.NewProductionEncoderConfig()
+	for _, f := range ecfs {
+		f(&encoderConfig)
+	}
 	return zapcore.NewJSONEncoder(encoderConfig)
 }
 
-func newConsoleEncoder() zapcore.Encoder {
+func newConsoleEncoder(ecfs []encoderConfigFunc) zapcore.Encoder {
 	encoderConfig := zap.NewDevelopmentEncoderConfig()
+	for _, f := range ecfs {
+		f(&encoderConfig)
+	}
 	return zapcore.NewConsoleEncoder(encoderConfig)
 }
 
+type timeEncoderFlag struct {
+	setFunc func(zapcore.TimeEncoder)
+	value   string
+}
+
+var _ pflag.Value = &timeEncoderFlag{}
+
+func (ev *timeEncoderFlag) String() string {
+	return ev.value
+}
+
+func (ev *timeEncoderFlag) Type() string {
+	return "timeEncoder"
+}
+
+func (ev *timeEncoderFlag) Set(flagValue string) error {
+	var encoder zapcore.TimeEncoder
+	val := strings.ToLower(flagValue)
+	switch val {
+	case "iso8601", "rfc3339", "rfc3339nano", "millis", "nanos", "epoch":
+		if err := encoder.UnmarshalText([]byte(val)); err != nil {
+			return fmt.Errorf("unable to unmarshal, \"%s\"", val)
+		}
+	default:
+		return fmt.Errorf("invalid value for time encoder, \"%s\"", val)
+	}
+	ev.setFunc(encoder)
+	ev.value = flagValue
+	return nil
+}
+
+func withTimeEncoding(te zapcore.TimeEncoder) encoderConfigFunc {
+	return func(ec *zapcore.EncoderConfig) {
+		ec.EncodeTime = te
+	}
+}
+
 type levelFlag struct {
 	setFunc func(zap.AtomicLevel)
 	value   string

pkg/log/zap/zap.go

@@ -30,6 +30,8 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
+var encVal encoderFlag
+
 // New returns a brand new Logger configured with Opts. It
 // uses KubeAwareEncoder which adds Type information and
 // Namespace/Name to the log.
@@ -98,6 +100,14 @@ func Encoder(encoder zapcore.Encoder) func(o *Options) {
 	}
 }
 
+// TimeEncoder configures how the logger will encode time format.
+// See Options.TimeEncoder
+func TimeEncoder(timeEncoder zapcore.TimeEncoder) func(o *Options) {
+	return func(o *Options) {
+		o.TimeEncoder = timeEncoder
+	}
+}
+
 // Level sets the the minimum enabled logging level e.g Debug, Info
 // See Options.Level
 func Level(level *zap.AtomicLevel) func(o *Options) {
@@ -132,6 +142,8 @@ type Options struct {
 	// Encoder configures how Zap will encode the output.  Defaults to
 	// console when Development is true and JSON otherwise
 	Encoder zapcore.Encoder
+	// TimeEncoder configures the zap time format. Defaults to epoch.
+	TimeEncoder zapcore.TimeEncoder
 	// DestWritter controls the destination of the log output.  Defaults to
 	// os.Stderr.
 	DestWritter io.Writer
@@ -155,8 +167,10 @@ func (o *Options) addDefaults() {
 
 	if o.Development {
 		if o.Encoder == nil {
-			encCfg := zap.NewDevelopmentEncoderConfig()
-			o.Encoder = zapcore.NewConsoleEncoder(encCfg)
+			if o.TimeEncoder != nil {
+				ecfs = append(ecfs, withTimeEncoding(o.TimeEncoder))
+			}
+			o.Encoder = newConsoleEncoder(ecfs)
 		}
 		if o.Level == nil {
 			lvl := zap.NewAtomicLevelAt(zap.DebugLevel)
@@ -170,8 +184,10 @@ func (o *Options) addDefaults() {
 
 	} else {
 		if o.Encoder == nil {
-			encCfg := zap.NewProductionEncoderConfig()
-			o.Encoder = zapcore.NewJSONEncoder(encCfg)
+			if o.TimeEncoder != nil {
+				ecfs = append(ecfs, withTimeEncoding(o.TimeEncoder))
+			}
+			o.Encoder = newJSONEncoder(ecfs)
 		}
 		if o.Level == nil {
 			lvl := zap.NewAtomicLevelAt(zap.InfoLevel)
@@ -223,8 +239,14 @@ func (o *Options) BindFlags(fs *flag.FlagSet) {
 		"Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). "+
 			"Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error)")
 
+	// Set TimeEncoder value
+	var timeEncVal timeEncoderFlag
+	timeEncVal.setFunc = func(fromFlag zapcore.TimeEncoder) {
+		o.TimeEncoder = fromFlag
+	}
+	fs.Var(&timeEncVal, "zap-time-encoder", "Zap time encoding format('rfc3339', 'rfc339nanos', 'epoch', 'millis', 'nano', or 'iso8601')")
+
 	// Set Encoder value
-	var encVal encoderFlag
 	encVal.setFunc = func(fromFlag zapcore.Encoder) {
 		o.Encoder = fromFlag
 	}
@@ -255,6 +277,14 @@ func (o *Options) BindFlags(fs *flag.FlagSet) {
 func UseFlagOptions(in *Options) Opts {
 	return func(o *Options) {
 		*o = *in
+		if o.Encoder != nil && o.TimeEncoder != nil {
+			ecfs = append(ecfs, withTimeEncoding(o.TimeEncoder))
+			if encVal.value == "json" {
+				o.Encoder = newJSONEncoder(ecfs)
+			} else {
+				o.Encoder = newConsoleEncoder(ecfs)
+			}
+		}
 		o.addDefaults()
 	}
 }