job

Documentation

Index

• Constants
• Variables
• func AggregateCheckStatus1d(ctx context.Context) (int, error)
• func AggregateCheckStatus1h(ctx context.Context) (int, error)
• func CleanupSoftDeletedComponents(ctx context.Context, olderThan time.Duration) (int, error)
• func DeleteOldCheckStatuses(ctx context.Context, retention int) (int, error)
• func DeleteOldCheckStatuses1d(ctx context.Context, retention int) (int, error)
• func DeleteOldCheckStatuses1h(ctx context.Context, retention int) (int, error)
• func RefreshCheckStatusSummary(ctx context.Context) error
• func RefreshCheckStatusSummaryAged(ctx context.Context) error
• type Job
  • func CleanupStaleHistoryJob(ctx context.Context, age time.Duration, name, resourceID string) *Job
  • func NewJob(ctx context.Context, name string, schedule string, ...) *Job
  • func (j *Job) AddToScheduler(cronRunner *cron.Cron) error
  • func (j *Job) FindHistory(statuses ...string) ([]models.JobHistory, error)
  • func (j *Job) GetEntry(cronRunner *cron.Cron) *cron.Entry
  • func (j *Job) GetResourcedName() string
  • func (j *Job) Label() string
  • func (j *Job) RemoveFromScheduler(cronRunner *cron.Cron)
  • func (j *Job) Reschedule(schedule string, cronRunner *cron.Cron) error
  • func (j *Job) Retain(r Retention) *Job
  • func (j *Job) Run()
  • func (j *Job) RunOnStart() *Job
  • func (j *Job) SetID(id string) *Job
  • func (j *Job) SetTimeout(t time.Duration) *Job
  • func (j *Job) String() string
  • func (j *Job) Unschedule()
• type JobRuntime
  • func (j *JobRuntime) Failf(message string, args ...interface{})
  • func (j *JobRuntime) ID() string
• type Retention
  • func (r Retention) Count(status string) int
  • func (r Retention) Empty() bool
  • func (r Retention) String() string
  • func (r Retention) WithData() Retention
• type StatusRing
  • func (sr *StatusRing) Add(job *models.JobHistory)

Constants

const (
	ResourceTypeCheckStatuses = "check_statuses"
	ResourceTypeComponent     = "components"
	ResourceTypePlaybook      = "playbook"
	ResourceTypeScraper       = "config_scraper"
	ResourceTypeUpstream      = "upstream"
)

Variables

var RetentionBalanced = Retention{
	Success: 3,
	Failed:  3,
}

var RetentionFailed = Retention{
	Success: 0,
	Failed:  3,
}

var RetentionFew = Retention{
	Success: 1,
	Failed:  3,
}

var RetentionHigh = Retention{
	Success: 3,
	Failed:  6,
}

Functions

func AggregateCheckStatus1d

func AggregateCheckStatus1d(ctx context.Context) (int, error)

func AggregateCheckStatus1h

func AggregateCheckStatus1h(ctx context.Context) (int, error)

func CleanupSoftDeletedComponents

func CleanupSoftDeletedComponents(ctx context.Context, olderThan time.Duration) (int, error)

func DeleteOldCheckStatuses

func DeleteOldCheckStatuses(ctx context.Context, retention int) (int, error)

func DeleteOldCheckStatuses1d

func DeleteOldCheckStatuses1d(ctx context.Context, retention int) (int, error)

func DeleteOldCheckStatuses1h

func DeleteOldCheckStatuses1h(ctx context.Context, retention int) (int, error)

func RefreshCheckStatusSummary

func RefreshCheckStatusSummary(ctx context.Context) error

func RefreshCheckStatusSummaryAged

func RefreshCheckStatusSummaryAged(ctx context.Context) error

Types

type Job

type Job struct {
	context.Context
	Name                     string
	Schedule                 string
	Singleton                bool
	Debug, Trace             bool
	Timeout                  time.Duration
	Fn                       func(ctx JobRuntime) error
	JobHistory               bool
	RunNow                   bool
	ID                       string
	ResourceID, ResourceType string

	Retention Retention
	LastJob   *models.JobHistory
	// contains filtered or unexported fields
}

func CleanupStaleHistoryJob

func CleanupStaleHistoryJob(ctx context.Context, age time.Duration, name, resourceID string) *Job

func NewJob

func NewJob(ctx context.Context, name string, schedule string, fn func(ctx JobRuntime) error) *Job

func (*Job) AddToScheduler

func (j *Job) AddToScheduler(cronRunner *cron.Cron) error

func (*Job) FindHistory

func (j *Job) FindHistory(statuses ...string) ([]models.JobHistory, error)

func (*Job) GetEntry

func (j *Job) GetEntry(cronRunner *cron.Cron) *cron.Entry

func (*Job) GetResourcedName

func (j *Job) GetResourcedName() string

func (*Job) Label

func (j *Job) Label() string

func (*Job) RemoveFromScheduler

func (j *Job) RemoveFromScheduler(cronRunner *cron.Cron)

func (*Job) Reschedule

func (j *Job) Reschedule(schedule string, cronRunner *cron.Cron) error

func (*Job) Retain

func (j *Job) Retain(r Retention) *Job

func (*Job) Run

func (j *Job) Run()

func (*Job) RunOnStart

func (j *Job) RunOnStart() *Job

func (*Job) SetID

func (j *Job) SetID(id string) *Job

func (*Job) SetTimeout

func (j *Job) SetTimeout(t time.Duration) *Job

func (*Job) String

func (j *Job) String() string

func (*Job) Unschedule

func (j *Job) Unschedule()

type JobRuntime

type JobRuntime struct {
	context.Context
	Job       *Job
	Span      trace.Span
	History   *models.JobHistory
	Table, Id string
	// contains filtered or unexported fields
}

func (*JobRuntime) Failf

func (j *JobRuntime) Failf(message string, args ...interface{})

func (*JobRuntime) ID

func (j *JobRuntime) ID() string

type Retention

type Retention struct {
	// Success is the number of finished/success job history to retain
	Success int

	// Failed is the number of unsuccessful job history to retain
	Failed int

	// Data ...?
	Data bool
}

func (Retention) Count

func (r Retention) Count(status string) int

func (Retention) Empty

func (r Retention) Empty() bool

func (Retention) String

func (r Retention) String() string

func (Retention) WithData

func (r Retention) WithData() Retention

type StatusRing

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

func (*StatusRing) Add

func (sr *StatusRing) Add(job *models.JobHistory)