logging

README

Logging

Logging is a Go library that holds a set of standardized utilities and interfaces for logging.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/loopholelabs/logging. For more contribution information check out the contribution guide.

License

The Logging project is available as open source under the terms of the Apache License, Version 2.0.

Code of Conduct

Everyone interacting in the Logging project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the CNCF Code of Conduct.

Project Managed By:

Documentation

Index

• Constants
• type ConsoleLogLevel
• type ConsoleLogger
  • func NewConsoleLogger(w io.Writer) *ConsoleLogger
  • func (c *ConsoleLogger) Debug(msg string)
  • func (c *ConsoleLogger) Debugf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Error(msg string)
  • func (c *ConsoleLogger) Errorf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Fatal(msg string)
  • func (c *ConsoleLogger) Fatalf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Important(msg string)
  • func (c *ConsoleLogger) Importantf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Info(msg string)
  • func (c *ConsoleLogger) Infof(msg string, args ...interface{})
  • func (c *ConsoleLogger) SetLevel(level ConsoleLogLevel)
  • func (c *ConsoleLogger) SetOutput(w io.Writer)
  • func (c *ConsoleLogger) Success(msg string)
  • func (c *ConsoleLogger) Successf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Warn(msg string)
  • func (c *ConsoleLogger) Warnf(msg string, args ...interface{})
• type Logger
• type NoopLogger
  • func NewNoopLogger() *NoopLogger
  • func (n *NoopLogger) Debug(string)
  • func (n *NoopLogger) Debugf(string, ...interface{})
  • func (n *NoopLogger) Error(string)
  • func (n *NoopLogger) Errorf(string, ...interface{})
  • func (n *NoopLogger) Fatal(string)
  • func (n *NoopLogger) Fatalf(string, ...interface{})
  • func (n *NoopLogger) Info(string)
  • func (n *NoopLogger) Infof(string, ...interface{})
  • func (n *NoopLogger) Warn(string)
  • func (n *NoopLogger) Warnf(string, ...interface{})
• type TestLogger
  • func NewTestLogger(t testing.TB) *TestLogger
  • func (t *TestLogger) Debug(msg string)
  • func (t *TestLogger) Debugf(msg string, args ...interface{})
  • func (t *TestLogger) Error(msg string)
  • func (t *TestLogger) Errorf(msg string, args ...interface{})
  • func (t *TestLogger) Fatal(msg string)
  • func (t *TestLogger) Fatalf(msg string, args ...interface{})
  • func (t *TestLogger) Info(msg string)
  • func (t *TestLogger) Infof(msg string, args ...interface{})
  • func (t *TestLogger) Warn(msg string)
  • func (t *TestLogger) Warnf(msg string, args ...interface{})
• type ZerologAdapter
  • func ConvertZerolog(l *zerolog.Logger) *ZerologAdapter
  • func (z *ZerologAdapter) Debug(msg string)
  • func (z *ZerologAdapter) Debugf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Error(msg string)
  • func (z *ZerologAdapter) Errorf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Fatal(msg string)
  • func (z *ZerologAdapter) Fatalf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Info(msg string)
  • func (z *ZerologAdapter) Infof(msg string, args ...interface{})
  • func (z *ZerologAdapter) Warn(msg string)
  • func (z *ZerologAdapter) Warnf(msg string, args ...interface{})

Constants

const (
	FatalLevel = iota
	ErrorLevel
	WarnLevel
	ImportantLevel
	SuccessLevel
	InfoLevel
	DebugLevel
)

Types

type ConsoleLogLevel

type ConsoleLogLevel int

ConsoleLogLevel is the log level for the ConsoleLogger

type ConsoleLogger

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

ConsoleLogger logs to the console and satisfies the Logger interface

func NewConsoleLogger

func NewConsoleLogger(w io.Writer) *ConsoleLogger

NewConsoleLogger creates a new instance of the *ConsoleLogger with a default logging level of FatalLevel

func (*ConsoleLogger) Debug

func (c *ConsoleLogger) Debug(msg string)

Debug logs a Debug level message in Cyan

func (*ConsoleLogger) Debugf

func (c *ConsoleLogger) Debugf(msg string, args ...interface{})

Debugf logs a Debug level message in Cyan

func (*ConsoleLogger) Error

func (c *ConsoleLogger) Error(msg string)

Error logs an Error level message in Red

func (*ConsoleLogger) Errorf

func (c *ConsoleLogger) Errorf(msg string, args ...interface{})

Errorf logs an Error level message in Red

func (*ConsoleLogger) Fatal

func (c *ConsoleLogger) Fatal(msg string)

Fatal logs a Fatal level message in White

func (*ConsoleLogger) Fatalf

func (c *ConsoleLogger) Fatalf(msg string, args ...interface{})

Fatalf logs a Fatal level message in White

func (*ConsoleLogger) Important

func (c *ConsoleLogger) Important(msg string)

Important logs an Important level message in Blue

func (*ConsoleLogger) Importantf

func (c *ConsoleLogger) Importantf(msg string, args ...interface{})

Importantf logs an Important level message in Blue

func (*ConsoleLogger) Info

func (c *ConsoleLogger) Info(msg string)

Info logs an Info level message in Gray

func (*ConsoleLogger) Infof

func (c *ConsoleLogger) Infof(msg string, args ...interface{})

Infof logs an Info level message in Gray

func (*ConsoleLogger) SetLevel

func (c *ConsoleLogger) SetLevel(level ConsoleLogLevel)

SetLevel sets the logging level of the ConsoleLogger to level

func (*ConsoleLogger) SetOutput

func (c *ConsoleLogger) SetOutput(w io.Writer)

SetOutput sets the output of the ConsoleLogger to an io.Writer

func (*ConsoleLogger) Success

func (c *ConsoleLogger) Success(msg string)

Success logs a Success level message in Green

func (*ConsoleLogger) Successf

func (c *ConsoleLogger) Successf(msg string, args ...interface{})

Successf logs a Success level message in Green

func (*ConsoleLogger) Warn

func (c *ConsoleLogger) Warn(msg string)

Warn logs a Warn level message Orange

func (*ConsoleLogger) Warnf

func (c *ConsoleLogger) Warnf(msg string, args ...interface{})

Warnf logs a Warn level message Orange

type Logger

type Logger interface {
	Fatal(msg string)
	Fatalf(msg string, args ...interface{})

	Error(msg string)
	Errorf(msg string, args ...interface{})

	Warn(msg string)
	Warnf(msg string, args ...interface{})

	Info(msg string)
	Infof(msg string, args ...interface{})

	Debug(msg string)
	Debugf(msg string, args ...interface{})
}

Logger is a standardized interface for a logger

type NoopLogger

type NoopLogger struct{}

NoopLogger is a no-op logger

func NewNoopLogger

func NewNoopLogger() *NoopLogger

NewNoopLogger creates a new instance of the *NoopLogger

func (*NoopLogger) Debug

func (n *NoopLogger) Debug(string)

func (*NoopLogger) Debugf

func (n *NoopLogger) Debugf(string, ...interface{})

func (*NoopLogger) Error

func (n *NoopLogger) Error(string)

func (*NoopLogger) Errorf

func (n *NoopLogger) Errorf(string, ...interface{})

func (*NoopLogger) Fatal

func (n *NoopLogger) Fatal(string)

func (*NoopLogger) Fatalf

func (n *NoopLogger) Fatalf(string, ...interface{})

func (*NoopLogger) Info

func (n *NoopLogger) Info(string)

func (*NoopLogger) Infof

func (n *NoopLogger) Infof(string, ...interface{})

func (*NoopLogger) Warn

func (n *NoopLogger) Warn(string)

func (*NoopLogger) Warnf

func (n *NoopLogger) Warnf(string, ...interface{})

type TestLogger

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

TestLogger is a logger for use in tests

func NewTestLogger

func NewTestLogger(t testing.TB) *TestLogger

NewTestLogger creates a new instance of the *TestLogger

func (*TestLogger) Debug

func (t *TestLogger) Debug(msg string)

func (*TestLogger) Debugf

func (t *TestLogger) Debugf(msg string, args ...interface{})

func (*TestLogger) Error

func (t *TestLogger) Error(msg string)

func (*TestLogger) Errorf

func (t *TestLogger) Errorf(msg string, args ...interface{})

func (*TestLogger) Fatal

func (t *TestLogger) Fatal(msg string)

func (*TestLogger) Fatalf

func (t *TestLogger) Fatalf(msg string, args ...interface{})

func (*TestLogger) Info

func (t *TestLogger) Info(msg string)

func (*TestLogger) Infof

func (t *TestLogger) Infof(msg string, args ...interface{})

func (*TestLogger) Warn

func (t *TestLogger) Warn(msg string)

func (*TestLogger) Warnf

func (t *TestLogger) Warnf(msg string, args ...interface{})

type ZerologAdapter

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

ZerologAdapter is an adapter to convert a zerolog.Logger into a struct that satisfies the Logger interface

func ConvertZerolog

func ConvertZerolog(l *zerolog.Logger) *ZerologAdapter

ConvertZerolog converts a *zerolog.Logger to a *ZerologAdapter

func (*ZerologAdapter) Debug

func (z *ZerologAdapter) Debug(msg string)

func (*ZerologAdapter) Debugf

func (z *ZerologAdapter) Debugf(msg string, args ...interface{})

func (*ZerologAdapter) Error

func (z *ZerologAdapter) Error(msg string)

func (*ZerologAdapter) Errorf

func (z *ZerologAdapter) Errorf(msg string, args ...interface{})

func (*ZerologAdapter) Fatal

func (z *ZerologAdapter) Fatal(msg string)

func (*ZerologAdapter) Fatalf

func (z *ZerologAdapter) Fatalf(msg string, args ...interface{})

func (*ZerologAdapter) Info

func (z *ZerologAdapter) Info(msg string)

func (*ZerologAdapter) Infof

func (z *ZerologAdapter) Infof(msg string, args ...interface{})

func (*ZerologAdapter) Warn

func (z *ZerologAdapter) Warn(msg string)

func (*ZerologAdapter) Warnf

func (z *ZerologAdapter) Warnf(msg string, args ...interface{})