remote

Documentation

Index

• Constants
• Variables
• func NewPromReadHandler(engine executor.Engine, fetchOptionsBuilder handler.FetchOptionsBuilder, ...) http.Handler
• func NewPromSeriesMatchHandler(storage storage.Storage, tagOptions models.TagOptions, ...) http.Handler
• func NewPromWriteHandler(downsamplerAndWriter ingest.DownsamplerAndWriter, tagOptions models.TagOptions, ...) (http.Handler, error)
• func NewTagValuesHandler(storage storage.Storage, fetchOptionsBuilder handler.FetchOptionsBuilder, ...) http.Handler
• type PromReadHandler
  • func (h *PromReadHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PromSeriesMatchHandler
  • func (h *PromSeriesMatchHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PromWriteHandler
  • func (h *PromWriteHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PromWriteHandlerForwardTargetOptions
• type PromWriteHandlerForwardingOptions
• type TagValuesHandler
  • func (h *TagValuesHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type TagValuesResponse

Constants

const (
	// PromReadURL is the url for remote prom read handler
	PromReadURL = handler.RoutePrefixV1 + "/prom/remote/read"

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

const (
	// NameReplace is the parameter that gets replaced.
	NameReplace = "name"

	// TagValuesURL is the url for tag values.
	TagValuesURL = handler.RoutePrefixV1 +
		"/label/{" + NameReplace + "}/values"

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

const (
	// PromWriteURL is the url for the prom write handler
	PromWriteURL = handler.RoutePrefixV1 + "/prom/remote/write"

	// PromWriteHTTPMethod is the HTTP method used with this resource.
	PromWriteHTTPMethod = http.MethodPost
)

const (
	// PromSeriesMatchURL is the url for remote prom series matcher handler.
	PromSeriesMatchURL = handler.RoutePrefixV1 + "/series"
)

Variables

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

Functions

func NewPromReadHandler

func NewPromReadHandler(
	engine executor.Engine,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	timeoutOpts *prometheus.TimeoutOpts,
	keepEmpty bool,
	instrumentOpts instrument.Options,
) http.Handler

NewPromReadHandler returns a new instance of handler.

func NewPromSeriesMatchHandler

func NewPromSeriesMatchHandler(
	storage storage.Storage,
	tagOptions models.TagOptions,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	instrumentOpts instrument.Options,
) http.Handler

NewPromSeriesMatchHandler returns a new instance of handler.

func NewPromWriteHandler

func NewPromWriteHandler(
	downsamplerAndWriter ingest.DownsamplerAndWriter,
	tagOptions models.TagOptions,
	forwarding PromWriteHandlerForwardingOptions,
	nowFn clock.NowFn,
	instrumentOpts instrument.Options,
) (http.Handler, error)

NewPromWriteHandler returns a new instance of handler.

func NewTagValuesHandler

func NewTagValuesHandler(
	storage storage.Storage,
	fetchOptionsBuilder handler.FetchOptionsBuilder,
	nowFn clock.NowFn,
	instrumentOpts instrument.Options,
) http.Handler

NewTagValuesHandler returns a new instance of handler.

Types

type PromReadHandler

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

PromReadHandler represents a handler for prometheus read endpoint.

func (*PromReadHandler) ServeHTTP

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

type PromSeriesMatchHandler

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

PromSeriesMatchHandler represents a handler for prometheus series matcher endpoint.

func (*PromSeriesMatchHandler) ServeHTTP

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

type PromWriteHandler

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

PromWriteHandler represents a handler for prometheus write endpoint.

func (*PromWriteHandler) ServeHTTP

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

type PromWriteHandlerForwardTargetOptions

type PromWriteHandlerForwardTargetOptions struct {
	// URL of the target to send to.
	URL string `yaml:"url"`
	// Method defaults to POST if not set.
	Method string `yaml:"method"`
}

PromWriteHandlerForwardTargetOptions is a prometheus write handler forwarder target.

type PromWriteHandlerForwardingOptions

type PromWriteHandlerForwardingOptions struct {
	// MaxConcurrency is the max parallel forwarding and if zero will be unlimited.
	MaxConcurrency int                                    `yaml:"maxConcurrency"`
	Timeout        time.Duration                          `yaml:"timeout"`
	Targets        []PromWriteHandlerForwardTargetOptions `yaml:"targets"`
}

PromWriteHandlerForwardingOptions is the forwarding options for prometheus write handler.

type TagValuesHandler

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

TagValuesHandler represents a handler for search tags endpoint.

func (*TagValuesHandler) ServeHTTP

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

type TagValuesResponse

type TagValuesResponse struct {
	Results storage.CompleteTagsResult `json:"results,omitempty"`
}

TagValuesResponse is the response that gets returned to the user