healthcheck

Documentation

Index

• Constants
• type HealthChecker
  • func NewHealthChecker(parentCheckIDs []healthcheck.CategoryID, options *VizOptions) *HealthChecker
  • func (hc *HealthChecker) ExternalPrometheusURL() string
  • func (hc *HealthChecker) RunChecks(observer healthcheck.CheckObserver) (bool, bool)
  • func (hc *HealthChecker) VizAPIClient() pb.ApiClient
  • func (hc *HealthChecker) VizCategory(fullCheck bool) *healthcheck.Category
  • func (hc *HealthChecker) VizDataPlaneCategory() *healthcheck.Category
  • func (hc *HealthChecker) VizNamespace() string
• type VizOptions

Constants

const (
	// VizExtensionName is the name of the viz extension
	VizExtensionName = "viz"

	// LinkerdVizExtensionCheck adds checks related to the Linkerd Viz extension
	LinkerdVizExtensionCheck healthcheck.CategoryID = "linkerd-viz"

	// LinkerdVizExtensionDataPlaneCheck adds checks related to dataplane for the linkerd-viz extension
	LinkerdVizExtensionDataPlaneCheck healthcheck.CategoryID = "linkerd-viz-data-plane"
)

Types

type HealthChecker

type HealthChecker struct {
	*healthcheck.HealthChecker
	// contains filtered or unexported fields
}

HealthChecker wraps Linkerd's main healthchecker, adding extra fields for Viz

func NewHealthChecker

func NewHealthChecker(parentCheckIDs []healthcheck.CategoryID, options *VizOptions) *HealthChecker

NewHealthChecker returns an initialized HealthChecker for Viz The parentCheckIDs are the category IDs of the linkerd core checks that are to be ran together with this instance The returned instance does not contain any of the viz Categories and to be explicitly added by using hc.AppendCategories

func (*HealthChecker) ExternalPrometheusURL

func (hc *HealthChecker) ExternalPrometheusURL() string

ExternalPrometheusURL returns URL of the external prometheus if one is configured. Otherwise, it returns an empty string.

func (*HealthChecker) RunChecks

func (hc *HealthChecker) RunChecks(observer healthcheck.CheckObserver) (bool, bool)

RunChecks implements the healthcheck.Runner interface

func (*HealthChecker) VizAPIClient

func (hc *HealthChecker) VizAPIClient() pb.ApiClient

VizAPIClient returns a fully configured Viz API client

func (*HealthChecker) VizCategory

func (hc *HealthChecker) VizCategory(fullCheck bool) *healthcheck.Category

VizCategory returns a healthcheck.Category containing checkers to verify the health of viz components fullCheck parameter will decide to run a full or a smaller set of healthchecks.

func (*HealthChecker) VizDataPlaneCategory

func (hc *HealthChecker) VizDataPlaneCategory() *healthcheck.Category

VizDataPlaneCategory returns a healthcheck.Category containing checkers to verify the data-plane metrics in prometheus and the tap injection

func (*HealthChecker) VizNamespace

func (hc *HealthChecker) VizNamespace() string

VizNamespace returns the namespace where the viz extension is installed.

type VizOptions

type VizOptions struct {
	*healthcheck.Options
	VizNamespaceOverride string
}