Créer un modèle de monitor pour l'intégration
Section Overview
Ce guide présente les étapes de création d’un modèle de monitor ainsi que les bonnes pratiques à suivre pendant le processus.
Les monitors Datadog permettent de suivre les métriques clés afin de surveiller efficacement votre infrastructure et vos intégrations. Datadog fournit un ensemble de monitors prêts à l’emploi pour de nombreuses fonctionnalités et intégrations. Consultez ces monitors dans votre liste de modèles de monitors.
Créez un monitor prêt à l’emploi pour aider les utilisateurs à tirer parti de votre intégration Datadog. Pour créer une intégration Datadog, consultez la section Créer une intégration.
Créer un monitor
Dans votre sandbox Datadog, créez un monitor.
Suivez les bonnes pratiques décrites dans ce guide pour configurer correctement votre monitor.
Importer votre monitor
Dans votre intégration, sur la plateforme de développement d’intégrations, accédez à l’onglet Content. À partir de là, sélectionnez import monitor pour choisir parmi les monitors disponibles. Vous pouvez en inclure jusqu’à 10 avec votre intégration.
Vérifier votre monitor en production
Pour afficher le monitor prêt à l’emploi :
- Recherchez la règle de détection dans la liste des modèles de monitors et cliquez dessus pour l’ouvrir.
- Vérifiez que les logos s’affichent correctement.
- Assurez-vous que le monitor est bien activé.
Recherchez votre monitor dans la liste de modèles de monitors. Vérifiez que les logos s’affichent correctement sur la page de cette liste.
Bonnes pratiques de configuration
Outre la définition du monitor, les champs Title, Description et Tags doivent obligatoirement être renseignés. Attribuez le tag « integration:<app_id> ». D’autres tags de monitors sont disponibles ici. Pour plus d’informations, consultez la documentation sur la configuration d’un monitor.
Titre
Le titre permet aux utilisateurs de comprendre rapidement le mode de défaillance couvert par l’alerte.
- Utilisez la voix active et commencez par un objet suivi d’un verbe.
- N’utilisez pas de template variables.
| À revoir | Amélioré | Optimal |
|---|
| Un grand nombre de messages non accusés détecté sur {{host.name}} | Un grand nombre de messages non accusés détecté | Le nombre de messages non accusés est supérieur à la normale |
Rôle
Ajoutez du contexte sur le mode de défaillance et son impact possible sur le système. L’objectif est de permettre à l’utilisateur de déterminer rapidement s’il est pertinent de créer un monitor à partir de ce modèle.
- Ce champ ne doit pas reprendre le titre à l’identique.
- Expliquez précisément le problème mentionné dans le titre.
- Justifiez pourquoi ce comportement doit faire l’objet d’une alerte.
- Décrivez les effets potentiels de cette défaillance.
| À revoir | Amélioré | Optimal |
|---|
| Alertez votre équipe si le nombre de messages non accusés est élevé. | Les messages non accusés sont ceux qui ont été remis à un consommateur mais n’ont pas été confirmés comme traités. Ce monitor suit le ratio de ces messages. | Les messages non accusés sont ceux qui ont été remis à un consommateur mais pas confirmés comme traités. Ce monitor suit leur ratio pour anticiper les goulots d’étranglement pouvant entraîner des retards dans le traitement des messages. |
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles:
