crontab

Documentation

Index

• Constants
• type Config
  • func NewConfig() Config
  • func (c Config) Validate() error
• type SourceProvider
  • func NewSourceProvider(config Config) *SourceProvider
  • func (p SourceProvider) OnTaskUpdate(fn func(*provider.Task) error)
  • func (p *SourceProvider) Read() error
  • func (p SourceProvider) Stop() error
  • func (p SourceProvider) String() string
  • func (p SourceProvider) TaskDone(t *provider.Task) error
  • func (p SourceProvider) TaskError(t *provider.Task, err error) error
  • func (p SourceProvider) TaskStarted(t *provider.Task) error

Constants

const (
	// DefaultEnable is default state for metrics
	DefaultEnable = true

	// DefaultSource defines a source file
	DefaultSource = "/etc/crontab"
)

Types

type Config

type Config struct {
	Enabled bool   `toml:"enabled"`
	Crontab string `toml:"source"`
}

Config represents the meta configuration.

func NewConfig

func NewConfig() Config

NewConfig builds a new configuration with default values.

func (Config) Validate

func (c Config) Validate() error

Validate the config

type SourceProvider

type SourceProvider struct {
	Config   Config
	TaskFlow chan *provider.Task
	QuitChan chan bool
}

SourceProvider creates a new src provider

func NewSourceProvider

func NewSourceProvider(config Config) *SourceProvider

NewSourceProvider creates a new src provider

func (SourceProvider) OnTaskUpdate

func (p SourceProvider) OnTaskUpdate(fn func(*provider.Task) error)

OnTaskUpdate runs when a task gets updated

func (*SourceProvider) Read

func (p *SourceProvider) Read() error

Read reads from FS

func (SourceProvider) Stop

func (p SourceProvider) Stop() error

Stop quits reading tasks

func (SourceProvider) String

func (p SourceProvider) String() string

String returns the Providers identity

func (SourceProvider) TaskDone

func (p SourceProvider) TaskDone(t *provider.Task) error

TaskDone will be executed when a task is done

func (SourceProvider) TaskError

func (p SourceProvider) TaskError(t *provider.Task, err error) error

TaskError will be called when an error occured

func (SourceProvider) TaskStarted

func (p SourceProvider) TaskStarted(t *provider.Task) error

TaskStarted will be executed when a task is started