api

Documentation

Overview

nolint: varnamelen

Index

• type Collector
  • func GetCollector(c *Controller) *Collector
  • func (zc Collector) Collect(ch chan<- prometheus.Metric)
  • func (zc Collector) Describe(ch chan<- *prometheus.Desc)
• type Config
  • func DefaultConfig() *Config
• type Controller
  • func NewController(cfg *Config) *Controller
  • func (c *Controller) Run()
• type ExporterConfig
• type LogConfig
• type MetricsConfig
• type ServerConfig

Types

type Collector

type Collector struct {
	Client      *monitoring.MetricsClient
	MetricsDesc map[string]*prometheus.Desc // all known metrics descriptions
	// contains filtered or unexported fields
}

func GetCollector

func GetCollector(c *Controller) *Collector

func (Collector) Collect

func (zc Collector) Collect(ch chan<- prometheus.Metric)

Implements prometheus.Collector interface.

func (Collector) Describe

func (zc Collector) Describe(ch chan<- *prometheus.Desc)

Implements prometheus.Collector interface.

type Config

type Config struct {
	Server   ServerConfig
	Exporter ExporterConfig
}

func DefaultConfig

func DefaultConfig() *Config

type Controller

type Controller struct {
	Config *Config
	Log    log.Logger
}

func NewController

func NewController(cfg *Config) *Controller

func (*Controller) Run

func (c *Controller) Run()

type ExporterConfig

type ExporterConfig struct {
	Port    string
	Log     *LogConfig
	Metrics *MetricsConfig
}

type LogConfig

type LogConfig struct {
	Level  string
	Output string
}

We export below types in order for cli package to be able to read it from configuration file.

type MetricsConfig

type MetricsConfig struct {
	Path string
}

type ServerConfig

type ServerConfig struct {
	Protocol string
	Host     string
	Port     string
}