traceable_context

README

Traceable Context

Traceable Context is a wrapper around go context which will provide a way to share a traceable UUID between different contexts

• New context

    ctx := traceable_context.WithUUID(uuid.New())

• Context from a parent context

    parent := contect.Background()
    ctx := traceable_context.WithUUID(parent, uuid.New())

Documentation

Index

• func Background() context.Context
• func FromContext(ctx context.Context) uuid.UUID
• type TraceableContext
  • func FromContextWithUUID(ctx context.Context, uuid uuid.UUID) TraceableContext
  • func WithCancel(parent context.Context) (ctx TraceableContext, cancel context.CancelFunc)
  • func WithDeadline(parent context.Context, deadline time.Time) (ctx TraceableContext, cancel context.CancelFunc)
  • func WithTimeout(parent context.Context, timeout time.Duration) (ctx TraceableContext, cancel context.CancelFunc)
  • func WithUUID(uuid uuid.UUID) TraceableContext
  • func WithValue(parent context.Context, key, val interface{}) TraceableContext

Functions

func Background

func Background() context.Context

func FromContext

func FromContext(ctx context.Context) uuid.UUID

Types

type TraceableContext

type TraceableContext interface {
	context.Context
	UUID() uuid.UUID
}

func FromContextWithUUID

func FromContextWithUUID(ctx context.Context, uuid uuid.UUID) TraceableContext

func WithCancel

func WithCancel(parent context.Context) (ctx TraceableContext, cancel context.CancelFunc)

func WithDeadline

func WithDeadline(parent context.Context, deadline time.Time) (ctx TraceableContext, cancel context.CancelFunc)

func WithTimeout

func WithTimeout(parent context.Context, timeout time.Duration) (ctx TraceableContext, cancel context.CancelFunc)

func WithUUID

func WithUUID(uuid uuid.UUID) TraceableContext

func WithValue

func WithValue(parent context.Context, key, val interface{}) TraceableContext