config

Documentation

Index

• Variables
• func CheckTargetAddress(address model.LabelValue) error
• func ReloadConfig(filename string, logger *zap.Logger, rls ...func(*Config) error) (err error)
• type Builder
  • func NewConfigBuilder() *Builder
  • func (b *Builder) AddFlags(flags *flag.FlagSet)
  • func (b *Builder) InitFromViper(v *viper.Viper) *Builder
• type Config
  • func Load(s string, logger *zap.Logger) (*Config, error)
  • func LoadFile(filename string, logger *zap.Logger) (*Config, error)
  • func (c *Config) SetDirectory(dir string)
  • func (c Config) String() string
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ExemplarsConfig
• type GlobalConfig
  • func (c *GlobalConfig) SetDirectory(dir string)
  • func (c *GlobalConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ScrapeConfig
  • func (c *ScrapeConfig) MarshalYAML() (interface{}, error)
  • func (c *ScrapeConfig) SetDirectory(dir string)
  • func (c *ScrapeConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
• type StorageConfig
• type TracingClientType
  • func (t *TracingClientType) UnmarshalYAML(unmarshal func(interface{}) error) error
• type TracingConfig
  • func (t *TracingConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var (
	// DefaultConfig is the default top-level configuration.
	DefaultConfig = Config{
		GlobalConfig: DefaultGlobalConfig,
	}

	// DefaultGlobalConfig is the default global configuration.
	DefaultGlobalConfig = GlobalConfig{
		ScrapeInterval:     model.Duration(1 * time.Minute),
		ScrapeTimeout:      model.Duration(10 * time.Second),
		EvaluationInterval: model.Duration(1 * time.Minute),
	}

	// DefaultScrapeConfig is the default scrape configuration.
	DefaultScrapeConfig = ScrapeConfig{

		MetricsPath:      "/metrics",
		Scheme:           "http",
		HonorLabels:      false,
		HonorTimestamps:  true,
		HTTPClientConfig: config.DefaultHTTPClientConfig,
	}
)

The defaults applied before parsing the respective config sections.

Functions

func CheckTargetAddress

func CheckTargetAddress(address model.LabelValue) error

CheckTargetAddress checks if target address is valid.

func ReloadConfig

func ReloadConfig(filename string, logger *zap.Logger, rls ...func(*Config) error) (err error)

Types

type Builder

type Builder struct {
	ConfigFile   string
	HostPort     int
	NewSDManager bool
}

func NewConfigBuilder

func NewConfigBuilder() *Builder

NewConfigBuilder creates a new configfile builder.

func (*Builder) AddFlags

func (b *Builder) AddFlags(flags *flag.FlagSet)

AddFlags adds flags for Options.

func (*Builder) InitFromViper

func (b *Builder) InitFromViper(v *viper.Viper) *Builder

InitFromViper initializes Options with properties retrieved from Viper.

type Config

type Config struct {
	GlobalConfig  GlobalConfig    `yaml:"global"`
	RuleFiles     []string        `yaml:"rule_files,omitempty"`
	ScrapeConfigs []*ScrapeConfig `yaml:"scrape_configs,omitempty"`
}

Config is the top-level configuration for Prometheus's config files.

func Load

func Load(s string, logger *zap.Logger) (*Config, error)

Load parses the YAML input s into a Config.

func LoadFile

func LoadFile(filename string, logger *zap.Logger) (*Config, error)

LoadFile parses the given YAML file into a Config.

func (*Config) SetDirectory

func (c *Config) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (Config) String

func (c Config) String() string

func (*Config) UnmarshalYAML

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

UnmarshalYAML implements the yaml.Unmarshaler interface.

type ExemplarsConfig

type ExemplarsConfig struct {
	// MaxExemplars sets the size, in # of exemplars stored, of the single circular buffer used to store exemplars in memory.
	// Use a value of 0 or less than 0 to disable the storage without having to restart Prometheus.
	MaxExemplars int64 `yaml:"max_exemplars,omitempty"`
}

ExemplarsConfig configures runtime reloadable configuration options.

type GlobalConfig

type GlobalConfig struct {
	// How frequently to scrape targets by default.
	ScrapeInterval model.Duration `yaml:"scrape_interval,omitempty"`
	// The default timeout when scraping targets.
	ScrapeTimeout model.Duration `yaml:"scrape_timeout,omitempty"`
	// How frequently to evaluate rules by default.
	EvaluationInterval model.Duration `yaml:"evaluation_interval,omitempty"`
	// File to which PromQL queries are logged.
	QueryLogFile string `yaml:"query_log_file,omitempty"`
	// The labels to add to any timeseries that this Prometheus instance scrapes.
	ExternalLabels labels.Labels `yaml:"external_labels,omitempty"`
}

GlobalConfig configures values that are used across other configuration objects.

func (*GlobalConfig) SetDirectory

func (c *GlobalConfig) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (*GlobalConfig) UnmarshalYAML

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

UnmarshalYAML implements the yaml.Unmarshaler interface.

type ScrapeConfig

type ScrapeConfig struct {
	// The job name to which the job label is set by default.
	JobName string `yaml:"job_name"`
	// Indicator whether the scraped metrics should remain unmodified.
	HonorLabels bool `yaml:"honor_labels,omitempty"`
	// Indicator whether the scraped timestamps should be respected.
	HonorTimestamps bool `yaml:"honor_timestamps"`
	// A set of query parameters with which the target is scraped.
	Params url.Values `yaml:"params,omitempty"`
	// How frequently to scrape the targets of this scrape config.
	ScrapeInterval model.Duration `yaml:"scrape_interval,omitempty"`
	// The timeout for scraping targets of this config.
	ScrapeTimeout model.Duration `yaml:"scrape_timeout,omitempty"`
	// The HTTP resource path on which to fetch metrics from targets.
	MetricsPath string `yaml:"metrics_path,omitempty"`
	// The URL scheme with which to fetch metrics from targets.
	Scheme string `yaml:"scheme,omitempty"`
	// An uncompressed response body larger than this many bytes will cause the
	// scrape to fail. 0 means no limit.
	BodySizeLimit units.Base2Bytes `yaml:"body_size_limit,omitempty"`
	// More than this many samples post metric-relabeling will cause the scrape to
	// fail.
	SampleLimit uint `yaml:"sample_limit,omitempty"`
	// More than this many targets after the target relabeling will cause the
	// scrapes to fail.
	TargetLimit uint `yaml:"target_limit,omitempty"`
	// More than this many labels post metric-relabeling will cause the scrape to
	// fail.
	LabelLimit uint `yaml:"label_limit,omitempty"`
	// More than this label name length post metric-relabeling will cause the
	// scrape to fail.
	LabelNameLengthLimit uint `yaml:"label_name_length_limit,omitempty"`
	// More than this label value length post metric-relabeling will cause the
	// scrape to fail.
	LabelValueLengthLimit uint `yaml:"label_value_length_limit,omitempty"`

	ServiceDiscoveryConfigs discovery.Configs       `yaml:"-"`
	HTTPClientConfig        config.HTTPClientConfig `yaml:",inline"`

	// List of target relabel configurations.
	RelabelConfigs []*relabel.Config `yaml:"relabel_configs,omitempty"`
	// List of metric relabel configurations.
	MetricRelabelConfigs []*relabel.Config `yaml:"metric_relabel_configs,omitempty"`
}

ScrapeConfig configures a scraping unit for Prometheus.

func (*ScrapeConfig) MarshalYAML

func (c *ScrapeConfig) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface.

func (*ScrapeConfig) SetDirectory

func (c *ScrapeConfig) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (*ScrapeConfig) UnmarshalYAML

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

UnmarshalYAML implements the yaml.Unmarshaler interface.

type StorageConfig

type StorageConfig struct {
	ExemplarsConfig *ExemplarsConfig `yaml:"exemplars,omitempty"`
}

StorageConfig configures runtime reloadable configuration options.

type TracingClientType

type TracingClientType string

const (
	TracingClientHTTP TracingClientType = "http"
	TracingClientGRPC TracingClientType = "grpc"
)

func (*TracingClientType) UnmarshalYAML

func (t *TracingClientType) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type TracingConfig

type TracingConfig struct {
	ClientType       TracingClientType `yaml:"client_type,omitempty"`
	Endpoint         string            `yaml:"endpoint,omitempty"`
	SamplingFraction float64           `yaml:"sampling_fraction,omitempty"`
	WithSecure       bool              `yaml:"with_secure,omitempty"`
	TLSConfig        config.TLSConfig  `yaml:"tls_config,omitempty"`
}

TracingConfig configures the tracing options.

func (*TracingConfig) UnmarshalYAML

func (t *TracingConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.