logs

Documentation

Overview

Package logs implements logs support for the Grafana Agent.

Index

• type Config
  • func (c *Config) ApplyDefaults() error
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Instance
  • func NewInstance(reg prometheus.Registerer, c *InstanceConfig, l log.Logger) (*Instance, error)
  • func (i *Instance) ApplyConfig(c *InstanceConfig) error
  • func (i *Instance) SendEntry(entry api.Entry, dur time.Duration) bool
  • func (i *Instance) Stop()
• type InstanceConfig
  • func (c *InstanceConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Logs
  • func New(reg prometheus.Registerer, c *Config, l log.Logger) (*Logs, error)
  • func (l *Logs) ApplyConfig(c *Config) error
  • func (l *Logs) Instance(name string) *Instance
  • func (l *Logs) Stop()

Types

type Config

type Config struct {
	PositionsDirectory string            `yaml:"positions_directory,omitempty"`
	Configs            []*InstanceConfig `yaml:"configs,omitempty"`
}

Config controls the configuration of the Loki log scraper.

func (*Config) ApplyDefaults

func (c *Config) ApplyDefaults() error

ApplyDefaults applies defaults to the Config and ensures that it is valid.

Validations:

1. No two InstanceConfigs may have the same name.
2. No two InstanceConfigs may have the same positions path.
3. No InstanceConfig may have an empty name.
4. If InstanceConfig positions path is empty, shared PositionsDirectory must not be empty.

Defaults:

1. If a positions config is empty, it will be generated based on the InstanceConfig name and Config.PositionsDirectory.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type Instance

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

Instance is an individual Logs instance.

func NewInstance

func NewInstance(reg prometheus.Registerer, c *InstanceConfig, l log.Logger) (*Instance, error)

NewInstance creates and starts a Logs instance.

func (*Instance) ApplyConfig

func (i *Instance) ApplyConfig(c *InstanceConfig) error

ApplyConfig will apply a new InstanceConfig. If the config hasn't changed, then nothing will happen, otherwise the old Promtail will be stopped and then replaced with a new one.

func (*Instance) SendEntry

func (i *Instance) SendEntry(entry api.Entry, dur time.Duration) bool

SendEntry passes an entry to the internal promtail client and returns true if successfully sent. It is best effort and not guaranteed to succeed.

func (*Instance) Stop

func (i *Instance) Stop()

Stop stops the Promtail instance.

type InstanceConfig

type InstanceConfig struct {
	Name string `yaml:"name,omitempty"`

	ClientConfigs   []client.Config       `yaml:"clients,omitempty"`
	PositionsConfig positions.Config      `yaml:"positions,omitempty"`
	ScrapeConfig    []scrapeconfig.Config `yaml:"scrape_configs,omitempty"`
	TargetConfig    file.Config           `yaml:"target_config,omitempty"`
}

InstanceConfig is an individual Promtail config.

func (*InstanceConfig) UnmarshalYAML

func (c *InstanceConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type Logs

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

Logs is a Logs log collection. It uses multiple distinct sets of Logs Promtail agents to collect logs and send them to a Logs server.

func New

func New(reg prometheus.Registerer, c *Config, l log.Logger) (*Logs, error)

New creates and starts Loki log collection.

func (*Logs) ApplyConfig

func (l *Logs) ApplyConfig(c *Config) error

ApplyConfig updates Logs with a new Config.

func (*Logs) Instance

func (l *Logs) Instance(name string) *Instance

Instance is used to retrieve a named Logs instance

func (*Logs) Stop

func (l *Logs) Stop()

Stop stops the log collector.