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, httpClient *http.Client) 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 ...any)
	Trace(args ...any)
	Debugf(format string, args ...any)
	Debug(args ...any)
	Infof(format string, args ...any)
	Info(args ...any)
	Warningf(format string, args ...any)
	Warning(args ...any)
	Errorf(format string, args ...any)
	Error(args ...any)
	Fatalf(format string, args ...any)
	Fatal(args ...any)
	WithField(key string, value any) *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, httpClient *http.Client) 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