Documentation
¶
Overview ¶
Package loki implements Loki logs support for the Grafana Cloud Agent.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Enabled bool `yaml:"-"`
PositionsDirectory string `yaml:"positions_directory"`
Configs []*InstanceConfig `yaml:"configs"`
}
Config controls the configuration of the Loki log scraper.
func (*Config) ApplyDefaults ¶ added in v0.12.0
func (c *Config) ApplyDefaults() error
ApplyDefaults applies defaults to the Config and ensures that it is valid.
Validations:
- No two InstanceConfigs may have the same name.
- No two InstanceConfigs may have the same positions path.
- No InstanceConfig may have an empty name.
- If InstanceConfig positions path is empty, shared PositionsDirectory must not be empty.
Defaults:
- 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
type Instance ¶ added in v0.13.0
type Instance struct {
// contains filtered or unexported fields
}
Instance is an individual Loki instance.
func NewInstance ¶ added in v0.13.0
func NewInstance(reg prometheus.Registerer, c *InstanceConfig, l log.Logger) (*Instance, error)
NewInstance creates and starts a Loki instance.
func (*Instance) ApplyConfig ¶ added in v0.13.0
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.
type InstanceConfig ¶ added in v0.12.0
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 ¶ added in v0.12.0
func (c *InstanceConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
type Loki ¶
type Loki struct {
// contains filtered or unexported fields
}
func New ¶
func New(reg prometheus.Registerer, c Config, l log.Logger) (*Loki, error)
New creates and starts Loki log collection.
func (*Loki) ApplyConfig ¶ added in v0.13.0
func (l *Loki) ApplyConfig(c Config) error
ApplyConfig updates Loki with a new Config.
Source Files
Click to show internal directories.
Click to hide internal directories.