sparrow

Documentation

Index

• type ChecksController
  • func NewChecksController(dbase db.DB, m metrics.Provider) *ChecksController
  • func (cc *ChecksController) GenerateCheckSpecs(ctx context.Context) (openapi3.T, error)
  • func (cc *ChecksController) Reconcile(ctx context.Context, cfg runtime.Config)
  • func (cc *ChecksController) RegisterCheck(ctx context.Context, check checks.Check)
  • func (cc *ChecksController) Run(ctx context.Context) error
  • func (cc *ChecksController) Shutdown(ctx context.Context)
  • func (cc *ChecksController) UnregisterCheck(ctx context.Context, check checks.Check)
• type ErrCreateOpenapiSchema
  • func (e ErrCreateOpenapiSchema) Error() string
• type ErrRunningCheck
  • func (e *ErrRunningCheck) Error() string
• type ErrShutdown
  • func (e ErrShutdown) HasError() bool
• type Sparrow
  • func New(cfg *config.Config) *Sparrow
  • func (s *Sparrow) Run(ctx context.Context) error

Types

type ChecksController

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

ChecksController is responsible for managing checks.

func NewChecksController

func NewChecksController(dbase db.DB, m metrics.Provider) *ChecksController

NewChecksController creates a new ChecksController.

func (*ChecksController) GenerateCheckSpecs

func (cc *ChecksController) GenerateCheckSpecs(ctx context.Context) (openapi3.T, error)

GenerateCheckSpecs generates the OpenAPI specifications for the given checks Returns the complete OpenAPI specification for all checks

func (*ChecksController) Reconcile

func (cc *ChecksController) Reconcile(ctx context.Context, cfg runtime.Config)

Reconcile reconciles the checks. It registers new checks, updates existing checks and unregisters checks not in the new config.

func (*ChecksController) RegisterCheck

func (cc *ChecksController) RegisterCheck(ctx context.Context, check checks.Check)

RegisterCheck registers a new check.

func (*ChecksController) Run

func (cc *ChecksController) Run(ctx context.Context) error

Run runs the ChecksController with handling results and errors.

func (*ChecksController) Shutdown

func (cc *ChecksController) Shutdown(ctx context.Context)

Shutdown shuts down the ChecksController.

func (*ChecksController) UnregisterCheck

func (cc *ChecksController) UnregisterCheck(ctx context.Context, check checks.Check)

UnregisterCheck unregisters a check.

type ErrCreateOpenapiSchema

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

func (ErrCreateOpenapiSchema) Error

func (e ErrCreateOpenapiSchema) Error() string

type ErrRunningCheck

type ErrRunningCheck struct {
	Check checks.Check
	Err   error
}

func (*ErrRunningCheck) Error

func (e *ErrRunningCheck) Error() string

type ErrShutdown

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

func (ErrShutdown) HasError

func (e ErrShutdown) HasError() bool

type Sparrow

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

Sparrow is the main struct of the sparrow application

func New

func New(cfg *config.Config) *Sparrow

New creates a new sparrow from a given configfile

func (*Sparrow) Run

func (s *Sparrow) Run(ctx context.Context) error

Run starts the sparrow