blob: 49a7543897d5574844d221e52699c5988fd902ae [file] [log] [blame]
Joey Armstronge8c091f2023-01-17 16:56:26 -05001// Copyright The OpenTelemetry Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package global
16
17import (
18 "go.opentelemetry.io/otel/api/global/internal"
19 "go.opentelemetry.io/otel/api/trace"
20)
21
22// Tracer creates a named tracer that implements Tracer interface.
23// If the name is an empty string then provider uses default name.
24//
25// This is short for TracerProvider().Tracer(name)
26func Tracer(name string) trace.Tracer {
27 return TracerProvider().Tracer(name)
28}
29
30// TracerProvider returns the registered global trace provider.
31// If none is registered then an instance of NoopTracerProvider is returned.
32//
33// Use the trace provider to create a named tracer. E.g.
34// tracer := global.TracerProvider().Tracer("example.com/foo")
35// or
36// tracer := global.Tracer("example.com/foo")
37func TracerProvider() trace.TracerProvider {
38 return internal.TracerProvider()
39}
40
41// SetTracerProvider registers `tp` as the global trace provider.
42func SetTracerProvider(tp trace.TracerProvider) {
43 internal.SetTracerProvider(tp)
44}