httpd

Documentation

Index

• Constants
• func NewQueryRouter() options.QueryRouter
• type Handler
  • func NewHandler(handlerOptions options.HandlerOptions, customHandlers ...options.CustomHandler) *Handler
  • func (h *Handler) RegisterRoutes() error
  • func (h *Handler) Router() http.Handler

Constants

const (

	// EngineHeaderName defines header name which is used to switch between
	// prometheus and m3query engines.
	EngineHeaderName = headers.M3HeaderPrefix + "Engine"
	// EngineURLParam defines query url parameter which is used to switch between
	// prometheus and m3query engines.
	EngineURLParam = "engine"
)

Functions

func NewQueryRouter

func NewQueryRouter() options.QueryRouter

Types

type Handler

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

Handler represents the top-level HTTP handler.

func NewHandler

func NewHandler(
	handlerOptions options.HandlerOptions,
	customHandlers ...options.CustomHandler,
) *Handler

NewHandler returns a new instance of handler with routes.

func (*Handler) RegisterRoutes

func (h *Handler) RegisterRoutes() error

RegisterRoutes registers all http routes.

func (*Handler) Router

func (h *Handler) Router() http.Handler

Router returns the http handler registered with all relevant routes for query.