job

Documentation

Index

• Variables
• func AggregateCheckStatus1d(ctx context.Context) (error, int)
• func AggregateCheckStatus1h(ctx context.Context) (error, int)
• func DeleteOldCheckStatuses(ctx context.Context, retention int) (error, int)
• func DeleteOldCheckStatuses1d(ctx context.Context, retention int) (error, int)
• func DeleteOldCheckStatuses1h(ctx context.Context, retention int) (error, int)
• func RefreshCheckStatusSummary(ctx context.Context) error
• func RefreshCheckStatusSummaryAged(ctx context.Context) error
• type 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) RemoveFromScheduler(cronRunner *cron.Cron)
  • 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) String() string

Variables

var Retention3Day = Retention{
	Success:  3,
	Failed:   3,
	Age:      time.Hour * 24 * 3,
	Interval: time.Hour * 4,
}

var RetentionDay = Retention{
	Success:  3,
	Failed:   3,
	Age:      time.Hour,
	Interval: time.Hour * 24,
}

var RetentionHour = Retention{
	Success:  1,
	Failed:   3,
	Age:      time.Hour,
	Interval: 5 * time.Minute,
}

Functions

func AggregateCheckStatus1d

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

func AggregateCheckStatus1h

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

func DeleteOldCheckStatuses

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

func DeleteOldCheckStatuses1d

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

func DeleteOldCheckStatuses1h

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

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

	Retention Retention
	// contains filtered or unexported fields
}

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) RemoveFromScheduler

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

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, Failed int
	Age             time.Duration
	Interval        time.Duration
}

func (Retention) String

func (r Retention) String() string