httpd

Documentation

Overview

Package httpd contains http routers.

Index

• Constants
• func NewGraphiteFindRouter() options.GraphiteFindRouter
• func NewGraphiteRenderRouter() options.GraphiteRenderRouter
• func NewQueryRouter() options.QueryRouter
• type Handler
  • func NewHandler(handlerOptions options.HandlerOptions, ...) *Handler
  • func (h *Handler) RegisterRoutes() error
  • func (h *Handler) Router() http.Handler

Constants

const (

	// EngineURLParam defines query url parameter which is used to switch between
	// prometheus and m3query engines.
	EngineURLParam = "engine"
)

Functions

func NewGraphiteFindRouter

func NewGraphiteFindRouter() options.GraphiteFindRouter

NewGraphiteFindRouter returns a new graphite find router.

func NewGraphiteRenderRouter

func NewGraphiteRenderRouter() options.GraphiteRenderRouter

NewGraphiteRenderRouter returns a new graphite render router.

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,
	middlewareConfig config.MiddlewareConfiguration,
	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.