package
1.429.0
Repository: https://github.com/sap/jenkins-library.git
Documentation: pkg.go.dev

# Functions

DeferExitHandler registers a logrus exit handler to allow cleanup activities.
Entry
Entry returns the logger entry or creates one if none is present.
ErrorCategoryByString returns the error category based on the category text.
GetErrorCategory retrieves the error category which is currently known to the execution of a step.
GetFatalErrorDetail retrieves the error which is currently known to the execution of a step.
IsVerbose returns true if DegbuLevel is enabled.
NewSentryHook initializes sentry sdk with dsn and creates new hook.
No description provided by the author
RegisterANSHookIfConfigured creates a new ANS hook for logrus if it is configured and registers it.
RegisterHook registers a logrus hook.
RegisterSecret registers a value which should be masked in every log message.
SetErrorCategory sets the error category This can be used later by calling log.GetErrorCategory() In addition it will be used when exiting the program with log.FatalError(err, message).
SetFatalErrorDetail sets the fatal error to be stored.
SetFormatter specifies the log format to use for piper's output.
SetStepName sets the stepName field.
SetVerbose sets the log level with respect to verbose flag.
Writer returns an io.Writer into which a tool's output can be redirected.

# Constants

Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.
Error categories which allow categorizing failures.

# Variables

No description provided by the author
LibraryRepository that is passed into with -ldflags.

# Structs

ANSHook is used to set the hook features for the logrus hook.
No description provided by the author
FatalHook provides a logrus hook which persists details about a fatal error into the file system.
No description provided by the author
PiperLogFormatter is the custom formatter of piper.
SentryHook provides a logrus hook which enables error logging to sentry platform.
No description provided by the author

# Type aliases

ErrorCategory defines the category of a pipeline error.