Passer au contenu principal
Une fois l’intégration GitHub d’AppSignal installée, qu’AppSignal a reçu l’autorisation de lire et d’écrire des tickets dans vos dépôts GitHub et que votre application AppSignal est connectée au dépôt souhaité, vous pouvez convertir les incidents AppSignal en tickets GitHub. Vous pouvez aussi lier des tickets et des pull requests qui existent déjà, et suivre leur statut depuis l’incident.

Créer un ticket GitHub à partir d’un incident

Ouvrez le namespace pertinent de votre application AppSignal, sélectionnez Errors dans la navigation latérale, puis Issue list. Ouvrez l’incident d’erreur que vous voulez envoyer à GitHub. Sur l’onglet Summary de l’incident, sélectionnez Send to GitHub dans le panneau Actions. Page de résumé d'un incident d'erreur avec l'action Send to GitHub dans le panneau Actions Cela ouvre un écran qui vous permet de créer un ticket GitHub. AppSignal remplit le titre et la description pour vous. La description comprend un lien vers l’incident AppSignal, le message d’erreur et, le cas échéant, jusqu’aux 10 dernières lignes du backtrace. Vous pouvez modifier le titre et la description, mais nous recommandons de conserver le lien vers l’incident et le backtrace. Écran de création de ticket GitHub avec un titre et une description préremplis Sélectionnez Create GitHub issue pour créer le ticket dans le dépôt GitHub auquel le namespace de votre application est connecté. Le nouveau ticket apparaît dans le panneau Actions, et le journal de l’incident enregistre Sent the issue to GitHub. Si AppSignal ne peut pas créer le ticket, l’écran de création vous en indique la raison. Soit votre application n’est pas encore liée à un dépôt GitHub, soit l’app GitHub d’AppSignal n’a pas la permission Issues (écriture) ou n’a pas accès au dépôt. Pour corriger l’un ou l’autre, consultez Lier AppSignal au dépôt GitHub de votre application. Vous pouvez modifier le dépôt auquel les namespaces de votre application AppSignal sont connectés depuis la page de paramètres de votre application AppSignal. Vous pouvez également gérer les droits d’accès d’AppSignal dans les paramètres de votre intégration GitHub. Souvent, le correctif est déjà en cours : quelqu’un a ouvert une pull request, ou le bug a un ticket GitHub. Ajoutez son lien dans une note, et AppSignal le suit pour vous. L’incident indique où en est le correctif, et personne n’a besoin de demander s’il a été livré. Ouvrez l’onglet Summary de l’incident, rédigez une note dans la zone Logbook avec l’URL du ticket GitHub, puis sélectionnez Post note. AppSignal reconnaît deux formes de référence n’importe où dans la note :
  • Une URL complète, comme https://github.com/acme/shop/issues/123 ou https://github.com/acme/shop/pull/456.
  • La forme abrégée acme/shop#123.
AppSignal ne lie que les références vers des dépôts de l’organisation GitHub, ou du compte utilisateur, qui possède le dépôt lié. Une application liée à acme/shop lie aussi les références vers acme/shop-api, mais ignore les références vers d’autres organisations. Un ticket déjà lié n’est pas lié une seconde fois : modifier la note ne crée donc pas de doublons. Le journal enregistre Linked #123 on GitHub, le numéro renvoyant vers le ticket. Le ticket apparaît aussi dans le panneau Actions avec son statut. Résumé d'un incident avec une note contenant l'URL d'un ticket GitHub, l'entrée de journal Linked #6 on GitHub et l'action View #6 in GitHub avec un badge Open Le serveur MCP d’AppSignal lie les tickets de la même manière lorsqu’un agent IA rédige une note sur un incident. Pour lier un incident depuis GitHub :
  1. Copiez l’URL de l’incident depuis AppSignal.
  2. Collez-la dans la description d’un ticket ou d’une pull request GitHub, précédée d’un mot. Par exemple : Fixes <incident URL>.
  3. Créez le ticket ou la pull request, ou enregistrez votre modification.
Le ticket ou la pull request apparaît alors dans le panneau Actions et le journal de l’incident. Les majuscules et un deux-points après le mot, comme Fixes:, fonctionnent aussi.
Le journal d'un incident dans AppSignal avec deux entrées ajoutées depuis GitHub : un ticket référencé et un ticket lié, chacun avec un badge github, au-dessus d'un lien antérieur ajouté depuis une note

Tickets liés et référencés depuis GitHub, dans le journal de l'incident.

Bon à savoir :
  • Le ticket ou la pull request doit se trouver dans un dépôt de la même organisation GitHub, ou du même compte utilisateur, que le dépôt connecté à votre application.
  • Retirer l’URL de la description ne supprime pas le lien de l’incident.
  • Le journal indique qui a ajouté le lien sur GitHub.
  • Les mêmes mots fonctionnent dans les notes sur l’incident. Par exemple, See acme/shop#123 référence le ticket.

Suivre les tickets liés depuis l’incident

Le panneau Actions affiche un bouton pour chaque ticket et pull request lié, intitulé View #123 in GitHub. Les boutons apparaissent dans l’ordre où les tickets ont été liés. Survolez un bouton pour voir quand le ticket a été lié ou référencé. Sélectionnez-le pour ouvrir le ticket sur GitHub, ou pour recréer le ticket. La recréation supprime le lien et rouvre l’écran de création. Chaque bouton affiche le statut du ticket sous forme de badge : Open, Closed ou, pour les pull requests, Merged ou Live. AppSignal lit le statut lorsque vous liez un ticket. Il met à jour le statut lorsque le ticket ou la pull request est fermé, rouvert ou fusionné sur GitHub. Chaque changement de statut apparaît aussi dans le journal de l’incident, par exemple Changed the status of #123 on GitHub from open → merged. L’entrée indique qui a effectué le changement sur GitHub. Si cette personne est membre de votre application AppSignal et a lié son compte GitHub, l’entrée affiche son nom AppSignal. Les mises à jour de statut nécessitent les permissions Issues et Pull requests de l’app GitHub d’AppSignal. Lorsqu’AppSignal les demande, un propriétaire de votre organisation GitHub doit approuver les nouvelles permissions sur GitHub. Sans elles, la liaison fonctionne toujours, mais les tickets liés n’affichent pas de badge de statut.

Voir quand une pull request liée est déployée

Dès qu’un deploy livre une pull request liée, son badge passe de Merged à Live. Survolez le bouton pour voir la révision du deploy et sa date, par exemple Deployed in 9175503 2 minutes ago. Le journal enregistre le changement sous la forme Changed the status of #20 on GitHub from merged → deployed, effectué par AppSignal.
L'onglet Summary d'un incident dans AppSignal. Le journal montre qu'AppSignal a changé le statut de #20 sur GitHub de merged à deployed. Dans le panneau Actions, View #20 in GitHub a un badge Live, et une infobulle indique Deployed in 9175503 2 minutes ago

Une pull request liée affiche Live dès qu'un deploy la livre.

Lorsqu’AppSignal crée un marqueur de déploiement pour un nouveau deploy, il demande à GitHub quels commits ont été ajoutés depuis le deploy précédent dans le même namespace. Si une pull request liée a été fusionnée dans l’un de ces commits, elle passe à Live. Pour qu’une pull request affiche Live, il vous faut :
  1. Un lien, pas une référence. Placez un mot de liaison, comme Fixes, ou aucun mot devant le lien, sur GitHub ou dans une note sur l’incident. Une pull request référencée, comme See acme/shop#123, reste Merged.
  2. Votre application liée au dépôt de la pull request. Consultez Lier AppSignal au dépôt GitHub de votre application.
  3. Un marqueur de déploiement pour chaque deploy, avec une révision que GitHub connaît : un SHA de commit, un tag ou un nom de branche. Consultez Choisir une valeur de révision.
  4. Les permissions Contents, Issues et Pull requests de l’app GitHub d’AppSignal. Lorsqu’AppSignal demande de nouvelles permissions, un propriétaire de votre organisation GitHub doit les approuver sur GitHub.
AppSignal ne suit pas :
  • Une pull request que vous liez après le deploy qui l’a livrée.
  • Un deploy de plus de 1 000 commits.
  • Une révision que GitHub ne connaît pas, comme un numéro de build, ou 1.2.3 lorsque le tag est v1.2.3.
  • Les rollbacks. Une pull request reste Live après que vous avez annulé le deploy qui l’a livrée.
  • Le commit exact d’un deploy de branche. Si la révision est un nom de branche, AppSignal utilise le dernier commit de la branche au moment de la vérification. Ce commit peut être plus récent que celui que vous avez déployé.
  • Le même deploy deux fois. Si un deploy a un marqueur de déploiement dans plusieurs namespaces, la pull request ne passe à Live qu’une seule fois.
  • Un deploy que GitHub ne peut pas comparer. Si GitHub renvoie une erreur, la pull request reste Merged, et AppSignal n’affiche pas l’erreur.
  • Une entrée de journal en échec. Si son enregistrement échoue après le passage de la pull request à Live, AppSignal ne réessaie pas.

Fermer l’incident lorsque son correctif est déployé

Cette fonctionnalité est en bêta, dans le cadre d’AppSignal Labs. Demandez au support de l’activer pour votre organisation.
Pour qu’AppSignal ferme un incident lorsque son correctif est livré :
  1. Dans la description de la pull request sur GitHub, écrivez Fixes <incident URL>. Vous pouvez aussi publier l’URL de la pull request dans une note sur l’incident.
  2. Fusionnez la pull request.
  3. Déployez-la. AppSignal doit voir le deploy, pour que la pull request passe à Live.
AppSignal ferme alors l’incident. Le journal enregistre le passage à Closed avec un badge deploy, et nomme la pull request. Bon à savoir :
  • L’incident doit être ouvert. Son état doit être Open ou Work in progress.
  • Liez la pull request, ne la référencez pas. Collez l’URL de l’incident dans la description de la pull request, ou l’URL de la pull request dans une note sur l’incident. Placez Fixes, ou aucun mot, devant l’URL. Un mot comme See devant l’URL ne fait que la référencer, et une référence ne ferme jamais l’incident.
  • AppSignal attend chaque pull request fusionnée. Si l’incident en a plusieurs, AppSignal le ferme dès que la dernière est Live. Les tickets liés, et les pull requests qui ne sont pas encore fusionnées, ne le maintiennent pas ouvert.
  • Les erreurs de l’ancien code ne le rouvrent pas. Pendant le déploiement progressif d’un deploy, les hôtes qui exécutent encore un deploy plus ancien peuvent signaler l’erreur. Ces erreurs comptent pour l’incident, mais ne le rouvrent pas et n’envoient pas de notifications. Une erreur du nouveau deploy, ou d’un deploy ultérieur, le rouvre comme d’habitude.
  • Vos changements passent en premier. Si vous rouvrez l’incident, déployer à nouveau la même révision ne le ferme pas. Dès que l’état de l’incident change à nouveau, les erreurs des deploys plus anciens peuvent le rouvrir, comme n’importe quelle autre erreur.
L’incident devient le seul endroit où vérifier l’état d’un correctif : quels tickets et pull requests lui appartiennent, et si chacun est ouvert, fusionné, fermé ou live. Pour passer d’une ligne de backtrace au code livré, configurez ensuite les liens de backtrace.
🛟 Si vous rencontrez des difficultés à créer des tickets GitHub à partir d’incidents AppSignal, n’hésitez pas à nous contacter et nous vous aiderons.