Documentation

Overview

Package api provides a handler for /api/

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetRequestOptions

func GetRequestOptions(r *http.Request) (v2.RequestOptions, error)

GetRequestOptions returns the metrics request options from a HTTP request.

func RegisterHandlers

func RegisterHandlers(mux httpmux.Mux, m manager.Manager) error

Types

type ApiVersion

type ApiVersion interface {
	// Returns the version string.
	Version() string

	// List of supported API endpoints.
	SupportedRequestTypes() []string

	// Handles a request. The second argument is the parameters after /api/<version>/<endpoint>
	HandleRequest(requestType string, request []string, m manager.Manager, w http.ResponseWriter, r *http.Request) error
}

Interface for a cAdvisor API version