checks

Documentation

Index

• Constants
• Variables
• func LoggingContextForCheck(checkType string, uuid string, environment string, transactionID string) string
• func ScheduleChecks(p *SchedulerParam, endpointSpecificChecks map[string]EndpointSpecificCheck, ...)
• type ContentCheck
  • func NewContentCheck(httpCaller httpcaller.Caller) ContentCheck
• type ContentNeo4jCheck
  • func NewContentNeo4jCheck(httpCaller httpcaller.Caller) ContentNeo4jCheck
• type EndpointSpecificCheck
• type NotificationsCheck
  • func NewNotificationsCheck(httpCaller httpcaller.Caller, subscribedFeeds map[string][]feeds.Feed, ...) NotificationsCheck
• type PreCheck
  • func MainPreChecks() []PreCheck
• type PublishCheck
  • func NewPublishCheck(metric metrics.PublishMetric, username, password string, ...) *PublishCheck
  • func (pc PublishCheck) DoCheck() (checkSuccessful, ignoreCheck bool)
  • func (pc PublishCheck) String() string
• type SchedulerParam

Constants

const DateLayout = time.RFC3339Nano

Variables

var (
	AbsoluteURLRegex = regexp.MustCompile("(?i)https?://.*")
)

Functions

func LoggingContextForCheck

func LoggingContextForCheck(checkType string, uuid string, environment string, transactionID string) string

func ScheduleChecks

func ScheduleChecks(
	p *SchedulerParam,
	endpointSpecificChecks map[string]EndpointSpecificCheck,
	appConfig *config.AppConfig,
	metricSink chan metrics.PublishMetric,
	e2eTestUUIDs []string,
	log *logger.UPPLogger,
)

Types

type ContentCheck

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

ContentCheck implements the EndpointSpecificCheck interface to check operation status for the content endpoint.

func NewContentCheck

func NewContentCheck(httpCaller httpcaller.Caller) ContentCheck

type ContentNeo4jCheck

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

ContentNeo4jCheck implements the EndpointSpecificCheck interface to check operation status for the content endpoint.

func NewContentNeo4jCheck

func NewContentNeo4jCheck(httpCaller httpcaller.Caller) ContentNeo4jCheck

type EndpointSpecificCheck

type EndpointSpecificCheck interface {
	// contains filtered or unexported methods
}

EndpointSpecificCheck is the interface which determines the state of the operation we are currently checking.

type NotificationsCheck

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

NotificationsCheck implements the EndpointSpecificCheck interface to build the endpoint URL and to check the operation is present in the notification feed

func NewNotificationsCheck

func NewNotificationsCheck(httpCaller httpcaller.Caller, subscribedFeeds map[string][]feeds.Feed, feedName string) NotificationsCheck

type PreCheck

type PreCheck func(
	publishedContent content.Content,
	tid string,
	publishDate time.Time,
	appConfig *config.AppConfig,
	metricContainer *metrics.History,
	environments *envs.Environments,
	log *logger.UPPLogger,
) (bool, *SchedulerParam)

func MainPreChecks

func MainPreChecks() []PreCheck

type PublishCheck

type PublishCheck struct {
	Metric metrics.PublishMetric

	Threshold     int
	CheckInterval int
	ResultSink    chan metrics.PublishMetric
	// contains filtered or unexported fields
}

PublishCheck performs an availability check on a piece of content, at a given endpoint, and returns whether the check was successful or not. Holds all the information necessary to check content availability at an endpoint, as well as store and send the results of the check.

func NewPublishCheck

func NewPublishCheck(
	metric metrics.PublishMetric,
	username, password string,
	threshold, checkInterval int,
	resultSink chan metrics.PublishMetric,
	endpointSpecificChecks map[string]EndpointSpecificCheck,
	log *logger.UPPLogger,
) *PublishCheck

NewPublishCheck returns a PublishCheck ready to perform a check for pm.UUID, at the pm.Endpoint.

func (PublishCheck) DoCheck

func (pc PublishCheck) DoCheck() (checkSuccessful, ignoreCheck bool)

DoCheck performs an availability check on a piece of content at a certain endpoint, applying endpoint-specific processing. Returns true if the content is available at the endpoint, false otherwise.

func (PublishCheck) String

func (pc PublishCheck) String() string

type SchedulerParam

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