counter

Documentation

Index

• type Counter
  • func New(ctx context.Context, config *client.Config, options ...Option) (*Counter, error)
  • func (c *Counter) PostRun(ctx context.Context, log *logger.Entry, n string, f events.Action, ...) error
  • func (c *Counter) PreRun(ctx context.Context, log *logger.Entry, n string, f events.Action) (err error)
• type Option
  • func WithActions(actions map[string]events.Action) Option
  • func WithDryRun(dryRun bool) Option
  • func WithHumanize(humanize bool) Option
  • func WithLogger(l *logger.Logger) Option
  • func WithLoop(loop bool) Option
  • func WithPid(pid int) Option
  • func WithPollingTimeout(timeout time.Duration) Option
  • func WithRoundDuration(duration time.Duration) Option
  • func WithSleep(sleep time.Duration) Option
• type Options
  • func (o Options) Apply(c *Counter) error

Types

type Counter

type Counter struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Counter is a plugin that

func New

func New(ctx context.Context, config *client.Config, options ...Option) (*Counter, error)

New returns a new Counter instance.

func (*Counter) PostRun

func (c *Counter) PostRun(ctx context.Context, log *logger.Entry, n string, f events.Action, actErr error) error

func (*Counter) PreRun

func (c *Counter) PreRun(ctx context.Context, log *logger.Entry, n string, f events.Action) (err error)

type Option

type Option func(*Counter) error

Option is a functional option for extractors.

func WithActions

func WithActions(actions map[string]events.Action) Option

func WithDryRun

func WithDryRun(dryRun bool) Option

func WithHumanize

func WithHumanize(humanize bool) Option

func WithLogger

func WithLogger(l *logger.Logger) Option

func WithLoop

func WithLoop(loop bool) Option

func WithPid

func WithPid(pid int) Option

func WithPollingTimeout

func WithPollingTimeout(timeout time.Duration) Option

func WithRoundDuration

func WithRoundDuration(duration time.Duration) Option

func WithSleep

func WithSleep(sleep time.Duration) Option

type Options

type Options []Option

Options is a slice of Option.

func (Options) Apply

func (o Options) Apply(c *Counter) error

Apply interates over Options and calls each functional option with a given Counter.