Support configurable delimiter for console encoder

zapcore/console_encoder.go

@@ -22,10 +22,9 @@ package zapcore
 
 import (
 	"fmt"
-	"sync"
-
 	"go.uber.org/zap/buffer"
 	"go.uber.org/zap/internal/bufferpool"
+	"sync"
 )
 
 var _sliceEncoderPool = sync.Pool{
@@ -56,6 +55,9 @@ type consoleEncoder struct {
 // encoder configuration, it will omit any element whose key is set to the empty
 // string.
 func NewConsoleEncoder(cfg EncoderConfig) Encoder {
+	if cfg.ElementDelimiter == 0 {
+		cfg.ElementDelimiter = '\t'
+	}
 	return consoleEncoder{newJSONEncoder(cfg, true)}
 }
 
@@ -94,15 +96,15 @@ func (c consoleEncoder) EncodeEntry(ent Entry, fields []Field) (*buffer.Buffer,
 	}
 	for i := range arr.elems {
 		if i > 0 {
-			line.AppendByte('\t')
+			line.AppendByte(c.ElementDelimiter)
 		}
 		fmt.Fprint(line, arr.elems[i])
 	}
 	putSliceEncoder(arr)
 
 	// Add the message itself.
 	if c.MessageKey != "" {
-		c.addTabIfNecessary(line)
+		c.addDelimiterIfNecessary(line)
 		line.AppendString(ent.Message)
 	}
 
@@ -134,14 +136,14 @@ func (c consoleEncoder) writeContext(line *buffer.Buffer, extra []Field) {
 		return
 	}
 
-	c.addTabIfNecessary(line)
+	c.addDelimiterIfNecessary(line)
 	line.AppendByte('{')
 	line.Write(context.buf.Bytes())
 	line.AppendByte('}')
 }
 
-func (c consoleEncoder) addTabIfNecessary(line *buffer.Buffer) {
+func (c consoleEncoder) addDelimiterIfNecessary(line *buffer.Buffer) {
 	if line.Len() > 0 {
-		line.AppendByte('\t')
+		line.AppendByte(c.ElementDelimiter)
 	}
 }

zapcore/console_encoder_test.go

@@ -0,0 +1,56 @@
+// Copyright (c) 2016 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+package zapcore_test
+
+import (
+	"github.com/stretchr/testify/assert"
+	. "go.uber.org/zap/zapcore"
+	"testing"
+)
+
+func TestSetConsoleElementDelimiter(t *testing.T) {
+	encodeConfig := humanEncoderConfig()
+	encodeConfig.ElementDelimiter = ' '
+	enc := NewConsoleEncoder(encodeConfig)
+	enc.AddString("str", "foo")
+
+	buf, _ := enc.EncodeEntry(Entry{
+		Message: "fake",
+		Level:   DebugLevel,
+	}, nil)
+
+	assert.Equal(t, `0001-01-01T00:00:00.000Z DEBUG fake {"str": "foo"}
+`, buf.String())
+	buf.Free()
+
+	encodeConfig.ElementDelimiter = '-'
+	enc = NewConsoleEncoder(encodeConfig)
+	enc.AddString("str", "foo")
+
+	buf, _ = enc.EncodeEntry(Entry{
+		Message: "fake",
+		Level:   DebugLevel,
+	}, nil)
+
+	assert.Equal(t, `0001-01-01T00:00:00.000Z-DEBUG-fake-{"str": "foo"}
+`, buf.String())
+	buf.Free()
+
+}

zapcore/encoder.go

@@ -239,6 +239,8 @@ type EncoderConfig struct {
 	// Unlike the other primitive type encoders, EncodeName is optional. The
 	// zero value falls back to FullNameEncoder.
 	EncodeName NameEncoder `json:"nameEncoder" yaml:"nameEncoder"`
+	//More on console, the delimiter of each element
+	ElementDelimiter byte `json:"elementDelimiter" yaml:"elementDelimiter"`
 }
 
 // ObjectEncoder is a strongly-typed, encoding-agnostic interface for adding a