log

package

v1.45.0 Latest Latest Go to latest Published: Jun 16, 2020 License: Apache-2.0 Imports: 11 Imported by: 93

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SAP/jenkins-library

Links

Documentation ¶

Index ¶

Variables
func DeferExitHandler(handler func())
func Entry() *logrus.Entry
func RegisterHook(hook logrus.Hook)
func RegisterSecret(secret string)
func SetFormatter(logFormat string)
func SetStepName(stepName string)
func SetVerbose(verbose bool)
func Writer() io.Writer
type FatalHook
- func (f *FatalHook) Fire(entry *logrus.Entry) error
- func (f *FatalHook) Levels() []logrus.Level
type PiperLogFormatter
- func (formatter *PiperLogFormatter) Format(entry *logrus.Entry) (bytes []byte, err error)
type SentryHook
- func NewSentryHook(sentryDsn, correlationID string) SentryHook
- func (sentryHook *SentryHook) Fire(entry *logrus.Entry) error
- func (sentryHook *SentryHook) Levels() []logrus.Level

Constants ¶

This section is empty.

Variables ¶

View Source

var LibraryRepository string

LibraryRepository that is passed into with -ldflags

Functions ¶

func DeferExitHandler ¶ added in v1.9.0

func DeferExitHandler(handler func())

DeferExitHandler registers a logrus exit handler to allow cleanup activities.

func Entry ¶

func Entry() *logrus.Entry

Entry returns the logger entry or creates one if none is present.

func RegisterHook ¶ added in v1.25.0

func RegisterHook(hook logrus.Hook)

RegisterHook registers a logrus hook

func RegisterSecret ¶ added in v1.23.0

func RegisterSecret(secret string)

func SetFormatter ¶ added in v1.28.0

func SetFormatter(logFormat string)

SetFormatter specifies the log format to use for piper's output

func SetVerbose ¶

func SetVerbose(verbose bool)

SetVerbose sets the log level with respect to verbose flag.

func Writer ¶ added in v1.28.0

func Writer() io.Writer

Writer returns an io.Writer into which a tool's output can be redirected.

Types ¶

type FatalHook ¶ added in v1.25.0

type FatalHook struct {
	Path          string
	CorrelationID string
}

FatalHook provides a logrus hook which persists details about a fatal error into the file system. This is helpful in order to transfer the error details to an orchestrating CI/CD system and by that make it possible to provide better error messages to the user.

func (*FatalHook) Fire ¶ added in v1.25.0

func (f *FatalHook) Fire(entry *logrus.Entry) error

Fire persists the error message of the fatal error as json file into the file system.

func (*FatalHook) Levels ¶ added in v1.25.0

func (f *FatalHook) Levels() []logrus.Level

Levels returns the supported log level of the hook.

type PiperLogFormatter ¶ added in v1.28.0

type PiperLogFormatter struct {
	logrus.TextFormatter
	// contains filtered or unexported fields
}

PiperLogFormatter is the custom formatter of piper

func (*PiperLogFormatter) Format ¶ added in v1.28.0

func (formatter *PiperLogFormatter) Format(entry *logrus.Entry) (bytes []byte, err error)

Format the log message

type SentryHook ¶ added in v1.28.0

type SentryHook struct {
	Hub *sentry.Hub

	Event *sentry.Event
	// contains filtered or unexported fields
}

SentryHook provides a logrus hook which enables error logging to sentry platform. This is helpful in order to provide better monitoring and alerting on errors as well as the given error details can help to find the root cause of bugs.

func NewSentryHook ¶ added in v1.28.0

func NewSentryHook(sentryDsn, correlationID string) SentryHook

NewSentryHook initializes sentry sdk with dsn and creates new hook

func (*SentryHook) Fire ¶ added in v1.28.0

func (sentryHook *SentryHook) Fire(entry *logrus.Entry) error

Fire creates a new event from the error and sends it to sentry

func (*SentryHook) Levels ¶ added in v1.28.0

func (sentryHook *SentryHook) Levels() []logrus.Level