logretention

Documentation

Index

• Variables
• func DeleteExpiredTaskLogs(ctx context.Context, days *int16) (int64, error)
• func Schedule(config model.LogRetentionPolicy) error
• func SetupScheduler(opts ...gocron.SchedulerOption)

Variables

var (

	// TestingOnlySynchronizationHelper is used for testing purposes to wait for the log retention scheduler to finish.
	TestingOnlySynchronizationHelper *sync.WaitGroup
)

Functions

func DeleteExpiredTaskLogs

func DeleteExpiredTaskLogs(ctx context.Context, days *int16) (int64, error)

DeleteExpiredTaskLogs deletes task logs older than days time when defined and non-negative. Task configured values may override the default provided number of days for retention.

func Schedule

func Schedule(config model.LogRetentionPolicy) error

Schedule begins a log deletion schedule according to the provided LogRetentionPolicy.

func SetupScheduler

func SetupScheduler(opts ...gocron.SchedulerOption)

SetupScheduler creates a new scheduler with the provided options. Should only be called by init() or test functions, and will panic on error.