services

Documentation

Index

• func HealthCheck(ctx context.Context, deps []Dependency) error
• type Dependency

Functions

func HealthCheck

func HealthCheck(ctx context.Context, deps []Dependency) error

HealthCheck performs a health check on each provided dependency and returns an error on any failures.

Types

type Dependency

type Dependency interface {
	// Name returns the name of the service dependency
	Name() string

	// HealthCheck provides a mechanism for the client to check health of the provider.
	// Should return true if health check is successful, false otherwise.
	HealthCheck(ctx context.Context) (bool, error)
}

Dependency provides a unified interface for a service dependency requiring a health check.