tracer

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func GetTraceURL(ctx context.Context) (u string)
• func InitOpenTracing(serviceName string, opts ...OptionFunc) error
• func IsTracerActive() bool
• func Log(ctx context.Context, key string, value interface{})
• func LogEvent(ctx context.Context, event string, payload ...interface{})
• func LogStackTrace(trace Tracer)
• func SetError(ctx context.Context, err error)
• func SetTracerPlatformType(t PlatformType)
• func SkipTraceContext(ctx context.Context) context.Context
• 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
  • func FinishWithFunc(finishFunc func()) FinishOptionFunc
  • func FinishWithRecoverPanic(recoverFunc func(panicMessage any)) FinishOptionFunc
  • func FinishWithStackTraceDetail() FinishOptionFunc
• type Option
• type OptionFunc
  • func OptionSetAgentHost(agent string) OptionFunc
  • func OptionSetBuildNumberTag(number string) OptionFunc
  • func OptionSetErrorWhitelist(errs []error) OptionFunc
  • func OptionSetLevel(level string) OptionFunc
  • func OptionSetLogAllSpan() OptionFunc
  • func OptionSetMaxGoroutineTag(max int) OptionFunc
  • func OptionSetTraceDashboardURL(dashboardURL string) OptionFunc
  • func OptionSetTraceIDExtractor(extractor func(context.Context) string) OptionFunc
• type PlatformType
  • func InitJaeger(serviceName string, opts ...OptionFunc) 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

DEPRECATED: use InitJaeger

func IsTracerActive

func IsTracerActive() bool

IsTracerActive check tracer has been initialized with platform

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 LogStackTrace

func LogStackTrace(trace Tracer)

LogStackTrace log stack trace in recover panic

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 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 {
	// contains filtered or unexported fields
}

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

func FinishWithFunc

func FinishWithFunc(finishFunc func()) FinishOptionFunc

FinishWithFunc option for add callback function before finish span

func FinishWithRecoverPanic

func FinishWithRecoverPanic(recoverFunc func(panicMessage any)) FinishOptionFunc

FinishWithRecoverPanic option for add recover func if panic

func FinishWithStackTraceDetail

func FinishWithStackTraceDetail() FinishOptionFunc

FinishWithStackTraceDetail option for add stack trace detail

type Option

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

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 OptionSetErrorWhitelist

func OptionSetErrorWhitelist(errs []error) OptionFunc

OptionSetErrorWhitelist option func, set no error if error in whitelist

func OptionSetLevel

func OptionSetLevel(level string) OptionFunc

OptionSetLevel option func

func OptionSetLogAllSpan

func OptionSetLogAllSpan() OptionFunc

OptionSetLogAllSpan option func

func OptionSetMaxGoroutineTag

func OptionSetMaxGoroutineTag(max int) OptionFunc

OptionSetMaxGoroutineTag option func

func OptionSetTraceDashboardURL

func OptionSetTraceDashboardURL(dashboardURL string) OptionFunc

OptionSetTraceDashboardURL option func

func OptionSetTraceIDExtractor

func OptionSetTraceIDExtractor(extractor func(context.Context) string) OptionFunc

OptionSetTraceIDExtractor option func, set trace id extractor

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
	interfaces.Closer
}

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

func InitJaeger

func InitJaeger(serviceName string, opts ...OptionFunc) PlatformType

InitJaeger init jaeger tracing

type Tracer

type Tracer interface {
	Context() context.Context
	NewContext() context.Context
	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