v1

Documentation

Index

• type Api
  • func NewApi(m manager.Manager) *Api
  • func (a *Api) Register(container *restful.Container)
• type Point
• type Timeseries

Types

type Api

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

func NewApi

func NewApi(m manager.Manager) *Api

Create a new Api to serve from the specified cache.

func (*Api) Register

func (a *Api) Register(container *restful.Container)

Register the Api on the specified endpoint.

type Point

type Point struct {
	// The start and end time for which this data is representative.
	Start time.Time `json:"start"`
	End   time.Time `json:"end"`

	// Labels specific to this data point.
	Labels map[string]string `json:"labels,omitempty"`

	// The value of the metric.
	Value interface{} `json:"value"`
}

Point represent a metric value.

type Timeseries

type Timeseries struct {
	// Map of metric names to their values.
	Metrics map[string][]Point `json:"metrics"`

	// Common labels for all metrics.
	Labels map[string]string `json:"labels,omitempty"`
}

Timeseries represents a set of metrics for the same target object (typically a container).