config

Documentation

Index

• Variables
• type Config
  • func Load(s string) (*Config, error)
  • func LoadFile(logger log.Logger, filename string) (*Config, error)
  • func ParseCommandLine() *Config
  • func (c Config) String() string
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var DefaultConfig = Config{
	Web: webOptions{
		ListenAddress: "0.0.0.0:9201",
		TelemetryPath: "/metrics",
	},
	Read: readOptions{
		Timeout:     5 * time.Minute,
		Delay:       1 * time.Hour,
		IgnoreError: true,
	},
	Write: writeOptions{
		Timeout: 5 * time.Minute,
	},
	Graphite: graphite.DefaultConfig,
}

DefaultConfig is the default top-level configuration.

Types

type Config

type Config struct {
	ConfigFile string
	LogLevel   promlog.AllowedLevel
	Web        webOptions      `yaml:"web,omitempty" json:"web,omitempty"`
	Read       readOptions     `yaml:"read,omitempty" json:"read,omitempty"`
	Write      writeOptions    `yaml:"write,omitempty" json:"write,omitempty"`
	Graphite   graphite.Config `yaml:"graphite,omitempty" json:"graphite,omitempty"`

	// Catches all undefined fields and must be empty after parsing.
	XXX map[string]interface{} `yaml:",inline" json:"-"`
	// contains filtered or unexported fields
}

Config is the top-level configuration.

func Load

func Load(s string) (*Config, error)

Load parses the YAML input s into a Config.

func LoadFile

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

LoadFile parses the given YAML file into a Config.

func ParseCommandLine

func ParseCommandLine() *Config

ParseCommandLine parse flags and args from cli.

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.