velocity

package module

Go to main page

Versions in this module

v1

v1.1.3

May 8, 2026

Changes in this version

type Theme

+ func (t *Theme) EnsureCached() *Theme

v1.1.2

May 8, 2026

Changes in this version

type Template

+ func (t *Template) CachedMessageIndentStr() string

v1.1.1

May 8, 2026

v1.1.0

May 8, 2026

Changes in this version

type Logger

+ func (l *Logger) Newline()

+ func (l *Logger) Render(r Renderable)

+ func (l *Logger) RenderRaw(r Renderable)

+ func (l *Logger) SetTheme(theme *Theme)

+ func (l *Logger) Theme() *Theme

+ type Renderable interface

+ Render func(w io.Writer) error

type Template

+ func (t *Template) CachedIndentStr() string

+ func (t *Template) CachedPrefixWidth() int

type Theme

+ func (t *Theme) CachedFieldKeyFg() string

+ func (t *Theme) CachedFieldValFg() string

+ func (t *Theme) CachedInfoColourFg() string

+ func (t *Theme) CachedMessageFg() string

+ func (t *Theme) CachedTableHeaderFg() string

v1.0.0

Apr 4, 2026

Changes in this version

+ const DefaultBatchSize

+ const DefaultFlushInterval

+ const DefaultRingBufferSize

+ const HintConsoleLog

+ const HintStackTrace

+ const HintStructuredLog

+ const LevelStrDebug

+ const LevelStrError

+ const LevelStrFatal

+ const LevelStrInfo

+ const LevelStrOff

+ const LevelStrWarn

+ const Reset

+ var ErrWriterClosed = errors.New("writer is closed")

+ var TemplateDefault = &Template

+ var TemplateJSON = &Template

+ var TemplateMinimal = &Template

+ var TemplateSimple = &Template

+ var ThemeDracula = cachedTheme(Theme{ ... })

+ var ThemeNightOwl = cachedTheme(Theme{ ... })

+ var ThemeNord = cachedTheme(Theme{ ... })

+ var ThemeSolarized = cachedTheme(Theme{ ... })

+ func AppendString(b []byte, s string) []byte

+ func ByteSlice(s string) []byte

+ func ContextWithFields(ctx context.Context, fields ...Field) context.Context

+ func FieldValueToString(f Field) string

+ func GetBuffer(hint int) *bytes.Buffer

+ func GetTemplateBuffer() *bytes.Buffer

+ func IsTerminalWriter(w io.Writer) bool

+ func NewContext(ctx context.Context, l *Logger) context.Context

+ func PutBuffer(buf *bytes.Buffer)

+ func PutFieldSlice(fields []Field)

+ func PutTemplateBuffer(buf *bytes.Buffer)

+ func UnsafeString(b []byte) string

+ type AtomicLevel struct

+ func NewAtomicLevel(l Level) *AtomicLevel

+ func (al *AtomicLevel) CompareAndSwap(old, newLevel Level) bool

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

+ func (al *AtomicLevel) Level() Level

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

+ type BufferPool struct

+ func NewBufferPool() *BufferPool

+ func (bp *BufferPool) Get(hint int) *bytes.Buffer

+ func (bp *BufferPool) Put(buf *bytes.Buffer)

+ type Builder struct

+ func ApplyOptions(b *Builder, opts ...Option) *Builder

+ func NewConfig() *Builder

+ func PresetContainer() *Builder

+ func PresetDevelopment() *Builder

+ func PresetHighPerformance() *Builder

+ func PresetProduction() *Builder

+ func PresetTesting(w io.Writer) *Builder

+ func (b *Builder) Build() (*Config, error)

+ func (b *Builder) Clone() *Builder

+ func (b *Builder) DisableColour() *Builder

+ func (b *Builder) MustBuild() *Config

+ func (b *Builder) MustWithDisplayTimezone(tz string) *Builder

+ func (b *Builder) WithBufferSize(size int) *Builder

+ func (b *Builder) WithColour(enabled bool) *Builder

+ func (b *Builder) WithDisplayTimezone(tz string) (*Builder, error)

+ func (b *Builder) WithFatalHandler(fn FatalHandler) *Builder

+ func (b *Builder) WithFieldDisplayMode(mode FieldDisplayMode) *Builder

+ func (b *Builder) WithFieldPoolSize(size int) *Builder

+ func (b *Builder) WithFormat(format Format) *Builder

+ func (b *Builder) WithLevel(level Level) *Builder

+ func (b *Builder) WithOutput(w io.Writer) *Builder

+ func (b *Builder) WithSampling(initial, thereafter uint32) *Builder

+ func (b *Builder) WithStructuredLevel(level Level) *Builder

+ func (b *Builder) WithStructuredOutput(w io.Writer) *Builder

+ func (b *Builder) WithTheme(theme *Theme) *Builder

+ func (b *Builder) WithTimeFormat(format string) *Builder

+ type BytesBuffer struct

+ func NewBytesBuffer(buf *bytes.Buffer) *BytesBuffer

+ func (b *BytesBuffer) AppendTime(t time.Time, layout string)

+ func (b *BytesBuffer) Bytes() []byte

+ func (b *BytesBuffer) String() string

+ func (b *BytesBuffer) Write(p []byte) (int, error)

+ func (b *BytesBuffer) WriteByte(c byte) error

+ func (b *BytesBuffer) WriteInt(i int64)

+ func (b *BytesBuffer) WriteString(s string)

+ type Colour struct

+ func Colour256(c int) Colour

+ func RGB(r, g, b uint8) Colour

+ func (c Colour) ANSI(foreground bool) string

+ type Config struct

+ AddCaller bool

+ BufferSize int

+ CallerSkip int

+ ConsoleLevel Level

+ ConsoleOutput io.Writer

+ ConsoleTheme *Theme

+ DisableColour bool

+ DisplayTimezone *time.Location

+ FatalHandler FatalHandler

+ FieldDisplayMode FieldDisplayMode

+ FieldPoolSize int

+ Sampler Sampler

+ StructuredFormat Format

+ StructuredLevel Level

+ StructuredOutput io.Writer

+ TimeFormat string

+ func DefaultConfig() *Config

+ func DefaultContainerConfig() *Config

+ func DefaultDevelopmentConfig() *Config

+ func DefaultHighPerformanceConfig() *Config

+ func DefaultProductionConfig() *Config

+ func DefaultTestingConfig(w io.Writer) *Config

+ type ConsoleWriter struct

+ func NewConsoleWriter(out io.Writer, theme *Theme) *ConsoleWriter

+ func NewConsoleWriterWithOptions(out io.Writer, theme *Theme, displayTimezone *time.Location, ...) *ConsoleWriter

+ func NewConsoleWriterWithTimezone(out io.Writer, theme *Theme, displayTimezone *time.Location) *ConsoleWriter

+ func (w *ConsoleWriter) Close() error

+ func (w *ConsoleWriter) IsTTY() bool

+ func (w *ConsoleWriter) SetTemplate(t *Template)

+ func (w *ConsoleWriter) SetTheme(theme *Theme)

+ func (w *ConsoleWriter) Write(e *Entry) error

+ type ConsoleWriterRB struct

+ func NewConsoleWriterRB(out io.Writer, theme *Theme, displayTimezone *time.Location, ...) *ConsoleWriterRB

+ func (w *ConsoleWriterRB) Close() error

+ func (w *ConsoleWriterRB) Metrics() (writes, errors, dropped uint64)

+ func (w *ConsoleWriterRB) SetTheme(theme *Theme)

+ func (w *ConsoleWriterRB) Write(e *Entry) error

+ type CountSampler struct

+ Initial uint64

+ Thereafter uint64

+ func NewCountSampler(initial, thereafter uint64) *CountSampler

+ func (s *CountSampler) Sample(level Level, _ string) bool

+ type Entry struct

+ Caller string

+ Fields []Field

+ Function string

+ Level Level

+ Line int

+ Message string

+ Time time.Time

+ func GetEntry() *Entry

+ func (e *Entry) Buffer() *bytes.Buffer

+ func (e *Entry) Bytes() []byte

+ func (e *Entry) Release()

+ func (e *Entry) Reset()

+ func (e *Entry) Retain()

+ func (e *Entry) SetLevel(level Level) *Entry

+ func (e *Entry) SetMessage(msg string) *Entry

+ func (e *Entry) SetTime(t time.Time) *Entry

+ func (e *Entry) String() string

+ func (e *Entry) WithError(err error) *Entry

+ func (e *Entry) WithField(key string, value any) *Entry

+ func (e *Entry) WithFields(fields ...Field) *Entry

+ func (e *Entry) Write()

+ type FatalHandler func()

+ type Field struct

+ Key string

+ Type FieldType

+ func Any(key string, val any) Field

+ func Bool(key string, val bool) Field

+ func Bytes(key string, val []byte) Field

+ func Duration(key string, val time.Duration) Field

+ func Error(key string, val error) Field

+ func F(key string, value any) Field

+ func Float64(key string, val float64) Field

+ func GetFieldSlice() []Field

+ func GetFieldSliceWithCapacity(capacity int) []Field

+ func Int(key string, val int) Field

+ func Int64(key string, val int64) Field

+ func Milliseconds(key string, val time.Duration) Field

+ func String(key, val string) Field

+ func Stringer(key string, val fmt.Stringer) Field

+ func Time(key string, val time.Time) Field

+ func (f Field) Value() any

+ type FieldDisplayMode int

+ const FieldDisplayInline

+ const FieldDisplayTree

+ func (m FieldDisplayMode) String() string

+ type FieldType byte

+ const FieldTypeAny

+ const FieldTypeBool

+ const FieldTypeBytes

+ const FieldTypeDuration

+ const FieldTypeError

+ const FieldTypeFloat64

+ const FieldTypeInt

+ const FieldTypeInt64

+ const FieldTypeString

+ const FieldTypeStringer

+ const FieldTypeTime

+ const FieldTypeUnknown

+ type Fields struct

+ func NewFields(capacity int) *Fields

+ func (fs *Fields) Add(key string, value any) *Fields

+ func (fs *Fields) AddField(f Field) *Fields

+ func (fs *Fields) Reset()

+ func (fs *Fields) Slice() []Field

+ type FilteredWriter struct

+ func NewFilteredWriter(w Writer, fn func(*Entry) bool) *FilteredWriter

+ func (fw *FilteredWriter) Close() error

+ func (fw *FilteredWriter) Write(e *Entry) error

+ type Format int

+ const FormatJSON

+ func (f Format) String() string

+ type Formatter struct

+ func NewFormatter(hint int) *Formatter

+ func (f *Formatter) AppendByte(b byte) *Formatter

+ func (f *Formatter) Bytes() []byte

+ func (f *Formatter) Release()

+ func (f *Formatter) String() string

+ func (f *Formatter) WriteInt(i int64) *Formatter

+ func (f *Formatter) WriteString(s string) *Formatter

+ type JSONWriter struct

+ func NewJSONWriter(out io.Writer) *JSONWriter

+ func (w *JSONWriter) Close() error

+ func (w *JSONWriter) Write(e *Entry) error

+ type Level int32

+ const LevelDebug

+ const LevelError

+ const LevelFatal

+ const LevelInfo

+ const LevelOff

+ const LevelWarn

+ func MustParseLevel(level string) Level

+ func (l Level) ConciseLabel() string

+ func (l Level) Icon() string

+ func (l Level) Short() byte

+ func (l Level) String() string

+ type LevelStyle int

+ const LevelStyleBadge

+ const LevelStyleIcon

+ const LevelStyleText

+ type Logger struct

+ func FromContext(ctx context.Context) *Logger

+ func New(w io.Writer) *Logger

+ func NewDevelopment() *Logger

+ func NewForTesting(w io.Writer) *Logger

+ func NewWithBuilder(builder *Builder) *Logger

+ func NewWithConfig(cfg *Config) *Logger

+ func NewWithOptions(opts ...Option) *Logger

+ func NopLogger() *Logger

+ func (l *Logger) AddWriter(name string, w Writer)

+ func (l *Logger) Banner(lines ...string)

+ func (l *Logger) Close() error

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

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

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

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

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

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

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

+ func (l *Logger) Level() Level

+ func (l *Logger) LogEntry(e *Entry)

+ func (l *Logger) Raw(message string)

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

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

+ func (l *Logger) SetTemplate(t *Template)

+ func (l *Logger) Status() *StatusFormatter

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

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

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

+ func (l *Logger) WithTemplate(t *Template) *Logger

+ type MultiWriter struct

+ func NewMultiWriter() *MultiWriter

+ func (mw *MultiWriter) AddWriter(name string, w Writer)

+ func (mw *MultiWriter) Close() error

+ func (mw *MultiWriter) RemoveWriter(name string)

+ func (mw *MultiWriter) Stats() map[string]int

+ func (mw *MultiWriter) Write(e *Entry) error

+ type NoOpWriter struct

+ func (*NoOpWriter) Close() error

+ func (*NoOpWriter) Write(_ *Entry) error

+ type Option func(*Builder)

+ func WithBufferSize(size int) Option

+ func WithCaller(enabled bool) Option

+ func WithCallerSkip(skip int) Option

+ func WithColourDisabled() Option

+ func WithColourEnabled(enabled bool) Option

+ func WithConsoleOutput(w io.Writer) Option

+ func WithDisplayTimezone(tz string) Option

+ func WithFieldPoolSize(size int) Option

+ func WithFormat(format Format) Option

+ func WithLevel(level Level) Option

+ func WithSampler(s Sampler) Option

+ func WithSampling(initial, thereafter uint32) Option

+ func WithStructuredLevel(level Level) Option

+ func WithStructuredOutput(w io.Writer) Option

+ func WithTheme(theme *Theme) Option

+ func WithTimeFormat(format string) Option

+ type RingBuffer struct

+ func NewRingBuffer(writer io.Writer, size int) *RingBuffer

+ func (rb *RingBuffer) Close() error

+ func (rb *RingBuffer) DroppedCount() uint64

+ func (rb *RingBuffer) Write(data []byte) bool

+ type RingBufferEntry struct

+ type Sampler interface

+ Sample func(level Level, msg string) bool

+ type StatusFormatter struct

+ func NewStatusFormatter(theme *Theme, isTTY bool) *StatusFormatter

+ func (sf *StatusFormatter) Fail(text string) string

+ func (sf *StatusFormatter) Info(text string) string

+ func (sf *StatusFormatter) Okay(text string) string

+ func (sf *StatusFormatter) Warn(text string) string

+ type Template struct

+ func (t *Template) CalculatePrefixWidth(entry *Entry) int

+ type TemplateBuilder struct

+ func NewTemplateBuilder() *TemplateBuilder

+ func (b *TemplateBuilder) Build() *Template

+ func (b *TemplateBuilder) WithColours(enabled bool) *TemplateBuilder

+ func (b *TemplateBuilder) WithFieldDisplayMode(mode FieldDisplayMode) *TemplateBuilder

+ func (b *TemplateBuilder) WithFields(enabled bool) *TemplateBuilder

+ func (b *TemplateBuilder) WithLevel(enabled bool) *TemplateBuilder

+ func (b *TemplateBuilder) WithLevelStyle(style LevelStyle) *TemplateBuilder

+ func (b *TemplateBuilder) WithMessage(enabled bool) *TemplateBuilder

+ func (b *TemplateBuilder) WithTime(enabled bool) *TemplateBuilder

+ func (b *TemplateBuilder) WithTimeFormat(format string) *TemplateBuilder

+ type TemplateType int

+ const TemplateTypeDefault

+ const TemplateTypeJSON

+ const TemplateTypeMinimal

+ const TemplateTypeSimple

+ type Theme struct

+ DebugColour Colour

+ ErrorColour Colour

+ ErrorValColour Colour

+ FatalColour Colour

+ FieldKeyColour Colour

+ FieldValColour Colour

+ InfoColour Colour

+ MessageColour Colour

+ Name string

+ StatusFailColour Colour

+ StatusInfoColour Colour

+ StatusOKColour Colour

+ StatusWarnColour Colour

+ TableHeader Colour

+ TimestampColour Colour

+ WarnColour Colour

+ func (t *Theme) Cache()

+ func (t *Theme) GetColourForLevel(level Level) Colour

+ type Writer interface

+ Close func() error

+ Write func(e *Entry) error

+ type WriterFunc func(*Entry) error

+ func (WriterFunc) Close() error

+ func (f WriterFunc) Write(e *Entry) error

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