bgjobx

Documentation

Index

• func WithDurationMeasure(storage MetricStorage, handler bgjob.Handler) bgjob.Handler
• type Client
  • func NewClient(db DBProvider, logger log.Logger) *Client
  • func (c *Client) BulkEnqueue(ctx context.Context, list []bgjob.EnqueueRequest) error
  • func (c *Client) Close()
  • func (c *Client) Enqueue(ctx context.Context, req bgjob.EnqueueRequest) error
  • func (c *Client) Upgrade(ctx context.Context, workerConfigs []WorkerConfig) error
• type DBProvider
• type MetricStorage
• type Observer
  • func (o Observer) JobCompleted(ctx context.Context, job bgjob.Job)
  • func (o Observer) JobMovedToDlq(ctx context.Context, job bgjob.Job, err error)
  • func (o Observer) JobRescheduled(ctx context.Context, job bgjob.Job, after time.Duration)
  • func (o Observer) JobStarted(ctx context.Context, job bgjob.Job)
  • func (o Observer) JobWillBeRetried(ctx context.Context, job bgjob.Job, after time.Duration, err error)
  • func (o Observer) QueueIsEmpty(ctx context.Context)
  • func (o Observer) WorkerError(ctx context.Context, err error)
• type WorkerConfig
  • func (c WorkerConfig) GetConcurrency() int
  • func (c WorkerConfig) GetPollInterval() time.Duration

Functions

func WithDurationMeasure

func WithDurationMeasure(storage MetricStorage, handler bgjob.Handler) bgjob.Handler

Types

type Client

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

func NewClient

func NewClient(db DBProvider, logger log.Logger) *Client

func (*Client) BulkEnqueue

func (c *Client) BulkEnqueue(ctx context.Context, list []bgjob.EnqueueRequest) error

func (*Client) Close

func (c *Client) Close()

func (*Client) Enqueue

func (c *Client) Enqueue(ctx context.Context, req bgjob.EnqueueRequest) error

func (*Client) Upgrade

func (c *Client) Upgrade(ctx context.Context, workerConfigs []WorkerConfig) error

type DBProvider

type DBProvider interface {
	DB() (*dbx.Client, error)
}

type MetricStorage

type MetricStorage interface {
	ObserveExecuteDuration(queue string, jobType string, t time.Duration)
	IncRetryCount(queue string, jobType string)
	IncDlqCount(queue string, jobType string)
	IncSuccessCount(queue string, jobType string)
	IncInternalErrorCount()
}

type Observer

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

func (Observer) JobCompleted

func (o Observer) JobCompleted(ctx context.Context, job bgjob.Job)

func (Observer) JobMovedToDlq

func (o Observer) JobMovedToDlq(ctx context.Context, job bgjob.Job, err error)

func (Observer) JobRescheduled

func (o Observer) JobRescheduled(ctx context.Context, job bgjob.Job, after time.Duration)

func (Observer) JobStarted

func (o Observer) JobStarted(ctx context.Context, job bgjob.Job)

func (Observer) JobWillBeRetried

func (o Observer) JobWillBeRetried(ctx context.Context, job bgjob.Job, after time.Duration, err error)

func (Observer) QueueIsEmpty

func (o Observer) QueueIsEmpty(ctx context.Context)

func (Observer) WorkerError

func (o Observer) WorkerError(ctx context.Context, err error)

type WorkerConfig

type WorkerConfig struct {
	Queue        string
	Concurrency  int
	PollInterval time.Duration
	Handle       bgjob.Handler
}

func (WorkerConfig) GetConcurrency

func (c WorkerConfig) GetConcurrency() int

func (WorkerConfig) GetPollInterval

func (c WorkerConfig) GetPollInterval() time.Duration