management

Documentation

Index

• Variables
• func AppMetaInfoContributor(app metadata.ApplicationMetadata) info.InfoContributorOut
• func NewHealthCheckController(log *zap.SugaredLogger, i healthIndicators) server.ManagementController
• func NewInfoController(log *zap.SugaredLogger, is *info.InfoService) server.ManagementController
• type Health
• type HealthCheckResponse
• type HealthController
  • func (c *HealthController) Handlers() []server.Handler
• type HealthIndicator
• type InfoController
  • func (i InfoController) Handlers() []server.Handler
• type InfoResponse

Variables

var Module = fx.Options(
	fx.Provide(
		NewHealthCheckController,
		NewInfoController,
		AppMetaInfoContributor,
	),
)

Functions

func AppMetaInfoContributor

func AppMetaInfoContributor(app metadata.ApplicationMetadata) info.InfoContributorOut

func NewHealthCheckController

func NewHealthCheckController(log *zap.SugaredLogger, i healthIndicators) server.ManagementController

func NewInfoController

func NewInfoController(log *zap.SugaredLogger, is *info.InfoService) server.ManagementController

Types

type Health

type Health struct {
	Name  string
	Ready bool
	Alive bool
	Msg   string
}

Health Carries information about the health of a component or subsystem.

type HealthCheckResponse

type HealthCheckResponse struct {
	Status string         `json:"status"`
	Info   map[string]any `json:"info,omitempty"`
}

type HealthController

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

func (*HealthController) Handlers

func (c *HealthController) Handlers() []server.Handler

type HealthIndicator

type HealthIndicator struct {
	fx.Out
	HealthIndicator indicator `group:"health-check"`
}

type InfoController

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

func (InfoController) Handlers

func (i InfoController) Handlers() []server.Handler

type InfoResponse

type InfoResponse map[string]any