handler

Documentation

Overview

Package handler contains root level handlers.

Index

• Constants
• func CloseWatcher(ctx context.Context, cancel context.CancelFunc, w http.ResponseWriter, ...)
• func NewReadyHandler(opts options.HandlerOptions) http.Handler
• func NewSearchHandler(opts options.HandlerOptions) http.Handler
• type CancelWatcher
  • func NewResponseWriterCanceller(w http.ResponseWriter, iOpts instrument.Options) CancelWatcher
• type HeaderKeyType
• type ReadyHandler
  • func (h *ReadyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type SearchHandler
  • func (h *SearchHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (
	// ReadyURL is the url to check for readiness.
	ReadyURL = "/ready"

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

const (
	// SearchURL is the url to search for metric ids
	SearchURL = "/search"

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

const (
	// HeaderKey is the key which headers will be added to in the request context.
	HeaderKey HeaderKeyType = iota

	// RoutePrefixV1 is the v1 prefix for all coordinator routes.
	RoutePrefixV1 = "/api/v1"

	// RoutePrefixExperimental is the experimental prefix for all coordinator routes.
	RoutePrefixExperimental = "/api/experimental"
)

Functions

func CloseWatcher

func CloseWatcher(
	ctx context.Context,
	cancel context.CancelFunc,
	w http.ResponseWriter,
	instrumentOpts instrument.Options,
)

CloseWatcher watches for CloseNotify and context timeout. It is best effort and may sometimes not close the channel relying on GC.

func NewReadyHandler

func NewReadyHandler(opts options.HandlerOptions) http.Handler

NewReadyHandler returns a new instance of handler.

func NewSearchHandler

func NewSearchHandler(opts options.HandlerOptions) http.Handler

NewSearchHandler returns a new instance of handler

Types

type CancelWatcher

type CancelWatcher interface {
	// WatchForCancel watches on the given context, and applies
	// the given cancellation function.
	WatchForCancel(context.Context, context.CancelFunc)
}

CancelWatcher is an interface that wraps a WatchForCancel method. TODO: make this generic middleware, rather than applied per function.

func NewResponseWriterCanceller

func NewResponseWriterCanceller(
	w http.ResponseWriter,
	iOpts instrument.Options,
) CancelWatcher

NewResponseWriterCanceller creates a canceller on the given context with the given response writer.

type HeaderKeyType

type HeaderKeyType int

HeaderKeyType is the type for the header key.

type ReadyHandler

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

ReadyHandler tests whether the service is connected to underlying storage.

func (*ReadyHandler) ServeHTTP

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

ServeHTTP serves HTTP handler. This comment only here so doesn't break lint by not being "ServeHTTP" as the comment above this function which needs // nolint:gocyclo. nolint:gocyclo

type SearchHandler

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

SearchHandler represents a handler for the search endpoint

func (*SearchHandler) ServeHTTP

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