log

Documentation

Index

• Constants
• func ReopenOnSignal(logger *Logger, reopener Reopener) func(context.Context) error
• type HCLogAdapter
  • func NewHCLogAdapter(log logrus.FieldLogger, name string) *HCLogAdapter
  • func (a *HCLogAdapter) CreateEntry(args []any) *logrus.Entry
  • func (a *HCLogAdapter) Debug(msg string, args ...any)
  • func (a *HCLogAdapter) Error(msg string, args ...any)
  • func (a *HCLogAdapter) GetLevel() hclog.Level
  • func (a *HCLogAdapter) ImpliedArgs() []any
  • func (a *HCLogAdapter) Info(msg string, args ...any)
  • func (a *HCLogAdapter) IsDebug() bool
  • func (a *HCLogAdapter) IsError() bool
  • func (a *HCLogAdapter) IsInfo() bool
  • func (a *HCLogAdapter) IsTrace() bool
  • func (a *HCLogAdapter) IsWarn() bool
  • func (a *HCLogAdapter) Log(level hclog.Level, msg string, args ...any)
  • func (a *HCLogAdapter) Name() string
  • func (a *HCLogAdapter) Named(name string) hclog.Logger
  • func (a *HCLogAdapter) ResetNamed(name string) hclog.Logger
  • func (a *HCLogAdapter) SetLevel(hclog.Level)
  • func (a *HCLogAdapter) StandardLogger(*hclog.StandardLoggerOptions) *log.Logger
  • func (a *HCLogAdapter) StandardWriter(*hclog.StandardLoggerOptions) io.Writer
  • func (*HCLogAdapter) Trace(_ string, _ ...any)
  • func (a *HCLogAdapter) Warn(msg string, args ...any)
  • func (a *HCLogAdapter) With(args ...any) hclog.Logger
• type LocalTimeHook
  • func (l LocalTimeHook) Fire(entry *logrus.Entry) error
  • func (l LocalTimeHook) Levels() []logrus.Level
• type Logger
  • func NewLogger(options ...Option) (*Logger, error)
• type Option
  • func WithFormat(format string) Option
  • func WithLevel(logLevel string) Option
  • func WithOutputFile(file string) Option
  • func WithReopenableOutputFile(reopenableFile *ReopenableFile) Option
  • func WithSourceLocation() Option
• type ReopenableFile
  • func NewReopenableFile(name string) (*ReopenableFile, error)
  • func (r *ReopenableFile) Close() error
  • func (r *ReopenableFile) Name() string
  • func (r *ReopenableFile) Reopen() error
  • func (r *ReopenableFile) Write(b []byte) (n int, err error)
• type ReopenableWriteCloser
• type Reopener

Constants

const (
	DefaultFormat = ""
	JSONFormat    = "JSON"
	TextFormat    = "TEXT"
)

Functions

func ReopenOnSignal

func ReopenOnSignal(logger *Logger, reopener Reopener) func(context.Context) error

ReopenOnSignal returns a function compatible with RunTasks.

Types

type HCLogAdapter

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

HCLogAdapter implements the hclog interface, and wraps it around a Logrus entry

func NewHCLogAdapter

func NewHCLogAdapter(log logrus.FieldLogger, name string) *HCLogAdapter

func (*HCLogAdapter) CreateEntry

func (a *HCLogAdapter) CreateEntry(args []any) *logrus.Entry

func (*HCLogAdapter) Debug

func (a *HCLogAdapter) Debug(msg string, args ...any)

func (*HCLogAdapter) Error

func (a *HCLogAdapter) Error(msg string, args ...any)

func (*HCLogAdapter) GetLevel

func (a *HCLogAdapter) GetLevel() hclog.Level

func (*HCLogAdapter) ImpliedArgs

func (a *HCLogAdapter) ImpliedArgs() []any

ImpliedArgs returns With key/value pairs

func (*HCLogAdapter) Info

func (a *HCLogAdapter) Info(msg string, args ...any)

func (*HCLogAdapter) IsDebug

func (a *HCLogAdapter) IsDebug() bool

func (*HCLogAdapter) IsError

func (a *HCLogAdapter) IsError() bool

func (*HCLogAdapter) IsInfo

func (a *HCLogAdapter) IsInfo() bool

func (*HCLogAdapter) IsTrace

func (a *HCLogAdapter) IsTrace() bool

func (*HCLogAdapter) IsWarn

func (a *HCLogAdapter) IsWarn() bool

func (*HCLogAdapter) Log

func (a *HCLogAdapter) Log(level hclog.Level, msg string, args ...any)

func (*HCLogAdapter) Name

func (a *HCLogAdapter) Name() string

func (*HCLogAdapter) Named

func (a *HCLogAdapter) Named(name string) hclog.Logger

func (*HCLogAdapter) ResetNamed

func (a *HCLogAdapter) ResetNamed(name string) hclog.Logger

func (*HCLogAdapter) SetLevel

func (a *HCLogAdapter) SetLevel(hclog.Level)

func (*HCLogAdapter) StandardLogger

func (a *HCLogAdapter) StandardLogger(*hclog.StandardLoggerOptions) *log.Logger

StandardLogger is meant to return a stdlib Logger type which wraps around hclog. It does this by providing an io.Writer and instantiating a new Logger. It then tries to interpret the log level by parsing the message.

Since we are not using `hclog` in a generic way, and I cannot find any calls to this method from go-plugin, we will poorly support this method. Rather than pull in all of hclog writer parsing logic, pass it a Logrus writer, and hardcode the level to INFO.

Apologies to those who find themselves here.

func (*HCLogAdapter) StandardWriter

func (a *HCLogAdapter) StandardWriter(*hclog.StandardLoggerOptions) io.Writer

func (*HCLogAdapter) Trace

func (*HCLogAdapter) Trace(_ string, _ ...any)

HCLog has one more level than we do. As such, we will never set trace level.

func (*HCLogAdapter) Warn

func (a *HCLogAdapter) Warn(msg string, args ...any)

func (*HCLogAdapter) With

func (a *HCLogAdapter) With(args ...any) hclog.Logger

type LocalTimeHook

type LocalTimeHook struct{}

LocalTimeHook is a logrus hook that converts all log fields with type time.Time to local time.

func (LocalTimeHook) Fire

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

Fire is called when one of the log levels defined in Levels() is triggered.

func (LocalTimeHook) Levels

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

Levels defines on which log levels this hook would trigger.

type Logger

type Logger struct {
	*logrus.Logger
	io.Closer
}

func NewLogger

func NewLogger(options ...Option) (*Logger, error)

type Option

type Option func(*Logger) error

An Option can change the Logger to apply desired configuration in NewLogger

func WithFormat

func WithFormat(format string) Option

func WithLevel

func WithLevel(logLevel string) Option

func WithOutputFile

func WithOutputFile(file string) Option

WithOutputFile requires lossy copytruncate directive in logrotate.

func WithReopenableOutputFile

func WithReopenableOutputFile(reopenableFile *ReopenableFile) Option

WithReopenableOutputFile uses ReopenableFile to support handling a signal to rotate log files (e.g. from a logrotate postrotate script).

func WithSourceLocation

func WithSourceLocation() Option

type ReopenableFile

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

func NewReopenableFile

func NewReopenableFile(name string) (*ReopenableFile, error)

func (*ReopenableFile) Close

func (r *ReopenableFile) Close() error

func (*ReopenableFile) Name

func (r *ReopenableFile) Name() string

Name implements part of os.FileInfo without needing a lock on the underlying file.

func (*ReopenableFile) Reopen

func (r *ReopenableFile) Reopen() error

func (*ReopenableFile) Write

func (r *ReopenableFile) Write(b []byte) (n int, err error)

type ReopenableWriteCloser

type ReopenableWriteCloser interface {
	Reopener
	io.WriteCloser
}

type Reopener

type Reopener interface {
	Reopen() error
}

Reopener inspired by https://github.com/client9/reopen