trace

package

v0.2.4 Latest Latest Go to latest Published: Aug 29, 2023 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

trace.New creates new random trace string.

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

This section is empty.

This section is empty.

func New() string

New creates new random string using ksuid

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

NewContext create new context that is injected with trace

func TraceFromContext(ctx context.Context) string

TraceFromContext extract trace from context

type TraceContextKeyType string

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