promtail

Documentation

Index

• type Option
  • func WithLogger(log log.Logger) Option
  • func WithRegisterer(reg prometheus.Registerer) Option
• type Promtail
  • func New(ctx context.Context, f io.Writer, cfg config.Config, opts ...Option) (*Promtail, error)
  • func (p *Promtail) Client() client.Client
  • func (p *Promtail) Run(ctx context.Context) error
  • func (p *Promtail) Shutdown()

Types

type Option

type Option func(p *Promtail)

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

func WithLogger

func WithLogger(log log.Logger) Option

WithLogger overrides the default logger for Promtail.

func WithRegisterer

func WithRegisterer(reg prometheus.Registerer) Option

WithRegisterer overrides the default registerer for Promtail.

type Promtail

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

Promtail is the root struct for Promtail.

func New

func New(ctx context.Context, f io.Writer, cfg config.Config, opts ...Option) (*Promtail, error)

New makes a new Promtail.

func (*Promtail) Client

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

Client returns the underlying client Promtail uses to write to Loki.

func (*Promtail) Run

func (p *Promtail) Run(ctx context.Context) error

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

func (*Promtail) Shutdown

func (p *Promtail) Shutdown()

Shutdown the promtail.