Documentation
¶
Overview ¶
Package logs implements logs support for the Grafana Agent.
Index ¶
- Variables
- func DefaultConfig() config.Config
- type Config
- type GlobalConfig
- type Instance
- type InstanceConfig
- type ListTargetsResponse
- type Logs
- func (l *Logs) ApplyConfig(c *Config, dryRun bool) error
- func (l *Logs) Instance(name string) *Instance
- func (l *Logs) ListInstancesHandler(w http.ResponseWriter, _ *http.Request)
- func (l *Logs) ListTargetsHandler(w http.ResponseWriter, r *http.Request)
- func (l *Logs) Stop()
- func (l *Logs) WireAPI(r *mux.Router)
- type TargetInfo
- type TargetSet
Constants ¶
This section is empty.
Variables ¶
var DefaultGlobalConfig = GlobalConfig{ ClientConfigs: []client.Config{}, FileWatch: file.WatchConfig{ MinPollFrequency: 250 * time.Millisecond, MaxPollFrequency: 250 * time.Millisecond, }, }
DefaultGlobalConfig holds default global settings to be used across all instances.
Functions ¶
func DefaultConfig ¶
DefaultConfig returns a default config for a Logs instance.
Types ¶
type Config ¶
type Config struct {
PositionsDirectory string `yaml:"positions_directory,omitempty"`
Global GlobalConfig `yaml:"global,omitempty"`
Configs []*InstanceConfig `yaml:"configs,omitempty"`
}
Config controls the configuration of the Loki log scraper.
func (*Config) ApplyDefaults ¶
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.
- If an InstanceConfigs's ClientConfigs is empty, it will be generated based on the Config.GlobalConfig.ClientConfigs.
func (*Config) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
type GlobalConfig ¶
type GlobalConfig struct {
FileWatch file.WatchConfig `yaml:"file_watch_config,omitempty"`
ClientConfigs []client.Config `yaml:"clients,omitempty"`
}
GlobalConfig holds global settings that apply to all instances by default.
func (GlobalConfig) IsZero ¶
func (c GlobalConfig) IsZero() bool
func (*GlobalConfig) UnmarshalYAML ¶
func (c *GlobalConfig) 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, g GlobalConfig, l log.Logger, dryRun bool) (*Instance, error)
NewInstance creates and starts a Logs instance.
func (*Instance) ApplyConfig ¶
func (i *Instance) ApplyConfig(c *InstanceConfig, g GlobalConfig, dryRun bool) 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 ¶
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"`
LimitsConfig limit.Config `yaml:"limits_config,omitempty"`
}
InstanceConfig is an individual Promtail config.
func (*InstanceConfig) Initialize ¶
func (c *InstanceConfig) Initialize()
func (*InstanceConfig) UnmarshalYAML ¶
func (c *InstanceConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements yaml.Unmarshaler.
type ListTargetsResponse ¶
type ListTargetsResponse []TargetInfo
ListTargetsResponse is returned by the ListTargetsHandler.
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, dryRun bool) (*Logs, error)
New creates and starts Loki log collection.
func (*Logs) ApplyConfig ¶
ApplyConfig updates Logs with a new Config.
func (*Logs) ListInstancesHandler ¶
func (l *Logs) ListInstancesHandler(w http.ResponseWriter, _ *http.Request)
ListInstancesHandler writes the set of currently running instances to the http.ResponseWriter.
func (*Logs) ListTargetsHandler ¶
func (l *Logs) ListTargetsHandler(w http.ResponseWriter, r *http.Request)
ListTargetsHandler retrieves the full set of targets across all instances and shows information on them.
type TargetInfo ¶
type TargetInfo struct {
InstanceName string `json:"instance"`
TargetGroup string `json:"target_group"`
Type target.TargetType `json:"type"`
Labels model.LabelSet `json:"labels"`
DiscoveredLabels model.LabelSet `json:"discovered_labels"`
Ready bool `json:"ready"`
Details interface{} `json:"details"`
}
TargetInfo describes a specific target.
Source Files