zaputil

package

v1.52.1 Latest Latest Go to latest Published: Sep 24, 2026 License: Apache-2.0 Imports: 12 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livekit/protocol

Links

Open Source Insights

Documentation ¶

Index ¶

func NewDeferredValueCore(core zapcore.Core, def *Deferrer) zapcore.Core
func NewFieldSampler(core zapcore.Core, config FieldSamplerConfig) zapcore.Core
func NewSamplerCore(core zapcore.Core, s *Sampler) zapcore.Core
type AtomicFieldSampleRate
- func NewAtomicFieldSampleRate(rate float64) *AtomicFieldSampleRate
- func (r *AtomicFieldSampleRate) SetRate(rate float64)
- func (r *AtomicFieldSampleRate) Threshold() uint64
type ComponentLevelResolver
type ComponentLeveler
- func NewComponentLeveler(parent *ComponentLeveler, r ComponentLevelResolver) *ComponentLeveler
- func NewRootComponentLeveler(ws zapcore.WriteSyncer, r ComponentLevelResolver) *ComponentLeveler
- func (l *ComponentLeveler) ComponentLevel(component string) zapcore.LevelEnabler
- func (l *ComponentLeveler) Refresh()
- func (l *ComponentLeveler) WriteEnabler(component string) *WriteEnabler
type DeferredFieldResolver
type Deferrer
- func (b *Deferrer) Reset()
- func (b *Deferrer) Resolve(args ...any)
type Encoder
- func NewDevelopmentEncoder() Encoder
- func NewProductionEncoder() Encoder
- func (e Encoder) Core(out *WriteEnabler) zapcore.Core
- func (e Encoder) WithValues(kvs ...any) Encoder
type FieldSampleRate
type FieldSamplerAction
type FieldSamplerConfig
type FixedComponentLevel
- func (l FixedComponentLevel) ResolveComponentLevel(string) (zapcore.Level, bool)
type NoOpDeferrer
- func (n NoOpDeferrer) Reset()
- func (n NoOpDeferrer) Resolve(args ...any)
type OrLevelEnabler
- func (e OrLevelEnabler) Enabled(lvl zapcore.Level) bool
type Sampler
- func NewSampler(tick time.Duration, first, thereafter int) *Sampler
type Tee
- func NewTee(newCore func(enab zapcore.LevelEnabler) zapcore.Core) Tee
- func (t Tee) Core(enab zapcore.LevelEnabler) zapcore.Core
- func (t Tee) WithValues(kvs ...any) Tee
type WriteEnabler
- func NewWriteEnabler(ws zapcore.WriteSyncer, enab zapcore.LevelEnabler) *WriteEnabler

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewDeferredValueCore ¶

func NewDeferredValueCore(core zapcore.Core, def *Deferrer) zapcore.Core

func NewFieldSampler ¶

func NewFieldSampler(core zapcore.Core, config FieldSamplerConfig) zapcore.Core

func NewSamplerCore ¶

func NewSamplerCore(core zapcore.Core, s *Sampler) zapcore.Core

Types ¶

type AtomicFieldSampleRate ¶

type AtomicFieldSampleRate uint64

func NewAtomicFieldSampleRate ¶

func NewAtomicFieldSampleRate(rate float64) *AtomicFieldSampleRate

func (*AtomicFieldSampleRate) SetRate ¶

func (r *AtomicFieldSampleRate) SetRate(rate float64)

func (*AtomicFieldSampleRate) Threshold ¶

func (r *AtomicFieldSampleRate) Threshold() uint64

type ComponentLevelResolver ¶ added in v1.52.0

type ComponentLevelResolver interface {
	ResolveComponentLevel(component string) (zapcore.Level, bool)
}

ComponentLevelResolver is given a full dotted component path. Returning false defers to the leveler's parent.

type ComponentLeveler ¶ added in v1.52.0

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

One ComponentLeveler per configuration source.

func NewComponentLeveler ¶ added in v1.52.0

func NewComponentLeveler(parent *ComponentLeveler, r ComponentLevelResolver) *ComponentLeveler

NewComponentLeveler derives a leveler that can only widen parent: a level parent already enables stays enabled whatever r resolves.

func NewRootComponentLeveler ¶ added in v1.52.0

func NewRootComponentLeveler(ws zapcore.WriteSyncer, r ComponentLevelResolver) *ComponentLeveler

func (*ComponentLeveler) ComponentLevel ¶ added in v1.52.0

func (l *ComponentLeveler) ComponentLevel(component string) zapcore.LevelEnabler

func (*ComponentLeveler) Refresh ¶ added in v1.52.0

func (l *ComponentLeveler) Refresh()

Refresh re-resolves in place, so enablers already handed out see the new levels.

func (*ComponentLeveler) WriteEnabler ¶ added in v1.52.0

func (l *ComponentLeveler) WriteEnabler(component string) *WriteEnabler

WriteEnabler is memoized per component so that rebuilding a core does not allocate.

type DeferredFieldResolver ¶

type DeferredFieldResolver interface {
	Resolve(args ...any)
	Reset()
}

type Deferrer ¶

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

func (*Deferrer) Reset ¶ added in v1.39.0

func (b *Deferrer) Reset()

func (*Deferrer) Resolve ¶ added in v1.39.0

func (b *Deferrer) Resolve(args ...any)

type Encoder ¶

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

func NewDevelopmentEncoder ¶

func NewDevelopmentEncoder() Encoder

func NewProductionEncoder ¶

func NewProductionEncoder() Encoder

func (Encoder) Core ¶

func (e Encoder) Core(out *WriteEnabler) zapcore.Core

func (Encoder) WithValues ¶

func (e Encoder) WithValues(kvs ...any) Encoder

type FieldSampleRate ¶

type FieldSampleRate interface {
	Threshold() uint64
}

type FieldSamplerAction ¶

type FieldSamplerAction int

const (
	OmitSampledLog FieldSamplerAction = iota
	AnnotateSampledLog
)

type FieldSamplerConfig ¶

type FieldSamplerConfig struct {
	FieldName           string
	Rate                FieldSampleRate
	Action              FieldSamplerAction
	AnnotationFieldName string
}

type FixedComponentLevel ¶ added in v1.52.0

type FixedComponentLevel zapcore.Level

func (FixedComponentLevel) ResolveComponentLevel ¶ added in v1.52.0

func (l FixedComponentLevel) ResolveComponentLevel(string) (zapcore.Level, bool)

type NoOpDeferrer ¶ added in v1.39.0

type NoOpDeferrer struct{}

func (NoOpDeferrer) Reset ¶ added in v1.39.0

func (n NoOpDeferrer) Reset()

func (NoOpDeferrer) Resolve ¶ added in v1.39.0

func (n NoOpDeferrer) Resolve(args ...any)

type OrLevelEnabler ¶ added in v1.14.0

type OrLevelEnabler [2]zapcore.LevelEnabler

func (OrLevelEnabler) Enabled ¶ added in v1.14.0

func (e OrLevelEnabler) Enabled(lvl zapcore.Level) bool

type Sampler ¶

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

func NewSampler ¶

func NewSampler(tick time.Duration, first, thereafter int) *Sampler

type Tee ¶ added in v1.52.0

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

Tee duplicates every entry a derived logger writes. The enabler handed to newCore is the level that logger resolved, and is what the built core must gate on.

func NewTee ¶ added in v1.52.0

func NewTee(newCore func(enab zapcore.LevelEnabler) zapcore.Core) Tee

func (Tee) Core ¶ added in v1.52.0

func (t Tee) Core(enab zapcore.LevelEnabler) zapcore.Core

Core returns nil for the zero Tee.

func (Tee) WithValues ¶ added in v1.52.0

func (t Tee) WithValues(kvs ...any) Tee

type WriteEnabler ¶

type WriteEnabler struct {
	zapcore.WriteSyncer
	zapcore.LevelEnabler
}

func NewWriteEnabler ¶

func NewWriteEnabler(ws zapcore.WriteSyncer, enab zapcore.LevelEnabler) *WriteEnabler

Source Files ¶

View all Source files

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