config

Documentation

Index

• type Config
  • func (c *Config) RegisterFlags(f *flag.FlagSet)
  • func (c *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (c *Config) Setup(l log.Logger)
  • func (c Config) String() string
• type GlobalConfig
  • func (cfg *GlobalConfig) RegisterFlags(flags *flag.FlagSet)
  • func (cfg *GlobalConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
• type Options

Types

type Config

type Config struct {
	Global       GlobalConfig  `yaml:"global,omitempty"`
	ServerConfig server.Config `yaml:"server,omitempty"`
	// deprecated use ClientConfigs instead
	ClientConfig    client.Config         `yaml:"client,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"`
	Options         Options               `yaml:"options,omitempty"`
	Tracing         tracing.Config        `yaml:"tracing"`
	WAL             wal.Config            `yaml:"wal"`
}

Config for promtail, describing what files to watch.

func (*Config) RegisterFlags

func (c *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.

func (*Config) RegisterFlagsWithPrefix

func (c *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlags with prefix registers flags where every name is prefixed by prefix. If prefix is a non-empty string, prefix should end with a period.

func (*Config) Setup

func (c *Config) Setup(l log.Logger)

func (Config) String

func (c Config) String() string

type GlobalConfig

type GlobalConfig struct {
	FileWatch file.WatchConfig `mapstructure:"file_watch_config" yaml:"file_watch_config"`
}

GlobalConfig holds configuration settings which apply to all targets. Individual scrape jobs can override the defaults.

func (*GlobalConfig) RegisterFlags

func (cfg *GlobalConfig) RegisterFlags(flags *flag.FlagSet)

RegisterFlags register flags.

func (*GlobalConfig) RegisterFlagsWithPrefix

func (cfg *GlobalConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlags with prefix registers flags where every name is prefixed by prefix. If prefix is a non-empty string, prefix should end with a period.

type Options

type Options struct {
	StreamLagLabels dskit_flagext.StringSliceCSV `mapstructure:"stream_lag_labels,omitempty" yaml:"stream_lag_labels,omitempty" doc:"deprecated"`
}

Options contains cross-cutting promtail configurations