config

Documentation

Index

• type Body
• type Config
  • func LoadConfig(configPath string) (Config, error)
• type Metric
• type Module
• type ScrapeType
• type ValueType

Types

type Body

type Body struct {
	Content    string `yaml:"content"`
	Templatize bool   `yaml:"templatize,omitempty"`
}

type Config

type Config struct {
	Modules map[string]Module `yaml:"modules"`
}

Config contains multiple modules.

func LoadConfig

func LoadConfig(configPath string) (Config, error)

type Metric

type Metric struct {
	Name           string
	Path           string
	Labels         map[string]string
	Type           ScrapeType
	ValueType      ValueType
	EpochTimestamp string
	Help           string
	Values         map[string]string
}

Metric contains values that define a metric

type Module

type Module struct {
	Headers          map[string]string        `yaml:"headers,omitempty"`
	Metrics          []Metric                 `yaml:"metrics"`
	HTTPClientConfig pconfig.HTTPClientConfig `yaml:"http_client_config,omitempty"`
	Body             Body                     `yaml:"body,omitempty"`
	ValidStatusCodes []int                    `yaml:"valid_status_codes,omitempty"`
}

Module contains metrics and headers defining a configuration

type ScrapeType

type ScrapeType string

const (
	ValueScrape  ScrapeType = "value" // default
	ObjectScrape ScrapeType = "object"
)

type ValueType

type ValueType string

const (
	ValueTypeGauge   ValueType = "gauge"
	ValueTypeCounter ValueType = "counter"
	ValueTypeUntyped ValueType = "untyped"
)