From 149f505d236abbe0d3e5568efdd1210e3b74e034 Mon Sep 17 00:00:00 2001 From: Steve Jones Date: Tue, 15 Mar 2022 12:06:17 -0700 Subject: [PATCH 1/2] Update dependencies --- go.mod | 9 ++++---- go.sum | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 64 insertions(+), 13 deletions(-) diff --git a/go.mod b/go.mod index caaff05..6e9f130 100644 --- a/go.mod +++ b/go.mod @@ -3,9 +3,8 @@ module github.com/snovichkov/zap-gelf go 1.12 require ( - github.com/pkg/errors v0.8.1 // indirect - github.com/stretchr/testify v1.3.0 - go.uber.org/atomic v1.4.0 // indirect - go.uber.org/multierr v1.1.0 // indirect - go.uber.org/zap v1.10.0 + github.com/stretchr/testify v1.7.0 + go.uber.org/atomic v1.9.0 // indirect + go.uber.org/multierr v1.8.0 // indirect + go.uber.org/zap v1.21.0 ) diff --git a/go.sum b/go.sum index c33382c..3ac1144 100644 --- a/go.sum +++ b/go.sum @@ -1,15 +1,67 @@ -github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8= +github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= -go.uber.org/atomic v1.4.0 h1:cxzIVoETapQEqDhQu3QfnvXAV4AlzcvUCxkVUFw3+EU= -go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= -go.uber.org/multierr v1.1.0 h1:HoEmRHQPVSqub6w2z2d2EOVs2fjyFRGyofhKuyDq0QI= -go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= -go.uber.org/zap v1.10.0 h1:ORx85nbTijNz8ljznvCMR1ZBIPKFn3jQrag10X2AsuM= -go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/atomic v1.9.0 h1:ECmE8Bn/WFTYwEW/bpKD3M8VtR/zQVbavAoalC1PYyE= +go.uber.org/atomic v1.9.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI= +go.uber.org/goleak v1.1.11/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ= +go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= +go.uber.org/multierr v1.8.0 h1:dg6GjLku4EH+249NNmoIciG9N/jURbDG+pFlTkhzIC8= +go.uber.org/multierr v1.8.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= +go.uber.org/zap v1.21.0 h1:WefMeulhovoZ2sYXz7st6K0sLj7bBhpiFaud4r4zST8= +go.uber.org/zap v1.21.0/go.mod h1:wjWOCqI0f2ZZrJF/UufIOkiC8ii6tm1iqIsLo76RfJw= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007 h1:gG67DSER+11cZvqIMb8S8bt0vZtiN6xWYARwirrOSfE= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.5 h1:ouewzE6p+/VEB31YYnTbEJdi8pFqKp4P4n85vwo3DHA= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= From 2bbe11b6e6ef095c45bbc71839fa75d0b072c4f5 Mon Sep 17 00:00:00 2001 From: Steve Jones Date: Tue, 15 Mar 2022 12:09:20 -0700 Subject: [PATCH 2/2] Additional configuration options --- gelf.go | 56 +++++++++++++++++++++++++++++++++++++++++++ gelf_test.go | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 124 insertions(+) diff --git a/gelf.go b/gelf.go index 6bdfe6b..ba96c18 100644 --- a/gelf.go +++ b/gelf.go @@ -178,6 +178,30 @@ func Version(value string) Option { }) } +// MessageKey set zapcore.EncoderConfig MessageKey property. +func MessageKey(value string) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.MessageKey = escapeKey(value) + return nil + }) +} + +// LevelKey set zapcore.EncoderConfig LevelKey property. +func LevelKey(value string) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.LevelKey = escapeKey(value) + return nil + }) +} + +// TimeKey set zapcore.EncoderConfig TimeKey property. +func TimeKey(value string) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.TimeKey = escapeKey(value) + return nil + }) +} + // NameKey set zapcore.EncoderConfig NameKey property. func NameKey(value string) Option { return optionFunc(func(conf *optionConf) error { @@ -194,6 +218,30 @@ func CallerKey(value string) Option { }) } +// FunctionKey set zapcore.EncoderConfig FunctionKey property. +func FunctionKey(value string) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.FunctionKey = escapeKey(value) + return nil + }) +} + +// StacktraceKey set zapcore.EncoderConfig StacktraceKey property. +func StacktraceKey(value string) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.StacktraceKey = escapeKey(value) + return nil + }) +} + +// SkipLineEnding set zapcore.EncoderConfig SkipLineEnding property. +func SkipLineEnding(value bool) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.SkipLineEnding = value + return nil + }) +} + // LineEnding set zapcore.EncoderConfig LineEnding property. func LineEnding(value string) Option { return optionFunc(func(conf *optionConf) error { @@ -226,6 +274,14 @@ func EncodeName(value zapcore.NameEncoder) Option { }) } +// NewReflectedEncoder set zapcore.EncoderConfig NewReflectedEncoder property. +func NewReflectedEncoder(value func(io.Writer) zapcore.ReflectedEncoder) Option { + return optionFunc(func(conf *optionConf) error { + conf.encoder.NewReflectedEncoder = value + return nil + }) +} + // Level set logging level. func Level(value zapcore.Level) Option { return optionFunc(func(conf *optionConf) error { diff --git a/gelf_test.go b/gelf_test.go index aa951b5..1913fdc 100644 --- a/gelf_test.go +++ b/gelf_test.go @@ -1,6 +1,8 @@ package gelf_test import ( + "encoding/json" + "io" "testing" "github.com/stretchr/testify/assert" @@ -37,6 +39,33 @@ func TestVersion(t *testing.T) { assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") } +func TestMessageKey(t *testing.T) { + var core, err = gelf.NewCore( + gelf.MessageKey("custom_message"), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + +func TestLevelKey(t *testing.T) { + var core, err = gelf.NewCore( + gelf.LevelKey("custom_level"), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + +func TestTimeKey(t *testing.T) { + var core, err = gelf.NewCore( + gelf.TimeKey("custom_time"), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + func TestNameKey(t *testing.T) { var core, err = gelf.NewCore( gelf.NameKey("custom_name"), @@ -55,6 +84,33 @@ func TestCallerKey(t *testing.T) { assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") } +func TestFunctionKey(t *testing.T) { + var core, err = gelf.NewCore( + gelf.FunctionKey("custom_function"), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + +func TestStacktraceKey(t *testing.T) { + var core, err = gelf.NewCore( + gelf.StacktraceKey("custom_stacktrace"), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + +func TestSkipLineEnding(t *testing.T) { + var core, err = gelf.NewCore( + gelf.SkipLineEnding(true), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + func TestLineEnding(t *testing.T) { var core, err = gelf.NewCore( gelf.LineEnding("\r\n"), @@ -91,6 +147,18 @@ func TestEncodeName(t *testing.T) { assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") } +func TestNewReflectedEncoder(t *testing.T) { + var newEncoder = func(writer io.Writer) zapcore.ReflectedEncoder { + return json.NewEncoder(writer) + } + var core, err = gelf.NewCore( + gelf.NewReflectedEncoder(newEncoder), + ) + + assert.Nil(t, err, "Unexpected error") + assert.Implements(t, (*zapcore.Core)(nil), core, "Expect zapcore.Core") +} + func TestLevel(t *testing.T) { var core, err = gelf.NewCore( gelf.Level(zap.DebugLevel),