template

Documentation

Index

• type MetricTemplate
  • func (m *MetricTemplate) Collect(ch chan<- prometheus.Metric, obj interface{}, parameters ...interface{})
  • func (m *MetricTemplate) Register(ch chan<- *prometheus.Desc)
• type Type

Types

type MetricTemplate

type MetricTemplate struct {
	Name   string
	Help   string
	Labels []string
	Type   Type

	CollectFunc func(interface{}, ...interface{}) (*[]float64, *[][]string, error)
	// contains filtered or unexported fields
}

MetricTemplate define a template for metrics of same kind. It holds all necessary information about the metric and instructions how to collect metric samples.

func (*MetricTemplate) Collect

func (m *MetricTemplate) Collect(ch chan<- prometheus.Metric, obj interface{}, parameters ...interface{})

Collect triggers the collection of metric samples which are created based on template by executing the internal CollectFunc.

func (*MetricTemplate) Register

func (m *MetricTemplate) Register(ch chan<- *prometheus.Desc)

Register registers the MetricTemplate to the Prometheus Gatherer to allow the collection of metric samples which are created based on the template.

type Type

type Type string

Type define a metric type for a Prometheus metric.

var (
	// Gauge is a type which refers to Prometheus Gauge value.
	Gauge Type = "gauge"

	// Counter is a type which refers to Prometheus Counter value.
	Counter Type = "counter"
)