Merge pull request #37 from opentracing/bhs/kv_logging

Adjust to the new key-value logging regime

event.go

@@ -19,7 +19,12 @@ type EventBaggage struct {
 	Key, Value string
 }
 
+// EventLogFields is received when LogFields or LogKV is called.
+type EventLogFields opentracing.LogRecord
+
 // EventLog is received when Log (or one of its derivatives) is called.
+//
+// DEPRECATED
 type EventLog opentracing.LogData
 
 // EventFinish is received when Finish is called.
@@ -40,6 +45,11 @@ func (s *spanImpl) onLog(ld opentracing.LogData) {
 		s.event(EventLog(ld))
 	}
 }
+func (s *spanImpl) onLogFields(lr opentracing.LogRecord) {
+	if s.event != nil {
+		s.event(EventLogFields(lr))
+	}
+}
 func (s *spanImpl) onBaggage(key, value string) {
 	if s.event != nil {
 		s.event(EventBaggage{Key: key, Value: value})

raw.go

@@ -30,5 +30,5 @@ type RawSpan struct {
 	Tags opentracing.Tags
 
 	// The span's "microlog".
-	Logs []opentracing.LogData
+	Logs []opentracing.LogRecord
 }

span.go

@@ -6,6 +6,7 @@ import (
 
 	opentracing "github.com/opentracing/opentracing-go"
 	"github.com/opentracing/opentracing-go/ext"
+	"github.com/opentracing/opentracing-go/log"
 )
 
 // Span provides access to the essential details of the span, for use
@@ -88,6 +89,31 @@ func (s *spanImpl) SetTag(key string, value interface{}) opentracing.Span {
 	return s
 }
 
+func (s *spanImpl) LogKV(keyValues ...interface{}) {
+	fields, err := log.InterleavedKVToFields(keyValues...)
+	if err != nil {
+		s.LogFields(log.Error(err), log.String("function", "LogKV"))
+		return
+	}
+	s.LogFields(fields...)
+}
+
+func (s *spanImpl) LogFields(fields ...log.Field) {
+	lr := opentracing.LogRecord{
+		Fields: fields,
+	}
+	defer s.onLogFields(lr)
+	s.Lock()
+	defer s.Unlock()
+	if s.trim() || s.tracer.options.DropAllLogs {
+		return
+	}
+	if lr.Timestamp.IsZero() {
+		lr.Timestamp = time.Now()
+	}
+	s.raw.Logs = append(s.raw.Logs, lr)
+}
+
 func (s *spanImpl) LogEvent(event string) {
 	s.Log(opentracing.LogData{
 		Event: event,
@@ -113,7 +139,7 @@ func (s *spanImpl) Log(ld opentracing.LogData) {
 		ld.Timestamp = time.Now()
 	}
 
-	s.raw.Logs = append(s.raw.Logs, ld)
+	s.raw.Logs = append(s.raw.Logs, ld.ToLogRecord())
 }
 
 func (s *spanImpl) Finish() {
@@ -129,8 +155,11 @@ func (s *spanImpl) FinishWithOptions(opts opentracing.FinishOptions) {
 
 	s.Lock()
 	defer s.Unlock()
-	if opts.BulkLogData != nil {
-		s.raw.Logs = append(s.raw.Logs, opts.BulkLogData...)
+	if opts.LogRecords != nil {
+		s.raw.Logs = append(s.raw.Logs, opts.LogRecords...)
+	}
+	for _, ld := range opts.BulkLogData {
+		s.raw.Logs = append(s.raw.Logs, ld.ToLogRecord())
 	}
 	s.raw.Duration = duration