logging

Documentation

Overview

Package logging provides the logger interface abstraction and implementation for Bee. It uses logrus under the hood.

Index

• type Logger
  • func New(w io.Writer, level logrus.Level, opts ...LoggerOption) Logger
• type LoggerOption
  • func WithLokiOption(lokiEndpoint string) LoggerOption
  • func WithMetricsOption() LoggerOption
• type LokiHook
  • func (l LokiHook) Fire(entry *logrus.Entry) error
  • func (l LokiHook) Levels() []logrus.Level

Types

type Logger

type Logger interface {
	Tracef(format string, args ...interface{})
	Trace(args ...interface{})
	Debugf(format string, args ...interface{})
	Debug(args ...interface{})
	Infof(format string, args ...interface{})
	Info(args ...interface{})
	Warningf(format string, args ...interface{})
	Warning(args ...interface{})
	Errorf(format string, args ...interface{})
	Error(args ...interface{})
	Fatalf(format string, args ...interface{})
	Fatal(args ...interface{})
	WithField(key string, value interface{}) *logrus.Entry
	WithFields(fields logrus.Fields) *logrus.Entry
	WriterLevel(logrus.Level) *io.PipeWriter
	NewEntry() *logrus.Entry
	GetLevel() string
}

func New

func New(w io.Writer, level logrus.Level, opts ...LoggerOption) Logger

New initializes a new logger instance with given options.

type LoggerOption

type LoggerOption func(*logger)

func WithLokiOption

func WithLokiOption(lokiEndpoint string) LoggerOption

WithLokiOption sets the hook for Loki logging.

func WithMetricsOption

func WithMetricsOption() LoggerOption

WithMetricsOption sets the hook for metrics logging.

type LokiHook

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

func (LokiHook) Fire

func (l LokiHook) Fire(entry *logrus.Entry) error

func (LokiHook) Levels

func (l LokiHook) Levels() []logrus.Level