v1

Documentation

Index

• type Api
  • func NewApi(runningInKubernetes bool, metricSink *metricsink.MetricSink, ...) *Api
  • func (a *Api) Register(container *restful.Container)
  • func (normalApi *Api) RegisterHistorical(container *restful.Container)
  • func (a *Api) RegisterModel(container *restful.Container)
• type HistoricalApi

Types

type Api

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

func NewApi

func NewApi(runningInKubernetes bool, metricSink *metricsink.MetricSink, historicalSource core.HistoricalSource, disableMetricExport bool) *Api

Create a new Api to serve from the specified cache.

func (*Api) Register

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

Register the mainApi on the specified endpoint.

func (*Api) RegisterHistorical

func (normalApi *Api) RegisterHistorical(container *restful.Container)

RegisterHistorical registers the Historical API endpoints. It will register the same endpoints as those in the model API, plus endpoints for aggregation retrieval, and endpoints to retrieve pod metrics by using the pod id.

func (*Api) RegisterModel

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

RegisterModel registers the Model API endpoints. All endpoints that end with a {metric-name} also receive a start time query parameter. The start and end times should be specified as a string, formatted according to RFC 3339.

type HistoricalApi

type HistoricalApi struct {
	*Api
}

HistoricalApi wraps the standard API to overload the fetchers to use the one of the persistent storage sinks instead of the in-memory metrics sink