Change FormatName to [Trace|Metrics]FormatName to be able to use as tags. (#463)

Author: Bogdan Drutu

exporter/exportertest/nop_exporter.go

@@ -34,10 +34,17 @@ func (ne *nopExporter) ProcessMetricsData(ctx context.Context, md data.MetricsDa
 	return nil
 }
 
-const nopExportFormat = "NopExporter"
+const (
+	nopTraceExportFormat   = "nop_trace"
+	nopMetricsExportFormat = "nop_metrics"
+)
+
+func (ne *nopExporter) TraceExportFormat() string {
+	return nopTraceExportFormat
+}
 
-func (ne *nopExporter) ExportFormat() string {
-	return nopExportFormat
+func (ne *nopExporter) MetricsExportFormat() string {
+	return nopMetricsExportFormat
 }
 
 // NewNopTraceExporter creates an TraceExporter that just drops the received data.

exporter/exportertest/nop_exporter_test.go

@@ -31,8 +31,8 @@ func TestNopTraceExporterNoErrors(t *testing.T) {
 		t.Errorf("Wanted nil got error")
 		return
 	}
-	if "NopExporter" != nte.ExportFormat() {
-		t.Errorf("Wanted NopExporter got %s", nte.ExportFormat())
+	if "nop_trace" != nte.TraceExportFormat() {
+		t.Errorf("Wanted nop_trace got %s", nte.TraceExportFormat())
 		return
 	}
 }
@@ -46,8 +46,8 @@ func TestNoopMetricsExporterNoErrors(t *testing.T) {
 		t.Errorf("Wanted nil got error")
 		return
 	}
-	if "NopExporter" != nme.ExportFormat() {
-		t.Errorf("Wanted NopExporter got %s", nme.ExportFormat())
+	if "nop_metrics" != nme.MetricsExportFormat() {
+		t.Errorf("Wanted nop_metrics got %s", nme.MetricsExportFormat())
 		return
 	}
 }

exporter/exportertest/sink_exporter.go

@@ -40,11 +40,14 @@ func (ste *SinkTraceExporter) ProcessTraceData(ctx context.Context, td data.Trac
 	return nil
 }
 
-const sinkExportFormat = "SinkExporter"
+const (
+	sinkTraceExportFormat   = "sink_trace"
+	sinkMetricsExportFormat = "sink_metrics"
+)
 
-// ExportFormat retruns the name of this TraceExporter
-func (ste *SinkTraceExporter) ExportFormat() string {
-	return sinkExportFormat
+// TraceExportFormat retruns the name of this TraceExporter
+func (ste *SinkTraceExporter) TraceExportFormat() string {
+	return sinkTraceExportFormat
 }
 
 // AllTraces returns the traces sent to the test sink.
@@ -73,9 +76,9 @@ func (sme *SinkMetricsExporter) ProcessMetricsData(ctx context.Context, md data.
 	return nil
 }
 
-// ExportFormat retruns the name of this TraceExporter
-func (sme *SinkMetricsExporter) ExportFormat() string {
-	return sinkExportFormat
+// MetricsExportFormat retruns the name of this MetricsExporter
+func (sme *SinkMetricsExporter) MetricsExportFormat() string {
+	return sinkMetricsExportFormat
 }
 
 // AllMetrics returns the metrics sent to the test sink.

exporter/exportertest/sink_exporter_test.go

@@ -40,8 +40,8 @@ func TestSinkTraceExporter(t *testing.T) {
 	if !reflect.DeepEqual(got, want) {
 		t.Errorf("Mismatches responses\nGot:\n\t%v\nWant:\n\t%v\n", got, want)
 	}
-	if "SinkExporter" != sink.ExportFormat() {
-		t.Errorf("Wanted SinkExporter got %s", sink.ExportFormat())
+	if "sink_trace" != sink.TraceExportFormat() {
+		t.Errorf("Wanted sink_trace got %s", sink.TraceExportFormat())
 		return
 	}
 }
@@ -63,8 +63,8 @@ func TestSinkMetricsExporter(t *testing.T) {
 	if !reflect.DeepEqual(got, want) {
 		t.Errorf("Mismatches responses\nGot:\n\t%v\nWant:\n\t%v\n", got, want)
 	}
-	if "SinkExporter" != sink.ExportFormat() {
-		t.Errorf("Wanted SinkExporter got %s", sink.ExportFormat())
+	if "sink_metrics" != sink.MetricsExportFormat() {
+		t.Errorf("Wanted sink_metrics got %s", sink.MetricsExportFormat())
 		return
 	}
 }

exporter/factory.go

@@ -27,8 +27,10 @@ import (
 type TraceExporter interface {
 	processor.TraceDataProcessor
 
-	// ExportFormat gets the name of the format in which this exporter sends its data.
-	ExportFormat() string
+	// TraceExportFormat gets the name of the format in which this exporter sends its data.
+	// For exporters that can export multiple signals it is recommended to encode the signal
+	// as suffix (e.g. "oc_trace").
+	TraceExportFormat() string
 }
 
 // TraceExporterFactory is an interface that builds a new TraceExporter based on
@@ -50,8 +52,10 @@ type TraceExporterFactory interface {
 type MetricsExporter interface {
 	processor.MetricsDataProcessor
 
-	// ExportFormat gets the name of the format in which this exporter sends its data.
-	ExportFormat() string
+	// MetricsExportFormat gets the name of the format in which this exporter sends its data.
+	// For exporters that can export multiple signals it is recommended to encode the signal
+	// as suffix (e.g. "oc_metrics").
+	MetricsExportFormat() string
 }
 
 // MetricsExporterFactory is an interface that builds a new MetricsExporter based on

exporter/loggingexporter/logging_exporter.go

@@ -23,7 +23,10 @@ import (
 	"go.uber.org/zap"
 )
 
-const exportFormat = "LoggingExporter"
+const (
+	traceExportFormat   = "logging_trace"
+	metricsExportFormat = "logging_metrics"
+)
 
 // A logging exporter that does not sends the data to any destination but logs debugging messages.
 type loggingExporter struct{ logger *zap.Logger }
@@ -36,7 +39,7 @@ func (le *loggingExporter) ProcessTraceData(ctx context.Context, td data.TraceDa
 	// TODO: Add ability to record the received data
 
 	// Even though we just log all the spans, we record 0 dropped spans.
-	observability.RecordTraceExporterMetrics(observability.ContextWithExporterName(ctx, "logging_trace"), len(td.Spans), 0)
+	observability.RecordTraceExporterMetrics(observability.ContextWithExporterName(ctx, traceExportFormat), len(td.Spans), 0)
 	return nil
 }
 
@@ -47,8 +50,12 @@ func (le *loggingExporter) ProcessMetricsData(ctx context.Context, md data.Metri
 	return nil
 }
 
-func (le *loggingExporter) ExportFormat() string {
-	return exportFormat
+func (le *loggingExporter) TraceExportFormat() string {
+	return traceExportFormat
+}
+
+func (le *loggingExporter) MetricsExportFormat() string {
+	return metricsExportFormat
 }
 
 // NewTraceExporter creates an exporter.TraceExporter that just drops the

exporter/loggingexporter/logging_exporter_test.go

@@ -33,14 +33,14 @@ func TestLoggingTraceExporterNoErrors(t *testing.T) {
 		t.Errorf("Wanted nil got error")
 		return
 	}
-	if "LoggingExporter" != lte.ExportFormat() {
-		t.Errorf("Wanted LoggingExporter got %v", lte.ExportFormat())
+	if "logging_trace" != lte.TraceExportFormat() {
+		t.Errorf("Wanted logging_trace got %v", lte.TraceExportFormat())
 	}
 }
 
 func TestLoggingTraceExporterRecordMetrics(t *testing.T) {
 	lte := NewTraceExporter(zap.NewNop())
-	observabilitytest.CheckRecordedMetricsForTraceExporter(t, lte, "logging_trace")
+	observabilitytest.CheckRecordedMetricsForTraceExporter(t, lte)
 }
 
 func TestLoggingMetricsExporterNoErrors(t *testing.T) {
@@ -52,7 +52,7 @@ func TestLoggingMetricsExporterNoErrors(t *testing.T) {
 		t.Errorf("Wanted nil got error")
 		return
 	}
-	if "LoggingExporter" != lme.ExportFormat() {
-		t.Errorf("Wanted LoggingExporter got %v", lme.ExportFormat())
+	if "logging_metrics" != lme.MetricsExportFormat() {
+		t.Errorf("Wanted logging_metrics got %v", lme.MetricsExportFormat())
 	}
 }

observability/observabilitytest/observabilitytest.go

@@ -43,7 +43,7 @@ func (cme *nopMetricsExporter) ExportView(vd *view.Data) {}
 
 // CheckRecordedMetricsForTraceExporter checks that the given TraceExporter records the correct set of metrics with the correct
 // set of tags by sending some TraceData to the exporter. The exporter should be able to handle the requests.
-func CheckRecordedMetricsForTraceExporter(t *testing.T, te exporter.TraceExporter, exporterTagName string) {
+func CheckRecordedMetricsForTraceExporter(t *testing.T, te exporter.TraceExporter) {
 	// Register a nop metrics exporter for the OC library.
 	nmp := new(nopMetricsExporter)
 	view.RegisterExporter(nmp)
@@ -98,8 +98,8 @@ func CheckRecordedMetricsForTraceExporter(t *testing.T, te exporter.TraceExporte
 		}
 	}
 
-	checkValueForExporterView(t, observability.ViewExporterReceivedSpans, exporterTagName, int64(numBatches*len(spans)))
-	checkValueForExporterView(t, observability.ViewExporterDroppedSpans, exporterTagName, 0)
+	checkValueForExporterView(t, observability.ViewExporterReceivedSpans, te.TraceExportFormat(), int64(numBatches*len(spans)))
+	checkValueForExporterView(t, observability.ViewExporterDroppedSpans, te.TraceExportFormat(), 0)
 }
 
 func checkValueForExporterView(t *testing.T, v *view.View, exporterTagName string, value int64) {