healthz

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• type Config
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) GetHealthz(ctx context.Context) (healthzservice.Response, error)

Constants

const (
	// AWSRegion is required even though the IAM API is global.
	AWSRegion string = "eu-central-1"

	// Description describes which functionality this health check implements.
	Description = "Ensure AWS API availability."
	// Name is the identifier of the health check. This can be used for emitting
	// metrics.
	Name = "aws"
	// SuccessMessage is the message returned in case the health check did not
	// fail.
	SuccessMessage = "all good"
	// Timeout is the time being waited until timing out health check, which
	// renders its result unsuccessful.
	Timeout = 5 * time.Second
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	Logger micrologger.Logger

	AwsConfig awsutil.Config
}

Config represents the configuration used to create a healthz service.

type Service

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

Service implements the healthz service interface.

func New

func New(config Config) (*Service, error)

New creates a new configured healthz service.

func (*Service) GetHealthz

func (s *Service) GetHealthz(ctx context.Context) (healthzservice.Response, error)

GetHealthz implements the health check for AWS. It does this by calling the IAM API to get the current user. This checks that we can connect to the API and the credentials are correct.