logs

README

概述

LOGS 是一个 AAC FACTORY 的 LOG 规范。

获取

go get github.com/aacfactory/logs

使用

log, logErr := logs.New(
    logs.WithLevel(logs.DebugLevel),
)
// handle logErr
// print
log.Debug().Caller().With("f1", "f1").With("f2", 2).Message("debug")
log.Info().With("time", time.Now()).Message("info")
log.Warn().Caller().Message("warn")
log.Error().Caller().Cause(errors.New("some error")).Message("error")
// shutdown
shutdownErr := log.Shutdown(context.Background())

压测

BenchmarkLogger_Info-20 1602939   744.5 ns/op   243 B/op  5 allocs/op

Documentation

Index

• Variables
• func ConvertToStandardLogger(logger Logger, level Level, withCaller bool) (v *log.Logger)
• type Caller
  • func (caller Caller) MarshalJSON() (p []byte, err error)
• type ColorableLevelWriterTo
  • func (lc ColorableLevelWriterTo) WriteTo(writer io.Writer) (int64, error)
• type ConsoleWriter
  • func (writer *ConsoleWriter) Close() (err error)
  • func (writer *ConsoleWriter) Write(entry Entry)
• type ConsoleWriterFormatter
• type ConsoleWriterOutType
• type Entry
  • func (e Entry) MarshalJSON() (p []byte, err error)
• type EntryEncoder
• type Error
• type Event
• type Events
  • func (events *Events) Get(level Level, fields Fields) (v Event)
  • func (events *Events) Shutdown(ctx context.Context) (err error)
• type Field
  • func (field Field) MarshalJSON() (p []byte, err error)
  • func (field Field) ValueBytes() (p []byte)
• type Fields
  • func (fields Fields) Add(key string, value any) Fields
  • func (fields Fields) MarshalJSON() (p []byte, err error)
• type JsonEntryEncoder
  • func (encoder *JsonEntryEncoder) Encode(entry Entry) (p []byte)
• type Level
  • func (level Level) Bytes() []byte
  • func (level Level) ColorableLevelWriterTo() (w io.WriterTo)
  • func (level Level) MarshalJSON() ([]byte, error)
  • func (level Level) String() string
• type Logger
  • func New(options ...Option) (log Logger, err error)
• type Option
  • func DisableConsoleWriter() Option
  • func WithBuffer(size int) Option
  • func WithConsoleWriterFormatter(formatter ConsoleWriterFormatter) Option
  • func WithConsoleWriterOutType(typ ConsoleWriterOutType) Option
  • func WithConsumes(consumes int) Option
  • func WithLevel(value Level) Option
  • func WithSendTimeout(timeout time.Duration) Option
  • func WithShutdownTimeout(timeout time.Duration) Option
  • func WithTimeoutDiscardLevel(value Level) Option
  • func WithWriter(writers ...Writer) Option
• type Options
• type Sink
  • func (sink *Sink) Emit(entry Entry)
  • func (sink *Sink) Listen()
  • func (sink *Sink) Shutdown(ctx context.Context) (err error)
• type TextEntryEncoder
  • func (encoder *TextEntryEncoder) Encode(entry Entry) (p []byte)
• type Timers
  • func NewTimers() *Timers
  • func (timers *Timers) Get(d time.Duration) (timer *time.Timer)
  • func (timers *Timers) Put(timer *time.Timer)
• type Writer
  • func NewConsoleWriter(formatter ConsoleWriterFormatter, out ConsoleWriterOutType) (w Writer)

Variables

var (
	ErrCloseTimeout = errors.New("logs: close time out")
)

Functions

func ConvertToStandardLogger

func ConvertToStandardLogger(logger Logger, level Level, withCaller bool) (v *log.Logger)

Types

type Caller

type Caller struct {
	Fn   string
	File string
	Line int
}

func (Caller) MarshalJSON

func (caller Caller) MarshalJSON() (p []byte, err error)

type ColorableLevelWriterTo

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

func (ColorableLevelWriterTo) WriteTo

func (lc ColorableLevelWriterTo) WriteTo(writer io.Writer) (int64, error)

type ConsoleWriter

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

func (*ConsoleWriter) Close

func (writer *ConsoleWriter) Close() (err error)

func (*ConsoleWriter) Write

func (writer *ConsoleWriter) Write(entry Entry)

type ConsoleWriterFormatter

type ConsoleWriterFormatter int

const (
	TextFormatter ConsoleWriterFormatter = iota
	ColorTextFormatter
	JsonFormatter
)

type ConsoleWriterOutType

type ConsoleWriterOutType int

const (
	StdOut ConsoleWriterOutType = iota
	StdErr
	StdMix
)

type Entry

type Entry struct {
	Level   Level
	Occur   time.Time
	Message string
	Fields  Fields
	Cause   Error
	Caller  Caller
}

func (Entry) MarshalJSON

func (e Entry) MarshalJSON() (p []byte, err error)

type EntryEncoder

type EntryEncoder interface {
	Encode(entry Entry) (p []byte)
}

type Error

type Error interface {
	json.Marshaler
	Error() string
}

type Event

type Event interface {
	Message(message string)
	MessageF(format string, a ...any)
	Cause(err error) Event
	Caller() Event
	CallerWithSkip(skip int) Event
	With(key string, value any) Event
}

type Events

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

func (*Events) Get

func (events *Events) Get(level Level, fields Fields) (v Event)

func (*Events) Shutdown

func (events *Events) Shutdown(ctx context.Context) (err error)

type Field

type Field struct {
	Key   string
	Value any
}

func (Field) MarshalJSON

func (field Field) MarshalJSON() (p []byte, err error)

func (Field) ValueBytes

func (field Field) ValueBytes() (p []byte)

type Fields

type Fields []Field

func (Fields) Add

func (fields Fields) Add(key string, value any) Fields

func (Fields) MarshalJSON

func (fields Fields) MarshalJSON() (p []byte, err error)

type JsonEntryEncoder

type JsonEntryEncoder struct {
}

func (*JsonEntryEncoder) Encode

func (encoder *JsonEntryEncoder) Encode(entry Entry) (p []byte)

type Level

type Level int

const (
	DebugLevel Level = iota + 1
	InfoLevel
	WarnLevel
	ErrorLevel
)

func (Level) Bytes

func (level Level) Bytes() []byte

func (Level) ColorableLevelWriterTo

func (level Level) ColorableLevelWriterTo() (w io.WriterTo)

func (Level) MarshalJSON

func (level Level) MarshalJSON() ([]byte, error)

func (Level) String

func (level Level) String() string

type Logger

type Logger interface {
	With(key string, value any) Logger
	DebugEnabled() (ok bool)
	Debug() (event Event)
	InfoEnabled() (ok bool)
	Info() (event Event)
	WarnEnabled() (ok bool)
	Warn() (event Event)
	ErrorEnabled() (ok bool)
	Error() (event Event)
	Shutdown(ctx context.Context) (err error)
}

func New

func New(options ...Option) (log Logger, err error)

type Option

type Option = func(options *Options) (err error)

func DisableConsoleWriter

func DisableConsoleWriter() Option

func WithBuffer

func WithBuffer(size int) Option

func WithConsoleWriterFormatter

func WithConsoleWriterFormatter(formatter ConsoleWriterFormatter) Option

func WithConsoleWriterOutType

func WithConsoleWriterOutType(typ ConsoleWriterOutType) Option

func WithConsumes

func WithConsumes(consumes int) Option

func WithLevel

func WithLevel(value Level) Option

func WithSendTimeout

func WithSendTimeout(timeout time.Duration) Option

func WithShutdownTimeout

func WithShutdownTimeout(timeout time.Duration) Option

func WithTimeoutDiscardLevel

func WithTimeoutDiscardLevel(value Level) Option

func WithWriter

func WithWriter(writers ...Writer) Option

type Options

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

type Sink

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

func (*Sink) Emit

func (sink *Sink) Emit(entry Entry)

func (*Sink) Listen

func (sink *Sink) Listen()

func (*Sink) Shutdown

func (sink *Sink) Shutdown(ctx context.Context) (err error)

type TextEntryEncoder

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

func (*TextEntryEncoder) Encode

func (encoder *TextEntryEncoder) Encode(entry Entry) (p []byte)

type Timers

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

func NewTimers

func NewTimers() *Timers

func (*Timers) Get

func (timers *Timers) Get(d time.Duration) (timer *time.Timer)

func (*Timers) Put

func (timers *Timers) Put(timer *time.Timer)

type Writer

type Writer interface {
	Write(entry Entry)
	Close() (err error)
}

func NewConsoleWriter

func NewConsoleWriter(formatter ConsoleWriterFormatter, out ConsoleWriterOutType) (w Writer)