http

Documentation

Index

• Constants
• func Register(h *Handler)
• func RegisterCheckComponentReady(checkActive func(role string) error)
• func RegisterStopComponent(triggerComponentStop func(role string) error)
• func ServeHTTP()
• type Handler
• type Request
• type ResponseWriter

Constants

const (
	MetricsPath        = "/metrics"
	MetricsDefaultPath = "/metrics_default"
)

Prometheus restful api path

const (
	RouteTriggerStopPath     = "/management/stop"
	RouteCheckComponentReady = "/management/check/ready"
)

for every component, register it's own api to trigger stop and check ready

const (
	RouteGcPause  = "/management/datacoord/garbage_collection/pause"
	RouteGcResume = "/management/datacoord/garbage_collection/resume"

	RouteSuspendQueryCoordBalance = "/management/querycoord/balance/suspend"
	RouteResumeQueryCoordBalance  = "/management/querycoord/balance/resume"
	RouteTransferSegment          = "/management/querycoord/transfer/segment"
	RouteTransferChannel          = "/management/querycoord/transfer/channel"

	RouteSuspendQueryNode           = "/management/querycoord/node/suspend"
	RouteResumeQueryNode            = "/management/querycoord/node/resume"
	RouteListQueryNode              = "/management/querycoord/node/list"
	RouteGetQueryNodeDistribution   = "/management/querycoord/distribution/get"
	RouteCheckQueryNodeDistribution = "/management/querycoord/distribution/check"
)

proxy management restful api root path

const (
	DefaultListenPort = "9091"
	ListenPortEnvKey  = "METRICS_PORT"
)

const EventLogRouterPath = "/eventlog"

EventLogRouterPath is path for eventlog control.

const ExprPath = "/expr"

ExprPath is path for expression.

const HealthzRouterPath = "/healthz"

HealthzRouterPath is default path for check health state.

const LogLevelRouterPath = "/log/level"

LogLevelRouterPath is path for Get and Update log level at runtime.

const RootPath = "/"

Functions

func Register

func Register(h *Handler)

func RegisterCheckComponentReady

func RegisterCheckComponentReady(checkActive func(role string) error)

func RegisterStopComponent

func RegisterStopComponent(triggerComponentStop func(role string) error)

func ServeHTTP

func ServeHTTP()

Types

type Handler

type Handler struct {
	Path        string
	HandlerFunc http.HandlerFunc
	Handler     http.Handler
}

type Request

type Request = http.Request

type ResponseWriter

type ResponseWriter = http.ResponseWriter