trace

Documentation

Index

• Constants
• func ContextWithSpan(ctx context.Context, span Span) context.Context
• func NewHTTPHandler(name string, handler http.Handler, tp Provider, attr ...Attribute) http.Handler
• func NewHTTPTransport(base http.RoundTripper) http.RoundTripper
• type Attribute
  • func NewAttribute(key string, value interface{}) Attribute
• type Logger
• type Option
  • func WithConfig(cfg *config.OpenTelemetry) Option
  • func WithContainerDetector() Option
  • func WithContext(ctx context.Context) Option
  • func WithCustomResourceAttributes(attrs ...Attribute) Option
  • func WithHostDetector() Option
  • func WithLogger(logger Logger) Option
  • func WithProcessDetector() Option
  • func WithServiceID(id string) Option
  • func WithServiceVersion(version string) Option
• type Provider
  • func NewProvider(opts ...Option) (Provider, error)
• type Span
  • func NewSpanFromContext(ctx context.Context, tracerName, spanName string) (context.Context, Span)
  • func SpanFromContext(ctx context.Context) Span
• type Tracer

Constants

const (
	SPAN_STATUS_ERROR = codes.Error
	SPAN_STATUS_UNSET = codes.Unset
	SPAN_STATUS_OK    = codes.Ok
)

const (
	NOOP_PROVIDER = "noop"
	OTEL_PROVIDER = "otel"
)

Functions

func ContextWithSpan

func ContextWithSpan(ctx context.Context, span Span) context.Context

ContextWithSpan returns a child context from ctx with span embedded

func NewHTTPHandler

func NewHTTPHandler(name string, handler http.Handler, tp Provider, attr ...Attribute) http.Handler

NewHTTPHandler wraps the provided http.Handler with one that starts a span and injects the span context into the outbound request headers. You need to initialize the TracerProvider first since it utilizes the underlying TracerProvider and propagators. It also utilizes a spanNameFormatter to format the span name r.Method + " " + r.URL.Path.

func NewHTTPTransport

func NewHTTPTransport(base http.RoundTripper) http.RoundTripper

NewHTTPTransport wraps the provided http.RoundTripper with one that starts a span and injects the span context into the outbound request headers.

Types

type Attribute

type Attribute = attribute.KeyValue

func NewAttribute

func NewAttribute(key string, value interface{}) Attribute

NewAttribute creates a new attribute.KeyValue pair based on the provided key and value. The function supports multiple types for the value parameter including basic types (string, bool, int, int64, float64), their pointer types, slices of basic types, and any type implementing the fmt.Stringer interface.

Usage:

attr := trace.NewAttribute("key1", "value1")
fmt.Println(attr) // Output: "key1":"value1"

type Logger

type Logger interface {
	Info(args ...interface{})
	Error(args ...interface{})
}

Logger represents the internal library logger used for error and info messages

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithConfig

func WithConfig(cfg *config.OpenTelemetry) Option

WithConfig sets the configuration options for the tracer provider

Example

config := &config.OpenTelemetry{
	Enabled:  true,
	Exporter: "grpc",
	Endpoint: "localhost:4317",
}
provider, err := trace.NewProvider(trace.WithConfig(config))
if err != nil {
	panic(err)
}

func WithContainerDetector

func WithContainerDetector() Option

WithContainerDetector adds attributes from the container to the configured resource.

Example

provider, err := trace.NewProvider(trace.WithContainerDetector())
if err != nil {
	panic(err)
}

func WithContext

func WithContext(ctx context.Context) Option

WithContext sets the context for the tracer provider

Example

ctx := context.Background()
provider, err := trace.NewProvider(trace.WithContext(ctx))
if err != nil {
	panic(err)
}

func WithCustomResourceAttributes

func WithCustomResourceAttributes(attrs ...Attribute) Option

WithCustomResourceAttributes adds custom attributes to the configured resource.

Example

attrs := []trace.Attribute{trace.NewAttribute("key", "value")}
provider, err := trace.NewProvider(trace.WithCustomResourceAttributes(attrs...))
if err != nil {
	panic(err)
}

func WithHostDetector

func WithHostDetector() Option

WithHostDetector adds attributes from the host to the configured resource.

Example

provider, err := trace.NewProvider(trace.WithHostDetector())
if err != nil {
	panic(err)
}

func WithLogger

func WithLogger(logger Logger) Option

WithLogger sets the logger for the tracer provider
This is used to log errors and info messages for underlying operations

Example

logger := logrus.New().WithField("component", "trace")
provider, err := trace.NewProvider(trace.WithLogger(logger))
if err != nil {
	panic(err)
}

func WithProcessDetector

func WithProcessDetector() Option

func WithServiceID

func WithServiceID(id string) Option

WithServiceID sets the resource service.id for the tracer provider
This is useful to identify service instance on the trace resource.

Example

provider, err := trace.NewProvider(trace.WithServiceID("instance-id"))
if err != nil {
	panic(err)
}

func WithServiceVersion

func WithServiceVersion(version string) Option

WithServiceVersion sets the resource service.version for the tracer provider
This is useful to identify service version on the trace resource.

Example

provider, err := trace.NewProvider(trace.WithServiceVersion("v4.0.5"))
if err != nil {
	panic(err)
}

type Provider

type Provider interface {
	// Shutdown execute the underlying exporter shutdown function
	Shutdown(context.Context) error
	// Tracer returns a tracer with pre-configured name. It's used to create spans.
	Tracer() Tracer
	// Type returns the type of the provider, it can be either "noop" or "otel"
	Type() string
}

Provider is the interface that wraps the basic methods of a tracer provider. If missconfigured or disabled, the provider will return a noop tracer

func NewProvider

func NewProvider(opts ...Option) (Provider, error)

 NewProvider creates a new tracer provider with the given options
 The tracer provider is responsible for creating spans and sending them to the exporter

 Example
	provider, err := trace.NewProvider(
		trace.WithContext(context.Background()),
		trace.WithConfig(&config.OpenTelemetry{
			Enabled:  true,
			Exporter: "grpc",
			Endpoint: "localhost:4317",
		}),
		trace.WithLogger(logrus.New().WithField("component", "tyk")),
	)
	if err != nil {
		panic(err)
	}

type Span

type Span trace.Span

func NewSpanFromContext

func NewSpanFromContext(ctx context.Context, tracerName, spanName string) (context.Context, Span)

NewSpanFromContext creates a new span from the given context. If the context already has a span attached to it, the new span will be a child of the existing span. If the context does not have a span attached to it, the new span will be a root span. The tracer name is used to identify the tracer to be used to create the span. If the tracer name is not provided, the default 'tyk' tracer name will be used. Example:

spanCtx, span := trace.NewSpanFromContext(ctx, "my-tracer", "my-span")
defer span.End()

func SpanFromContext

func SpanFromContext(ctx context.Context) Span

SpanFromContext returns the span attached to the given context. If the context does not have a span attached to it, a no-op span will be returned. Example:

span := trace.SpanFromContext(ctx) defer span.End()

type Tracer

type Tracer = oteltrace.Tracer