log

Documentation

Index

• func AddField(ctx context.Context, key string, value any)
• func SetJww(verbose bool, w io.Writer)
• func ToContext(ctx context.Context, logger *Logger) context.Context
• type Logger
  • func Extract(ctx context.Context) *Logger
  • func New(verbose, sendDiagsOnErrors, metrics bool) *Logger
  • func (l *Logger) Debugf(format string, args ...any)
  • func (l *Logger) Debugln(args ...any)
  • func (l *Logger) Errorf(format string, args ...any)
  • func (l *Logger) Errorln(args ...any)
  • func (l *Logger) Fatalf(format string, args ...any)
  • func (l *Logger) Fatalln(args ...any)
  • func (l *Logger) Flush()
  • func (l *Logger) Infof(format string, args ...any)
  • func (l *Logger) Infoln(args ...any)
  • func (l *Logger) IsMetricsEnabled() bool
  • func (l *Logger) IsVerboseEnabled() bool
  • func (l *Logger) Output() io.Writer
  • func (l *Logger) SendDiagsOnErrors() bool
  • func (l *Logger) SetOutput(w io.Writer)
  • func (l *Logger) SetVerbose(verbose bool)
  • func (l *Logger) Warnf(format string, args ...any)
  • func (l *Logger) Warnln(args ...any)
  • func (l *Logger) WithField(key string, value any)

Functions

func AddField

func AddField(ctx context.Context, key string, value any)

AddField adds a field to the context logger.

func SetJww

func SetJww(verbose bool, w io.Writer)

SetJww sets jww log when debug enabled.

func ToContext

func ToContext(ctx context.Context, logger *Logger) context.Context

ToContext adds the log.Logger to the context for extraction later. Returning the new context that has been created.

Types

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger is the log entry.

func Extract

func Extract(ctx context.Context) *Logger

Extract takes the call-scoped Logger.

func New

func New(verbose, sendDiagsOnErrors, metrics bool) *Logger

New creates a new Logger.

func (*Logger) Debugf

func (l *Logger) Debugf(format string, args ...any)

Debugf logs a message at level Debug.

func (*Logger) Debugln

func (l *Logger) Debugln(args ...any)

Debugln logs a message at level Debug.

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...any)

Errorf logs a message at level Error.

func (*Logger) Errorln

func (l *Logger) Errorln(args ...any)

Errorln logs a message at level Error.

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, args ...any)

Fatalf logs a message at level Fatal then the process will exit with status set to 1.

func (*Logger) Fatalln

func (l *Logger) Fatalln(args ...any)

Fatalln logs a message at level Fatal then the process will exit with status set to 1.

func (*Logger) Flush

func (l *Logger) Flush()

Flush flushes the log output and closes the file.

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...any)

Infof logs a message at level Info.

func (*Logger) Infoln

func (l *Logger) Infoln(args ...any)

Infoln logs a message at level Info.

func (*Logger) IsMetricsEnabled

func (l *Logger) IsMetricsEnabled() bool

IsMetricsEnabled returns true if it should collect metrics.

func (*Logger) IsVerboseEnabled

func (l *Logger) IsVerboseEnabled() bool

IsVerboseEnabled returns true if debug is enabled.

func (*Logger) Output

func (l *Logger) Output() io.Writer

Output returns the current log output.

func (*Logger) SendDiagsOnErrors

func (l *Logger) SendDiagsOnErrors() bool

SendDiagsOnErrors returns true if diagnostics should be sent on errors.

func (*Logger) SetOutput

func (l *Logger) SetOutput(w io.Writer)

SetOutput defines sets the log output to io.Writer.

func (*Logger) SetVerbose

func (l *Logger) SetVerbose(verbose bool)

SetVerbose sets log level to debug if enabled.

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...any)

Warnf logs a message at level Warn.

func (*Logger) Warnln

func (l *Logger) Warnln(args ...any)

Warnln logs a message at level Warn.

func (*Logger) WithField

func (l *Logger) WithField(key string, value any)

WithField adds a single field to the Logger.