Skip to content

Commit

Permalink
Add options to opencensus bridge, and install tracer instead of retur…
Browse files Browse the repository at this point in the history
…ning (#4567)

* Add options to opencensus bridge, and install tracer instead of returning

* add unit test

* update unit tests

* fix example

* import ordering

---------

Co-authored-by: Tyler Yahn <[email protected]>
  • Loading branch information
dashpole and MrAlias authored Sep 29, 2023
1 parent 0022098 commit 0f09b9b
Show file tree
Hide file tree
Showing 7 changed files with 149 additions and 12 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased]

### Added

- Add `go.opentelemetry.io/otel/bridge/opencensus.InstallTraceBridge`, which installs the OpenCensus trace bridge, and replaces `opencensus.NewTracer`. (#4567)

### Deprecated

- Deprecate `go.opentelemetry.io/otel/bridge/opencensus.NewTracer` in favor of `opencensus.InstallTraceBridge`. (#4567)

## [1.19.0/0.42.0/0.0.7] 2023-09-28

This release contains the first stable release of the OpenTelemetry Go [metric SDK].
Expand Down
65 changes: 65 additions & 0 deletions bridge/opencensus/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// 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 opencensus // import "go.opentelemetry.io/otel/bridge/opencensus"

import (
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/trace"
)

const scopeName = "go.opentelemetry.io/otel/bridge/opencensus"

// newTraceConfig returns a config configured with options.
func newTraceConfig(options []TraceOption) traceConfig {
conf := traceConfig{tp: otel.GetTracerProvider()}
for _, o := range options {
conf = o.apply(conf)
}
return conf
}

type traceConfig struct {
tp trace.TracerProvider
}

// TraceOption applies a configuration option value to an OpenCensus bridge
// Tracer.
type TraceOption interface {
apply(traceConfig) traceConfig
}

// traceOptionFunc applies a set of options to a config.
type traceOptionFunc func(traceConfig) traceConfig

// apply returns a config with option(s) applied.
func (o traceOptionFunc) apply(conf traceConfig) traceConfig {
return o(conf)
}

// WithTracerProvider specifies a tracer provider to use for creating a tracer.
func WithTracerProvider(tp trace.TracerProvider) TraceOption {
return traceOptionFunc(func(conf traceConfig) traceConfig {
conf.tp = tp
return conf
})
}

type metricConfig struct{}

// MetricOption applies a configuration option value to an OpenCensus bridge
// MetricProducer.
type MetricOption interface {
apply(metricConfig) metricConfig
}
56 changes: 56 additions & 0 deletions bridge/opencensus/config_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
// 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 opencensus // import "go.opentelemetry.io/otel/bridge/opencensus"

import (
"testing"

"github.com/stretchr/testify/assert"

"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/trace"
)

func TestNewTraceConfig(t *testing.T) {
globalTP := trace.NewNoopTracerProvider()
customTP := trace.NewNoopTracerProvider()
otel.SetTracerProvider(globalTP)
for _, tc := range []struct {
desc string
opts []TraceOption
expected traceConfig
}{
{
desc: "default",
expected: traceConfig{
tp: globalTP,
},
},
{
desc: "overridden",
opts: []TraceOption{
WithTracerProvider(customTP),
},
expected: traceConfig{
tp: customTP,
},
},
} {
t.Run(tc.desc, func(t *testing.T) {
cfg := newTraceConfig(tc.opts)
assert.Equal(t, tc.expected, cfg)
})
}
}
4 changes: 1 addition & 3 deletions bridge/opencensus/metric.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,13 @@ import (
"go.opentelemetry.io/otel/sdk/metric/metricdata"
)

const scopeName = "go.opentelemetry.io/otel/bridge/opencensus"

type producer struct {
manager *metricproducer.Manager
}

// NewMetricProducer returns a metric.Producer that fetches metrics from
// OpenCensus.
func NewMetricProducer() metric.Producer {
func NewMetricProducer(opts ...MetricOption) metric.Producer {
return &producer{
manager: metricproducer.GlobalManager(),
}
Expand Down
12 changes: 6 additions & 6 deletions bridge/opencensus/test/bridge_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func TestMixedAPIs(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
tracer := tp.Tracer("mixedapitracer")
octrace.DefaultTracer = ocbridge.NewTracer(tracer)
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))

func() {
ctx := context.Background()
Expand Down Expand Up @@ -77,7 +77,7 @@ func TestMixedAPIs(t *testing.T) {
func TestStartOptions(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
octrace.DefaultTracer = ocbridge.NewTracer(tp.Tracer("startoptionstracer"))
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))

ctx := context.Background()
_, span := octrace.StartSpan(ctx, "OpenCensusSpan", octrace.WithSpanKind(octrace.SpanKindClient))
Expand All @@ -97,8 +97,8 @@ func TestStartOptions(t *testing.T) {
func TestStartSpanWithRemoteParent(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))
tracer := tp.Tracer("remoteparent")
octrace.DefaultTracer = ocbridge.NewTracer(tracer)

ctx := context.Background()
ctx, parent := tracer.Start(ctx, "OpenTelemetrySpan1")
Expand All @@ -120,8 +120,8 @@ func TestStartSpanWithRemoteParent(t *testing.T) {
func TestToFromContext(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))
tracer := tp.Tracer("tofromcontext")
octrace.DefaultTracer = ocbridge.NewTracer(tracer)

func() {
ctx := context.Background()
Expand Down Expand Up @@ -159,7 +159,7 @@ func TestToFromContext(t *testing.T) {
func TestIsRecordingEvents(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
octrace.DefaultTracer = ocbridge.NewTracer(tp.Tracer("isrecordingevents"))
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))

ctx := context.Background()
_, ocspan := octrace.StartSpan(ctx, "OpenCensusSpan1")
Expand All @@ -179,7 +179,7 @@ func attrsMap(s []attribute.KeyValue) map[attribute.Key]attribute.Value {
func TestSetThings(t *testing.T) {
sr := tracetest.NewSpanRecorder()
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
octrace.DefaultTracer = ocbridge.NewTracer(tp.Tracer("setthings"))
ocbridge.InstallTraceBridge(ocbridge.WithTracerProvider(tp))

ctx := context.Background()
_, ocspan := octrace.StartSpan(ctx, "OpenCensusSpan1")
Expand Down
11 changes: 11 additions & 0 deletions bridge/opencensus/trace.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,21 @@ import (
// NewTracer returns an implementation of the OpenCensus Tracer interface which
// uses OpenTelemetry APIs. Using this implementation of Tracer "upgrades"
// libraries that use OpenCensus to OpenTelemetry to facilitate a migration.
//
// Deprecated: Use InstallTraceBridge instead.
func NewTracer(tracer trace.Tracer) octrace.Tracer {
return internal.NewTracer(tracer)
}

// InstallTraceBridge installs the OpenCensus trace bridge, which overwrites
// the global OpenCensus tracer implementation. Once the bridge is installed,
// spans recorded using OpenCensus are redirected to the OpenTelemetry SDK.
func InstallTraceBridge(opts ...TraceOption) {
cfg := newTraceConfig(opts)
tracer := cfg.tp.Tracer(scopeName)
octrace.DefaultTracer = internal.NewTracer(tracer)
}

// OTelSpanContextToOC converts from an OpenTelemetry SpanContext to an
// OpenCensus SpanContext, and handles any incompatibilities with the global
// error handler.
Expand Down
5 changes: 2 additions & 3 deletions example/opencensus/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ func tracing(otExporter sdktrace.SpanExporter) {
otel.SetTracerProvider(tp)

log.Println("Installing the OpenCensus bridge to make OpenCensus libraries write spans using OpenTelemetry.")
tracer := tp.Tracer("simple")
octrace.DefaultTracer = opencensus.NewTracer(tracer)
opencensus.InstallTraceBridge()
tp.ForceFlush(ctx)

log.Println("Creating OpenCensus span, which should be printed out using the OpenTelemetry stdouttrace exporter.\n-- It should have no parent, since it is the first span.")
Expand All @@ -88,7 +87,7 @@ func tracing(otExporter sdktrace.SpanExporter) {
tp.ForceFlush(ctx)

log.Println("Creating OpenTelemetry span\n-- It should have the OpenCensus span as a parent, since the OpenCensus span was written with using OpenTelemetry APIs.")
ctx, otspan := tracer.Start(ctx, "OpenTelemetrySpan")
ctx, otspan := tp.Tracer("simple").Start(ctx, "OpenTelemetrySpan")
otspan.End()
tp.ForceFlush(ctx)

Expand Down

0 comments on commit 0f09b9b

Please sign in to comment.