canary

Documentation

Index

• Constants
• Variables
• func CleanupMetricsGauges()
• func DeleteCanaryJob(id string)
• func ScanCanaryConfigs()
• func ScheduleFunc(schedule string, fn func()) (interface{}, error)
• func StartScanCanaryConfigs(dataFile string, configFiles []string)
• func StartUpstreamEventQueueConsumer(ctx *context.Context) error
• func SyncCanaryJob(ctx context.Context, dbCanary pkg.Canary, options ...SyncCanaryJobOption) error
• func SyncCanaryJobs(ctx dutyjob.JobRuntime) error
• type CanaryJob
  • func (j CanaryJob) GetNamespacedName() types.NamespacedName
  • func (j CanaryJob) Run(ctx dutyjob.JobRuntime) error
• type CanaryPullResponse
• type CanaryStatusPayload
• type RelatableCheck
• type SyncCanaryJobConfig
• type SyncCanaryJobOption
  • func WithRunNow(value bool) SyncCanaryJobOption
  • func WithSchedule(schedule string) SyncCanaryJobOption

Constants

const (
	EventPushQueueCreate = "push_queue.create"
)

Variables

var (
	ReconcilePageSize int

	// Only sync data created/updated in the last ReconcileMaxAge duration
	ReconcileMaxAge time.Duration

	// UpstreamConf is the global configuration for upstream
	UpstreamConf upstream.UpstreamConfig
)

var CanaryConfigFiles []string

var CanaryScheduler = cron.New()

var CanaryStatusChannel chan CanaryStatusPayload

var DataFile string

var Executor bool

var FuncScheduler = cron.New()

var Kommons *kommons.Client

var Kubernetes kubernetes.Interface

var LogPass, LogFail bool

var MinimumTimeBetweenCanaryRuns = 10 * time.Second

var PullUpstreamCanaries = job.Job{
	Name:       "PullUpstreamCanaries",
	JobHistory: true,
	Singleton:  true,
	Schedule:   "@every 10m",
	Fn: func(ctx job.JobRuntime) error {
		count, err := pull(ctx, UpstreamConf)
		ctx.History.SuccessCount = count
		return err
	},
}

var ReconcileChecks = job.Job{
	Name:       "PushChecksToUpstream",
	JobHistory: true,
	Singleton:  true,
	Schedule:   "@every 30m",
	Fn: func(ctx job.JobRuntime) error {
		reconciler := upstream.NewUpstreamReconciler(UpstreamConf, 5)
		return reconciler.SyncAfter(ctx.Context, "checks", ReconcileMaxAge)
	},
}

var SyncCheckStatuses = job.Job{
	Name:       "SyncCheckStatusesWithUpstream",
	JobHistory: true,
	Singleton:  true,
	Schedule:   "@every 1m",
	Fn: func(ctx job.JobRuntime) error {
		err, count := upstream.SyncCheckStatuses(ctx.Context, UpstreamConf, ReconcilePageSize)
		ctx.History.SuccessCount = count
		return err
	},
}

var UpstreamJobs = []job.Job{
	SyncCheckStatuses,
	PullUpstreamCanaries,
	ReconcileChecks,
}

Functions

func CleanupMetricsGauges

func CleanupMetricsGauges()

CleanupMetricsGauges removes gauges for checks that no longer exist.

func DeleteCanaryJob

func DeleteCanaryJob(id string)

func ScanCanaryConfigs

func ScanCanaryConfigs()

func ScheduleFunc

func ScheduleFunc(schedule string, fn func()) (interface{}, error)

func StartScanCanaryConfigs

func StartScanCanaryConfigs(dataFile string, configFiles []string)

func StartUpstreamEventQueueConsumer

func StartUpstreamEventQueueConsumer(ctx *context.Context) error

func SyncCanaryJob

func SyncCanaryJob(ctx context.Context, dbCanary pkg.Canary, options ...SyncCanaryJobOption) error

TODO: Refactor to use database object instead of kubernetes

func SyncCanaryJobs

func SyncCanaryJobs(ctx dutyjob.JobRuntime) error

Types

type CanaryJob

type CanaryJob struct {
	Canary   v1.Canary
	DBCanary pkg.Canary
	LogPass  bool
	LogFail  bool
}

func (CanaryJob) GetNamespacedName

func (j CanaryJob) GetNamespacedName() types.NamespacedName

func (CanaryJob) Run

func (j CanaryJob) Run(ctx dutyjob.JobRuntime) error

type CanaryPullResponse

type CanaryPullResponse struct {
	Before   time.Time       `json:"before"`
	Canaries []models.Canary `json:"canaries,omitempty"`
}

type CanaryStatusPayload

type CanaryStatusPayload struct {
	Pass                 bool
	CheckStatus          map[string]*v1.CheckStatus
	FailEvents           []string
	LastTransitionedTime *metav1.Time
	Message              string
	ErrorMessage         string
	Uptime               string
	Latency              string
	NamespacedName       types.NamespacedName
}

type RelatableCheck

type RelatableCheck interface {
	GetRelationship() *v1.CheckRelationship
}

type SyncCanaryJobConfig

type SyncCanaryJobConfig struct {
	RunNow bool

	// Schedule to override the schedule from the spec
	Schedule string
}

type SyncCanaryJobOption

type SyncCanaryJobOption func(*SyncCanaryJobConfig)

func WithRunNow

func WithRunNow(value bool) SyncCanaryJobOption

func WithSchedule

func WithSchedule(schedule string) SyncCanaryJobOption