updown

Documentation

Overview

Package UpdownMonitor adds updown website monitoring tool's support in IngressMonitorController

Index

• Constants
• type UpdownMonitorService
  • func (service *UpdownMonitorService) Add(updownMonitor models.Monitor)
  • func (updownService *UpdownMonitorService) GetAll() []models.Monitor
  • func (updownService *UpdownMonitorService) GetByName(monitorName string) (*models.Monitor, error)
  • func (updownService *UpdownMonitorService) Remove(updownMonitor models.Monitor)
  • func (updownService *UpdownMonitorService) Setup(confProvider config.Provider)
  • func (service *UpdownMonitorService) Update(updownMonitor models.Monitor)

Constants

const (
	UpdownEnableCheckAnnotation = "updown.monitor.stakater.com/enable"
	UpdownPeriodAnnotation      = "updown.monitor.stakater.com/period"
	UpdownPublishPageAnnotation = "updown.monitor.stakater.com/publish-page"
	// this annotation is not enabled
	UpdownRequestHeadersAnnotation = "updown.monitor.stakater.com/request-headers"

	// Default value for annotations
	UpdownPeriodAnnotationDefaultValue    = 15
	UpdownPublishedAnnotationDefaultValue = true
	UpdownEnableAnnotationDefaultValue    = true
)

Types

type UpdownMonitorService

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

UpdownMonitorService struct contains parameters required by updown go client

func (*UpdownMonitorService) Add

func (service *UpdownMonitorService) Add(updownMonitor models.Monitor)

Add function method will add a monitor (updown check)

func (*UpdownMonitorService) GetAll

func (updownService *UpdownMonitorService) GetAll() []models.Monitor

GetAll function will return all monitors (updown checks) object in an array

func (*UpdownMonitorService) GetByName

func (updownService *UpdownMonitorService) GetByName(monitorName string) (*models.Monitor, error)

GetByName function will return a monitor(updown check) object based on the name provided

func (*UpdownMonitorService) Remove

func (updownService *UpdownMonitorService) Remove(updownMonitor models.Monitor)

Remove method will remove a monitor (updown check)

func (*UpdownMonitorService) Setup

func (updownService *UpdownMonitorService) Setup(confProvider config.Provider)

Setup method will initialize a updown's go client object by using the configuration parameters

func (*UpdownMonitorService) Update

func (service *UpdownMonitorService) Update(updownMonitor models.Monitor)

Update method will update a monitor (updown check)