flusher

Documentation

Index

• type Config
  • func NewConfig() Config
  • func (c *Config) Build(logger *zap.SugaredLogger) *Flusher
• type FlushFunc
• type Flusher
  • func (f *Flusher) Do(flush FlushFunc)
  • func (f *Flusher) Stop()

Types

type Config

type Config struct {
	// MaxConcurrent is the maximum number of goroutines flushing entries concurrently.
	// Defaults to 16.
	MaxConcurrent int `json:"max_concurrent" yaml:"max_concurrent"`
}

Config holds the configuration to build a new flusher

func NewConfig

func NewConfig() Config

NewConfig creates a new default flusher config

func (*Config) Build

func (c *Config) Build(logger *zap.SugaredLogger) *Flusher

Build uses a Config to build a new Flusher

type FlushFunc

type FlushFunc func(context.Context) error

FlushFunc is any function that flushes

type Flusher

type Flusher struct {
	*zap.SugaredLogger
	// contains filtered or unexported fields
}

Flusher is used to flush entries from a buffer concurrently. It handles max concurrency, retry behavior, and cancellation.

func (*Flusher) Do

func (f *Flusher) Do(flush FlushFunc)

Do executes the flusher function in a goroutine

func (*Flusher) Stop

func (f *Flusher) Stop()

Stop cancels all the in-progress flushers and waits until they have returned