health

Documentation

Overview

Package health implements the application health verifier to EKS knows if application is healthy

Index

• Variables
• type HealthChecker
• type HealthInterface
  • func NewHealthHandler() HealthInterface

Variables

var (
	//HEALTH_CHECKER_ADDRESS receives the health endpoint port path to EKS to use
	HEALTH_CHECKER_ADDRESS = "HEALTH_CHECKER_ADDRESS"

	//HEALTH_CHECKER_PATH receives the health endpoint path to EKS to use
	HEALTH_CHECKER_PATH = "HEALTH_CHECKER_PATH"
)

Types

type HealthChecker

type HealthChecker func() error

HealthChecker is a function that will return if the application is ok

type HealthInterface

type HealthInterface interface {
	HealthCheck(
		logger logger.Logger,
		channelError chan<- error,
		checkers ...HealthChecker,
	)
}

HealthInterface is an interface to implement the methods that health package implements

func NewHealthHandler

func NewHealthHandler() HealthInterface

NewHealthHandler is used to return a instance of the required interface, so you can use health methods