Skip to main content
L’add-on AppSignal pour Heroku configure AppSignal pour votre application Heroku sans configuration manuelle. Lorsque vous l’ajoutez à une application, AppSignal crée un compte, génère une clé Push API et définit cette clé comme config var APPSIGNAL_PUSH_API_KEY de l’application. Votre intégration AppSignal lit automatiquement la clé et commence le reporting. Vous pouvez attacher un même add-on à plusieurs applications Heroku pour qu’elles rapportent au même compte AppSignal. Cela est utile lorsqu’un projet s’étend sur plusieurs applications, comme une application web et un worker en arrière-plan.
L’add-on rapporte les données propres de votre application (erreurs et performance) via votre intégration de langage. Pour également collecter les données de la plateforme Heroku, comme les erreurs de plateforme, les métriques d’hôte et les tableaux de bord automatisés, configurez également un log drain ou telemetry drain.

​
Installer l’add-on

Vous pouvez provisionner l’add-on depuis le tableau de bord Heroku ou la CLI Heroku. L’add-on est répertorié sur le Heroku Elements Marketplace sous le nom AppSignal APM. Pour le provisionner depuis le tableau de bord Heroku :
  1. Ouvrez votre application dans Heroku et sélectionnez Configure Add-ons sous Installed Add-ons sur l’onglet Overview. Cela ouvre l’onglet Resources de l’application.
  2. Dans le champ Add-on Services, recherchez AppSignal APM et sélectionnez-le dans les résultats.
  3. Sélectionnez un plan dans Plan name, puis sélectionnez Submit Order Form.
Heroku provisionne l’add-on, et AppSignal APM apparaît dans la liste des services d’add-ons de l’onglet Resources. Pour le provisionner depuis la CLI Heroku, exécutez :
Bash
Remplacez <PLAN> par le plan souhaité et <YOUR_APP_NAME> par le nom de votre application Heroku. Pour lister les plans disponibles, exécutez heroku addons:plans appsignal. Le provisionnement prend quelques secondes. Une fois terminé, AppSignal :
  • Crée un compte AppSignal pour l’application.
  • Génère une clé Push API et la définit comme config var APPSIGNAL_PUSH_API_KEY de l’application. Vous pouvez la voir sous Config Vars sur l’onglet Settings de l’application.
Vous n’avez pas besoin de définir le nom de l’application ou la clé Push API dans le code de votre application. L’add-on fournit la clé via les variables configurées par Heroku, et votre application apparaît dans AppSignal sous son nom d’application Heroku. Après le provisionnement, votre application peut prendre quelques minutes pour apparaître dans AppSignal. Elle apparaît dès qu’AppSignal reçoit les premières données de votre application.

​
Ouvrir AppSignal depuis Heroku

Provisionner l’add-on crée un compte AppSignal pour votre application. Pour l’ouvrir, sélectionnez le lien AppSignal APM sous Installed Add-ons sur l’onglet Overview de votre application Heroku. Heroku vous connecte à AppSignal via l’authentification unique (SSO), où vous pouvez voir les applications qui rapportent à ce compte, ainsi que leurs erreurs, performance et métriques.
Votre application peut prendre quelques minutes pour rapporter ses premières données après l’ouverture d’AppSignal. Vous n’avez pas besoin de recréer l’application dans AppSignal. Attendez qu’elle apparaisse. Une fois qu’AppSignal reçoit des données, l’assistant d’installation affiche un message de succès confirmant que l’application est prête à l’emploi.
Lorsque votre application traite des requêtes, elle rapporte des données telles que le débit, les temps de réponse et les erreurs, que vous pouvez consulter dans les tableaux de bord. Pour réutiliser le même tableau de bord sur plusieurs applications, importez-le depuis une définition JSON : sélectionnez Add dashboard, collez le JSON du tableau de bord, puis sélectionnez Create dashboard.

​
Surveiller plusieurs applications avec un seul add-on

Attachez l’add-on à une autre application Heroku pour que les deux applications rapportent au même compte AppSignal avec la même clé Push API.
Attacher un add-on existant partage une même clé Push API AppSignal entre plusieurs applications. Ajouter à la place un add-on AppSignal distinct à chaque application créerait un compte et une clé Push API distincts par application, et les applications ne seraient pas liées.
Pour l’attacher depuis le tableau de bord Heroku :
  1. Ouvrez l’application qui possède l’add-on et sélectionnez Configure Add-ons sur son onglet Overview. Cela ouvre l’onglet Resources.
  2. Dans le tableau Add-on Services, trouvez la ligne AppSignal APM. Dans sa colonne Attachments, ouvrez le menu Attached as APPSIGNAL et sélectionnez Manage attachments.
  3. Dans le panneau Add-on Attachments, sélectionnez Attach to another app, puis saisissez le nom de l’application et sélectionnez-la dans les résultats.
Pour l’attacher depuis la CLI Heroku, exécutez :
Bash
Remplacez <APPSIGNAL_ADDON_NAME> par le nom de l’add-on AppSignal existant et <TARGET_APP_NAME> par l’application à laquelle vous voulez l’attacher. Les deux applications partagent désormais la même config var APPSIGNAL_PUSH_API_KEY et rapportent au même compte AppSignal. Les applications restent indépendantes dans Heroku. Par exemple, les deux peuvent être des applications de production. Comme pour l’installation initiale, la seconde application peut prendre quelques minutes pour apparaître dans AppSignal.

​
Comment le compte est nommé

Le compte prend son nom de la première application sur laquelle l’add-on a été provisionné. Les comptes créés par l’add-on fonctionnent différemment des comptes AppSignal classiques, ce nom ne peut donc pas être modifié par la suite. Provisionnez l’add-on sur l’application dont vous voulez que le nom soit utilisé par le compte.

​
Si l’add-on ne semble pas fonctionner

L’add-on définit votre clé Push API comme une config var Heroku, que votre intégration lit comme une variable d’environnement. Si votre application définit également une clé Push API dans son propre code, cette valeur peut remplacer celle de l’add-on, ce qui fait que votre application rapporte à un compte différent.
Si votre application n’apparaît pas sous le compte de l’add-on, vérifiez si votre application définit une clé Push API AppSignal dans le code. En Ruby, par exemple, cela peut se trouver dans un fichier appsignal.rb ou un bloc Appsignal.configure. Supprimez-la pour que votre application utilise la clé de la config var Heroku.
La priorité exacte dépend de l’ordre de chargement de la configuration de votre langage. Pour plus de détails, consultez la documentation sur l’ordre de chargement de votre langage, comme l’ordre de chargement pour Ruby.

​
Supprimer l’add-on

Supprimer l’add-on vous fait perdre l’accès à son compte AppSignal et à ses données. Si vous provisionnez à nouveau l’add-on, AppSignal génère une nouvelle clé Push API et un nouveau compte, et vos données précédentes ne sont pas conservées. Exportez d’abord toutes les données que vous souhaitez conserver.
Vous ne pouvez pas supprimer l’add-on tant que plus d’une application y est attachée. Si vous essayez, Heroku affiche l’erreur « Resource must be detached from all other apps before deprovisioning ». Détachez d’abord les autres applications, puis supprimez l’add-on depuis l’application qui le possède. L’application propriétaire est affichée comme Billed to dans la colonne Plan. Détacher une application ne supprime pas l’add-on ni ses données. Cela arrête seulement le reporting de cette application via l’add-on partagé. Pour le supprimer depuis le tableau de bord Heroku :
  1. Ouvrez une application attachée et sélectionnez Configure Add-ons sur son onglet Overview. Cela ouvre l’onglet Resources.
  2. Dans le tableau Add-on Services, ouvrez le menu des attachments de AppSignal APM dans la colonne Attachments et sélectionnez Manage attachments.
  3. Dans le panneau Add-on Attachments, sélectionnez l’icône de suppression à côté de chaque application sauf l’application propriétaire, et confirmez chacune avec Remove Attachment.
  4. Sur l’onglet Resources de l’application propriétaire, ouvrez le menu Actions de la ligne AppSignal APM et sélectionnez Delete Add-on.
  5. Saisissez le nom de l’application pour confirmer, puis sélectionnez Remove add-on.
Pour le supprimer depuis la CLI Heroku, détachez chaque attachment, puis détruisez l’add-on :
Bash
Remplacez <ATTACHMENT_NAME> par l’attachment à supprimer, <APP_NAME> par l’application à laquelle il appartient, et <APPSIGNAL_ADDON_NAME> par le nom de l’add-on AppSignal.