iris

package module

Go to main page

Versions in this module

v1

v1.2.7

May 3, 2026

v1.2.6

Apr 19, 2026

Changes in this version

type ConsoleEncoder

+ func NewConsoleEncoderWithColorize(colorize bool) *ConsoleEncoder

v1.2.5

Apr 12, 2026

v1.2.4

Apr 12, 2026

Changes in this version

type AdaptiveLogger

+ func (al *AdaptiveLogger) Named(name string) *AdaptiveLogger

+ func (al *AdaptiveLogger) With(fields ...Field) *AdaptiveLogger

v1.2.3

Apr 12, 2026

Changes in this version

type Config

+ OnDrop func(totalDropped int64)

v1.2.2

Apr 12, 2026

v1.2.1

Apr 12, 2026

Changes in this version

type AdaptiveLogger

+ func (al *AdaptiveLogger) Level() Level

+ func (al *AdaptiveLogger) SetLevel(level Level)

+ func (al *AdaptiveLogger) Sync() error

+ type LevelAwareSampler struct

+ func DefaultLevelAwareSampler() *LevelAwareSampler

+ func NewLevelAwareSampler(limits map[Level]SamplerLimit) *LevelAwareSampler

+ func (s *LevelAwareSampler) Allow(level Level) bool

+ type SamplerLimit struct

+ Capacity int64

+ Every time.Duration

+ Refill int64

v1.2.0

Apr 12, 2026

Changes in this version

+ type AdaptiveLogger struct

+ func NewAdaptiveLogger(cfg ScalerConfig) (*AdaptiveLogger, error)

+ func (al *AdaptiveLogger) Close() error

+ func (al *AdaptiveLogger) Debug(msg string, fields ...Field)

+ func (al *AdaptiveLogger) Error(msg string, fields ...Field)

+ func (al *AdaptiveLogger) Info(msg string, fields ...Field)

+ func (al *AdaptiveLogger) Mode() ScalingMode

+ func (al *AdaptiveLogger) Start() error

+ func (al *AdaptiveLogger) Stats() AdaptiveStats

+ func (al *AdaptiveLogger) Warn(msg string, fields ...Field)

+ type AdaptiveStats struct

+ ActiveWriters uint32

+ Mode ScalingMode

+ ScaleDownCount uint64

+ ScaleUpCount uint64

+ TotalWrites uint64

type Config

+ ErrorHandler ErrorHandler

+ type ContextOption func(*contextOptions)

+ func WithExtractor(extractor *ContextExtractor) ContextOption

+ func WithKey(key ContextKey, fieldName string) ContextOption

+ func WithKeys(keys ...ContextKey) ContextOption

+ type OwnedWriter interface

+ WriteOwned func([]byte) (int, error)

+ type ScalerConfig struct

+ BaseConfig Config

+ GoroutineThreshold uint32

+ Options []Option

+ ScaleDownCooldown time.Duration

+ func DefaultScalerConfig(cfg Config, opts ...Option) ScalerConfig

+ type ScalingMode uint32

+ const MultiMode

+ const SingleMode

+ func (m ScalingMode) String() string

v1.1.1

Sep 8, 2025

Changes in this version

type Logger

+ func NewMagicLogger(filename string, level Level, opts ...Option) (*Logger, error)

v1.1.0

Sep 6, 2025

Changes in this version

+ func EstimateBinarySize(rec *Record) int

+ func NewReaderLogger(config Config, readers []SyncReader, opts ...Option) (*readerLogger, error)

+ type BinaryDecoder struct

+ func (d *BinaryDecoder) DecodeMagic(data []byte) (bool, int)

+ func (d *BinaryDecoder) ReadVarint(data []byte, offset int) (uint64, int, error)

+ type BinaryEncoder struct

+ IncludeCaller bool

+ IncludeLoggerName bool

+ IncludeStack bool

+ UseUnixNano bool

+ func NewBinaryEncoder() *BinaryEncoder

+ func NewCompactBinaryEncoder() *BinaryEncoder

+ func (e *BinaryEncoder) Encode(rec *Record, now time.Time, buf *bytes.Buffer)

type Config

+ func TestConfig() Config

+ func TestConfigSmall() Config

+ func TestConfigWithOutput(output WriteSyncer) Config

type Option

+ func WithSampler(s Sampler) Option

+ type SyncReader interface

+ Read func(ctx context.Context) (*Record, error)

+ type SyncWriter interface

+ WriteRecord func(record *Record) error

v1.0.0

Sep 4, 2025

Changes in this version

+ const ErrCodeBufferOverflow

+ const ErrCodeEncodingFailed

+ const ErrCodeFieldTypeMismatch

+ const ErrCodeFileOpen

+ const ErrCodeFileRotation

+ const ErrCodeFileWrite

+ const ErrCodeFilterFailed

+ const ErrCodeFlushFailed

+ const ErrCodeHookExecution

+ const ErrCodeInvalidConfig

+ const ErrCodeInvalidField

+ const ErrCodeInvalidFormat

+ const ErrCodeInvalidLevel

+ const ErrCodeInvalidOutput

+ const ErrCodeLoggerClosed

+ const ErrCodeLoggerCreation

+ const ErrCodeLoggerDisabled

+ const ErrCodeLoggerExecution

+ const ErrCodeLoggerNotFound

+ const ErrCodeMemoryAllocation

+ const ErrCodeMiddlewareChain

+ const ErrCodePermissionDenied

+ const ErrCodePoolExhausted

+ const ErrCodeResourceLimit

+ const ErrCodeRingBuildFailed

+ const ErrCodeRingClosed

+ const ErrCodeRingInvalidBatchSize

+ const ErrCodeRingInvalidCapacity

+ const ErrCodeRingMissingProcessor

+ const ErrCodeSyncFailed

+ const ErrCodeTimeout

+ const ErrCodeWriteFailed

+ const ErrCodeWriterNotAvailable

+ var BalancedStrategy = NewProgressiveIdleStrategy()

+ var DefaultContextExtractor = &ContextExtractor

+ var EfficientStrategy = NewSleepingIdleStrategy(time.Millisecond, 0)

+ var ErrLoggerClosed = errors.New(ErrCodeLoggerClosed, "logger is closed")

+ var ErrLoggerCreationFailed = errors.New(ErrCodeLoggerCreation, "failed to create logger")

+ var ErrLoggerNotStarted = errors.New(ErrCodeLoggerNotFound, "logger not started - call Start() first")

+ var HybridStrategy = NewSleepingIdleStrategy(time.Millisecond, 1000)

+ var SpinningStrategy = NewSpinningIdleStrategy()

+ func AllLevelNames() []string

+ func CIFriendlyRetryCount(normalRetries int) int

+ func CIFriendlySleep(normalDuration time.Duration)

+ func CIFriendlyTimeout(normalTimeout time.Duration) time.Duration

+ func FreeStack(stack *Stack)

+ func GetErrorCode(err error) errors.ErrorCode

+ func GetUserMessage(err error) string

+ func IsCIEnvironment() bool

+ func IsFileSyncer(ws WriteSyncer) bool

+ func IsLoggerError(err error, code errors.ErrorCode) bool

+ func IsNopSyncer(ws WriteSyncer) bool

+ func IsRetryableError(err error) bool

+ func IsValidLevel(level Level) bool

+ func NewAtomicLevelFromConfig(config *Config) *atomicLevel

+ func NewLoggerError(code errors.ErrorCode, message string) *errors.Error

+ func NewLoggerErrorWithField(code errors.ErrorCode, message, field, value string) *errors.Error

+ func RecoverWithError(code errors.ErrorCode) *errors.Error

+ func SafeExecute(fn func() error, operation string) error

+ func SetErrorHandler(handler ErrorHandler)

+ func WrapLoggerError(originalErr error, code errors.ErrorCode, message string) *errors.Error

+ type Architecture int

+ const SingleRing

+ const ThreadedRings

+ func ParseArchitecture(s string) (Architecture, error)

+ func (a Architecture) String() string

+ type AtomicLevel struct

+ func NewAtomicLevel(level Level) *AtomicLevel

+ func (al *AtomicLevel) Enabled(level Level) bool

+ func (al *AtomicLevel) Level() Level

+ func (al *AtomicLevel) MarshalText() ([]byte, error)

+ func (al *AtomicLevel) SetLevel(level Level)

+ func (al *AtomicLevel) String() string

+ func (al *AtomicLevel) UnmarshalText(b []byte) error

+ type AutoScalingConfig struct

+ MeasurementWindow time.Duration

+ ScaleToMPSCContentionRatio uint32

+ ScaleToMPSCGoroutineCount uint32

+ ScaleToMPSCLatencyThreshold time.Duration

+ ScaleToMPSCWriteThreshold uint64

+ ScaleToSingleContentionRatio uint32

+ ScaleToSingleLatencyMax time.Duration

+ ScaleToSingleWriteThreshold uint64

+ ScalingCooldown time.Duration

+ StabilityRequirement int

+ func DefaultAutoScalingConfig() AutoScalingConfig

+ type AutoScalingLogger struct

+ func NewAutoScalingLogger(cfg Config, scalingConfig AutoScalingConfig, opts ...Option) (*AutoScalingLogger, error)

+ func (asl *AutoScalingLogger) Close() error

+ func (asl *AutoScalingLogger) Debug(msg string, fields ...Field)

+ func (asl *AutoScalingLogger) Error(msg string, fields ...Field)

+ func (asl *AutoScalingLogger) GetCurrentMode() AutoScalingMode

+ func (asl *AutoScalingLogger) GetScalingStats() AutoScalingStats

+ func (asl *AutoScalingLogger) Info(msg string, fields ...Field)

+ func (asl *AutoScalingLogger) Start() error

+ func (asl *AutoScalingLogger) Warn(msg string, fields ...Field)

+ type AutoScalingMetrics struct

+ type AutoScalingMode uint32

+ const MPSCMode

+ const SingleRingMode

+ func (m AutoScalingMode) String() string

+ type AutoScalingStats struct

+ ActiveGoroutines uint32

+ ContentionCount uint64

+ CurrentMode AutoScalingMode

+ ScaleToMPSCCount uint64

+ ScaleToSingleCount uint64

+ TotalScaleOperations uint64

+ TotalWrites uint64

+ type Config struct

+ Architecture Architecture

+ BackpressurePolicy zephyroslite.BackpressurePolicy

+ BatchSize int64

+ Capacity int64

+ Encoder Encoder

+ IdleStrategy zephyroslite.IdleStrategy

+ Level Level

+ Name string

+ NumRings int

+ Output WriteSyncer

+ Sampler Sampler

+ TimeFn func() time.Time

+ func LoadConfigFromEnv() (*Config, error)

+ func LoadConfigFromJSON(filename string) (*Config, error)

+ func LoadConfigMultiSource(jsonFile string) (*Config, error)

+ func (c *Config) Clone() *Config

+ func (c *Config) GetStats() *stats

+ func (c *Config) Validate() error

+ type ConsoleEncoder struct

+ EnableColor bool

+ LevelCasing string

+ TimeFormat string

+ func NewColorConsoleEncoder() *ConsoleEncoder

+ func NewConsoleEncoder() *ConsoleEncoder

+ func (e *ConsoleEncoder) Encode(rec *Record, now time.Time, buf *bytes.Buffer)

+ type ContextExtractor struct

+ Keys map[ContextKey]string

+ MaxDepth int

+ type ContextKey string

+ const RequestIDKey

+ const SessionIDKey

+ const SpanIDKey

+ const TraceIDKey

+ const UserIDKey

+ type ContextLogger struct

+ func (cl *ContextLogger) Debug(msg string, fields ...Field)

+ func (cl *ContextLogger) Error(msg string, fields ...Field)

+ func (cl *ContextLogger) Fatal(msg string, fields ...Field)

+ func (cl *ContextLogger) Info(msg string, fields ...Field)

+ func (cl *ContextLogger) Warn(msg string, fields ...Field)

+ func (cl *ContextLogger) With(fields ...Field) *ContextLogger

+ func (cl *ContextLogger) WithAdditionalContext(ctx context.Context, extractor *ContextExtractor) *ContextLogger

+ type Depth int

+ const FirstFrame

+ const FullStack

+ type DynamicConfigWatcher struct

+ func EnableDynamicLevel(logger *Logger, configPath string) (*DynamicConfigWatcher, error)

+ func NewDynamicConfigWatcher(configPath string, atomicLevel *AtomicLevel) (*DynamicConfigWatcher, error)

+ func (w *DynamicConfigWatcher) IsRunning() bool

+ func (w *DynamicConfigWatcher) Start() error

+ func (w *DynamicConfigWatcher) Stop() error

+ type Encoder interface

+ Encode func(rec *Record, now time.Time, buf *bytes.Buffer)

+ type ErrorHandler func(err *errors.Error)

+ func GetErrorHandler() ErrorHandler

+ type Field struct

+ B []byte

+ F64 float64

+ I64 int64

+ K string

+ Obj interface{}

+ Str string

+ T kind

+ U64 uint64

+ func Binary(k string, v []byte) Field

+ func Bool(k string, v bool) Field

+ func Bytes(k string, v []byte) Field

+ func Dur(k string, v time.Duration) Field

+ func Err(err error) Field

+ func ErrorField(err error) Field

+ func Errors(k string, errs []error) Field

+ func Float32(k string, v float32) Field

+ func Float64(k string, v float64) Field

+ func Int(k string, v int) Field

+ func Int16(k string, v int16) Field

+ func Int32(k string, v int32) Field

+ func Int64(k string, v int64) Field

+ func Int8(k string, v int8) Field

+ func NamedErr(k string, err error) Field

+ func NamedError(k string, err error) Field

+ func Object(k string, val interface{}) Field

+ func Secret(k, v string) Field

+ func Str(k, v string) Field

+ func String(k, v string) Field

+ func Stringer(k string, val interface{ ... }) Field

+ func Time(k string, v time.Time) Field

+ func TimeField(k string, v time.Time) Field

+ func Uint(k string, v uint) Field

+ func Uint16(k string, v uint16) Field

+ func Uint32(k string, v uint32) Field

+ func Uint64(k string, v uint64) Field

+ func Uint8(k string, v uint8) Field

+ func (f Field) BoolValue() bool

+ func (f Field) BytesValue() []byte

+ func (f Field) DurationValue() time.Duration

+ func (f Field) FloatValue() float64

+ func (f Field) IntValue() int64

+ func (f Field) IsBool() bool

+ func (f Field) IsBytes() bool

+ func (f Field) IsDuration() bool

+ func (f Field) IsFloat() bool

+ func (f Field) IsInt() bool

+ func (f Field) IsString() bool

+ func (f Field) IsTime() bool

+ func (f Field) IsUint() bool

+ func (f Field) Key() string

+ func (f Field) StringValue() string

+ func (f Field) TimeValue() time.Time

+ func (f Field) Type() kind

+ func (f Field) UintValue() uint64

+ type Hook func(rec *Record)

+ type IdleStrategy = zephyroslite.IdleStrategy

+ func NewChannelIdleStrategy(timeout time.Duration) IdleStrategy

+ func NewProgressiveIdleStrategy() IdleStrategy

+ func NewSleepingIdleStrategy(sleepDuration time.Duration, maxSpins int) IdleStrategy

+ func NewSpinningIdleStrategy() IdleStrategy

+ func NewYieldingIdleStrategy(maxSpins int) IdleStrategy

+ type JSONEncoder struct

+ LevelKey string

+ MsgKey string

+ RFC3339 bool

+ TimeKey string

+ func NewJSONEncoder() *JSONEncoder

+ func (e *JSONEncoder) Encode(rec *Record, now time.Time, buf *bytes.Buffer)

+ type Level int32

+ const DPanic

+ const Debug

+ const Error

+ const Fatal

+ const Info

+ const Panic

+ const StacktraceDisabled

+ const Warn

+ func AllLevels() []Level

+ func ParseLevel(s string) (Level, error)

+ func (l *Level) UnmarshalText(b []byte) error

+ func (l Level) Enabled(min Level) bool

+ func (l Level) IsDPanic() bool

+ func (l Level) IsDebug() bool

+ func (l Level) IsError() bool

+ func (l Level) IsFatal() bool

+ func (l Level) IsInfo() bool

+ func (l Level) IsPanic() bool

+ func (l Level) IsWarn() bool

+ func (l Level) MarshalText() ([]byte, error)

+ func (l Level) String() string

+ type LevelFlag struct

+ func NewLevelFlag(level *Level) *LevelFlag

+ func (lf *LevelFlag) Set(s string) error

+ func (lf *LevelFlag) String() string

+ func (lf *LevelFlag) Type() string

+ type Logger struct

+ func New(cfg Config, opts ...Option) (*Logger, error)

+ func (l *Logger) AtomicLevel() *AtomicLevel

+ func (l *Logger) Close() error

+ func (l *Logger) DPanic(msg string, fields ...Field) bool

+ func (l *Logger) Debug(msg string, fields ...Field) bool

+ func (l *Logger) Debugf(format string, args ...any) bool

+ func (l *Logger) Error(msg string, fields ...Field) bool

+ func (l *Logger) Errorf(format string, args ...any) bool

+ func (l *Logger) Fatal(msg string, fields ...Field)

+ func (l *Logger) Info(msg string, fields ...Field) bool

+ func (l *Logger) InfoFields(msg string, fields ...Field) bool

+ func (l *Logger) Infof(format string, args ...any) bool

+ func (l *Logger) Level() Level

+ func (l *Logger) Named(name string) *Logger

+ func (l *Logger) Panic(msg string, fields ...Field) bool

+ func (l *Logger) SetLevel(min Level)

+ func (l *Logger) Start()

+ func (l *Logger) Stats() map[string]int64

+ func (l *Logger) Sync() error

+ func (l *Logger) Warn(msg string, fields ...Field) bool

+ func (l *Logger) Warnf(format string, args ...any) bool

+ func (l *Logger) With(fields ...Field) *Logger

+ func (l *Logger) WithContext(ctx context.Context) *ContextLogger

+ func (l *Logger) WithContextExtractor(ctx context.Context, extractor *ContextExtractor) *ContextLogger

+ func (l *Logger) WithContextValue(ctx context.Context, key ContextKey, fieldName string) *ContextLogger

+ func (l *Logger) WithOptions(opts ...Option) *Logger

+ func (l *Logger) WithRequestID(ctx context.Context) *ContextLogger

+ func (l *Logger) WithTraceID(ctx context.Context) *ContextLogger

+ func (l *Logger) WithUserID(ctx context.Context) *ContextLogger

+ func (l *Logger) Write(fill func(*Record)) bool

+ type Option func(*loggerOptions)

+ func AddStacktrace(min Level) Option

+ func Development() Option

+ func WithCaller() Option

+ func WithCallerSkip(n int) Option

+ func WithHook(h Hook) Option

+ type ProcessorFunc func(record *Record)

+ type Record struct

+ Caller string

+ Level Level

+ Logger string

+ Msg string

+ Stack string

+ func NewRecord(level Level, msg string) *Record

+ func (r *Record) AddField(field Field) bool

+ func (r *Record) FieldCount() int

+ func (r *Record) GetField(index int) Field

+ func (r *Record) Reset()

+ type Ring struct

+ func (r *Ring) Close()

+ func (r *Ring) Flush() error

+ func (r *Ring) Loop()

+ func (r *Ring) ProcessBatch() int

+ func (r *Ring) Stats() map[string]int64

+ func (r *Ring) Write(fill func(*Record)) bool

+ type Sampler interface

+ Allow func(level Level) bool

+ type Stack struct

+ func CaptureStack(skip int, depth Depth) *Stack

+ func (s *Stack) FormatStack() string

+ func (s *Stack) Next() (runtime.Frame, bool)

+ type TextEncoder struct

+ QuoteValues bool

+ SanitizeKeys bool

+ TimeFormat string

+ func NewTextEncoder() *TextEncoder

+ func (e *TextEncoder) Encode(rec *Record, now time.Time, buf *bytes.Buffer)

+ type TokenBucketSampler struct

+ func NewTokenBucketSampler(capacity, refill int64, every time.Duration) *TokenBucketSampler

+ func (s *TokenBucketSampler) Allow(_ Level) bool

+ type WriteSyncer interface

+ Sync func() error

+ func AddSync(w io.Writer) WriteSyncer

+ func MultiWriteSyncer(writers ...WriteSyncer) WriteSyncer

+ func MultiWriter(writers ...io.Writer) WriteSyncer

+ func NewFileSyncer(file *os.File) WriteSyncer

+ func NewNopSyncer(w io.Writer) WriteSyncer

+ func WrapWriter(w io.Writer) WriteSyncer

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