ulog

package module

Go to main page

Versions in this module

v0

v0.4.3

Aug 24, 2024

Changes in this version

+ type JSONFormatterOption func(*jsonfmt) error

v0.4.2

Jun 18, 2024

Changes in this version

+ const NilIfNotPresent

+ const NoopIfNotPresent

+ const PanicIfNotPresent

v0.4.1

May 31, 2024

v0.4.0

May 27, 2024

Changes in this version

+ func EnableTraceLogs(fn func(...any))

v0.3.0

May 23, 2024

v0.2.2

May 21, 2024

v0.2.1

Mar 20, 2024

Changes in this version

type FieldId

+ const CallsiteFileField

+ const CallsiteFunctionField

v0.2.0

Mar 20, 2024

Changes in this version

+ var ErrMalformedLogEntry = errors.New("log entry did not meet expectations")

+ var ErrMissingExpectedLogEntry = errors.New("missing an expected log entry")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrUnexpectedLogEntry = errors.New("unexpected log entry")

+ func AtLevel(l Level) func(*MockEntry)

+ func EnableTrace()

+ func LogfmtFormatter(opt ...LogfmtOption) func() (Formatter, error)

+ func LogtailTransport(opts ...LogtailOption) func() (transport, error)

+ func MuxFormat(id string, f FormatterFactory) func(*mux) error

+ func WithField(key string) func(*MockEntry)

+ func WithFieldValue(k, v string) func(*MockEntry)

+ func WithFieldValues(fields map[string]string) func(*MockEntry)

+ func WithFields(key string, moreKeys ...string) func(*MockEntry)

+ func WithMessage(s string) func(*MockEntry)

+ type Batch struct

+ type EntryExpectation = func(*MockEntry)

type FormatterFactory

+ func MsgpackFormatter(opts ...MsgpackOption) FormatterFactory

type JsonFormatterOption

+ func JSONFieldNames(keys map[FieldId]string) JsonFormatterOption

+ func JSONLevelLabels(levels map[Level]string) JsonFormatterOption

type LogfmtOption

+ func LogfmtFieldNames(keys map[FieldId]string) LogfmtOption

+ func LogfmtLevelLabels(levels map[Level]string) LogfmtOption

type Logger

+ WithExitCode func(int) Logger

+ type LogtailOption = func(*logtail) error

+ func LogtailEndpoint(s string) LogtailOption

+ func LogtailMaxBatch(m int) LogtailOption

+ func LogtailMaxLatency(d time.Duration) LogtailOption

+ func LogtailSourceToken(s string) LogtailOption

+ type MockEntry struct

+ func (me *MockEntry) String() string

+ type MsgpackOption func(*msgpackfmt) error

+ func MsgpackKeys(keys map[FieldId]string) MsgpackOption

+ func MsgpackLevels(levels map[Level]string) MsgpackOption

type MuxOption

+ func MuxTarget(cfg ...TargetOption) MuxOption

+ type StdioTransportOption = func(*stdioTransport) error

v0.1.0

Nov 26, 2023

Changes in this version

+ const Required

+ var ContextLoggerRequired bool

+ var ErrBackendNotConfigured = errors.New("a backend must be configured first")

+ var ErrExpectationsNotMet = errors.New("expectations were not met")

+ var ErrFormatAlreadyRegistered = errors.New("a format with this id is already registered")

+ var ErrInvalidConfiguration = errors.New("invalid configuration")

+ var ErrInvalidFormatReference = errors.New(...)

+ var ErrKeyNotSupported = errors.New("key not supported")

+ var ErrLogtailConfiguration = errors.New("logtail transport configuration")

+ var ErrNoLoggerInContext = errors.New("no logger in context")

+ var ErrUnknownFormat = errors.New("unknown format")

+ var ExitFn func(int) = os.Exit

+ var ExitOnFatalLog = ExitAlways

+ var JSONFormatter = newJsonFormatter()

+ var Levels = []Level

+ func ContextWithLogger(ctx context.Context, lg Logger) context.Context

+ func ExpectField(s string) func(*mockentry)

+ func ExpectFieldValue(s, v string) func(*mockentry)

+ func ExpectFieldValues(fields map[string]string) func(*mockentry)

+ func ExpectLevel(l Level) func(*mockentry)

+ func ExpectMessage(s string) func(*mockentry)

+ func Format(id string, f FormatterFactory) func(*mux) error

+ func Logfmt(opt ...LogfmtOption) func() (Formatter, error)

+ func NewMock() (Logger, MockLog)

+ func RegisterEnrichment(d EnrichmentFunc)

+ type ByteWriter interface

+ type CloseFn func()

+ type ContextLoggerOption int

+ type EnrichmentFunc func(context.Context) map[string]any

+ type FatalExitOption int

+ const ExitAlways

+ const ExitNever

+ const ExitWhenLogged

+ type FieldId int

+ const FileField

+ const FunctionField

+ const LevelField

+ const MessageField

+ const TimeField

+ type Formatter interface

+ Format func(int, entry, ByteWriter)

+ type FormatterFactory = func() (Formatter, error)

+ func NewJSONFormatter(opt ...JsonFormatterOption) FormatterFactory

+ type JsonFormatterOption func(*jsonfmt) error

+ func JsonLabels(keys map[FieldId]string) JsonFormatterOption

+ func JsonLevels(levels map[Level]string) JsonFormatterOption

+ type Level int

+ const DebugLevel

+ const ErrorLevel

+ const FatalLevel

+ const InfoLevel

+ const TraceLevel

+ const WarnLevel

+ func (lv Level) String() string

+ type LevelLogger interface

+ Log func(string)

+ Logf func(string, ...any)

+ WithField func(string, any) LevelLogger

+ WithFields func(map[string]any) LevelLogger

+ type LogfmtOption func(*logfmt) error

+ func LogfmtLabels(keys map[FieldId]string) LogfmtOption

+ func LogfmtLevels(levels map[Level]string) LogfmtOption

+ type Logger interface

+ AtLevel func(Level) LevelLogger

+ Debug func(s string)

+ Debugf func(format string, args ...any)

+ Error func(err any)

+ Errorf func(format string, args ...any)

+ Fatal func(err any)

+ Fatalf func(format string, args ...any)

+ Info func(s string)

+ Infof func(format string, args ...any)

+ Log func(Level, string)

+ Logf func(level Level, format string, args ...any)

+ Trace func(s string)

+ Tracef func(format string, args ...any)

+ Warn func(s string)

+ Warnf func(format string, args ...any)

+ WithContext func(context.Context) Logger

+ WithField func(string, any) Logger

+ WithFields func(map[string]any) Logger

+ func FromContext(ctx context.Context, opt ...ContextLoggerOption) Logger

+ func NewLogger(ctx context.Context, cfg ...LoggerOption) (Logger, func(), error)

+ type LoggerOption = func(*logger) error

+ func LogCallsite(e bool) LoggerOption

+ func LoggerBackend(t dispatcher) LoggerOption

+ func LoggerFormat(f FormatterFactory) LoggerOption

+ func LoggerLevel(level Level) LoggerOption

+ func LoggerOutput(out io.Writer) LoggerOption

+ func Mux(cfg ...MuxOption) LoggerOption

+ type MockConfiguration = func(*mockentry)

+ type MockLog interface

+ ExpectDebug func(...MockConfiguration)

+ ExpectEntry func(...MockConfiguration)

+ ExpectFatal func(...MockConfiguration)

+ ExpectInfo func(...MockConfiguration)

+ ExpectTrace func(...MockConfiguration)

+ ExpectWarn func(...MockConfiguration)

+ ExpectationsWereMet func() error

+ Reset func()

+ type MuxOption = func(*mux) error

+ func Target(cfg ...TargetOption) MuxOption

+ type StdioOption = func(*stdio) error

+ func StdioOutput(out io.Writer) StdioOption

+ type TargetOption = func(*mux, *target) error

+ func TargetFormat(f any) TargetOption

+ func TargetLevel(level Level) TargetOption

+ func TargetTransport(cfg TransportFactory) TargetOption

+ type TransportFactory = func(*mux, *target) (transport, error)

+ func StdioTransport(opt ...StdioOption) TransportFactory

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL