trace

README

trace

Trace provides usecase for generating trace id, commonly used for tracing your request throughout its lifecycle.

How to Use

trace.New creates new random trace string.

Context

Use NewContext to inject your trace to context.

ctx := trace.NewContext(context.Background(), "your-trace-id")

Use TraceFromContext to extract your trace from context

trace := trace.TraceFromContext(ctx)
fmt.Println(trace)
// your-trace-id

Documentation

Index

• func New() string
• func NewContext(parentCtx context.Context, trace string) context.Context
• func TraceFromContext(ctx context.Context) string
• type TraceContextKeyType

Functions

func New

func New() string

New creates new random string using ksuid

func NewContext

func NewContext(parentCtx context.Context, trace string) context.Context

NewContext create new context that is injected with trace

func TraceFromContext

func TraceFromContext(ctx context.Context) string

TraceFromContext extract trace from context

Types

type TraceContextKeyType

type TraceContextKeyType string

const (
	// TraceContextKey is a custom context key for trace
	TraceContextKey TraceContextKeyType = "trace.context.key"
)