signals

README

Signals package

The signals package contains common signal handling functions that are shared by the binaries built in this repository.

Documentation

Index

• Variables
• func Backtrace()
• func Die(dieCb DieCb)
• func FatalSignal(sig syscall.Signal) bool
• func HandlePanic(dieCb DieCb)
• func HandledSignals() []syscall.Signal
• func NonFatalSignal(sig syscall.Signal) bool
• func SetLogger(logger *logrus.Entry)
• type DieCb

Variables

var CrashOnError = false

CrashOnError causes a coredump to be produced when an internal error occurs or a fatal signal is received.

Functions

func Backtrace

func Backtrace()

Backtrace writes a multi-line backtrace to the logger.

func Die

func Die(dieCb DieCb)

Die causes a backtrace to be produced. If CrashOnError is set a coredump will be produced, else the program will exit.

func FatalSignal

func FatalSignal(sig syscall.Signal) bool

FatalSignal returns true if the specified signal should cause the program to abort.

func HandlePanic

func HandlePanic(dieCb DieCb)

HandlePanic writes a message to the logger and then calls Die().

func HandledSignals

func HandledSignals() []syscall.Signal

HandledSignals returns a list of signals the package can deal with.

func NonFatalSignal

func NonFatalSignal(sig syscall.Signal) bool

NonFatalSignal returns true if the specified signal should simply cause the program to Backtrace() but continue running.

func SetLogger

func SetLogger(logger *logrus.Entry)

SetLogger sets the custom logger to be used by this package. If not called, the package will create its own logger.

Types

type DieCb

type DieCb func()

DieCb is the callback function type that needs to be defined for every call into the Die() function. This callback will be run as the first function of the Die() implementation.