handler

package

v0.4.7 Latest Latest Go to latest Published: Oct 10, 2018 License: Apache-2.0 Imports: 9 Imported by: 35

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/m3db/m3

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CloseWatcher(ctx context.Context, w http.ResponseWriter) (<-chan bool, <-chan bool)
func NewSearchHandler(storage storage.Storage) http.Handler
type HeaderKeyType
type SearchHandler
- func (h *SearchHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

const (
	// WarningsHeader is the M3 warnings header when to display a warning to a user
	WarningsHeader = "M3-Warnings"

	// RetryHeader is the M3 retry header to display when it is safe to retry
	RetryHeader = "M3-Retry"

	// ServedByHeader is the M3 query storage execution breakdown
	ServedByHeader = "M3-Storage-By"

	// DeprecatedHeader is the M3 deprecated header
	DeprecatedHeader = "M3-Deprecated"
)

View Source

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

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

Variables ¶

This section is empty.

Functions ¶

func CloseWatcher ¶

func CloseWatcher(ctx context.Context, w http.ResponseWriter) (<-chan bool, <-chan bool)

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

func NewSearchHandler ¶

func NewSearchHandler(storage storage.Storage) http.Handler

NewSearchHandler returns a new instance of handler

Types ¶

type HeaderKeyType ¶ added in v0.4.5

type HeaderKeyType int

HeaderKeyType is the type for the header key

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"
)

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)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
database
json
namespace
openapi
placement
prometheus
native
remote
remote/test
topic

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL