healthz

Documentation

Index

• Constants
• func Register(indicator Indicator)
• func UnRegister(role string)
• type GetComponentStatesInterface
• type HealthHandler
  • func Handler() *HealthHandler
  • func (handler *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HealthResponse
• type Indicator
• type IndicatorState

Constants

const (
	// ContentTypeHeader is the health check request type header.
	ContentTypeHeader = "Content-Type"
	// ContentTypeText is the health check request type text.
	ContentTypeText = "text/plain"
	// ContentTypeJSON is another health check request type text, which response contains more info.
	ContentTypeJSON = "application/json"
)

Functions

func Register

func Register(indicator Indicator)

func UnRegister

func UnRegister(role string)

Types

type GetComponentStatesInterface

type GetComponentStatesInterface interface {
	// GetComponentStates returns the states of component.
	GetComponentStates(ctx context.Context, request *milvuspb.GetComponentStatesRequest) (*milvuspb.ComponentStates, error)
}

GetComponentStatesInterface defines the interface that get states from component.

type HealthHandler

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

func Handler

func Handler() *HealthHandler

func (*HealthHandler) ServeHTTP

func (handler *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HealthResponse

type HealthResponse struct {
	State  string            `json:"state"`
	Detail []*IndicatorState `json:"detail"`
}

type Indicator

type Indicator interface {
	GetName() string
	Health(ctx context.Context) commonpb.StateCode
}

type IndicatorState

type IndicatorState struct {
	Name string             `json:"name"`
	Code commonpb.StateCode `json:"code"`
}