native

Documentation

Index

• Constants
• Variables
• func NewCompleteTagsHandler(storage storage.Storage, fetchOptionsBuilder handler.FetchOptionsBuilder) http.Handler
• func NewListTagsHandler(storage storage.Storage, fetchOptionsBuilder handler.FetchOptionsBuilder, ...) http.Handler
• type CompleteTagsHandler
  • func (h *CompleteTagsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ListTagsHandler
  • func (h *ListTagsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PromReadHandler
  • func NewPromReadHandler(engine executor.Engine, fetchOptionsBuilder handler.FetchOptionsBuilder, ...) *PromReadHandler
  • func (h *PromReadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (h *PromReadHandler) ServeHTTPWithEngine(w http.ResponseWriter, r *http.Request, engine executor.Engine, ...) ([]*ts.Series, models.RequestParams, *RespError)
• type PromReadInstantHandler
  • func NewPromReadInstantHandler(engine executor.Engine, fetchOptionsBuilder handler.FetchOptionsBuilder, ...) *PromReadInstantHandler
  • func (h *PromReadInstantHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ReadResponse
• type RespError

Constants

const (
	// CompleteTagsURL is the url for searching tags.
	CompleteTagsURL = handler.RoutePrefixV1 + "/search"

	// CompleteTagsHTTPMethod is the HTTP method used with this resource.
	CompleteTagsHTTPMethod = http.MethodGet
)

const (
	// PromReadURL is the url for native prom read handler, this matches the
	// default URL for the query range endpoint found on a Prometheus server
	PromReadURL = handler.RoutePrefixV1 + "/query_range"

	// PromReadHTTPMethod is the HTTP method used with this resource.
	PromReadHTTPMethod = http.MethodGet
)

const (
	// PromReadInstantURL is the url for native instantaneous prom read
	// handler, this matches the  default URL for the query endpoint
	// found on a Prometheus server
	PromReadInstantURL = handler.RoutePrefixV1 + "/query"

	// PromReadInstantHTTPMethod is the HTTP method used with this resource.
	PromReadInstantHTTPMethod = http.MethodGet
)

const (
	// ListTagsURL is the url for listing tags.
	ListTagsURL = handler.RoutePrefixV1 + "/labels"
)

Variables

var (
	// ListTagsHTTPMethods are the HTTP methods used with this resource.
	ListTagsHTTPMethods = []string{http.MethodGet, http.MethodPost}
)

Functions

func NewCompleteTagsHandler

func NewCompleteTagsHandler(
	storage storage.Storage,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
) http.Handler

NewCompleteTagsHandler returns a new instance of handler.

func NewListTagsHandler

func NewListTagsHandler(
	storage storage.Storage,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	nowFn clock.NowFn,
) http.Handler

NewListTagsHandler returns a new instance of handler.

Types

type CompleteTagsHandler

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

CompleteTagsHandler represents a handler for search tags endpoint.

func (*CompleteTagsHandler) ServeHTTP

func (h *CompleteTagsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ListTagsHandler

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

ListTagsHandler represents a handler for list tags endpoint.

func (*ListTagsHandler) ServeHTTP

func (h *ListTagsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type PromReadHandler

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

PromReadHandler represents a handler for prometheus read endpoint.

func NewPromReadHandler

func NewPromReadHandler(
	engine executor.Engine,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	tagOpts models.TagOptions,
	limitsCfg *config.LimitsConfiguration,
	scope tally.Scope,
	timeoutOpts *prometheus.TimeoutOpts,
	keepNans bool,
) *PromReadHandler

NewPromReadHandler returns a new instance of handler.

func (*PromReadHandler) ServeHTTP

func (h *PromReadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*PromReadHandler) ServeHTTPWithEngine

func (h *PromReadHandler) ServeHTTPWithEngine(
	w http.ResponseWriter,
	r *http.Request,
	engine executor.Engine,
	opts *executor.QueryOptions,
) ([]*ts.Series, models.RequestParams, *RespError)

ServeHTTPWithEngine returns query results from the storage

type PromReadInstantHandler

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

PromReadInstantHandler represents a handler for prometheus instantaneous read endpoint.

func NewPromReadInstantHandler

func NewPromReadInstantHandler(
	engine executor.Engine,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	tagOpts models.TagOptions,
	timeoutOpts *prometheus.TimeoutOpts,
) *PromReadInstantHandler

NewPromReadInstantHandler returns a new instance of handler.

func (*PromReadInstantHandler) ServeHTTP

func (h *PromReadInstantHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ReadResponse

type ReadResponse struct {
	Results []ts.Series `json:"results,omitempty"`
}

ReadResponse is the response that gets returned to the user

type RespError

type RespError struct {
	Err  error
	Code int
}

RespError wraps error and status code