valitail

Documentation

Index

• type Option
  • func WithLogger(log log.Logger) Option
  • func WithRegisterer(reg prometheus.Registerer) Option
• type Valitail
  • func New(cfg config.Config, dryRun bool, opts ...Option) (*Valitail, error)
  • func (p *Valitail) Client() client.Client
  • func (p *Valitail) Run() error
  • func (p *Valitail) Shutdown()

Types

type Option

type Option func(p *Valitail)

Option is a function that can be passed to the New method of Valitail and customize the Valitail that is created.

func WithLogger

func WithLogger(log log.Logger) Option

WithLogger overrides the default logger for Valitail.

func WithRegisterer

func WithRegisterer(reg prometheus.Registerer) Option

WithRegisterer overrides the default registerer for Valitail.

type Valitail

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

Valitail is the root struct for Valitail.

func New

func New(cfg config.Config, dryRun bool, opts ...Option) (*Valitail, error)

New makes a new Valitail.

func (*Valitail) Client

func (p *Valitail) Client() client.Client

Client returns the underlying client Valitail uses to write to Vali.

func (*Valitail) Run

func (p *Valitail) Run() error

Run the valitail; will block until a signal is received.

func (*Valitail) Shutdown

func (p *Valitail) Shutdown()

Shutdown the valitail.