http

Documentation

Index

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

Constants

const (
	HTTPHeaderAllowInt64     = "Accept-Type-Allow-Int64"
	HTTPHeaderRequestTimeout = "Request-Timeout"
	HTTPDefaultTimeout       = 30 * time.Second
	HTTPReturnCode           = "code"
	HTTPReturnMessage        = "message"
	HTTPReturnData           = "data"
)

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

Prometheus restful api path

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

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 (
	// ClusterInfoPath is the path to get cluster information.
	ClusterInfoPath = "/_cluster/info"
	// ClusterConfigsPath is the path to get cluster configurations.
	ClusterConfigsPath = "/_cluster/configs"
	// ClusterClientsPath is the path to get connected clients.
	ClusterClientsPath = "/_cluster/clients"
	// ClusterDependenciesPath is the path to get cluster dependencies.
	ClusterDependenciesPath = "/_cluster/dependencies"
	// HookConfigsPath is the path to get hook configurations.
	HookConfigsPath = "/_hook/configs"
	// SlowQueryPath is the path to get slow queries metrics
	SlowQueryPath = "/_cluster/slow_query"

	// QCDistPath is the path to get QueryCoord distribution.
	QCDistPath = "/_qc/dist"
	// QCTargetPath is the path to get QueryCoord target.
	QCTargetPath = "/_qc/target"
	// QCReplicaPath is the path to get QueryCoord replica.
	QCReplicaPath = "/_qc/replica"
	// QCResourceGroupPath is the path to get QueryCoord resource group.
	QCResourceGroupPath = "/_qc/resource_group"
	// QCAllTasksPath is the path to get all tasks in QueryCoord.
	QCAllTasksPath = "/_qc/tasks"
	// QCSegmentsPath is the path to get segments in QueryCoord.
	QCSegmentsPath = "/_qc/segments"

	// QNSegmentsPath is the path to get segments in QueryNode.
	QNSegmentsPath = "/_qn/segments"
	// QNChannelsPath is the path to get channels in QueryNode.
	QNChannelsPath = "/_qn/channels"

	// DCDistPath is the path to get all segments and channels distribution in DataCoord.
	DCDistPath = "/_dc/dist"
	// DCImportTasksPath is the path to get import tasks in DataCoord.
	DCImportTasksPath = "/_dc/tasks/import"
	// DCCompactionTasksPath is the path to get compaction tasks in DataCoord.
	DCCompactionTasksPath = "/_dc/tasks/compaction"
	// DCBuildIndexTasksPath is the path to get build index tasks in DataCoord.
	DCBuildIndexTasksPath = "/_dc/tasks/build_index"
	// DCSegmentsPath is the path to get segments in DataCoord.
	DCSegmentsPath = "/_dc/segments"

	// DNSyncTasksPath is the path to get sync tasks in DataNode.
	DNSyncTasksPath = "/_dn/tasks/sync"
	// DNSegmentsPath is the path to get segments in DataNode.
	DNSegmentsPath = "/_dn/segments"
	// DNChannelsPath is the path to get channels in DataNode.
	DNChannelsPath = "/_dn/channels"

	// DatabaseListPath is the path to get all databases.
	DatabaseListPath = "/_db/list"
	//	DatabaseDescPath is the path to get database description.
	DatabaseDescPath = "/_db/desc"

	// CollectionListPath is the path to get all collections.
	CollectionListPath = "/_collection/list"
	// CollectionDescPath is the path to get collection description.
	CollectionDescPath = "/_collection/desc"

	// IndexListPath is the path to get all indexes.
	IndexListPath = "/_index/list"
)

for WebUI 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 = "/"

const StaticPath = "/static/"

StaticPath is path for the static view.

Functions

func GetStaticHandler

func GetStaticHandler() http.Handler

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 RegisterWebUIHandler

func RegisterWebUIHandler()

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