v1

Documentation

Index

• func NewRulesHandler(client rules.UnaryClient, enablePartialResponse bool) func(*http.Request) (interface{}, []error, *ApiError)
• func Respond(w http.ResponseWriter, data interface{}, warnings []error)
• func RespondError(w http.ResponseWriter, apiErr *ApiError, data interface{})
• func SetCORS(w http.ResponseWriter)
• type API
  • func NewAPI(logger log.Logger, reg *prometheus.Registry, storeSet *query.StoreSet, ...) *API
  • func (api *API) Register(r *route.Router, tracer opentracing.Tracer, logger log.Logger, ...)
• type ApiError
  • func (e *ApiError) Error() string
• type ApiFunc
• type ErrorType

Functions

func NewRulesHandler

func NewRulesHandler(client rules.UnaryClient, enablePartialResponse bool) func(*http.Request) (interface{}, []error, *ApiError)

NewRulesHandler created handler compatible with HTTP /api/v1/rules https://prometheus.io/docs/prometheus/latest/querying/api/#rules which uses gRPC Unary Rules API.

func Respond

func Respond(w http.ResponseWriter, data interface{}, warnings []error)

func RespondError

func RespondError(w http.ResponseWriter, apiErr *ApiError, data interface{})

func SetCORS

func SetCORS(w http.ResponseWriter)

Enables cross-site script calls.

Types

type API

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

API can register a set of endpoints in a router and handle them using the provided storage and query engine.

func NewAPI

func NewAPI(
	logger log.Logger,
	reg *prometheus.Registry,
	storeSet *query.StoreSet,
	qe *promql.Engine,
	c query.QueryableCreator,
	ruleGroups rules.UnaryClient,
	enableAutodownsampling bool,
	enableQueryPartialResponse bool,
	enableRulePartialResponse bool,
	replicaLabels []string,
	flagsMap map[string]string,
	defaultInstantQueryMaxSourceResolution time.Duration,
	maxConcurrentQueries int,
) *API

NewAPI returns an initialized API type.

func (*API) Register

func (api *API) Register(r *route.Router, tracer opentracing.Tracer, logger log.Logger, ins extpromhttp.InstrumentationMiddleware)

Register the API's endpoints in the given router.

type ApiError

type ApiError struct {
	Typ ErrorType
	Err error
}

func (*ApiError) Error

func (e *ApiError) Error() string

type ApiFunc

type ApiFunc func(r *http.Request) (interface{}, []error, *ApiError)

type ErrorType

type ErrorType string

const (
	ErrorInternal ErrorType = "internal"
)