native

package
v0.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2020 License: Apache-2.0 Imports: 35 Imported by: 4

Documentation

Index

Constants

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

	// CompleteTagsHTTPMethod is the HTTP method used with this resource.
	CompleteTagsHTTPMethod = http.MethodGet
)
View Source
const (
	// PromParseURL is the url for native prom parse handler, this parses out the
	// query and returns a JSON representation of the execution DAG.
	PromParseURL = handler.RoutePrefixV1 + "/parse"

	// PromParseHTTPMethod is the HTTP method used with this resource.
	PromParseHTTPMethod = http.MethodGet
)
View Source
const (
	// PromThresholdURL is the url for native prom threshold handler, this  parses
	// out the  query and returns a JSON representation of the execution DAG.
	PromThresholdURL = handler.RoutePrefixV1 + "/threshold"

	// PromThresholdHTTPMethod is the HTTP method used with this resource.
	PromThresholdHTTPMethod = http.MethodGet
)
View Source
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"

	// 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"
)
View Source
const (
	// ListTagsURL is the url for listing tags.
	ListTagsURL = handler.RoutePrefixV1 + "/labels"
)

Variables

View Source
var (
	// PromReadHTTPMethods are the HTTP methods for the read handler.
	PromReadHTTPMethods = []string{
		http.MethodGet,
		http.MethodPost,
	}

	// PromReadInstantHTTPMethods are the HTTP methods for the instant handler.
	PromReadInstantHTTPMethods = []string{
		http.MethodGet,
		http.MethodPost,
	}
)
View Source
var (
	// ListTagsHTTPMethods are the HTTP methods for this handler.
	ListTagsHTTPMethods = []string{http.MethodGet, http.MethodPost}
)

Functions

func NewCompleteTagsHandler added in v0.5.0

func NewCompleteTagsHandler(opts options.HandlerOptions) http.Handler

NewCompleteTagsHandler returns a new instance of handler.

func NewListTagsHandler added in v0.9.0

func NewListTagsHandler(opts options.HandlerOptions) http.Handler

NewListTagsHandler returns a new instance of handler.

func NewPromParseHandler added in v0.14.1

func NewPromParseHandler(opts options.HandlerOptions) http.Handler

NewPromParseHandler returns a new instance of handler.

func NewPromReadHandler

func NewPromReadHandler(opts options.HandlerOptions) http.Handler

NewPromReadHandler returns a new prometheus-compatible read handler.

func NewPromReadInstantHandler added in v0.5.0

func NewPromReadInstantHandler(opts options.HandlerOptions) http.Handler

NewPromReadInstantHandler returns a new pro instance of handler.

func NewPromThresholdHandler added in v0.14.1

func NewPromThresholdHandler(opts options.HandlerOptions) http.Handler

NewPromThresholdHandler returns a new instance of handler.

func RenderResultsJSON added in v0.15.0

func RenderResultsJSON(
	w io.Writer,
	result ReadResult,
	opts RenderResultsOptions,
) error

RenderResultsJSON renders results in JSON for range queries.

Types

type CompleteTagsHandler added in v0.5.0

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

CompleteTagsHandler represents a handler for search tags endpoint.

func (*CompleteTagsHandler) ServeHTTP added in v0.5.0

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

type FunctionNode added in v0.14.1

type FunctionNode struct {
	// Name is the name of the function node.
	Name string `json:"name,omitempty"`
	// Children are any children this function node has.
	Children []FunctionNode `json:"children,omitempty"`
	// contains filtered or unexported fields
}

FunctionNode is a JSON representation of a function.

func (FunctionNode) QueryRepresentation added in v0.14.1

func (n FunctionNode) QueryRepresentation() (QueryRepresentation, error)

QueryRepresentation gives the query representation of the function node.

func (FunctionNode) String added in v0.14.1

func (n FunctionNode) String() string

String prints the string representation of a function node.

type ListTagsHandler added in v0.9.0

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

ListTagsHandler represents a handler for list tags endpoint.

func (*ListTagsHandler) ServeHTTP added in v0.9.0

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

type ParsedOptions added in v0.15.0

type ParsedOptions struct {
	QueryOpts     *executor.QueryOptions
	FetchOpts     *storage.FetchOptions
	Params        models.RequestParams
	CancelWatcher handler.CancelWatcher
}

ParsedOptions are parsed options for the query.

func ParseRequest added in v0.15.0

func ParseRequest(
	ctx context.Context,
	r *http.Request,
	instantaneous bool,
	opts options.HandlerOptions,
) (ParsedOptions, *xhttp.ParseError)

ParseRequest parses the given request.

type QueryRepresentation added in v0.14.1

type QueryRepresentation struct {
	// Query is the non-threshold part of a query.
	Query FunctionNode `json:"query,omitempty"`
	// Threshold is any detected threshold (top level comparison functions).
	// NB: this is a pointer so it does not have to be present in output if unset.
	Thresold *Threshold `json:"threshold,omitempty"`
}

QueryRepresentation is a JSON representation of a query after attempting to extract any threshold-specific parameters.

NB: this is always presented with the threshold value (if present) as appearing on the right of the query. e.g. `1 > up` will instead be inverted to `up < 1`

type ReadResponse

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

ReadResponse is the response that gets returned to the user

type ReadResult added in v0.15.0

type ReadResult struct {
	Series    []*ts.Series
	Meta      block.ResultMetadata
	BlockType block.BlockType
}

ReadResult is a result from a remote read.

type RenderResultsOptions added in v0.15.0

type RenderResultsOptions struct {
	KeepNaNs bool
	Start    time.Time
	End      time.Time
}

RenderResultsOptions is a set of options for rendering the result.

type Threshold added in v0.14.1

type Threshold struct {
	// Comparator is the threshold comparator.
	Comparator string `json:"comparator"`
	// Value is the threshold value.
	Value float64 `json:"value"`
}

Threshold is a JSON representation of a threshold, represented by a top level comparison function.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL