go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-09-16 09:26:25 +02:00
Code Issues Releases Activity

Rename GetTracer to Tracer (#347)

Browse Source 
* Rename GetTracer to NewTracer

* Drop New prefix
This commit is contained in:
ferhat elmas
2019-11-25 18:46:07 +01:00
committed by rghetia
parent 059ca3ef6f
commit 0f052af2f4
26 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/trace/api.go
View File

@@ -24,9 +24,9 @@ import (
)
type Provider interface {
// GetTracer creates a named tracer that implements Tracer interface.
// Tracer creates a named tracer that implements Tracer interface.
// If the name is an empty string then provider uses default name.
GetTracer(name string) Tracer
Tracer(name string) Tracer
}
type Tracer interface {

4
api/trace/noop_trace_provider.go
View File

@@ -18,7 +18,7 @@ type NoopProvider struct{}
var _ Provider = NoopProvider{}
// GetTracer returns noop implementation of Tracer.
func (p NoopProvider) GetTracer(name string) Tracer {
// Tracer returns noop implementation of Tracer.
func (p NoopProvider) Tracer(name string) Tracer {
return NoopTracer{}
}

6
bridge/opentracing/mix_test.go
View File

@@ -423,7 +423,7 @@ func (tm *tracerMessTest) setup(t *testing.T, tracer *internal.MockTracer) {
func (tm *tracerMessTest) check(t *testing.T, tracer *internal.MockTracer) {
globalOtTracer := ot.GlobalTracer()
globalOtelTracer := global.TraceProvider().GetTracer("")
globalOtelTracer := global.TraceProvider().Tracer("")
if len(tm.recordedOTSpanTracers) != 3 {
t.Errorf("Expected 3 recorded OpenTracing tracers from spans, got %d", len(tm.recordedOTSpanTracers))
}
@@ -535,7 +535,7 @@ func min(a, b int) int {
}
func runOtelOTOtel(t *testing.T, ctx context.Context, name string, callback func(*testing.T, context.Context)) {
tr := global.TraceProvider().GetTracer("")
tr := global.TraceProvider().Tracer("")
ctx, span := tr.Start(ctx, fmt.Sprintf("%s_Otel_OTOtel", name), oteltrace.WithSpanKind(oteltrace.SpanKindClient))
defer span.End()
callback(t, ctx)
@@ -552,7 +552,7 @@ func runOtelOTOtel(t *testing.T, ctx context.Context, name string, callback func
}
func runOTOtelOT(t *testing.T, ctx context.Context, name string, callback func(*testing.T, context.Context)) {
tr := global.TraceProvider().GetTracer("")
tr := global.TraceProvider().Tracer("")
span, ctx := ot.StartSpanFromContext(ctx, fmt.Sprintf("%s_OT_OtelOT", name), ot.Tag{Key: "span.kind", Value: "client"})
defer span.Finish()
callback(t, ctx)

2
bridge/opentracing/util.go
View File

@@ -27,6 +27,6 @@ import (
func NewTracerPair(tracer oteltrace.Tracer) (*BridgeTracer, *WrapperProvider) {
bridgeTracer := NewBridgeTracer()
wrapperProvider := NewWrappedProvider(bridgeTracer, tracer)
bridgeTracer.SetOpenTelemetryTracer(wrapperProvider.GetTracer(""))
bridgeTracer.SetOpenTelemetryTracer(wrapperProvider.Tracer(""))
return bridgeTracer, wrapperProvider
}

6
bridge/opentracing/wrapper.go
View File

@@ -28,12 +28,12 @@ type WrapperProvider struct {
var _ oteltrace.Provider = (*WrapperProvider)(nil)
// GetTracer returns the WrapperTracer associated with the WrapperProvider.
func (p *WrapperProvider) GetTracer(name string) oteltrace.Tracer {
// Tracer returns the WrapperTracer associated with the WrapperProvider.
func (p *WrapperProvider) Tracer(name string) oteltrace.Tracer {
return p.wTracer
}
// WrapperProvider creates a new trace provider that creates a single
// NewWrappedProvider creates a new trace provider that creates a single
// instance of WrapperTracer that wraps OpenTelemetry tracer.
func NewWrappedProvider(bridge *BridgeTracer, tracer oteltrace.Tracer) *WrapperProvider {
return &WrapperProvider{

2
example/basic/main.go
View File

@@ -80,7 +80,7 @@ func main() {
// Note: Have to get the meter and tracer after the global is
// initialized. See OTEP 0005.
tracer := global.TraceProvider().GetTracer("ex.com/basic")
tracer := global.TraceProvider().Tracer("ex.com/basic")
meter := global.MeterProvider().GetMeter("ex.com/basic")
oneMetric := meter.NewFloat64Gauge("ex.com.one",

2
example/http-stackdriver/client/client.go
View File

@@ -59,7 +59,7 @@ func initTracer() {
func main() {
initTracer()
tr := global.TraceProvider().GetTracer("stackdriver/example/client")
tr := global.TraceProvider().Tracer("stackdriver/example/client")
client := http.DefaultClient
ctx := distributedcontext.NewContext(context.Background(),

2
example/http-stackdriver/server/server.go
View File

@@ -53,7 +53,7 @@ func initTracer() {
func main() {
initTracer()
tr := global.TraceProvider().GetTracer("stackdriver/example/server")
tr := global.TraceProvider().Tracer("stackdriver/example/server")
helloHandler := func(w http.ResponseWriter, req *http.Request) {
attrs, entries, spanCtx := httptrace.Extract(req.Context(), req)

2
example/http/client/client.go
View File

@@ -62,7 +62,7 @@ func main() {
var body []byte
tr := global.TraceProvider().GetTracer("example/client")
tr := global.TraceProvider().Tracer("example/client")
err := tr.WithSpan(ctx, "say hello",
func(ctx context.Context) error {
req, _ := http.NewRequest("GET", "http://localhost:7777/hello", nil)

2
example/http/server/server.go
View File

@@ -47,7 +47,7 @@ func initTracer() {
func main() {
initTracer()
tr := global.TraceProvider().GetTracer("example/server")
tr := global.TraceProvider().Tracer("example/server")
helloHandler := func(w http.ResponseWriter, req *http.Request) {
attrs, entries, spanCtx := httptrace.Extract(req.Context(), req)

4
example/jaeger/main.go
View File

@@ -66,14 +66,14 @@ func main() {
ctx := context.Background()
tr := global.TraceProvider().GetTracer("component-main")
tr := global.TraceProvider().Tracer("component-main")
ctx, span := tr.Start(ctx, "foo")
bar(ctx)
span.End()
}
func bar(ctx context.Context) {
tr := global.TraceProvider().GetTracer("component-bar")
tr := global.TraceProvider().Tracer("component-bar")
_, span := tr.Start(ctx, "bar")
defer span.End()

2
example/namedtracer/foo/foo.go
View File

@@ -32,7 +32,7 @@ func SubOperation(ctx context.Context) error {
// Using global provider. Alternative is to have application provide a getter
// for its component to get the instance of the provider.
tr := global.TraceProvider().GetTracer("example/namedtracer/foo")
tr := global.TraceProvider().Tracer("example/namedtracer/foo")
return tr.WithSpan(
ctx,
"Sub operation...",

2
example/namedtracer/main.go
View File

@@ -56,7 +56,7 @@ func main() {
initTracer()
// Create a named tracer with package path as its name.
tracer := tp.GetTracer("example/namedtracer/main")
tracer := tp.Tracer("example/namedtracer/main")
ctx := context.Background()
ctx = distributedcontext.NewContext(ctx,

2
exporter/trace/jaeger/jaeger_test.go
View File

@@ -111,7 +111,7 @@ func TestExporter_ExportSpan(t *testing.T) {
assert.NoError(t, err)
global.SetTraceProvider(tp)
_, span := global.TraceProvider().GetTracer("test-tracer").Start(context.Background(), "test-span")
_, span := global.TraceProvider().Tracer("test-tracer").Start(context.Background(), "test-span")
span.End()
assert.True(t, span.SpanContext().IsValid())

4
exporter/trace/stackdriver/stackdriver_test.go
View File

@@ -113,7 +113,7 @@ func TestExporter_ExportSpans(t *testing.T) {
assert.NoError(t, err)
global.SetTraceProvider(tp)
_, span := global.TraceProvider().GetTracer("test-tracer").Start(context.Background(), "test-span")
_, span := global.TraceProvider().Tracer("test-tracer").Start(context.Background(), "test-span")
span.End()
assert.True(t, span.SpanContext().IsValid())
@@ -145,7 +145,7 @@ func TestExporter_Timeout(t *testing.T) {
assert.NoError(t, err)
global.SetTraceProvider(tp)
_, span := global.TraceProvider().GetTracer("test-tracer").Start(context.Background(), "test-span")
_, span := global.TraceProvider().Tracer("test-tracer").Start(context.Background(), "test-span")
span.End()
assert.True(t, span.SpanContext().IsValid())

2
global/global.go
View File

@@ -39,7 +39,7 @@ var (
// TraceProvider returns the registered global trace provider.
// If none is registered then an instance of trace.NoopProvider is returned.
// Use the trace provider to create a named tracer. E.g.
// tracer := global.TraceProvider().GetTracer("example.com/foo")
// tracer := global.TraceProvider().Tracer("example.com/foo")
func TraceProvider() trace.Provider {
if gp := globalTracer.Load(); gp != nil {
return gp.(traceProvider).tp

4
global/global_test.go
View File

@@ -32,11 +32,11 @@ var (
_ metric.Provider = &testMeterProvider{}
)
func (*testTraceProvider) GetTracer(name string) trace.Tracer {
func (*testTraceProvider) Tracer(_ string) trace.Tracer {
return &trace.NoopTracer{}
}
func (*testMeterProvider) GetMeter(name string) metric.Meter {
func (*testMeterProvider) GetMeter(_ string) metric.Meter {
return &metric.NoopMeter{}
}

2
plugin/httptrace/clienttrace.go
View File

@@ -54,7 +54,7 @@ func NewClientTrace(ctx context.Context) *httptrace.ClientTrace {
activeHooks: make(map[string]trace.Span),
}
ct.tr = global.TraceProvider().GetTracer("go.opentelemetry.io/otel/plugin/httptrace")
ct.tr = global.TraceProvider().Tracer("go.opentelemetry.io/otel/plugin/httptrace")
ct.start("http.request", "http.request")
return &httptrace.ClientTrace{

2
plugin/httptrace/clienttrace_test.go
View File

@@ -58,7 +58,7 @@ func TestHTTPRequestWithClientTrace(t *testing.T) {
tp, _ := sdktrace.NewProvider(sdktrace.WithSyncer(exp), sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}))
global.SetTraceProvider(tp)
tr := tp.GetTracer("httptrace/client")
tr := tp.Tracer("httptrace/client")
// Mock http server
ts := httptest.NewServer(

2
plugin/othttp/handler.go
View File

@@ -130,7 +130,7 @@ func WithMessageEvents(events ...event) Option {
func NewHandler(handler http.Handler, operation string, opts ...Option) http.Handler {
h := Handler{handler: handler, operation: operation}
defaultOpts := []Option{
WithTracer(global.TraceProvider().GetTracer("go.opentelemetry.io/plugin/othttp")),
WithTracer(global.TraceProvider().Tracer("go.opentelemetry.io/plugin/othttp")),
WithPropagator(prop.HTTPTraceContextPropagator{}),
WithSpanOptions(trace.WithSpanKind(trace.SpanKindServer)),
}

2
sdk/trace/batch_span_processor_test.go
View File

@@ -145,7 +145,7 @@ func TestNewBatchSpanProcessorWithOptions(t *testing.T) {
t.Errorf("%s: Error creating new instance of BatchSpanProcessor\n", option.name)
}
tp.RegisterSpanProcessor(ssp)
tr := tp.GetTracer("BatchSpanProcessorWithOptions")
tr := tp.Tracer("BatchSpanProcessorWithOptions")
generateSpan(t, tr, option)

8
sdk/trace/benchmark_test.go
View File

@@ -191,18 +191,18 @@ func BenchmarkSpanID_DotString(b *testing.B) {
func traceBenchmark(b *testing.B, name string, fn func(*testing.B, apitrace.Tracer)) {
b.Run("AlwaysSample", func(b *testing.B) {
b.ReportAllocs()
fn(b, getTracer(b, name, sdktrace.AlwaysSample()))
fn(b, tracer(b, name, sdktrace.AlwaysSample()))
})
b.Run("NeverSample", func(b *testing.B) {
b.ReportAllocs()
fn(b, getTracer(b, name, sdktrace.NeverSample()))
fn(b, tracer(b, name, sdktrace.NeverSample()))
})
}
func getTracer(b *testing.B, name string, sampler sdktrace.Sampler) apitrace.Tracer {
func tracer(b *testing.B, name string, sampler sdktrace.Sampler) apitrace.Tracer {
tp, err := sdktrace.NewProvider(sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sampler}))
if err != nil {
b.Fatalf("Failed to create trace provider for test %s\n", name)
}
return tp.GetTracer(name)
return tp.Tracer(name)
}

4
sdk/trace/provider.go
View File

@@ -91,9 +91,9 @@ func NewProvider(opts ...ProviderOption) (*Provider, error) {
return tp, nil
}
// GetTracer with the given name. If a tracer for the given name does not exist,
// Tracer with the given name. If a tracer for the given name does not exist,
// it is created first. If the name is empty, DefaultTracerName is used.
func (p *Provider) GetTracer(name string) apitrace.Tracer {
func (p *Provider) Tracer(name string) apitrace.Tracer {
p.mu.Lock()
defer p.mu.Unlock()
if name == "" {

2
sdk/trace/simple_span_processor_test.go
View File

@@ -57,7 +57,7 @@ func TestSimpleSpanProcessorOnEnd(t *testing.T) {
}
tp.RegisterSpanProcessor(ssp)
tr := tp.GetTracer("SimpleSpanProcessor")
tr := tp.Tracer("SimpleSpanProcessor")
tid, _ := core.TraceIDFromHex("01020304050607080102040810203040")
sid, _ := core.SpanIDFromHex("0102040810203040")
sc := core.SpanContext{

6
sdk/trace/span_processor_test.go
View File

@@ -45,7 +45,7 @@ func TestRegisterSpanProcessort(t *testing.T) {
sp := NewTestSpanProcessor()
tp.RegisterSpanProcessor(sp)
tr := tp.GetTracer("SpanProcessor")
tr := tp.Tracer("SpanProcessor")
_, span := tr.Start(context.Background(), "OnStart")
span.End()
wantCount := 1
@@ -65,7 +65,7 @@ func TestUnregisterSpanProcessor(t *testing.T) {
sp := NewTestSpanProcessor()
tp.RegisterSpanProcessor(sp)
tr := tp.GetTracer("SpanProcessor")
tr := tp.Tracer("SpanProcessor")
_, span := tr.Start(context.Background(), "OnStart")
span.End()
tp.UnregisterSpanProcessor(sp)
@@ -92,7 +92,7 @@ func TestUnregisterSpanProcessorWhileSpanIsActive(t *testing.T) {
sp := NewTestSpanProcessor()
tp.RegisterSpanProcessor(sp)
tr := tp.GetTracer("SpanProcessor")
tr := tp.Tracer("SpanProcessor")
_, span := tr.Start(context.Background(), "OnStart")
tp.UnregisterSpanProcessor(sp)

24
sdk/trace/trace_test.go
View File

@@ -51,7 +51,7 @@ func TestTracerFollowsExpectedAPIBehaviour(t *testing.T) {
}
harness := testharness.NewHarness(t)
subjectFactory := func() trace.Tracer {
return tp.GetTracer("")
return tp.Tracer("")
}
harness.TestTracer(subjectFactory)
@@ -128,7 +128,7 @@ func TestSetName(t *testing.T) {
func TestRecordingIsOff(t *testing.T) {
tp, _ := NewProvider()
_, span := tp.GetTracer("Recording off").Start(context.Background(), "StartSpan")
_, span := tp.Tracer("Recording off").Start(context.Background(), "StartSpan")
defer span.End()
if span.IsRecording() == true {
t.Error("new span is recording events")
@@ -172,7 +172,7 @@ func TestSampling(t *testing.T) {
if err != nil {
t.Fatal("unexpected error:", err)
}
tr := p.GetTracer("test")
tr := p.Tracer("test")
var sampled int
for i := 0; i < total; i++ {
var opts []apitrace.SpanOption
@@ -210,7 +210,7 @@ func TestSampling(t *testing.T) {
func TestStartSpanWithChildOf(t *testing.T) {
tp, _ := NewProvider()
tr := tp.GetTracer("SpanWith ChildOf")
tr := tp.Tracer("SpanWith ChildOf")
sc1 := core.SpanContext{
TraceID: tid,
@@ -252,7 +252,7 @@ func TestStartSpanWithChildOf(t *testing.T) {
func TestStartSpanWithFollowsFrom(t *testing.T) {
tp, _ := NewProvider()
tr := tp.GetTracer("SpanWith FollowsFrom")
tr := tp.Tracer("SpanWith FollowsFrom")
sc1 := core.SpanContext{
TraceID: tid,
@@ -611,7 +611,7 @@ func TestSetSpanName(t *testing.T) {
tp, _ := NewProvider(WithSyncer(te))
want := "SetSpanName/SpanName-1"
_, span := tp.GetTracer("SetSpanName").Start(context.Background(), "SpanName-1",
_, span := tp.Tracer("SetSpanName").Start(context.Background(), "SpanName-1",
apitrace.ChildOf(core.SpanContext{
TraceID: tid,
SpanID: sid,
@@ -702,7 +702,7 @@ func startSpan(tp *Provider, trName string, args ...apitrace.SpanOption) apitrac
// automatically sampled.
func startNamedSpan(tp *Provider, trName, name string, args ...apitrace.SpanOption) apitrace.Span {
args = append(args, apitrace.ChildOf(remoteSpanContext()), apitrace.WithRecord())
_, span := tp.GetTracer(trName).Start(
_, span := tp.Tracer(trName).Start(
context.Background(),
name,
args...,
@@ -776,7 +776,7 @@ func TestStartSpanAfterEnd(t *testing.T) {
spans := make(fakeExporter)
tp, _ := NewProvider(WithConfig(Config{DefaultSampler: AlwaysSample()}), WithSyncer(spans))
tr := tp.GetTracer("SpanAfterEnd")
tr := tp.Tracer("SpanAfterEnd")
ctx, span0 := tr.Start(context.Background(), "parent", apitrace.ChildOf(remoteSpanContext()))
ctx1, span1 := tr.Start(ctx, "span-1")
span1.End()
@@ -806,7 +806,7 @@ func TestChildSpanCount(t *testing.T) {
spans := make(fakeExporter)
tp, _ := NewProvider(WithConfig(Config{DefaultSampler: AlwaysSample()}), WithSyncer(spans))
tr := tp.GetTracer("ChidSpanCount")
tr := tp.Tracer("ChidSpanCount")
ctx, span0 := tr.Start(context.Background(), "parent")
ctx1, span1 := tr.Start(ctx, "span-1")
_, span2 := tr.Start(ctx1, "span-2")
@@ -841,7 +841,7 @@ func TestNilSpanEnd(t *testing.T) {
func TestExecutionTracerTaskEnd(t *testing.T) {
var n uint64
tp, _ := NewProvider(WithConfig(Config{DefaultSampler: NeverSample()}))
tr := tp.GetTracer("Execution Tracer Task End")
tr := tp.Tracer("Execution Tracer Task End")
executionTracerTaskEnd := func() {
atomic.AddUint64(&n, 1)
@@ -892,7 +892,7 @@ func TestCustomStartEndTime(t *testing.T) {
startTime := time.Date(2019, time.August, 27, 14, 42, 0, 0, time.UTC)
endTime := startTime.Add(time.Second * 20)
_, span := tp.GetTracer("Custom Start and End time").Start(
_, span := tp.Tracer("Custom Start and End time").Start(
context.Background(),
"testspan",
apitrace.WithStartTime(startTime),
@@ -914,7 +914,7 @@ func TestCustomStartEndTime(t *testing.T) {
func TestWithSpanKind(t *testing.T) {
var te testExporter
tp, _ := NewProvider(WithSyncer(&te), WithConfig(Config{DefaultSampler: AlwaysSample()}))
tr := tp.GetTracer("withSpanKind")
tr := tp.Tracer("withSpanKind")
_, span := tr.Start(context.Background(), "WithoutSpanKind")
spanData, err := endSpan(&te, span)