healthcheck

Documentation

Overview

Package healthcheck typically enables readiness or liveness probes within kubernetes. IMPORTANT: If you update this behavior, be sure to update internal/fullnode/pod_builder.go with the new cosmos operator image in the "healthcheck" container.

Index

• Constants
• func DiskUsage(w http.ResponseWriter, r *http.Request)
• type Client
  • func NewClient(client *http.Client) *Client
  • func (c Client) DiskUsage(ctx context.Context, host, homeDir string) (DiskUsageResponse, error)
• type Comet
  • func NewComet(logger logr.Logger, client Statuser, rpcHost string, timeout time.Duration) *Comet
  • func (h *Comet) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type DiskUsageResponse
• type Statuser

Constants

const Port = 1251

Port is the port for the healthcheck sidecar.

Functions

func DiskUsage

func DiskUsage(w http.ResponseWriter, r *http.Request)

DiskUsage returns a handler which responds with disk statistics in JSON. Path is the filesystem path from which to check disk usage.

Types

type Client

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

Client can be used to query healthcheck information.

func NewClient

func NewClient(client *http.Client) *Client

func (Client) DiskUsage

func (c Client) DiskUsage(ctx context.Context, host, homeDir string) (DiskUsageResponse, error)

DiskUsage returns disk usage statistics or an error if unable to obtain. Do not include the port in the host.

type Comet

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

Comet checks the CometBFT status endpoint to determine if the node is in-sync or not.

func NewComet

func NewComet(logger logr.Logger, client Statuser, rpcHost string, timeout time.Duration) *Comet

func (*Comet) ServeHTTP

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

ServeHTTP implements http.Handler.

type DiskUsageResponse

type DiskUsageResponse struct {
	Dir       string `json:"dir"`
	AllBytes  uint64 `json:"all_bytes,omitempty"`
	FreeBytes uint64 `json:"free_bytes,omitempty"`
	Error     string `json:"error,omitempty"`
}

DiskUsageResponse returns disk statistics in bytes.

type Statuser

type Statuser interface {
	Status(ctx context.Context, rpcHost string) (cosmos.CometStatus, error)
}

Statuser can query the Comet status endpoint.