trace

Documentation

Overview

Package trace provides otel span tracer for YoMo's stream function.

Index

• Variables
• func GetGlobalClient() otlptrace.Client
• func NewContextWithMetadata(md metadata.M) context.Context
• func NewTracerProviderFromClient(ctx context.Context, serviceName string, client otlptrace.Client) *tracesdk.TracerProvider
• func SetTracerProvider()
• func ShutdownTracerProvider()
• type Tracer
  • func NewTracer(name string, enable ...bool) *Tracer
  • func (t *Tracer) End(md metadata.M, span trace.Span, kv ...attribute.KeyValue)
  • func (t *Tracer) Start(md metadata.M, operation string) trace.Span

Variables

var (
	// ServiceName is the default service name for otel.
	ServiceName = "yomo"
)

Functions

func GetGlobalClient

func GetGlobalClient() otlptrace.Client

GetGlobalClient return the global otel client.

func NewContextWithMetadata

func NewContextWithMetadata(md metadata.M) context.Context

NewContextWithMetadata create new context with metadata for tracer starting. In yomo, we use metadata from dataFrame as the trace Propagator. And yomo only carries traceID and spanID in metadata.

func NewTracerProviderFromClient

func NewTracerProviderFromClient(ctx context.Context, serviceName string, client otlptrace.Client) *tracesdk.TracerProvider

NewTracerProviderFromClient create tracer provider from otlptrace.Client.

func SetTracerProvider

func SetTracerProvider()

SetTracerProvider set otel tracer provider. if enveronment BASELIME_API_KEY is set, the tracer provider will be baselime tracer provider. if enveronment OTEL_EXPORTER_OTLP_ENDPOINT is set, the tracer provider will be otlptracehttp tracer provider. This function set the global tracer provider by calling otel.SetTracerProvider(), User also can set other tracer provider by calling otel.SetTracerProvider()

func ShutdownTracerProvider

func ShutdownTracerProvider()

ShutdownTracerProvider shutdown the global TracerProvider.

Types

type Tracer

type Tracer struct {
	// contains filtered or unexported fields
}

Tracer is otel span tracer.

func NewTracer

func NewTracer(name string, enable ...bool) *Tracer

NewTracer create tracer instance.

func (*Tracer) End

func (t *Tracer) End(md metadata.M, span trace.Span, kv ...attribute.KeyValue)

End finish tracing span.

func (*Tracer) Start

func (t *Tracer) Start(md metadata.M, operation string) trace.Span

Start start tracing span.