config

Documentation

Overview

Package config implements global metrics configuration options.

Index

• type Config
  • func DefaultConfig() Config
  • func (c *Config) Validate() error

Types

type Config

type Config struct {
	// Metrics mode (none, pull, push).
	Mode string `yaml:"mode"`
	// Metrics pull address.
	Address string `yaml:"address"`

	// Metrics push job name (debug-only).
	JobName string `yaml:"job_name,omitempty"`
	// Metrics push instance labels (debug-only).
	Labels map[string]string `yaml:"labels,omitempty"`
	// Metrics push interval (debug-only).
	Interval time.Duration `yaml:"interval,omitempty"`
}

Config is the metrics configuration structure.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration settings.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration settings.