tracer

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func GetTraceURL(ctx context.Context) (u string)
• func InitOpenTracing(serviceName string, opts ...OptionFunc) error
• func Log(ctx context.Context, key string, value interface{})
• func LogEvent(ctx context.Context, event string, payload ...interface{})
• func SetError(ctx context.Context, err error)
• func SetTracerPlatformType(t PlatformType)
• func SkipTraceContext(ctx context.Context) context.Context
• func WithTraceFunc(ctx context.Context, operationName string, ...)
• func WithTracerFunc(ctx context.Context, operationName string, fn func(context.Context, Tracer))
• type FinishOption
• type FinishOptionFunc
  • func FinishWithAdditionalTags(tags map[string]interface{}) FinishOptionFunc
  • func FinishWithError(err error) FinishOptionFunc
• type Option
• type OptionFunc
  • func OptionSetAgentHost(agent string) OptionFunc
  • func OptionSetBuildNumberTag(number string) OptionFunc
  • func OptionSetLevel(level string) OptionFunc
  • func OptionSetMaxGoroutineTag(max int) OptionFunc
  • func OptionSetTraceDashboardURL(dashboardURL string) OptionFunc
• type PlatformType
• type Tracer
  • func StartTrace(ctx context.Context, operationName string) Tracer
  • func StartTraceFromHeader(ctx context.Context, operationName string, header map[string]string) (Tracer, context.Context)
  • func StartTraceWithContext(ctx context.Context, operationName string) (Tracer, context.Context)

Functions

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID func

func GetTraceURL

func GetTraceURL(ctx context.Context) (u string)

GetTraceURL log trace url

func InitOpenTracing

func InitOpenTracing(serviceName string, opts ...OptionFunc) error

InitOpenTracing init jaeger tracing

func Log

func Log(ctx context.Context, key string, value interface{})

Log trace

func LogEvent

func LogEvent(ctx context.Context, event string, payload ...interface{})

LogEvent trace

func SetError

func SetError(ctx context.Context, err error)

SetError global func TODO: separate in each tracer platform

func SetTracerPlatformType

func SetTracerPlatformType(t PlatformType)

SetTracerPlatformType function for set tracer platform

func SkipTraceContext

func SkipTraceContext(ctx context.Context) context.Context

SkipTraceContext inject to context for skip span tracer

func WithTraceFunc

func WithTraceFunc(ctx context.Context, operationName string, fn func(context.Context, map[string]interface{}))

WithTraceFunc functional with context and tags in function params (DEPRECATED, use WithTracerFunc)

func WithTracerFunc

func WithTracerFunc(ctx context.Context, operationName string, fn func(context.Context, Tracer))

WithTracerFunc functional with Tracer instance in function params

Types

type FinishOption

type FinishOption struct {
	Tags  map[string]interface{}
	Error error
}

FinishOption for option when trace is finished

type FinishOptionFunc

type FinishOptionFunc func(*FinishOption)

FinishOptionFunc func

func FinishWithAdditionalTags

func FinishWithAdditionalTags(tags map[string]interface{}) FinishOptionFunc

FinishWithAdditionalTags option for add tag when finish

func FinishWithError

func FinishWithError(err error) FinishOptionFunc

FinishWithError option for add error when finish

type Option

type Option struct {
	AgentHost       string
	TraceDashboard  string
	Level           string
	BuildNumberTag  string
	MaxGoroutineTag int
}

Option for init tracer option

type OptionFunc

type OptionFunc func(*Option)

OptionFunc func

func OptionSetAgentHost

func OptionSetAgentHost(agent string) OptionFunc

OptionSetAgentHost option func

func OptionSetBuildNumberTag

func OptionSetBuildNumberTag(number string) OptionFunc

OptionSetBuildNumberTag option func

func OptionSetLevel

func OptionSetLevel(level string) OptionFunc

OptionSetLevel option func

func OptionSetMaxGoroutineTag

func OptionSetMaxGoroutineTag(max int) OptionFunc

OptionSetMaxGoroutineTag option func

func OptionSetTraceDashboardURL

func OptionSetTraceDashboardURL(dashboardURL string) OptionFunc

OptionSetTraceDashboardURL option func

type PlatformType

type PlatformType interface {
	StartSpan(ctx context.Context, opName string) Tracer
	StartRootSpan(ctx context.Context, operationName string, header map[string]string) Tracer
	GetTraceID(ctx context.Context) string
	GetTraceURL(ctx context.Context) string
}

PlatformType define tracing platform. example using jaeger, sentry, aws x-ray, etc

type Tracer

type Tracer interface {
	Context() context.Context
	NewContext() context.Context
	Tags() map[string]interface{}
	SetTag(key string, value interface{})
	InjectRequestHeader(header map[string]string)
	SetError(err error)
	Log(key string, value interface{})
	Finish(opts ...FinishOptionFunc)
}

Tracer for trace

func StartTrace

func StartTrace(ctx context.Context, operationName string) Tracer

StartTrace starting trace child span from parent span

func StartTraceFromHeader

func StartTraceFromHeader(ctx context.Context, operationName string, header map[string]string) (Tracer, context.Context)

StartTraceFromHeader starting trace from root app handler based on header

func StartTraceWithContext

func StartTraceWithContext(ctx context.Context, operationName string) (Tracer, context.Context)

StartTraceWithContext starting trace child span from parent span, returning tracer and context