Active Job is a framework for declaring jobs and making them run on a variety of queuing backends shipped with Rails.
The Active Job integration tracks the execution and events from the job being performed.
When AppSignal detects Active Job metrics, it will create an Automated Dashboard, allowing you to monitor core metrics visually.
The Active Job integration supports all Active Job adapters.
It may also offer support for adapters not listed on that page, which are accessible through a separate gem. However, please note that these adapters have not been tested.
Integration with AppSignal-supported libraries
The following background job libraries that AppSignal supports are automatically integrated with Active Job, allowing AppSignal to give you more in-depth performance insights:
AppSignal collects the following metadata for Active Job jobs:
|Active Job ID
|The Active Job ID is reported by the Active Job adapter.
|Arguments passed to the job when calling
MyBackgroundJob#perform as used to group the job for AppSignal incidents.
|The sample's priority, if using an adapter that supports job priority.
|Provider job ID
|The job ID reported by the Active Job adapter.
|The sample's queue name, if using an adapter that supports multiple queues.
|Time elapsed from a job being queued and performed.
*From Rails version 6 onwards queue times are reported for the namespace they are reported from and can be viewed in AppSignal's Performance Graphs.
AppSignal uses Active Job metadata to give you deeper contextual insights into job performance. When inspecting Active Job samples in AppSignal:
- The Job name will be used to group the job for AppSignal incidents:
- Metadata (excluding job name and events) will be available as filterable tags on incident samples:
*.active_jobevents will shown in the event timeline for performance samples:
When AppSignal receives Active Job metrics, it will create an Active Job automated dashboard, available from the dashboard section of the AppSignal app.
The Active Job automated dashboard will have the following graphs:
|Duration per job class
|Job status per queue
|Job status per queue with priority
|Throughput per job class
Tags give you a contextual breakdown of Active job performance information, currently AppSignal reports the following tags for Active Job jobs:
|The name of the action the metric was reported from (eg:
|Named queue in which jobs are processed, e.g.
|Status of each job, either
Jobs that are
failed are also counted as
|The priority given to each job, e.g.
Each tag will be represented with a colored line on the graph:
Duration per job class graph
The Duration per job class graph shows the amount of time that it took for jobs to execute, grouped by the class that defines the job.
You can use this graph to monitor the performance of jobs, per class, giving you a helicopter view of job performance and allowing you to quickly identify and investigate spikes in duration time.
Job status per queue graph
The Job status per queue with priority graph shows the number of jobs that were executed, grouped by their resulting status, by the queue in which they were enqueued.
You can use this graph to monitor job error counts and performance based on queue, identify bottlenecks, and optimize your background jobs for scalability.
Job status per queue with priority graph
The Job status per queue with a priority graph shows the number of jobs that were executed, grouped by their resulting status by the queue in which they were enqueued, and by the priority that was given to them.
You can use this graph to monitor job error counts and performance based on queue and priority identify bottlenecks, and optimize your background jobs for scalability.
Throughput per job class graph
The Throughput per job class graph shows the amount of jobs that were executed, grouped by the class that defines the job.
You can use this graph to monitor how many jobs are executed, grouped by the class that defines the job.