Afficher l'onglet Monitoring sur un composant
Chaque composant annoté reçoit un onglet Monitoring : les alertes Grafana qui le concernent et les panneaux de son tableau de bord Grafana, dessinés par Astrolabe.
Deux étapes : allumer le plugin, annoter le composant.
Ce que l'onglet affiche, et pour qui
En haut, quatre boutons de période : 1 h, 6 h, 24 h et 7 j. 24 h est choisi quand tu ouvres l'onglet.
Sous Alertes, un tableau avec une ligne par règle d'alerte :
| Colonne | Quoi |
|---|---|
| État | L'état de la règle |
| Règle | Le nom de la règle |
| Gravité | Sa gravité |
| Résumé | Son résumé |
Dessous, les panneaux du tableau de bord nommé par le composant.
Toute personne qui peut ouvrir le composant voit l'onglet. Astrolabe lit Grafana avec le jeton de l'intégration, le même pour tout le monde.
1. 🔌 Allumer le plugin
-
Dans Administration, sous PLATEFORME, clique sur Plugins.
-
Sur la carte Grafana, allume l'interrupteur en haut à droite.
Si la carte dit Nécessite la licence Premium, l'interrupteur est grisé : Grafana fait partie de la licence Premium. Clique sur la ligne, ajoute une licence qui le couvre, puis reviens à cette étape.
Si la carte dit Configurez d'abord l'intégration Grafana, clique dessus : l'intégration s'ouvre dans Connexions de l'entreprise. Ajoute-la (Ajouter l'intégration Grafana). Le plugin s'allume tout seul quand tu enregistres l'intégration : passe à l'étape 2.
La carte n'a pas de réglages : Grafana se saisit une seule fois, dans l'intégration.
2. 🏷️ Annoter le composant
Dans le fichier catalog-info.yaml du composant, ajoute l'une de ces annotations, ou les deux. Une seule
suffit pour afficher l'onglet.
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: shop-api
annotations:
grafana/dashboard: shop-api-overview
grafana/alert-label-selector: service=shop-api
spec:
type: service
lifecycle: production
owner: team-a
| Annotation | Quoi écrire | Exemple |
|---|---|---|
grafana/dashboard | L'UID du tableau de bord : dans Grafana, la partie après /d/ dans son adresse | shop-api-overview |
grafana/alert-label-selector | Une étiquette de tes règles d'alerte, sous la forme nom=valeur | service=shop-api |
grafana/panels | Facultatif. Les identifiants des panneaux à dessiner, séparés par des virgules. Sans elle, tous les panneaux sont dessinés | 2,4 |
grafana/variables | Facultatif. Les valeurs des variables du tableau de bord, sous la forme nom=valeur, séparées par des virgules | env=prod |
Le dessin des panneaux n'a pas été vérifié sur une instance.
✅ Vérifier
Ouvre le composant dans Catalogue. Un onglet Monitoring est dans la barre d'onglets, à côté de Vue d'ensemble. Clique dessus : le tableau des alertes et les boutons de période sont là.
✅ C'est tout !
Quelque chose ne va pas ? Voir Problèmes courants avec Grafana.