crash

Documentation

Overview

Package crash provides a framework for adding probabilistic crash points. The package provides a global singleton that can be used to register, configure, and trigger crashes.

Index

• Constants
• func Config(crashPointConfig map[string]float64)
• func Here(crashPointID string)
• func InitFlags() *flag.FlagSet
• func ListRegisteredCrashPoints() []string
• func LoadViperArgValues()
• func OverrideGlobalOptions(options CrasherOptions)
• func RegisterCrashPoints(crashPointIDs ...string)
• type Crasher
  • func New(options CrasherOptions) *Crasher
  • func (c *Crasher) Config(crashPointConfig map[string]float64)
  • func (c *Crasher) Here(crashPointID string)
  • func (c *Crasher) InitFlags() *flag.FlagSet
  • func (c *Crasher) ListRegisteredCrashPoints() []string
  • func (c *Crasher) LoadViperArgValues()
  • func (c *Crasher) RegisterCrashPoints(crashPointIDs ...string)
• type CrasherOptions
• type RandomProvider

Constants

const (

	// CfgDefaultCrashPointProbability is the default crash point probability.
	CfgDefaultCrashPointProbability = "debug.crash.default"

	// CrashDefaultExitCode is the exit code that will be used if program is exited
	// due to a debug crash invocation.
	CrashDefaultExitCode = 123
)

Functions

func Config

func Config(crashPointConfig map[string]float64)

Config configure the global crash point values.

func Here

func Here(crashPointID string)

Here invokes the global crasher to crash at this point based on the passed in crashPointID's probability.

func InitFlags

func InitFlags() *flag.FlagSet

InitFlags creates flags from the registered crash points and registers those flags with Viper.

func ListRegisteredCrashPoints

func ListRegisteredCrashPoints() []string

ListRegisteredCrashPoints lists the registered crash points for the global Crasher instance.

func LoadViperArgValues

func LoadViperArgValues()

LoadViperArgValues loads viper arg values into the crash point config of the global crasher.

func OverrideGlobalOptions

func OverrideGlobalOptions(options CrasherOptions)

OverrideGlobalOptions overrides global crasher options.

func RegisterCrashPoints

func RegisterCrashPoints(crashPointIDs ...string)

RegisterCrashPoints registers crash points with the global Crasher instance.

Types

type Crasher

type Crasher struct {
	CrashPointConfig *sync.Map
	CrashMethod      func()
	CLIPrefix        string
	Rand             RandomProvider
	// contains filtered or unexported fields
}

Crasher is a crash controller.

func New

func New(options CrasherOptions) *Crasher

New creates a new crasher.

func (*Crasher) Config

func (c *Crasher) Config(crashPointConfig map[string]float64)

Config configures the crash point probabilities.

func (*Crasher) Here

func (c *Crasher) Here(crashPointID string)

Here crashes at this point based on the passed in crashPointID's probability.

func (*Crasher) InitFlags

func (c *Crasher) InitFlags() *flag.FlagSet

InitFlags creates flags from the registered crash points and registers those flags with Viper.

func (*Crasher) ListRegisteredCrashPoints

func (c *Crasher) ListRegisteredCrashPoints() []string

ListRegisteredCrashPoints lists the registered crash points for a Crasher instance.

func (*Crasher) LoadViperArgValues

func (c *Crasher) LoadViperArgValues()

LoadViperArgValues loads viper arg values into the crash point config.

func (*Crasher) RegisterCrashPoints

func (c *Crasher) RegisterCrashPoints(crashPointIDs ...string)

RegisterCrashPoints registers crash points for a Crasher instance.

type CrasherOptions

type CrasherOptions struct {
	CrashMethod func()
	CLIPrefix   string
	Rand        RandomProvider
	CallerSkip  int
}

CrasherOptions options used to create a new crasher.

type RandomProvider

type RandomProvider interface {
	Float64() float64
}

RandomProvider interface that provides a Float64 random.