exporter

Documentation

Overview

Package exporter provides prometheus exporter implementations.

Package exporter provides prometheus exporter implementations.

Index

• func NewCollector(metrics []Metric) prometheus.Collector
• func RegisterCollector(collectors ...prometheus.Collector) error
• func Start(address, urlPath string, listenAndServeFailureFunc func(error)) error
• func Stop(timeout time.Duration) error
• func UnRegisterCollector(collectors ...prometheus.Collector) bool
• type Metric
• type Value

Functions

func NewCollector

func NewCollector(metrics []Metric) prometheus.Collector

New is creates a Collector.

ex) collector01 := exporter.NewCollector([]exporter.Metric{...})

func RegisterCollector

func RegisterCollector(collectors ...prometheus.Collector) error

Register registers the Collectors.

ex) err := exporter.RegisterCollector(collector01)

func Start

func Start(address, urlPath string, listenAndServeFailureFunc func(error)) error

Start is start the server.

ex) err := exporter.Start(":10000", "metrics", func(err error) { klog.ErrorS(err, "") })

func Stop

func Stop(timeout time.Duration) error

Stop is stop the server.

ex) err := exporter.Stop(60)

func UnRegisterCollector

func UnRegisterCollector(collectors ...prometheus.Collector) bool

UnRegister unregister the Collectors.

ex) result := exporter.UnRegisterCollector(collector01)

Types

type Metric

type Metric interface {
	GetDesc() *prometheus.Desc
	GetValueType() prometheus.ValueType
	GetValues() []Value
}

Metric is an interface that provides the information to be collected.

type Value

type Value struct {
	Value       float64
	LabelValues []string
}

value is a struct that provides the value to collect.