Unify trace and metric stdout exporters (#956)

* Consolidate stdout exporter * Move config to own file and match project standard * Abstract Exporter into unified struct * Rename trace part of the exporter * Update import paths and configuration * Update tests * Update InstallNewPipeline to not return traceProvider It is a registered global, access it that way. * Update example_test * Update docs * Update example to be for whole package * Update metric output Closer match the span output. * Clean up span output Print as a batch and cleanup marshaling. * Correct spelling error in doc * Add Exporters README * Update Changelog * Propagate changes to rest of project * Lint fixes * Fix example test in metric SDK * Add disable config options for trace and metric Co-authored-by: Liz Fong-Jones <lizf@honeycomb.io>
ljmsc · Jul 22, 2020 · 452256c · 452256c
1 parent f31d8ec
commit 452256c
Show file tree

Hide file tree

Showing 22 changed files with 746 additions and 593 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 - Jaeger exporter helpers: added InstallNewPipeline and removed RegisterGlobal option instead. (#944)
 - Zipkin exporter helpers: pipeline methods introduced, new exporter method adjusted. (#944)
+- The trace (`go.opentelemetry.io/otel/exporters/trace/stdout`) and metric (`go.opentelemetry.io/otel/exporters/metric/stdout`) `stdout` exporters are now merged into a single exporter at `go.opentelemetry.io/otel/exporters/stdout`. (#956)
 
 ## [0.9.0] - 2020-07-20
 

diff --git a/README.md b/README.md
@@ -38,25 +38,17 @@ import (
 	"log"
 
 	"go.opentelemetry.io/otel/api/global"
-	"go.opentelemetry.io/otel/exporters/trace/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 )
 
-func initTracer() {
-	exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
-	if err != nil {
-		log.Fatal(err)
-	}
-	tp, err := sdktrace.NewProvider(sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}),
-		sdktrace.WithSyncer(exporter))
+func main() {
+    pusher, err := stdout.InstallNewPipeline(nil, nil)
 	if err != nil {
 		log.Fatal(err)
 	}
-	global.SetTraceProvider(tp)
-}
+	defer pusher.Stop()
 
-func main() {
-	initTracer()
 	tracer := global.Tracer("ex.com/basic")
 
 	tracer.WithSpan(context.Background(), "foo",

diff --git a/api/global/internal/meter_test.go b/api/global/internal/meter_test.go
@@ -30,7 +30,7 @@ import (
 	"go.opentelemetry.io/otel/api/global/internal"
 	"go.opentelemetry.io/otel/api/kv"
 	"go.opentelemetry.io/otel/api/metric"
-	"go.opentelemetry.io/otel/exporters/metric/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	metrictest "go.opentelemetry.io/otel/internal/metric"
 )
 
@@ -243,10 +243,10 @@ func TestDefaultSDK(t *testing.T) {
 	counter.Add(ctx, 1, labels1...)
 
 	in, out := io.Pipe()
-	pusher, err := stdout.InstallNewPipeline(stdout.Config{
-		Writer:         out,
-		DoNotPrintTime: true,
-	})
+	pusher, err := stdout.InstallNewPipeline([]stdout.Option{
+		stdout.WithWriter(out),
+		stdout.WithoutTimestamps(),
+	}, nil)
 	if err != nil {
 		panic(err)
 	}
@@ -262,7 +262,7 @@ func TestDefaultSDK(t *testing.T) {
 	pusher.Stop()
 	out.Close()
 
-	require.Equal(t, `{"updates":[{"name":"test.builtin{instrumentation.name=builtin,A=B}","sum":1}]}
+	require.Equal(t, `[{"Name":"test.builtin{instrumentation.name=builtin,A=B}","Sum":1}]
 `, <-ch)
 }
 
@@ -408,10 +408,10 @@ func TestRecordBatchRealSDK(t *testing.T) {
 
 	var buf bytes.Buffer
 
-	pusher, err := stdout.InstallNewPipeline(stdout.Config{
-		Writer:         &buf,
-		DoNotPrintTime: true,
-	})
+	pusher, err := stdout.InstallNewPipeline([]stdout.Option{
+		stdout.WithWriter(&buf),
+		stdout.WithoutTimestamps(),
+	}, nil)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -420,6 +420,6 @@ func TestRecordBatchRealSDK(t *testing.T) {
 	meter.RecordBatch(context.Background(), nil, counter.Measurement(1))
 	pusher.Stop()
 
-	require.Equal(t, `{"updates":[{"name":"test.counter{instrumentation.name=builtin}","sum":1}]}
+	require.Equal(t, `[{"Name":"test.counter{instrumentation.name=builtin}","Sum":1}]
 `, buf.String())
 }
diff --git a/example/basic/main.go b/example/basic/main.go
@@ -23,11 +23,7 @@ import (
 	"go.opentelemetry.io/otel/api/kv"
 	"go.opentelemetry.io/otel/api/metric"
 	"go.opentelemetry.io/otel/api/trace"
-	metricstdout "go.opentelemetry.io/otel/exporters/metric/stdout"
-	tracestdout "go.opentelemetry.io/otel/exporters/trace/stdout"
-	"go.opentelemetry.io/otel/sdk/metric/controller/push"
-	"go.opentelemetry.io/otel/sdk/resource"
-	sdktrace "go.opentelemetry.io/otel/sdk/trace"
+	"go.opentelemetry.io/otel/exporters/stdout"
 )
 
 var (
@@ -37,37 +33,15 @@ var (
 	anotherKey = kv.Key("ex.com/another")
 )
 
-// initTracer creates and registers trace provider instance.
-func initTracer() {
-	var err error
-	exp, err := tracestdout.NewExporter(tracestdout.Options{PrettyPrint: false})
-	if err != nil {
-		log.Panicf("failed to initialize trace stdout exporter %v", err)
-		return
-	}
-	tp, err := sdktrace.NewProvider(sdktrace.WithSyncer(exp),
-		sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}),
-		sdktrace.WithResource(resource.New(kv.String("rk1", "rv11"), kv.Int64("rk2", 5))))
-	if err != nil {
-		log.Panicf("failed to initialize trace provider %v", err)
-	}
-	global.SetTraceProvider(tp)
-}
-
-func initMeter() *push.Controller {
-	pusher, err := metricstdout.InstallNewPipeline(metricstdout.Config{
-		Quantiles:   []float64{0.5, 0.9, 0.99},
-		PrettyPrint: false,
-	})
+func main() {
+	pusher, err := stdout.InstallNewPipeline([]stdout.Option{
+		stdout.WithQuantiles([]float64{0.5, 0.9, 0.99}),
+		stdout.WithPrettyPrint(),
+	}, nil)
 	if err != nil {
-		log.Panicf("failed to initialize metric stdout exporter %v", err)
+		log.Fatalf("failed to initialize stdout export pipeline: %v", err)
 	}
-	return pusher
-}
-
-func main() {
-	defer initMeter().Stop()
-	initTracer()
+	defer pusher.Stop()
 
 	tracer := global.Tracer("ex.com/basic")
 	meter := global.Meter("ex.com/basic")
@@ -93,7 +67,7 @@ func main() {
 	valuerecorder := valuerecorderTwo.Bind(commonLabels...)
 	defer valuerecorder.Unbind()
 
-	err := tracer.WithSpan(ctx, "operation", func(ctx context.Context) error {
+	err = tracer.WithSpan(ctx, "operation", func(ctx context.Context) error {
 
 		trace.SpanFromContext(ctx).AddEvent(ctx, "Nice operation!", kv.Key("bogons").Int(100))
 

diff --git a/example/grpc/config/config.go b/example/grpc/config/config.go
@@ -18,13 +18,13 @@ import (
 	"log"
 
 	"go.opentelemetry.io/otel/api/global"
-	"go.opentelemetry.io/otel/exporters/trace/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 )
 
 // Init configures an OpenTelemetry exporter and trace provider
 func Init() {
-	exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
+	exporter, err := stdout.NewExporter(stdout.WithPrettyPrint())
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/example/http/client/client.go b/example/http/client/client.go
@@ -30,15 +30,15 @@ import (
 
 	"go.opentelemetry.io/otel/api/correlation"
 	"go.opentelemetry.io/otel/api/global"
-	"go.opentelemetry.io/otel/exporters/trace/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	"go.opentelemetry.io/otel/instrumentation/httptrace"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 )
 
 func initTracer() {
 	// Create stdout exporter to be able to retrieve
 	// the collected spans.
-	exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
+	exporter, err := stdout.NewExporter(stdout.WithPrettyPrint())
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/example/http/server/server.go b/example/http/server/server.go
@@ -23,7 +23,7 @@ import (
 	"go.opentelemetry.io/otel/api/global"
 	"go.opentelemetry.io/otel/api/standard"
 	"go.opentelemetry.io/otel/api/trace"
-	"go.opentelemetry.io/otel/exporters/trace/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	"go.opentelemetry.io/otel/instrumentation/httptrace"
 	"go.opentelemetry.io/otel/sdk/resource"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
@@ -32,7 +32,7 @@ import (
 func initTracer() {
 	// Create stdout exporter to be able to retrieve
 	// the collected spans.
-	exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
+	exporter, err := stdout.NewExporter(stdout.WithPrettyPrint())
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/example/namedtracer/main.go b/example/namedtracer/main.go
@@ -24,7 +24,7 @@ import (
 	"go.opentelemetry.io/otel/api/global"
 	"go.opentelemetry.io/otel/api/trace"
 	"go.opentelemetry.io/otel/example/namedtracer/foo"
-	"go.opentelemetry.io/otel/exporters/trace/stdout"
+	"go.opentelemetry.io/otel/exporters/stdout"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 )
 
@@ -39,7 +39,7 @@ var tp *sdktrace.Provider
 // initTracer creates and registers trace provider instance.
 func initTracer() {
 	var err error
-	exp, err := stdout.NewExporter(stdout.Options{})
+	exp, err := stdout.NewExporter(stdout.WithPrettyPrint())
 	if err != nil {
 		log.Panicf("failed to initialize stdout exporter %v\n", err)
 		return

diff --git a/exporters/README.md b/exporters/README.md
@@ -0,0 +1,18 @@
+# Exporters
+
+Included in this directory are exporters that export both metric and trace telemetry.
+
+- [stdout](./stdout): Writes telemetry to a specified local output as structured JSON.
+- [otlp](./otlp): Sends telemetry to an OpenTelemetry collector as OTLP.
+
+Additionally, there are [metric](./metric) and [trace](./trace) only exporters.
+
+## Metric Telemetry Only
+
+- [prometheus](./metric/prometheus): Exposes metric telemetry as Prometheus metrics.
+- [test](./metric/test): A development tool when testing the telemetry pipeline.
+
+## Trace Telemetry Only
+
+- [jaeger](./trace/jaeger): Sends properly transformed trace telemetry to a Jaeger endpoint.
+- [zipkin](./trace/zipkin): Sends properly transformed trace telemetry to a Zipkin endpoint.
diff --git a/exporters/metric/stdout/example_test.go b/exporters/metric/stdout/example_test.go