exporter

Documentation

Index

• Variables
• func New(cfg Config) (*promExporter, error)
• type Config
• type GMetric
• type GMetricSource
• type MetricCommons
• type StaticLabel

Variables

var Registry func(src GMetricSource, metrics []GMetric) error

Registry is a variable of type func(src GMetricSource, metrics []GMetric) error. It is used to register metric sources with the promExporter.

Functions

func New

func New(cfg Config) (*promExporter, error)

New creates a new promExporter instance with the provided configuration.

Types

type Config

type Config struct {
	ListenAddress string
	ListenPort    string
	ListenPath    string
	InstanceName  string
	MetricPrefix  string
	StaticLabels  []StaticLabel
}

type GMetric

type GMetric interface {
	// contains filtered or unexported methods
}

GMetric is an interface that represents a generic metric. User defined metrics must implement this interface

type GMetricSource

type GMetricSource interface {
	GetMetrics(ch chan<- GMetric)
}

GMetricSource is an interface for objects that provide metrics.

type MetricCommons

type MetricCommons struct {
	Name   string // Name of the metric
	Help   string // Help string for Prom metric description
	Device string // Device name (gnmi client)
	Type   prometheus.ValueType
	Value  float64
}

MetricCommons represents a common set of keys of a metric used in the application. Metric sources must embed this structure into their user defined metrics

type StaticLabel

type StaticLabel struct {
	Key   string
	Value string
}