monitoring

Documentation

Index

• func GetBuckets(metricName string) []float64
• func GetCounters() map[string][]string
• func GetDefaultBuckets() []float64
• func GetGauges() map[string][]string
• func GetHistograms() map[string][]string
• func GetMaxIdleScrapeInterval() time.Duration
• func GetStorageLatencyBuckets() []float64
• func GetSummaries() map[string][]string
• func IncDownloadCounter(ms MetricServer, repo string)
• func IncHTTPConnRequests(ms MetricServer, lvs ...string)
• func IncUploadCounter(ms MetricServer, repo string)
• func ObserveHTTPMethodLatency(ms MetricServer, method string, latency time.Duration)
• func ObserveHTTPRepoLatency(ms MetricServer, path string, latency time.Duration)
• func ObserveStorageLockLatency(ms MetricServer, latency time.Duration, storageName, lockType string)
• func SetServerInfo(ms MetricServer, lvs ...string)
• func SetStorageUsage(ms MetricServer, rootDir, repo string)
• type CounterValue
• type GaugeValue
• type HistogramValue
• type MetricServer
  • func NewMetricsServer(enabled bool, log log.Logger) MetricServer
• type MetricsClient
  • func NewMetricsClient(config *MetricsConfig, logger log.Logger) *MetricsClient
  • func (mc *MetricsClient) GetMetrics() (*MetricsInfo, error)
• type MetricsConfig
• type MetricsInfo
• type SummaryValue

Functions

func GetBuckets

func GetBuckets(metricName string) []float64

func GetCounters

func GetCounters() map[string][]string

contains a map with key=CounterName and value=CounterLabels.

func GetDefaultBuckets

func GetDefaultBuckets() []float64

func GetGauges

func GetGauges() map[string][]string

func GetHistograms

func GetHistograms() map[string][]string

func GetMaxIdleScrapeInterval

func GetMaxIdleScrapeInterval() time.Duration

func GetStorageLatencyBuckets

func GetStorageLatencyBuckets() []float64

func GetSummaries

func GetSummaries() map[string][]string

func IncDownloadCounter

func IncDownloadCounter(ms MetricServer, repo string)

func IncHTTPConnRequests

func IncHTTPConnRequests(ms MetricServer, lvs ...string)

func IncUploadCounter

func IncUploadCounter(ms MetricServer, repo string)

func ObserveHTTPMethodLatency

func ObserveHTTPMethodLatency(ms MetricServer, method string, latency time.Duration)

func ObserveHTTPRepoLatency

func ObserveHTTPRepoLatency(ms MetricServer, path string, latency time.Duration)

func ObserveStorageLockLatency

func ObserveStorageLockLatency(ms MetricServer, latency time.Duration, storageName, lockType string)

func SetServerInfo

func SetServerInfo(ms MetricServer, lvs ...string)

func SetStorageUsage

func SetStorageUsage(ms MetricServer, rootDir, repo string)

Types

type CounterValue

type CounterValue struct {
	Name        string
	Count       int
	LabelNames  []string
	LabelValues []string
}

CounterValue stores info about a metric that is incremented over time, such as the number of requests to an HTTP endpoint.

type GaugeValue

type GaugeValue struct {
	Name        string
	Value       float64
	LabelNames  []string
	LabelValues []string
}

GaugeValue stores one value that is updated as time goes on, such as the amount of memory allocated.

type HistogramValue

type HistogramValue struct {
	Name        string
	Count       int
	Sum         float64
	Buckets     map[string]int
	LabelNames  []string
	LabelValues []string
}

type MetricServer

type MetricServer interface {
	SendMetric(interface{})
	// works like SendMetric, but adds the metric regardless of the value of 'enabled' field for MetricServer
	ForceSendMetric(interface{})
	ReceiveMetrics() interface{}
	IsEnabled() bool
}

func NewMetricsServer

func NewMetricsServer(enabled bool, log log.Logger) MetricServer

type MetricsClient

type MetricsClient struct {
	// contains filtered or unexported fields
}

func NewMetricsClient

func NewMetricsClient(config *MetricsConfig, logger log.Logger) *MetricsClient

Creates a MetricsClient that can be used to retrieve in memory metrics The new MetricsClient retrieved must be cached and reused by the Node Exporter in order to prevent concurrent memory leaks.

func (*MetricsClient) GetMetrics

func (mc *MetricsClient) GetMetrics() (*MetricsInfo, error)

type MetricsConfig

type MetricsConfig struct {
	// Address of the zot http server
	Address string

	// Transport to use for the http client.
	Transport *http.Transport

	// HTTPClient is the client to use.
	HTTPClient *http.Client
}

MetricsConfig is used to configure the creation of a Node Exporter http client that will connect to a particular zot instance.

type MetricsInfo

type MetricsInfo struct {
	Counters   []*CounterValue
	Gauges     []*GaugeValue
	Summaries  []*SummaryValue
	Histograms []*HistogramValue
}

type SummaryValue

type SummaryValue struct {
	Name        string
	Count       int
	Sum         float64
	LabelNames  []string
	LabelValues []string
}

SummaryValue stores info about a metric that is incremented over time, such as the number of requests to an HTTP endpoint.