asynq

Documentation

Index

• type Client
  • func WrapClient(c *asynq.Client, opts ...Option) *Client
  • func (c *Client) Enqueue(task *asynq.Task, opts ...asynq.Option) (taskInfo *asynq.TaskInfo, err error)
• type Option
  • func WithAnalytics(on bool) Option
  • func WithAnalyticsRate(rate float64) Option
  • func WithServiceName(serviceName string) Option

Types

type Client

type Client struct {
	*asynq.Client
	// contains filtered or unexported fields
}

Client is a traced version of asynq.Client.

func WrapClient

func WrapClient(c *asynq.Client, opts ...Option) *Client

WrapClient wraps a asynq.Client so that all requests are traced.

func (*Client) Enqueue

func (c *Client) Enqueue(task *asynq.Task, opts ...asynq.Option) (taskInfo *asynq.TaskInfo, err error)

Enqueue enqueues a task and returns a task info.

type Option

type Option func(cfg *config)

An Option customizes the config.

func WithAnalytics

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) Option

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceName sets the config service name to serviceName.