health

Documentation

Index

• Constants
• Variables
• type Component
  • func New(components ...string) *Component
  • func (c *Component) Configure(opts ...components.Option) error
  • func (c *Component) HealthHandler(ctx *gin.Context)
  • func (c *Component) Shutdown() error
  • func (c *Component) Start() error
• type ComponentHealthCheck

Constants

const (
	ComponentName string = "http-health-endpoints"
)

Variables

var ErrUnknownComponent = fmt.Errorf("component is not the %s component", ComponentName)

Types

type Component

type Component struct {
	components.Base
	// contains filtered or unexported fields
}

func New

func New(components ...string) *Component

func (*Component) Configure

func (c *Component) Configure(opts ...components.Option) error

func (*Component) HealthHandler

func (c *Component) HealthHandler(ctx *gin.Context)

func (*Component) Shutdown

func (c *Component) Shutdown() error

func (*Component) Start

func (c *Component) Start() error

type ComponentHealthCheck

type ComponentHealthCheck interface {
	Health(context.Context) error
}