stack

README

Stack

Stack provides stack tracing and enhanced error logging. Much of this code predates pkg/errors supporting marshallable stacktraces but has been updated to have interoperability with it.

Features

• Grabs full traces at the invocation of the error trace
• Prevents repeated nesting of traces with automatic merging of new error data
• Allows for additional data to be attached to errors that can be optionally exported based on the error handling
• Provides automatic marshalling of entries to Zerolog

Documentation

Index

• func HasTrace(err error) (isStackTraced bool)
• func Trace(err error, extra ...ErrorKVP) error
• func TraceToString(err error) string
• func UpliftStackTrace(err error) error
• func Wrap(err error, message string, extra ...ErrorKVP) error
• type Error
  • func GetTrace(err error) (wrappedErr *Error, useNewError bool)
  • func ToTypedError(err error) (typedErr *Error)
  • func (es *Error) Cause() error
  • func (es *Error) Extra() []ErrorKVP
  • func (es *Error) Format(s fmt.State, verb rune)
  • func (es *Error) HasStack() bool
  • func (es *Error) Is(target error) bool
  • func (es *Error) MarshalZerologObject(e *zerolog.Event)
  • func (es *Error) RawStack() MarshableStack
  • func (es *Error) StackTrace() errors.StackTrace
  • func (es *Error) TopLine() (error, string)
  • func (es *Error) Unwrap() error
• type ErrorKVP
  • func (e ErrorKVP) MarshalZerologObject(ze *zerolog.Event)
• type IStacker
• type IUnwrapper
• type MarshableStack
  • func GetStackProgramCounter(offset int) MarshableStack
  • func MarshalStack() MarshableStack
  • func (m MarshableStack) Format(st fmt.State, verb rune)
  • func (m MarshableStack) MarshalString() string
  • func (m MarshableStack) MarshalStringFrame(i int) string
  • func (m MarshableStack) MarshalZerologArray(a *zerolog.Array)
  • func (m MarshableStack) MarshalZerologObject(e *zerolog.Event)
  • func (m MarshableStack) StackTrace() errors.StackTrace
• type PCFrame
  • func (f PCFrame) File() string
  • func (f PCFrame) Format(s fmt.State, verb rune)
  • func (f PCFrame) Line() int
  • func (f PCFrame) MarshalJSON() ([]byte, error)
  • func (f PCFrame) MarshalZerologObject(e *zerolog.Event)
  • func (f PCFrame) Name() string
  • func (f PCFrame) PC() uintptr
  • func (f PCFrame) UnmarshalJSON(b []byte) error

Functions

func HasTrace

func HasTrace(err error) (isStackTraced bool)

HasTrace determines if there is a traceable error

func Trace

func Trace(err error, extra ...ErrorKVP) error

func TraceToString

func TraceToString(err error) string

TraceToString converts a trace to a string that can be read, this doesn't capture the extra data just a stack trace This is mostly used for tests to make it more readable if something melts down

func UpliftStackTrace

func UpliftStackTrace(err error) error

func Wrap

func Wrap(err error, message string, extra ...ErrorKVP) error

Types

type Error

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

func GetTrace

func GetTrace(err error) (wrappedErr *Error, useNewError bool)

func ToTypedError

func ToTypedError(err error) (typedErr *Error)

func (*Error) Cause

func (es *Error) Cause() error

func (*Error) Extra

func (es *Error) Extra() []ErrorKVP

func (*Error) Format

func (es *Error) Format(s fmt.State, verb rune)

func (*Error) HasStack

func (es *Error) HasStack() bool

func (*Error) Is

func (es *Error) Is(target error) bool

func (*Error) MarshalZerologObject

func (es *Error) MarshalZerologObject(e *zerolog.Event)

func (*Error) RawStack

func (es *Error) RawStack() MarshableStack

func (*Error) StackTrace

func (es *Error) StackTrace() errors.StackTrace

func (*Error) TopLine

func (es *Error) TopLine() (error, string)

func (*Error) Unwrap

func (es *Error) Unwrap() error

type ErrorKVP

type ErrorKVP struct {
	Key   string
	Value any
}

func (ErrorKVP) MarshalZerologObject

func (e ErrorKVP) MarshalZerologObject(ze *zerolog.Event)

type IStacker

type IStacker interface {
	zerolog.LogObjectMarshaler
	RawStack() MarshableStack
}

type IUnwrapper

type IUnwrapper interface {
	Unwrap() error
}

type MarshableStack

type MarshableStack []stackFrame

func GetStackProgramCounter

func GetStackProgramCounter(offset int) MarshableStack

func MarshalStack

func MarshalStack() MarshableStack

func (MarshableStack) Format

func (m MarshableStack) Format(st fmt.State, verb rune)

func (MarshableStack) MarshalString

func (m MarshableStack) MarshalString() string

func (MarshableStack) MarshalStringFrame

func (m MarshableStack) MarshalStringFrame(i int) string

func (MarshableStack) MarshalZerologArray

func (m MarshableStack) MarshalZerologArray(a *zerolog.Array)

func (MarshableStack) MarshalZerologObject

func (m MarshableStack) MarshalZerologObject(e *zerolog.Event)

func (MarshableStack) StackTrace

func (m MarshableStack) StackTrace() errors.StackTrace

type PCFrame

type PCFrame uintptr

func (PCFrame) File

func (f PCFrame) File() string

func (PCFrame) Format

func (f PCFrame) Format(s fmt.State, verb rune)

func (PCFrame) Line

func (f PCFrame) Line() int

func (PCFrame) MarshalJSON

func (f PCFrame) MarshalJSON() ([]byte, error)

func (PCFrame) MarshalZerologObject

func (f PCFrame) MarshalZerologObject(e *zerolog.Event)

func (PCFrame) Name

func (f PCFrame) Name() string

func (PCFrame) PC

func (f PCFrame) PC() uintptr

func (PCFrame) UnmarshalJSON

func (f PCFrame) UnmarshalJSON(b []byte) error