Re-package tracetranslators by translation type (#418)

Re-package tracetranslators by translation type

Author: Steven Karis

cmd/occollector/app/sender/jaeger_thrift_http_sender.go

@@ -26,7 +26,7 @@ import (
 	"go.uber.org/zap"
 
 	agenttracepb "github.com/census-instrumentation/opencensus-proto/gen-go/agent/trace/v1"
-	"github.com/census-instrumentation/opencensus-service/translator/trace"
+	jaegertranslator "github.com/census-instrumentation/opencensus-service/translator/trace/jaeger"
 )
 
 // Default timeout for http request in seconds
@@ -86,7 +86,7 @@ func (s *JaegerThriftHTTPSender) ProcessSpans(batch *agenttracepb.ExportTraceSer
 		return 0, fmt.Errorf("Jaeger sender received nil batch")
 	}
 
-	tBatch, err := tracetranslator.OCProtoToJaegerThrift(batch)
+	tBatch, err := jaegertranslator.OCProtoToJaegerThrift(batch)
 	if err != nil {
 		return uint64(len(batch.Spans)), err
 	}

cmd/occollector/app/sender/jaeger_thrift_tchannel_sender.go

@@ -21,7 +21,7 @@ import (
 
 	agenttracepb "github.com/census-instrumentation/opencensus-proto/gen-go/agent/trace/v1"
 	"github.com/census-instrumentation/opencensus-service/internal/collector/processor"
-	"github.com/census-instrumentation/opencensus-service/translator/trace"
+	jaegertranslator "github.com/census-instrumentation/opencensus-service/translator/trace/jaeger"
 )
 
 // JaegerThriftTChannelSender takes span batches and sends them
@@ -47,7 +47,7 @@ func NewJaegerThriftTChannelSender(
 // ProcessSpans sends the received data to the configured Jaeger Thrift end-point.
 func (s *JaegerThriftTChannelSender) ProcessSpans(batch *agenttracepb.ExportTraceServiceRequest, spanFormat string) (uint64, error) {
 	// TODO: (@pjanotti) In case of failure the translation to Jaeger Thrift is going to be remade, cache it somehow.
-	tBatch, err := tracetranslator.OCProtoToJaegerThrift(batch)
+	tBatch, err := jaegertranslator.OCProtoToJaegerThrift(batch)
 	if err != nil {
 		return uint64(len(tBatch.Spans)), err
 	}

exporter/exporterparser/exparser.go

@@ -29,7 +29,7 @@ import (
 	tracepb "github.com/census-instrumentation/opencensus-proto/gen-go/trace/v1"
 	"github.com/census-instrumentation/opencensus-service/data"
 	"github.com/census-instrumentation/opencensus-service/internal"
-	tracetranslator "github.com/census-instrumentation/opencensus-service/translator/trace"
+	spandatatranslator "github.com/census-instrumentation/opencensus-service/translator/trace/spandata"
 )
 
 // OcProtoSpansToOCSpanDataInstrumented converts
@@ -61,7 +61,7 @@ func OcProtoSpansToOCSpanDataInstrumented(ctx context.Context, exporterName stri
 	var errs []error
 	var goodSpans []*tracepb.Span
 	for _, span := range td.Spans {
-		sd, err := tracetranslator.ProtoSpanToOCSpanData(span)
+		sd, err := spandatatranslator.ProtoSpanToOCSpanData(span)
 		if err == nil {
 			te.ExportSpan(sd)
 			goodSpans = append(goodSpans, span)

exporter/zipkinexporter/zipkin.go

@@ -34,7 +34,7 @@ import (
 	"github.com/census-instrumentation/opencensus-service/data"
 	"github.com/census-instrumentation/opencensus-service/exporter"
 	"github.com/census-instrumentation/opencensus-service/internal"
-	tracetranslator "github.com/census-instrumentation/opencensus-service/translator/trace"
+	spandatatranslator "github.com/census-instrumentation/opencensus-service/translator/trace/spandata"
 )
 
 // ZipkinConfig holds the configuration of a Zipkin exporter.
@@ -206,7 +206,7 @@ func (ze *zipkinExporter) ExportSpans(ctx context.Context, td data.TraceData) (z
 
 	goodSpans := make([]*tracepb.Span, 0, len(td.Spans))
 	for _, span := range td.Spans {
-		sd, err := tracetranslator.ProtoSpanToOCSpanData(span)
+		sd, err := spandatatranslator.ProtoSpanToOCSpanData(span)
 		if err != nil {
 			return err
 		}

receiver/jaegerreceiver/trace_receiver.go

@@ -40,7 +40,7 @@ import (
 	"github.com/census-instrumentation/opencensus-service/data"
 	"github.com/census-instrumentation/opencensus-service/internal"
 	"github.com/census-instrumentation/opencensus-service/receiver"
-	tracetranslator "github.com/census-instrumentation/opencensus-service/translator/trace"
+	jaegertranslator "github.com/census-instrumentation/opencensus-service/translator/trace/jaeger"
 )
 
 // Configuration defines the behavior and the ports that
@@ -230,7 +230,7 @@ func (jr *jReceiver) SubmitBatches(ctx thrift.Context, batches []*jaeger.Batch)
 	spansMetricsFn := internal.NewReceivedSpansRecorderStreaming(ctx, "jaeger-collector")
 
 	for _, batch := range batches {
-		octrace, err := tracetranslator.JaegerThriftBatchToOCProto(batch)
+		octrace, err := jaegertranslator.ThriftBatchToOCProto(batch)
 		// TODO: (@odeke-em) add this error for Jaeger observability
 		ok := false
 
@@ -260,7 +260,7 @@ func (jr *jReceiver) EmitZipkinBatch(spans []*zipkincore.Span) error {
 // EmitBatch implements cmd/agent/reporter.Reporter and it forwards
 // Jaeger spans received by the Jaeger agent processor.
 func (jr *jReceiver) EmitBatch(batch *jaeger.Batch) error {
-	octrace, err := tracetranslator.JaegerThriftBatchToOCProto(batch)
+	octrace, err := jaegertranslator.ThriftBatchToOCProto(batch)
 	if err != nil {
 		// TODO: (@odeke-em) add this error for Jaeger observability metrics
 		return err

receiver/zipkinreceiver/scribe/scribe_receiver.go

@@ -29,7 +29,7 @@ import (
 	"github.com/census-instrumentation/opencensus-service/data"
 	"github.com/census-instrumentation/opencensus-service/internal"
 	"github.com/census-instrumentation/opencensus-service/receiver"
-	"github.com/census-instrumentation/opencensus-service/translator/trace"
+	zipkintranslator "github.com/census-instrumentation/opencensus-service/translator/trace/zipkin"
 )
 
 var (
@@ -153,7 +153,7 @@ func (sc *scribeCollector) Log(messages []*scribe.LogEntry) (r scribe.ResultCode
 		return scribe.ResultCode_OK, nil
 	}
 
-	ocBatches, err := tracetranslator.ZipkinV1ThriftBatchToOCProto(zSpans)
+	ocBatches, err := zipkintranslator.V1ThriftBatchToOCProto(zSpans)
 	if err != nil {
 		return scribe.ResultCode_OK, err
 	}

receiver/zipkinreceiver/trace_receiver.go

@@ -42,7 +42,7 @@ import (
 	"github.com/census-instrumentation/opencensus-service/data"
 	"github.com/census-instrumentation/opencensus-service/internal"
 	"github.com/census-instrumentation/opencensus-service/receiver"
-	"github.com/census-instrumentation/opencensus-service/translator/trace"
+	zipkintranslator "github.com/census-instrumentation/opencensus-service/translator/trace/zipkin"
 )
 
 // ZipkinReceiver type is used to handle spans received in the Zipkin format.
@@ -120,9 +120,9 @@ func (zr *ZipkinReceiver) v1ToTraceSpans(blob []byte, hdr http.Header) (reqs []*
 			return nil, err
 		}
 
-		return tracetranslator.ZipkinV1ThriftBatchToOCProto(zSpans)
+		return zipkintranslator.V1ThriftBatchToOCProto(zSpans)
 	}
-	return tracetranslator.ZipkinV1JSONBatchToOCProto(blob)
+	return zipkintranslator.V1JSONBatchToOCProto(blob)
 }
 
 // deserializeThrift decodes Thrift bytes to a list of spans.

receiver/zipkinreceiver/trace_receiver_test.go

@@ -38,7 +38,7 @@ import (
 	"github.com/census-instrumentation/opencensus-service/internal"
 	"github.com/census-instrumentation/opencensus-service/internal/testutils"
 	"github.com/census-instrumentation/opencensus-service/receiver"
-	"github.com/census-instrumentation/opencensus-service/translator/trace"
+	spandatatranslator "github.com/census-instrumentation/opencensus-service/translator/trace/spandata"
 )
 
 func TestTraceIDConversion(t *testing.T) {
@@ -386,7 +386,7 @@ func TestConversionRoundtrip(t *testing.T) {
 		reporterShutdownFns = append(reporterShutdownFns, re.Close)
 
 		for _, span := range treq.Spans {
-			sd, _ := tracetranslator.ProtoSpanToOCSpanData(span)
+			sd, _ := spandatatranslator.ProtoSpanToOCSpanData(span)
 			ze.ExportSpan(sd)
 		}
 	}

translator/trace/big_endian_converter.go

@@ -0,0 +1,42 @@
+// Copyright 2019, OpenCensus Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package tracetranslator
+
+import (
+	"encoding/binary"
+)
+
+// Int64TraceIDToByteTraceID takes a long representaition of a trace id
+// and converts it to a []byte representation.
+func Int64TraceIDToByteTraceID(high, low int64) []byte {
+	if high == 0 && low == 0 {
+		return nil
+	}
+	traceID := make([]byte, 16)
+	binary.BigEndian.PutUint64(traceID[:8], uint64(high))
+	binary.BigEndian.PutUint64(traceID[8:], uint64(low))
+	return traceID
+}
+
+// Int64SpanIDToByteSpanID takes a long represenation of a span id and
+// converts it to a []byte representation.
+func Int64SpanIDToByteSpanID(id int64) []byte {
+	if id == 0 {
+		return nil
+	}
+	spanID := make([]byte, 8)
+	binary.BigEndian.PutUint64(spanID, uint64(id))
+	return spanID
+}

…lator/trace/jaegerthrift_to_protospan.go …race/jaeger/jaegerthrift_to_protospan.gotranslator/trace/jaegerthrift_to_protospan.go renamed to translator/trace/jaeger/jaegerthrift_to_protospan.go translator/trace/jaegerthrift_to_protospan.go renamed to translator/trace/jaeger/jaegerthrift_to_protospan.go

@@ -12,26 +12,26 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tracetranslator
+package jaeger
 
 import (
 	"encoding/base64"
-	"encoding/binary"
 	"fmt"
 	"reflect"
 	"strconv"
 	"time"
 
-	"github.com/census-instrumentation/opencensus-service/internal"
-
 	commonpb "github.com/census-instrumentation/opencensus-proto/gen-go/agent/common/v1"
 	agenttracepb "github.com/census-instrumentation/opencensus-proto/gen-go/agent/trace/v1"
 	tracepb "github.com/census-instrumentation/opencensus-proto/gen-go/trace/v1"
 	"github.com/jaegertracing/jaeger/thrift-gen/jaeger"
+
+	"github.com/census-instrumentation/opencensus-service/internal"
+	"github.com/census-instrumentation/opencensus-service/translator/trace"
 )
 
-// JaegerThriftBatchToOCProto converts a single Jaeger Thrift batch of spans to a OC proto batch.
-func JaegerThriftBatchToOCProto(jbatch *jaeger.Batch) (*agenttracepb.ExportTraceServiceRequest, error) {
+// ThriftBatchToOCProto converts a single Jaeger Thrift batch of spans to a OC proto batch.
+func ThriftBatchToOCProto(jbatch *jaeger.Batch) (*agenttracepb.ExportTraceServiceRequest, error) {
 	ocbatch := &agenttracepb.ExportTraceServiceRequest{
 		Node:  jProcessToOCProtoNode(jbatch.GetProcess()),
 		Spans: jSpansToOCProtoSpans(jbatch.GetSpans()),
@@ -106,10 +106,10 @@ func jSpansToOCProtoSpans(jspans []*jaeger.Span) []*tracepb.Span {
 		startTime := epochMicrosecondsAsTime(uint64(jspan.StartTime))
 		_, sKind, sStatus, sAttributes := jtagsToAttributes(jspan.Tags)
 		span := &tracepb.Span{
-			TraceId: jTraceIDToOCProtoTraceID(jspan.TraceIdHigh, jspan.TraceIdLow),
-			SpanId:  jSpanIDToOCProtoSpanID(jspan.SpanId),
+			TraceId: tracetranslator.Int64TraceIDToByteTraceID(jspan.TraceIdHigh, jspan.TraceIdLow),
+			SpanId:  tracetranslator.Int64SpanIDToByteSpanID(jspan.SpanId),
 			// TODO: Tracestate: Check RFC status and if is applicable,
-			ParentSpanId: jSpanIDToOCProtoSpanID(jspan.ParentSpanId),
+			ParentSpanId: tracetranslator.Int64SpanIDToByteSpanID(jspan.ParentSpanId),
 			Name:         strToTruncatableString(jspan.OperationName),
 			Kind:         sKind,
 			StartTime:    internal.TimeToTimestamp(startTime),
@@ -171,8 +171,8 @@ func jReferencesToOCProtoLinks(jrefs []*jaeger.SpanRef) *tracepb.Span_Links {
 		}
 
 		link := &tracepb.Span_Link{
-			TraceId: jTraceIDToOCProtoTraceID(jref.TraceIdHigh, jref.TraceIdLow),
-			SpanId:  jSpanIDToOCProtoSpanID(jref.SpanId),
+			TraceId: tracetranslator.Int64TraceIDToByteTraceID(jref.TraceIdHigh, jref.TraceIdLow),
+			SpanId:  tracetranslator.Int64SpanIDToByteSpanID(jref.SpanId),
 			Type:    linkType,
 		}
 		links = append(links, link)
@@ -181,25 +181,6 @@ func jReferencesToOCProtoLinks(jrefs []*jaeger.SpanRef) *tracepb.Span_Links {
 	return &tracepb.Span_Links{Link: links}
 }
 
-func jTraceIDToOCProtoTraceID(high, low int64) []byte {
-	if high == 0 && low == 0 {
-		return nil
-	}
-	traceID := make([]byte, 16)
-	binary.BigEndian.PutUint64(traceID[:8], uint64(high))
-	binary.BigEndian.PutUint64(traceID[8:], uint64(low))
-	return traceID
-}
-
-func jSpanIDToOCProtoSpanID(id int64) []byte {
-	if id == 0 {
-		return nil
-	}
-	spanID := make([]byte, 8)
-	binary.BigEndian.PutUint64(spanID, uint64(id))
-	return spanID
-}
-
 func jtagsToAttributes(tags []*jaeger.Tag) (string, tracepb.Span_SpanKind, *tracepb.Status, *tracepb.Span_Attributes) {
 	if tags == nil {
 		return "", tracepb.Span_SPAN_KIND_UNSPECIFIED, nil, nil