serviceability

Documentation

Index

• func BehaviorOnPanic(modeString string, productVersion version.Info) func()
• func InitLogrus(level string)
• func InitLogrusFromKlog()
• func StartProfiler()
• type Stop
  • func Profile(mode string) Stop

Functions

func BehaviorOnPanic

func BehaviorOnPanic(modeString string, productVersion version.Info) func()

BehaviorOnPanic is a helper for setting the crash mode of OpenShift when a panic is caught. It returns a function that should be the defer handler for the caller.

func InitLogrus

func InitLogrus(level string)

InitLogrus initializes logrus by setting a loglevel for it.

func InitLogrusFromKlog

func InitLogrusFromKlog()

InitLogrusFromKlog sets the logrus trace level based on the klog trace level.

func StartProfiler

func StartProfiler()

StartProfiler starts the golang profiler on a port if `web` is specified. It uses the "standard" openshift env vars

Types

type Stop

type Stop interface {
	Stop()
}

Stop is a function to defer in your main call to provide profile info.

func Profile

func Profile(mode string) Stop

Profile returns an interface to defer for a profile: `defer serviceability.Profile(os.Getenv("OPENSHIFT_PROFILE")).Stop()` is common. Suffixing the mode with `-tmp` will have the profiler write the run to a temporary directory with a unique name, which is useful when running the same command multiple times.