Aller au contenu principal

Surveiller un composant en 1 minute

Tu travailles avec un composant qui n'est pas à toi : une API que tu appelles, une bibliothèque dont tu dépends. Surveille-le, et Astrolabe te dit tout ce qui lui arrive : un pipeline qui démarre, échoue ou réussit, un quality gate qui passe au rouge ou au vert, un score Compass qui baisse.

Comment faire​

1. Surveille-le depuis le catalogue​

  1. Dans la barre latérale, clique sur Catalogue.
  2. Trouve le composant dans la liste (tape son nom dans Rechercher par nom, au-dessus de la liste).
  3. Sur sa ligne, clique sur Plus d'actions (les trois points), puis sur Surveiller.

Un message confirme : Vous surveillez payment-processor : vous serez prévenu de tout ce qui lui arrive.

Depuis la page du composant

À côté de l'étoile, près du nom du composant, clique sur l'œil Surveiller. Enfoncé, il devient Ne plus surveiller.

2. Retrouve ce que tu surveilles​

  1. En haut à droite, clique sur ton avatar, puis sur Mon compte.
  2. Ouvre l'onglet Notifications.

La carte Composants surveillés les liste. Clique sur un nom pour ouvrir sa page.

3. Reçois les notifications​

Ce qui arrive à un composant surveillé t'arrive dans la cloche, en haut à droite d'Astrolabe. Clique sur une notification : elle ouvre l'onglet du composant qui montre le problème (son onglet CI, SonarQube, Codacy ou Compass), ou la page du composant.

4. Éteins un seul événement​

Tu veux les échecs, pas les réussites ? Garde la surveillance, et éteins cet événement.

  1. Dans Mon compte › Notifications, descends jusqu'à Que voulez-vous recevoir ?.
  2. Dans la section Composants surveillés, ce qui casse vient d'abord. Clique sur Démarrages et réussites pour voir le reste.
  3. Éteins l'événement, par exemple GitHub — When a workflow completes successfully, dans la colonne Dans Astrolabe (la cloche) ou Sur ce navigateur. C'est enregistré tout de suite.

5. Arrête de surveiller​

Dans Mon compte › Notifications › Composants surveillés, clique sur Ne plus surveiller payment-processor à côté de son nom. Ou, sur sa page, clique sur l'œil enfoncé Ne plus surveiller.

✅ C'est tout !

Ce qu'on te dit, et quand​

OutilÉvénementsQuand
GitHub, GitLab, Azure DevOpsPipeline démarré, réussi, échoué, annuléTout de suite avec le webhook de l'outil, sinon en quelques minutes
JenkinsBuild démarré, réussi, échoué, interrompuEn quelques minutes
SonarQubeQuality gate passé au rouge, revenu au vertTout de suite avec le webhook, sinon en quelques minutes
CodacyNote en baisse, note en hausseEn quelques minutes
CompassScore en baisse, score en hausseEn quelques minutes

Un échec est Critique. Un état qui ne bouge pas ne dit rien : un quality gate qui reste rouge n'est signalé qu'une fois.

Le composant doit nommer son projet dans son catalog-info.yaml, pour chaque outil :

metadata:
annotations:
github.com/project-slug: acme/payment-processor
gitlab.com/project-slug: acme/payment-processor
dev.azure.com/project-repo: payments/payment-processor
jenkins.io/job-full-name: payment-processor
sonarqube.org/project-key: acme-payment-processor
codacy.com/project-slug: gh/acme/payment-processor

Compass n'a besoin d'aucune annotation.