Active Job

Active Job est un framework pour déclarer des jobs et les faire s’exécuter sur une variété de backends de queue livrés avec Rails. L’intégration Active Job suit l’exécution et les événements du job en cours d’exécution. Lorsqu’AppSignal détecte des métriques Active Job, il crée un Intelligence dashboard vous permettant de surveiller visuellement les métriques principales.

Adaptateurs pris en charge

L’intégration Active Job prend en charge tous les adaptateurs Active Job. Elle peut également offrir une prise en charge pour des adaptateurs non répertoriés sur cette page, accessibles via une gem séparée. Cependant, ces adaptateurs n’ont pas été testés.

Intégration avec les bibliothèques prises en charge par AppSignal

Les bibliothèques de background jobs suivantes prises en charge par AppSignal sont automatiquement intégrées à Active Job, permettant à AppSignal de vous fournir des informations de performance plus approfondies :

Signaler les erreurs lors de l’abandon d’un job

Définissez l’option de configuration activejob_report_errors sur discard pour ne signaler les erreurs que lorsqu’un job est abandonné. Lorsqu’un job est abandonné, toutes les nouvelles tentatives ont été épuisées et le job n’est plus réessayé. Consultez la documentation Active Job pour en savoir plus sur la gestion des exceptions Active Job et les nouvelles tentatives des jobs échoués.

class ExampleJob < ActiveJob::Base
  # Configure the retry attempts using the `retry_on` method
  retry_on StandardError, :attempts => 2

  # ...
end

Certains adaptateurs Active Job (tels que Sidekiq, Delayed::Job, etc.) ont leur propre système de nouvelles tentatives. Une fois qu’Active Job a épuisé ses nouvelles tentatives, ces bibliothèques peuvent déclencher leur propre système de nouvelles tentatives des jobs.Cela réessaie les jobs même après qu’Active Job ait épuisé ses nouvelles tentatives et abandonné le job. Pour éviter de réessayer les jobs après qu’Active Job ait cessé de les réessayer, et qu’il signale des erreurs pour ces nouvelles tentatives, assurez-vous que le système de nouvelles tentatives de l’adaptateur est désactivé.Lorsque vous vous appuyez sur le système de nouvelles tentatives de Sidekiq, configurez-le également pour ne signaler les erreurs qu’en cas d’abandon, afin qu’il ne signale pas les erreurs plusieurs fois.

Instrumentation de mise en file d’attente

Mettre un job en file d’attente via Active Job enregistre un événement enqueue.active_job, intitulé d’après le job mis en file d’attente. Lorsqu’un job est mis en file d’attente via un adaptateur qu’AppSignal instrumente également, comme Sidekiq ou Resque, AppSignal supprime l’événement de mise en file d’attente propre à l’adaptateur et enregistre la mise en file d’attente une seule fois sous forme d’événement Active Job. AppSignal enregistre les événements de mise en file d’attente dans la chronologie des événements de la transaction active, par exemple lorsque vous mettez en file d’attente un job depuis une requête web ou depuis un autre job. Il ne les enregistre que lorsqu’une transaction est active, donc mettre en file d’attente un job en dehors d’une transaction n’enregistre rien. Pour arrêter d’enregistrer les événements de mise en file d’attente pour toutes les intégrations de jobs en arrière-plan, définissez l’option de configuration enable_job_enqueue_instrumentation sur false. Cela n’affecte pas l’instrumentation des jobs eux-mêmes.

Métadonnées

AppSignal collecte les métadonnées suivantes pour les jobs Active Job :

Métadonnée	Description
ID Active Job	L’ID Active Job est signalé par l’adaptateur Active Job.
Arguments	Arguments passés au job lors de l’appel à `perform_later`.
Événements	Tous les événements `*.active_job`.
Nom du job	par exemple `MyBackgroundJob#perform` tel qu’utilisé pour regrouper le job pour les incidents AppSignal.
Priority	La priorité de l’échantillon, si vous utilisez un adaptateur qui prend en charge la priorité des jobs.
Provider job ID	L’ID du job signalé par l’adaptateur Active Job.
Queue	Le nom de la queue de l’échantillon, si vous utilisez un adaptateur qui prend en charge plusieurs queues.
Queue time*	Temps écoulé entre la mise en file d’attente et l’exécution d’un job.

*À partir de la version 6 de Rails, les queue times sont signalés pour le namespace depuis lequel ils sont signalés et peuvent être consultés dans les Performance Graphs d’AppSignal. AppSignal utilise les métadonnées Active Job pour vous donner des informations contextuelles plus approfondies sur les performances des jobs. Lors de l’inspection des échantillons Active Job dans AppSignal :

Le nom du job sera utilisé pour regrouper le job pour les incidents AppSignal :

Exemple d'aperçu des problèmes de performance

Les métadonnées (à l’exclusion du nom du job et des événements) seront disponibles sous forme de tags filtrables sur les échantillons d’incidents :

Les événements *.active_job seront affichés dans la chronologie des événements pour les échantillons de performance :

Intelligence dashboard

Lorsqu’AppSignal reçoit des métriques Active Job, il crée un Intelligence dashboard Active Job, disponible depuis la section dashboard de l’application AppSignal. Le Intelligence dashboard Active Job contiendra les graphiques suivants :

Graphique	Métriques	Tags
Duration per job class	`transaction_duration`	`namespace` `action`
Job status per queue	`active_job_queue_job_count`	`status` `queue`
Job status per queue with priority	`active_job_queue_job_count`	`status` `queue` `priority`
Throughput per job class	`transaction_duration`	`namespace` `action`

Les tags vous offrent une décomposition contextuelle des informations de performance Active Job. AppSignal signale actuellement les tags suivants pour les jobs Active Job :

Nom	Description
`action`	Le nom de l’action depuis laquelle la métrique a été signalée (par ex. : `YourWorker#perform`).
`queue`	Queue nommée dans laquelle les jobs sont traités, par exemple `default` ou `mailer`.
`status`	Statut de chaque job, soit `processed` soit `failed`. Les jobs `failed` sont également comptés comme `processed`.
`priority`	La priorité donnée à chaque job, par exemple `0` ou `1`.

Chaque tag sera représenté par une ligne colorée sur le graphique :

Graphique Duration per job class

Le graphique Duration per job class montre le temps qu’il a fallu aux jobs pour s’exécuter, regroupés par la classe qui définit le job. Vous pouvez utiliser ce graphique pour surveiller les performances des jobs, par classe, en vous offrant une vue d’ensemble des performances des jobs et en vous permettant d’identifier et d’enquêter rapidement sur les pics de durée.

Graphique Job status per queue

Le graphique Job status per queue montre le nombre de jobs qui ont été exécutés, regroupés par leur statut résultant et par la queue dans laquelle ils ont été mis en file d’attente. Vous pouvez utiliser ce graphique pour surveiller le nombre d’erreurs des jobs et leurs performances en fonction de la queue, identifier les goulots d’étranglement et optimiser vos background jobs pour la mise à l’échelle.

Graphique Job status per queue with priority

Tous les adaptateurs Active Job ne prennent pas en charge la priorité des jobs. Si les jobs n’ont pas de valeurs de priorité, le graphique sera vide.

Le graphique Job status per queue with priority montre le nombre de jobs qui ont été exécutés, regroupés par leur statut résultant, par la queue dans laquelle ils ont été mis en file d’attente et par la priorité qui leur a été donnée. Vous pouvez utiliser ce graphique pour surveiller le nombre d’erreurs des jobs et leurs performances en fonction de la queue et de la priorité, identifier les goulots d’étranglement et optimiser vos background jobs pour la mise à l’échelle.

Graphique Throughput per job class

Le graphique Throughput per job class montre le nombre de jobs qui ont été exécutés, regroupés par la classe qui définit le job. Vous pouvez utiliser ce graphique pour surveiller combien de jobs sont exécutés, regroupés par la classe qui définit le job.

SDK & télémétrie

SDK de langage

Outils de télémétrie

Adaptateurs pris en charge

Intégration avec les bibliothèques prises en charge par AppSignal

Signaler les erreurs lors de l’abandon d’un job

Instrumentation de mise en file d’attente

Métadonnées

Intelligence dashboard

Graphique Duration per job class

Graphique Job status per queue

Graphique Job status per queue with priority

Graphique Throughput per job class

​Adaptateurs pris en charge

​Intégration avec les bibliothèques prises en charge par AppSignal

​Signaler les erreurs lors de l’abandon d’un job

​Instrumentation de mise en file d’attente

​Métadonnées

​Intelligence dashboard

​Graphique Duration per job class

​Graphique Job status per queue

​Graphique Job status per queue with priority

​Graphique Throughput per job class

Adaptateurs pris en charge

Intégration avec les bibliothèques prises en charge par AppSignal

Signaler les erreurs lors de l’abandon d’un job

Instrumentation de mise en file d’attente

Métadonnées

Intelligence dashboard

Graphique Duration per job class

Graphique Job status per queue

Graphique Job status per queue with priority

Graphique Throughput per job class