Add zap logger support (#93)

config/config_test.go

@@ -28,6 +28,7 @@ import (
 	"github.com/uber/jaeger-lib/metrics"
 
 	"github.com/uber/jaeger-client-go"
+	"github.com/uber/jaeger-client-go/log"
 )
 
 func TestNewSamplerConst(t *testing.T) {
@@ -82,7 +83,7 @@ func TestInvalidSamplerType(t *testing.T) {
 
 func TestDefaultConfig(t *testing.T) {
 	cfg := Configuration{}
-	_, _, err := cfg.New("", Metrics(metrics.NullFactory), Logger(jaeger.NullLogger))
+	_, _, err := cfg.New("", Metrics(metrics.NullFactory), Logger(log.NullLogger))
 	require.EqualError(t, err, "no service name provided")
 
 	_, closer, err := cfg.New("testService")

crossdock/client/client_test.go

@@ -32,6 +32,7 @@ import (
 	"github.com/uber/jaeger-client-go/crossdock/common"
 	"github.com/uber/jaeger-client-go/crossdock/log"
 	"github.com/uber/jaeger-client-go/crossdock/server"
+	jlog "github.com/uber/jaeger-client-go/log"
 )
 
 func TestCrossdock(t *testing.T) {
@@ -40,7 +41,7 @@ func TestCrossdock(t *testing.T) {
 
 	var reporter jaeger.Reporter
 	if log.Enabled {
-		reporter = jaeger.NewLoggingReporter(jaeger.StdLogger)
+		reporter = jaeger.NewLoggingReporter(jlog.StdLogger)
 	} else {
 		reporter = jaeger.NewNullReporter()
 	}

crossdock/endtoend/handler_test.go

@@ -32,6 +32,7 @@ import (
 
 	"github.com/uber/jaeger-client-go"
 	"github.com/uber/jaeger-client-go/config"
+	"github.com/uber/jaeger-client-go/log"
 )
 
 var (
@@ -99,7 +100,7 @@ func newInMemoryTracer() (opentracing.Tracer, *jaeger.InMemoryReporter) {
 		jaeger.NewConstSampler(true),
 		inMemoryReporter,
 		jaeger.TracerOptions.Metrics(jaeger.NewNullMetrics()),
-		jaeger.TracerOptions.Logger(jaeger.NullLogger))
+		jaeger.TracerOptions.Logger(log.NullLogger))
 	return tracer, inMemoryReporter
 }
 

crossdock/main.go

@@ -30,6 +30,7 @@ import (
 	"github.com/uber/jaeger-client-go/crossdock/common"
 	"github.com/uber/jaeger-client-go/crossdock/log"
 	"github.com/uber/jaeger-client-go/crossdock/server"
+	jlog "github.com/uber/jaeger-client-go/log"
 )
 
 func main() {
@@ -54,6 +55,6 @@ func initTracer() (opentracing.Tracer, io.Closer) {
 	t, c := jaeger.NewTracer(
 		common.DefaultTracerServiceName,
 		jaeger.NewConstSampler(false),
-		jaeger.NewLoggingReporter(jaeger.StdLogger))
+		jaeger.NewLoggingReporter(jlog.StdLogger))
 	return t, c
 }

log/logger.go

@@ -0,0 +1,57 @@
+// 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 log
+
+import "log"
+
+// Logger provides an abstract interface for logging from Reporters.
+// Applications can provide their own implementation of this interface to adapt
+// reporters logging to whatever logging library they prefer (stdlib log,
+// logrus, go-logging, etc).
+type Logger interface {
+	// Error logs a message at error priority
+	Error(msg string)
+
+	// Infof logs a message at info priority
+	Infof(msg string, args ...interface{})
+}
+
+// StdLogger is implementation of the Logger interface that delegates to default `log` package
+var StdLogger = &stdLogger{}
+
+type stdLogger struct{}
+
+func (l *stdLogger) Error(msg string) {
+	log.Printf("ERROR: %s", msg)
+}
+
+// Infof logs a message at info priority
+func (l *stdLogger) Infof(msg string, args ...interface{}) {
+	log.Printf(msg, args...)
+}
+
+// NullLogger is implementation of the Logger interface that delegates to default `log` package
+var NullLogger = &nullLogger{}
+
+type nullLogger struct{}
+
+func (l *nullLogger) Error(msg string)                      {}
+func (l *nullLogger) Infof(msg string, args ...interface{}) {}

log/logger_test.go

@@ -0,0 +1,32 @@
+// Copyright (c) 2017 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 log
+
+import (
+	"testing"
+)
+
+func TestLogger(t *testing.T) {
+	for _, logger := range []Logger{StdLogger, NullLogger} {
+		logger.Infof("Hi %s", "there")
+		logger.Error("Bad wolf")
+	}
+}

log/zap/logger.go

@@ -0,0 +1,47 @@
+// Copyright (c) 2017 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 zap
+
+import (
+	"fmt"
+
+	"go.uber.org/zap"
+)
+
+// Logger is an adapter from zap Logger to jaeger-lib Logger.
+type Logger struct {
+	logger zap.Logger
+}
+
+// NewLogger creates a new Logger.
+func NewLogger(logger zap.Logger) *Logger {
+	return &Logger{logger: logger}
+}
+
+// Error logs a message at error priority
+func (l *Logger) Error(msg string) {
+	l.logger.Error(msg)
+}
+
+// Infof logs a message at info priority
+func (l *Logger) Infof(msg string, args ...interface{}) {
+	l.logger.Info(fmt.Sprintf(msg, args))
+}

log/zap/logger_test.go

@@ -0,0 +1,34 @@
+// Copyright (c) 2017 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 zap
+
+import (
+	"testing"
+
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+func TestLogger(t *testing.T) {
+	logger := NewLogger(*zap.New(zapcore.NewNopCore()))
+	logger.Infof("Hi %s", "there")
+	logger.Error("Bad wolf")
+}

logger.go

@@ -22,6 +22,8 @@ package jaeger
 
 import "log"
 
+// NB This will be deprecated in 3.0.0, please use jaeger-client-go/log/logger instead.
+
 // Logger provides an abstract interface for logging from Reporters.
 // Applications can provide their own implementation of this interface to adapt
 // reporters logging to whatever logging library they prefer (stdlib log,

logger_test.go

@@ -22,6 +22,8 @@ package jaeger
 
 import (
 	"testing"
+
+	"github.com/uber/jaeger-client-go/log"
 )
 
 func TestLogger(t *testing.T) {
@@ -30,3 +32,15 @@ func TestLogger(t *testing.T) {
 		logger.Error("Bad wolf")
 	}
 }
+
+func TestCompatibility(t *testing.T) {
+	for _, logger := range []log.Logger{StdLogger, NullLogger} {
+		logger.Infof("Hi %s", "there")
+		logger.Error("Bad wolf")
+	}
+
+	for _, logger := range []Logger{log.StdLogger, log.NullLogger} {
+		logger.Infof("Hi %s", "there")
+		logger.Error("Bad wolf")
+	}
+}

reporter.go

@@ -27,6 +27,7 @@ import (
 
 	"github.com/opentracing/opentracing-go"
 
+	"github.com/uber/jaeger-client-go/log"
 	"github.com/uber/jaeger-client-go/thrift-gen/zipkincore"
 	"github.com/uber/jaeger-client-go/transport"
 )
@@ -182,7 +183,7 @@ func NewRemoteReporter(sender transport.Transport, opts ...ReporterOption) Repor
 		options.bufferFlushInterval = defaultBufferFlushInterval
 	}
 	if options.logger == nil {
-		options.logger = NullLogger
+		options.logger = log.NullLogger
 	}
 	if options.metrics == nil {
 		options.metrics = NewNullMetrics()

reporter_options.go

@@ -20,7 +20,9 @@
 
 package jaeger
 
-import "time"
+import (
+	"time"
+)
 
 // ReporterOption is a function that sets some option on the reporter.
 type ReporterOption func(c *reporterOptions)

sampler.go

@@ -26,6 +26,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/uber/jaeger-client-go/log"
 	"github.com/uber/jaeger-client-go/thrift-gen/sampling"
 	"github.com/uber/jaeger-client-go/utils"
 )
@@ -428,7 +429,7 @@ func applySamplerOptions(opts ...SamplerOption) samplerOptions {
 		options.sampler = initialSampler
 	}
 	if options.logger == nil {
-		options.logger = NullLogger
+		options.logger = log.NullLogger
 	}
 	if options.maxOperations <= 0 {
 		options.maxOperations = defaultMaxOperations

sampler_options.go

@@ -20,7 +20,9 @@
 
 package jaeger
 
-import "time"
+import (
+	"time"
+)
 
 // SamplerOption is a function that sets some option on the sampler
 type SamplerOption func(options *samplerOptions)

sampler_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/uber/jaeger-lib/metrics"
 	mTestutils "github.com/uber/jaeger-lib/metrics/testutils"
 
+	"github.com/uber/jaeger-client-go/log"
 	"github.com/uber/jaeger-client-go/testutils"
 	"github.com/uber/jaeger-client-go/thrift-gen/sampling"
 	"github.com/uber/jaeger-client-go/utils"
@@ -293,7 +294,7 @@ func initAgent(t *testing.T) (*testutils.MockAgent, *RemotelyControlledSampler,
 		SamplerOptions.SamplingServerURL("http://"+agent.SamplingServerAddr()),
 		SamplerOptions.MaxOperations(testDefaultMaxOperations),
 		SamplerOptions.InitialSampler(initialSampler),
-		SamplerOptions.Logger(NullLogger),
+		SamplerOptions.Logger(log.NullLogger),
 		SamplerOptions.SamplingRefreshInterval(time.Minute),
 	)
 	sampler.Close() // stop timer-based updates, we want to call them manually