probe

Documentation

Overview

Package probe contains facilities for asserting the readiness of a multi-tenant receive adapter.

Index

• Constants
• func ReadinessCheckerHTTPHandler(c ReadinessChecker) http.Handler
• type AdapterReadyChecker
  • func NewAdapterReadyChecker(ls listersv1alpha1.AWSSNSSourceLister, r *router.Router) *AdapterReadyChecker
  • func (c *AdapterReadyChecker) IsReady() (bool, error)
• type ReadinessChecker

Constants

const EndpointPath = "/health"

EndpointPath is the recommended URL path of the health endpoint to serve a ReadinessChecker over HTTP.

Functions

func ReadinessCheckerHTTPHandler

func ReadinessCheckerHTTPHandler(c ReadinessChecker) http.Handler

ReadinessCheckerHTTPHandler returns a http.Handler which executes the given ReadinessChecker.

Types

type AdapterReadyChecker

type AdapterReadyChecker struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

AdapterReadyChecker asserts the readiness of a receive adapter.

func NewAdapterReadyChecker

func NewAdapterReadyChecker(ls listersv1alpha1.AWSSNSSourceLister, r *router.Router) *AdapterReadyChecker

NewAdapterReadyChecker returns an AdapterReadyChecker initialized with the given Lister and Router.

func (*AdapterReadyChecker) IsReady

func (c *AdapterReadyChecker) IsReady() (bool, error)

IsReady implements ReadinessChecker. It checks whether the adapter has registered a handler for all observed sources.

NOTE(antoineco): we might want to revisit this in the future, because the following implementation details are currently leaking into this ReadinessChecker implementation:

- The fact that the adapter exposes a health endpoint via the HTTP router. - The exact URL path of this health endpoint. - The fact that a handler isn't registered for sources which don't have a valid sink.

We consider this tight coupling acceptable for the time being, because this is a sub-package of the main adapter package for the SNS source specifically.

type ReadinessChecker

type ReadinessChecker interface {
	IsReady() (bool, error)
}

ReadinessChecker can assert the readiness of a component.