From ec01f5b32fb8c2ac00d8a9d63a4f36a31327fb75 Mon Sep 17 00:00:00 2001 From: David Ashpole Date: Thu, 13 May 2021 06:06:00 -0700 Subject: [PATCH 1/4] Add passthrough example --- .github/dependabot.yml | 10 +++ .gitignore | 1 + CHANGELOG.md | 1 + bridge/opencensus/go.mod | 2 + bridge/opentracing/go.mod | 2 + example/jaeger/go.mod | 2 + example/namedtracer/go.mod | 2 + example/opencensus/go.mod | 2 + example/otel-collector/go.mod | 2 + example/passthrough/README.md | 45 +++++++++++++ example/passthrough/go.mod | 57 +++++++++++++++++ example/passthrough/go.sum | 17 +++++ example/passthrough/handler/handler.go | 75 ++++++++++++++++++++++ example/passthrough/main.go | 89 ++++++++++++++++++++++++++ example/prom-collector/go.mod | 2 + example/prometheus/go.mod | 2 + example/zipkin/go.mod | 2 + exporters/metric/prometheus/go.mod | 2 + exporters/otlp/go.mod | 2 + exporters/stdout/go.mod | 2 + exporters/trace/jaeger/go.mod | 2 + exporters/trace/zipkin/go.mod | 2 + go.mod | 2 + internal/tools/go.mod | 2 + metric/go.mod | 2 + oteltest/go.mod | 2 + sdk/export/metric/go.mod | 2 + sdk/go.mod | 2 + sdk/metric/go.mod | 2 + trace/go.mod | 2 + 30 files changed, 339 insertions(+) create mode 100644 example/passthrough/README.md create mode 100644 example/passthrough/go.mod create mode 100644 example/passthrough/go.sum create mode 100644 example/passthrough/handler/handler.go create mode 100644 example/passthrough/main.go diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ee3196450d6..317913957ae 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -96,6 +96,16 @@ updates: schedule: day: sunday interval: weekly + - + package-ecosystem: gomod + directory: /example/passthrough + labels: + - dependencies + - go + - "Skip Changelog" + schedule: + day: sunday + interval: weekly - package-ecosystem: gomod directory: /example/prometheus diff --git a/.gitignore b/.gitignore index 69f09e575fc..f798ce8fbf7 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ gen/ /example/jaeger/jaeger /example/namedtracer/namedtracer /example/opencensus/opencensus +/example/passthrough/passthrough /example/prometheus/prometheus /example/prom-collector/prom-collector /example/zipkin/zipkin diff --git a/CHANGELOG.md b/CHANGELOG.md index af0c2db0607..cdc9d5c90bd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - The `SpanStub` type and its associated functions were added to the `go.opentelemetry.io/otel/sdk/trace/tracetest` package. This type can be used as a testing replacement for the `SpanSnapshot` that was removed from the `go.opentelemetry.io/otel/sdk/trace` package. (#1873) - Adds support for scheme in `OTEL_EXPORTER_OTLP_ENDPOINT` according to the spec. (#1886) +- An example of using OpenTelemetry Go as a trace context forwarder. (#1912) ### Changed diff --git a/bridge/opencensus/go.mod b/bridge/opencensus/go.mod index 7a89e5fac84..423a5ed7023 100644 --- a/bridge/opencensus/go.mod +++ b/bridge/opencensus/go.mod @@ -55,3 +55,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/bridge/opentracing/go.mod b/bridge/opentracing/go.mod index 218df8b7da2..5b39b2b862a 100644 --- a/bridge/opentracing/go.mod +++ b/bridge/opentracing/go.mod @@ -51,3 +51,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/example/jaeger/go.mod b/example/jaeger/go.mod index c246f2898dc..4542505a0bc 100644 --- a/example/jaeger/go.mod +++ b/example/jaeger/go.mod @@ -51,3 +51,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/namedtracer/go.mod b/example/namedtracer/go.mod index 6a57f10219f..043eeaa7627 100644 --- a/example/namedtracer/go.mod +++ b/example/namedtracer/go.mod @@ -52,3 +52,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/opencensus/go.mod b/example/opencensus/go.mod index 3106c5c80ab..8db092fe7a4 100644 --- a/example/opencensus/go.mod +++ b/example/opencensus/go.mod @@ -53,3 +53,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/otel-collector/go.mod b/example/otel-collector/go.mod index 1a8aa65b8a4..d78970a7052 100644 --- a/example/otel-collector/go.mod +++ b/example/otel-collector/go.mod @@ -55,3 +55,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/passthrough/README.md b/example/passthrough/README.md new file mode 100644 index 00000000000..121f71d48a1 --- /dev/null +++ b/example/passthrough/README.md @@ -0,0 +1,45 @@ +# "Passthrough" setup for OpenTelemetry + +Some go programs may wish to propagate context without recording spans. To do this in OpenTelemetry, simply install `TextMapPropagators`, but do not install a TracerProvider using the SDK. This works because the default TracerProvider implementation returns a "Non-Recording" span that keeps the context of the caller, but does not record spans. + +For example, when you initialize your global settings, the following will propagate context without recording spans: + +```golang +// Setup Propagators only +otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) +``` + +But the following will propagate context _and_ create new, potentially recorded spans: + +```golang +// Setup SDK +exp, _ := stdout.NewExporter(stdout.WithPrettyPrint()) +tp = sdktrace.NewTracerProvider( + sdktrace.WithSpanProcessor(sdktrace.NewBatchSpanProcessor(exp)), +) +otel.SetTracerProvider(tp) +// Setup Propagators +otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) +``` + +## The Demo + +The demo has the following call structure: + +`Outer -> Passthrough -> Inner` + +If all components had both an SDK and propagators registered, we would expect the trace to look like: + +``` +|-------outer---------| + |-Passthrough recv-| + |Passthrough send| + |---inner---| +``` + +However, in this demo, only the outer and inner have TracerProvider backed by the SDK. All components have Propagators set. In this case, we expect to see: + +``` +|-------outer---------| + |---inner---| +``` diff --git a/example/passthrough/go.mod b/example/passthrough/go.mod new file mode 100644 index 00000000000..938df4a03e0 --- /dev/null +++ b/example/passthrough/go.mod @@ -0,0 +1,57 @@ +module go.opentelemetry.io/otel/example/passthrough + +go 1.16 + +require ( + go.opentelemetry.io/otel v0.20.0 + go.opentelemetry.io/otel/exporters/stdout v0.20.0 + go.opentelemetry.io/otel/sdk v0.20.0 + go.opentelemetry.io/otel/trace v0.20.0 +) + +replace ( + go.opentelemetry.io/otel => ../.. + go.opentelemetry.io/otel/exporters/stdout => ../../exporters/stdout + go.opentelemetry.io/otel/sdk => ../../sdk + go.opentelemetry.io/otel/trace => ../../trace +) + +replace go.opentelemetry.io/otel/bridge/opencensus => ../../bridge/opencensus + +replace go.opentelemetry.io/otel/bridge/opentracing => ../../bridge/opentracing + +replace go.opentelemetry.io/otel/example/jaeger => ../jaeger + +replace go.opentelemetry.io/otel/example/namedtracer => ../namedtracer + +replace go.opentelemetry.io/otel/example/opencensus => ../opencensus + +replace go.opentelemetry.io/otel/example/otel-collector => ../otel-collector + +replace go.opentelemetry.io/otel/example/passthrough => ./ + +replace go.opentelemetry.io/otel/example/prom-collector => ../prom-collector + +replace go.opentelemetry.io/otel/example/prometheus => ../prometheus + +replace go.opentelemetry.io/otel/example/zipkin => ../zipkin + +replace go.opentelemetry.io/otel/exporters/metric/prometheus => ../../exporters/metric/prometheus + +replace go.opentelemetry.io/otel/exporters/otlp => ../../exporters/otlp + +replace go.opentelemetry.io/otel/exporters/trace/jaeger => ../../exporters/trace/jaeger + +replace go.opentelemetry.io/otel/exporters/trace/zipkin => ../../exporters/trace/zipkin + +replace go.opentelemetry.io/otel/internal/tools => ../../internal/tools + +replace go.opentelemetry.io/otel/metric => ../../metric + +replace go.opentelemetry.io/otel/oteltest => ../../oteltest + +replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric + +replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric + +replace go.opentelemetry.io/otel/sdk/trace => ../../sdk/trace diff --git a/example/passthrough/go.sum b/example/passthrough/go.sum new file mode 100644 index 00000000000..aa2d32aaea3 --- /dev/null +++ b/example/passthrough/go.sum @@ -0,0 +1,17 @@ +github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8= +github.com/benbjohnson/clock v1.1.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/example/passthrough/handler/handler.go b/example/passthrough/handler/handler.go new file mode 100644 index 00000000000..cc1abf5c175 --- /dev/null +++ b/example/passthrough/handler/handler.go @@ -0,0 +1,75 @@ +// Copyright The OpenTelemetry 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 handler + +import ( + "context" + "log" + "net/http" + "time" + + "go.opentelemetry.io/otel" + "go.opentelemetry.io/otel/propagation" + "go.opentelemetry.io/otel/trace" +) + +// handler is a minimal implementation of the handler and client from +// go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp for demonstration purposes. +// It handles an incoming http request, and makes an outgoing http request. +type Handler struct { + propagators propagation.TextMapPropagator + tracer trace.Tracer + next func(r *http.Request) +} + +func New(next func(r *http.Request)) *Handler { + // Like most instrumentation packages, this handler defaults to using the + // global progatators and tracer providers. + return &Handler{ + propagators: otel.GetTextMapPropagator(), + tracer: otel.GetTracerProvider().Tracer("examples/passthrough/handler"), + next: next, + } +} + +// HandleHTTPReq mimics what an instrumented http server does +func (h *Handler) HandleHTTPReq(r *http.Request) { + ctx := h.propagators.Extract(r.Context(), propagation.HeaderCarrier(r.Header)) + var span trace.Span + log.Println("The \"handle passthrough request\" span should NOT be recorded, because it is recorded by a TracerProvider not backed by the SDK.") + ctx, span = h.tracer.Start(ctx, "handle passthrough request") + defer span.End() + + // Pretend to do work + time.Sleep(time.Second) + + h.makeOutgoingRequest(ctx) +} + +// makeOutgoingRequest mimics what an instrumented http client does +func (h *Handler) makeOutgoingRequest(ctx context.Context) { + // make a new http request + r, err := http.NewRequest("", "", nil) + if err != nil { + panic(err) + } + + log.Println("The \"make outgoing request from passthrough\" span should NOT be recorded, because it is recorded by a TracerProvider not backed by the SDK.") + ctx, span := h.tracer.Start(ctx, "make outgoing request from passthrough") + defer span.End() + r = r.WithContext(ctx) + h.propagators.Inject(ctx, propagation.HeaderCarrier(r.Header)) + h.next(r) +} diff --git a/example/passthrough/main.go b/example/passthrough/main.go new file mode 100644 index 00000000000..0974096ad68 --- /dev/null +++ b/example/passthrough/main.go @@ -0,0 +1,89 @@ +// Copyright The OpenTelemetry 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 main + +import ( + "context" + "log" + "net/http" + "time" + + "go.opentelemetry.io/otel" + "go.opentelemetry.io/otel/example/passthrough/handler" + "go.opentelemetry.io/otel/exporters/stdout" + "go.opentelemetry.io/otel/propagation" + sdktrace "go.opentelemetry.io/otel/sdk/trace" + "go.opentelemetry.io/otel/trace" +) + +func main() { + ctx := context.Background() + + initPassthroughGlobals() + tp := nonGlobalTracer() + defer func() { _ = tp.Shutdown(ctx) }() + + // make an initial http request + r, err := http.NewRequest("", "", nil) + if err != nil { + panic(err) + } + + // This is roughly what an instrumented http client does. + log.Println("The \"make outer request\" span should be recorded, because it is recorded with a Tracer from the SDK TracerProvider") + var span trace.Span + ctx, span = tp.Tracer("example/passthrough/outer").Start(ctx, "make outer request") + defer span.End() + r = r.WithContext(ctx) + otel.GetTextMapPropagator().Inject(ctx, propagation.HeaderCarrier(r.Header)) + + backendFunc := func(r *http.Request) { + // This is roughly what an instrumented http server does. + ctx := otel.GetTextMapPropagator().Extract(r.Context(), propagation.HeaderCarrier(r.Header)) + log.Println("The \"handle inner request\" span should be recorded, because it is recorded with a Tracer from the SDK TracerProvider") + _, span := tp.Tracer("example/passthrough/inner").Start(ctx, "handle inner request") + defer span.End() + + // Do "backend work" + time.Sleep(time.Second) + } + // This handler will be a passthrough, since we didn't set a global TracerProvider + passthroughHandler := handler.New(backendFunc) + passthroughHandler.HandleHTTPReq(r) +} + +func initPassthroughGlobals() { + // We explicitly DO NOT set the global TracerProvider using otel.SetTracerProvider(). + // The unset TracerProvider returns a "non-recording" span, but still passes through context. + log.Println("Register a global TextMapPropagator, but do not register a global TracerProvider to be in \"passthrough\" mode.") + log.Println("The \"passthrough\" mode propagates the TraceContext and Baggage, but does not record spans.") + otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) +} + +// nonGlobalTracer creates a trace provider instance for testing, but doesn't +// set it as the global tracer provider +func nonGlobalTracer() *sdktrace.TracerProvider { + var err error + exp, err := stdout.NewExporter(stdout.WithPrettyPrint()) + if err != nil { + log.Panicf("failed to initialize stdout exporter %v\n", err) + } + bsp := sdktrace.NewBatchSpanProcessor(exp) + tp := sdktrace.NewTracerProvider( + sdktrace.WithSampler(sdktrace.AlwaysSample()), + sdktrace.WithSpanProcessor(bsp), + ) + return tp +} diff --git a/example/prom-collector/go.mod b/example/prom-collector/go.mod index 37299321977..6100e025dad 100644 --- a/example/prom-collector/go.mod +++ b/example/prom-collector/go.mod @@ -54,3 +54,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/prometheus/go.mod b/example/prometheus/go.mod index eb1c30c16ef..1c4be1cf10f 100644 --- a/example/prometheus/go.mod +++ b/example/prometheus/go.mod @@ -51,3 +51,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/example/zipkin/go.mod b/example/zipkin/go.mod index 465f57b39c8..8f5211b673f 100644 --- a/example/zipkin/go.mod +++ b/example/zipkin/go.mod @@ -52,3 +52,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../passthrough diff --git a/exporters/metric/prometheus/go.mod b/exporters/metric/prometheus/go.mod index f060b7f7447..2df40dc5f54 100644 --- a/exporters/metric/prometheus/go.mod +++ b/exporters/metric/prometheus/go.mod @@ -56,3 +56,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../../example/passthrough diff --git a/exporters/otlp/go.mod b/exporters/otlp/go.mod index 3ab54c7e96c..f96eb308d1d 100644 --- a/exporters/otlp/go.mod +++ b/exporters/otlp/go.mod @@ -62,3 +62,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/exporters/stdout/go.mod b/exporters/stdout/go.mod index 95f5b5d991a..d64847ecd1d 100644 --- a/exporters/stdout/go.mod +++ b/exporters/stdout/go.mod @@ -56,3 +56,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/exporters/trace/jaeger/go.mod b/exporters/trace/jaeger/go.mod index 85ad454d459..9de881eff27 100644 --- a/exporters/trace/jaeger/go.mod +++ b/exporters/trace/jaeger/go.mod @@ -54,3 +54,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../../example/passthrough diff --git a/exporters/trace/zipkin/go.mod b/exporters/trace/zipkin/go.mod index 5dda102acb1..56bc14ec6d7 100644 --- a/exporters/trace/zipkin/go.mod +++ b/exporters/trace/zipkin/go.mod @@ -55,3 +55,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../../example/passthrough diff --git a/go.mod b/go.mod index 3dc07a76b4e..f0b68994c74 100644 --- a/go.mod +++ b/go.mod @@ -53,3 +53,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ./sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ./sdk/metric replace go.opentelemetry.io/otel/trace => ./trace + +replace go.opentelemetry.io/otel/example/passthrough => ./example/passthrough diff --git a/internal/tools/go.mod b/internal/tools/go.mod index 2a7a9e2eb04..29319fd55ed 100644 --- a/internal/tools/go.mod +++ b/internal/tools/go.mod @@ -54,3 +54,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ../../sdk/export/metric replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric replace go.opentelemetry.io/otel/trace => ../../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/metric/go.mod b/metric/go.mod index c95f3e4fe02..abc6b1c4da4 100644 --- a/metric/go.mod +++ b/metric/go.mod @@ -52,3 +52,5 @@ require ( go.opentelemetry.io/otel v0.20.0 go.opentelemetry.io/otel/oteltest v0.20.0 ) + +replace go.opentelemetry.io/otel/example/passthrough => ../example/passthrough diff --git a/oteltest/go.mod b/oteltest/go.mod index f13318dcda0..cb37a2aad1d 100644 --- a/oteltest/go.mod +++ b/oteltest/go.mod @@ -51,3 +51,5 @@ require ( go.opentelemetry.io/otel/metric v0.20.0 go.opentelemetry.io/otel/trace v0.20.0 ) + +replace go.opentelemetry.io/otel/example/passthrough => ../example/passthrough diff --git a/sdk/export/metric/go.mod b/sdk/export/metric/go.mod index 41b9c4dc1a2..33b2ec7b474 100644 --- a/sdk/export/metric/go.mod +++ b/sdk/export/metric/go.mod @@ -52,3 +52,5 @@ require ( go.opentelemetry.io/otel/metric v0.20.0 go.opentelemetry.io/otel/sdk v0.20.0 ) + +replace go.opentelemetry.io/otel/example/passthrough => ../../../example/passthrough diff --git a/sdk/go.mod b/sdk/go.mod index 7b7b04465aa..e82a23b10cf 100644 --- a/sdk/go.mod +++ b/sdk/go.mod @@ -53,3 +53,5 @@ replace go.opentelemetry.io/otel/sdk/export/metric => ./export/metric replace go.opentelemetry.io/otel/sdk/metric => ./metric replace go.opentelemetry.io/otel/trace => ../trace + +replace go.opentelemetry.io/otel/example/passthrough => ../example/passthrough diff --git a/sdk/metric/go.mod b/sdk/metric/go.mod index 49b21c84338..06a95afa226 100644 --- a/sdk/metric/go.mod +++ b/sdk/metric/go.mod @@ -54,3 +54,5 @@ require ( go.opentelemetry.io/otel/sdk v0.20.0 go.opentelemetry.io/otel/sdk/export/metric v0.20.0 ) + +replace go.opentelemetry.io/otel/example/passthrough => ../../example/passthrough diff --git a/trace/go.mod b/trace/go.mod index dbb43bdfb62..48c8a4bc456 100644 --- a/trace/go.mod +++ b/trace/go.mod @@ -51,3 +51,5 @@ require ( github.com/stretchr/testify v1.7.0 go.opentelemetry.io/otel v0.20.0 ) + +replace go.opentelemetry.io/otel/example/passthrough => ../example/passthrough From f0a31cbe05d6c4d8e0a81638aca67730c204068b Mon Sep 17 00:00:00 2001 From: David Ashpole Date: Thu, 13 May 2021 12:10:26 -0400 Subject: [PATCH 2/4] Update example/passthrough/handler/handler.go Co-authored-by: Tyler Yahn --- example/passthrough/handler/handler.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/passthrough/handler/handler.go b/example/passthrough/handler/handler.go index cc1abf5c175..2ed681d0d59 100644 --- a/example/passthrough/handler/handler.go +++ b/example/passthrough/handler/handler.go @@ -39,7 +39,7 @@ func New(next func(r *http.Request)) *Handler { // global progatators and tracer providers. return &Handler{ propagators: otel.GetTextMapPropagator(), - tracer: otel.GetTracerProvider().Tracer("examples/passthrough/handler"), + tracer: otel.Tracer("examples/passthrough/handler"), next: next, } } From 2f576f8f8bd2e36907d28441de164728f700a3c3 Mon Sep 17 00:00:00 2001 From: David Ashpole Date: Thu, 13 May 2021 12:10:49 -0400 Subject: [PATCH 3/4] Update example/passthrough/README.md Co-authored-by: Tyler Yahn --- example/passthrough/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/passthrough/README.md b/example/passthrough/README.md index 121f71d48a1..1f794568a09 100644 --- a/example/passthrough/README.md +++ b/example/passthrough/README.md @@ -15,7 +15,7 @@ But the following will propagate context _and_ create new, potentially recorded // Setup SDK exp, _ := stdout.NewExporter(stdout.WithPrettyPrint()) tp = sdktrace.NewTracerProvider( - sdktrace.WithSpanProcessor(sdktrace.NewBatchSpanProcessor(exp)), + sdktrace.WithBatcher(exp), ) otel.SetTracerProvider(tp) // Setup Propagators From 82e40926b22f5947e0547e4f5aa07251ba3449eb Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Tue, 18 May 2021 14:39:16 +0000 Subject: [PATCH 4/4] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Pająk --- example/passthrough/README.md | 4 ++-- example/passthrough/handler/handler.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/example/passthrough/README.md b/example/passthrough/README.md index 1f794568a09..282ae4f3512 100644 --- a/example/passthrough/README.md +++ b/example/passthrough/README.md @@ -1,6 +1,6 @@ # "Passthrough" setup for OpenTelemetry -Some go programs may wish to propagate context without recording spans. To do this in OpenTelemetry, simply install `TextMapPropagators`, but do not install a TracerProvider using the SDK. This works because the default TracerProvider implementation returns a "Non-Recording" span that keeps the context of the caller, but does not record spans. +Some Go programs may wish to propagate context without recording spans. To do this in OpenTelemetry, simply install `TextMapPropagators`, but do not install a TracerProvider using the SDK. This works because the default TracerProvider implementation returns a "Non-Recording" span that keeps the context of the caller but does not record spans. For example, when you initialize your global settings, the following will propagate context without recording spans: @@ -37,7 +37,7 @@ If all components had both an SDK and propagators registered, we would expect th |---inner---| ``` -However, in this demo, only the outer and inner have TracerProvider backed by the SDK. All components have Propagators set. In this case, we expect to see: +However, in this demo, only the outer and inner have TracerProvider backed by the SDK. All components have Propagators set. In this case, we expect to see: ``` |-------outer---------| diff --git a/example/passthrough/handler/handler.go b/example/passthrough/handler/handler.go index 2ed681d0d59..4b8f7a53306 100644 --- a/example/passthrough/handler/handler.go +++ b/example/passthrough/handler/handler.go @@ -25,7 +25,7 @@ import ( "go.opentelemetry.io/otel/trace" ) -// handler is a minimal implementation of the handler and client from +// Handler is a minimal implementation of the handler and client from // go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp for demonstration purposes. // It handles an incoming http request, and makes an outgoing http request. type Handler struct {