prom

Documentation

Overview

Package prom provides custom handlers that support the prometheus query endpoints.

Index

• func ApplyRangeWarnings(query string, meta *block.ResultMetadata) error
• func NewReadHandler(hOpts options.HandlerOptions, options ...Option) (http.Handler, error)
• func Respond(w http.ResponseWriter, data interface{}, warnings promstorage.Warnings) error
• type NewQueryFn
• type Option
  • func WithEngine(promQLEngineFn options.PromQLEngineFn) Option
  • func WithInstantEngine(promQLEngineFn options.PromQLEngineFn) Option
• type QueryData

Functions

func ApplyRangeWarnings

func ApplyRangeWarnings(
	query string, meta *block.ResultMetadata,
) error

ApplyRangeWarnings applies warnings encountered during execution.

func NewReadHandler

func NewReadHandler(hOpts options.HandlerOptions, options ...Option) (http.Handler, error)

NewReadHandler creates a handler to handle PromQL requests.

func Respond

func Respond(w http.ResponseWriter, data interface{}, warnings promstorage.Warnings) error

Respond responds with HTTP OK status code and writes response JSON to response body.

Types

type NewQueryFn

type NewQueryFn func(params models.RequestParams) (promql.Query, error)

NewQueryFn creates a new promql Query.

type Option

type Option func(*opts) error

Option is a Prometheus handler option.

func WithEngine

func WithEngine(promQLEngineFn options.PromQLEngineFn) Option

WithEngine sets the PromQL engine.

func WithInstantEngine

func WithInstantEngine(promQLEngineFn options.PromQLEngineFn) Option

WithInstantEngine sets the PromQL instant engine.

type QueryData

type QueryData struct {
	ResultType promql.ValueType `json:"resultType"`
	Result     promql.Value     `json:"result"`
}

QueryData struct to be used when responding from HTTP handler.