health

Documentation

Index

• func NewHealthRoutes(logger logger.Logger, handler common.RequestHandler, ...) routes.Route
• type Health
  • func HealthToResponseHealth(health checker.Health) Health
• type HealthAPIConverter
  • func NewHealthAPIConverter() *HealthAPIConverter
  • func (h HealthAPIConverter) ResponseOf(result health.HealthResult) HealthResponse
• type HealthController
  • func NewHealthController(healthCheckerManager *health.HealthCheckerManager, ...) HealthController
  • func (h HealthController) Health(ctx *gin.Context) (*response.APIResponseEnvelope, error)
• type HealthResponse
• type HealthRoutes
  • func (s HealthRoutes) Setup()

Functions

func NewHealthRoutes

func NewHealthRoutes(
	logger logger.Logger,
	handler common.RequestHandler,
	healthController HealthController,
	rootHandler *routeHandlers.RootRouteHandler,
) routes.Route

NewHealthRoutes creates new health routes.

Types

type Health

type Health struct {
	Status  string
	Name    string
	Details map[string]any
}

func HealthToResponseHealth

func HealthToResponseHealth(health checker.Health) Health

type HealthAPIConverter

type HealthAPIConverter struct{}

func NewHealthAPIConverter

func NewHealthAPIConverter() *HealthAPIConverter

func (HealthAPIConverter) ResponseOf

func (h HealthAPIConverter) ResponseOf(result health.HealthResult) HealthResponse

type HealthController

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

func NewHealthController

func NewHealthController(
	healthCheckerManager *health.HealthCheckerManager,
	apiConverter *HealthAPIConverter,
) HealthController

func (HealthController) Health

func (h HealthController) Health(ctx *gin.Context) (*response.APIResponseEnvelope, error)

type HealthResponse

type HealthResponse struct {
	Health     string
	Components []Health
}

type HealthRoutes

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

HealthRoutes struct.

func (HealthRoutes) Setup

func (s HealthRoutes) Setup()

Setup health routes.