metrics

Documentation

Overview

Package metrics contains a client to query RBFS metrics

Index

• type Client
  • func NewClient(c *http.Client) Client
• type LabeledValue
• type Metric

Types

type Client

type Client interface {
	// QueryMetric queries a single metric.
	QueryMetric(ctx rbfs.RbfsContext, metric string) (*Metric, error)
}

Client provides access to the switch metrics.

func NewClient

func NewClient(c *http.Client) Client

NewClient creates a new client to query switch metrics.

type LabeledValue

type LabeledValue struct {
	// Value holds the metric value.
	Value float64
	// Labels contains the metric value.
	Labels map[string]string
}

LabeledValue contains a metric value with this assigned labels.

type Metric

type Metric struct {
	// MetricName holds the metric name.
	MetricName string
	// Values holds all metric values.
	Values []LabeledValue
}

Metric describes a single switch metric.