Application Real-Time Monitoring Service:Intégrer les alertes Grafana

Étape 1 : Créer une intégration Grafana

1. Connectez-vous à la console ARMS. Dans le volet de navigation de gauche, sélectionnez Alert Management > Integrations.

2. Sous l'onglet Alert Integration, cliquez sur Grafana.

3. Dans la boîte de dialogue New Grafana Integration, saisissez un nom et une description pour l'intégration, sélectionnez la version de Grafana, définissez le délai d'expiration pour la résolution automatique des événements d'alerte, puis cliquez sur Save.

   Remarque

   Délai de récupération automatique après expiration : si un événement d'alerte n'est pas déclenché à nouveau dans le délai spécifié, il est automatiquement résolu.

4. Sous l'onglet Alert Integration, localisez la nouvelle intégration Grafana et récupérez son endpoint d'intégration.

   Cliquez sur le bouton Copy situé à côté de l'endpoint d'intégration.

Étape 2 : Configurer les alertes Grafana

1. Dans le volet de navigation de gauche de Grafana, sélectionnez > Notification Channels.

2. Sous l'onglet Notification Channels, cliquez sur New channel.

   Remarque

   Si vous créez un canal pour la première fois, cliquez sur Add channel.

3. Sur la page New Notification Channel, effectuez les opérations suivantes.

   1. Saisissez un nom personnalisé pour l'alerte Grafana dans le champ Name.

   2. Définissez le paramètre Type sur webhook.

   3. Définissez le paramètre URL sur l'endpoint d'intégration obtenu à l'étape 1.

   4. Dans la section Notification settings, cochez les options Default, Include image et Send reminders. Si vous activez l'option Send reminders, définissez la fréquence de rapport pour la même alerte. Cette fréquence ne doit pas dépasser le délai d'expiration de résolution automatique configuré à l'étape 1.

      Remarque

      Si vous ne cochez pas l'option Send reminders, le système envoie une seule notification pour chaque alerte.

   5. Cliquez sur Test pour vérifier la connexion à la gestion des alertes ARMS.

   6. Une fois le test réussi, cliquez sur Save.

(Facultatif) Étape 3 : Modifier l'intégration

La gestion des alertes ARMS propose des mappages de champs par défaut entre Grafana et ARMS. Vous pouvez également ajouter ou modifier ces mappages selon vos besoins sur la page Edit Integration.

Le script suivant fournit un exemple de source d'alerte :

{
    "@timestamp":"2021-09-09T12:25:09.556Z",
    "orgId":0,
    "host":"10.1.11.14",
    "ruleName":"Test notification",
    "ruleUrl":"http://localhost:8001/grafana/",
    "state":"alerting",
    "title":"[Alerting] Test notification",
    "panelId":1,
    "imageUrl":"https://grafana.com/assets/img/blog/mixed_styles.png",
    "evalMatches":[
        {
            "metric":"High value",
            "value":100,
            "tags":null
        },
        {
            "metric":"Higher Value",
            "value":200,
            "tags":null
        }
    ],
    "ruleId":0,
    "tags":{
    },
    "dashboardId":1,
    "message":"Someone is testing the alert notification within grafana.",
    "@version":"1"
}

1. Sous l'onglet Alert Integration, localisez l'intégration à gérer et cliquez sur Edit dans la colonne Actions.

2. Dans la section Event Mapping, cliquez sur Send Test Data.

3. Dans la boîte de dialogue Send Test Data, saisissez le contenu JSON de votre source d'alerte, puis cliquez sur Send.

   Remarque

   • Si le message Uploaded. No events are generated. Configure mappings based on the original data. s'affiche, cela signifie que les champs de la source d'alerte ne sont pas mappés aux champs des événements d'alerte ARMS. Les données envoyées s'affichent dans la zone de gauche. Cela vous permet de sélectionner les champs source lors de la configuration des mappages.

   • Si le message Uploaded. s'affiche, le contenu de l'alerte est transmis à la page Alert Event History. Pour plus d'informations, consultez la rubrique View alert event history.

   La zone de texte de la boîte de dialogue Send Test Data contient des exemples de données de notification au format JSON, avec des champs tels que @timestamp, orgId, host, ruleName, ruleUrl, state, title et panelId. Vous pouvez cliquer sur Copy as cURL command pour obtenir la requête correspondante.

4. Dans la boîte de dialogue Send Test Data, cliquez sur Disable.

5. Dans la partie gauche de la section Event Mapping, cliquez sur les enregistrements de données pour lesquels vous souhaitez configurer des mappages afin d'en afficher les détails.

6. Dans le volet droit de la section Event Mapping, configurez les mappages entre les champs de la source d'alerte et les champs d'alerte ARMS.

   1. Facultatif : Dans la section Select Root Node, indiquez si vous souhaitez utiliser le traitement par lot.

      Si les données d'alerte contiennent un tableau, vous pouvez spécifier ce tableau comme nœud racine pour traiter ses éléments par lot.

      Après avoir sélectionné l'option Use Batch Processing, choisissez le nœud de tableau à traiter comme nœud racine.

      Remarque

      Vous ne pouvez sélectionner qu'un seul tableau pour le traitement par lot.

      Par exemple, dans l'alerte d'exemple, le tableau evalMatches contient deux champs value. Si vous sélectionnez evalMatches comme nœud racine, ARMS mappe les deux champs value situés dessous vers le même champ d'alerte ARMS spécifié.

      • Si vous sélectionnez un nœud racine, vous pouvez mapper de manière itérative les valeurs de l'attribut $.evalMatches[*].value pour tous les éléments du tableau vers le champ ARMS value.

      • Si vous ne sélectionnez pas de nœud racine, vous pouvez mapper la valeur d'attribut d'un élément spécifique du tableau, tel que $.evalMatches[0].value ou $.evalMatches[1].value, vers le champ ARMS value.

   2. Dans la section Map Source Fields to Target Fields, mappez les champs source vers les champs d'alerte ARMS cibles.

      Cliquez sur l'icône de mappage pour modifier la méthode de mappage.

      • Direct : Le champ source est directement mappé vers le champ d'alerte ARMS correspondant.

      • Series : Concatène plusieurs champs source en un seul champ à l'aide d'un séparateur spécifié, puis mappe ce champ vers un champ d'alerte ARMS. Vous ne pouvez utiliser que des caractères spéciaux comme séparateurs.

        Par exemple, vous pouvez utiliser un trait de soulignement (_) pour concaténer les champs $.host et $.title en $.host_$.title, puis mapper le résultat vers le champ ARMS alertname.

      • Condition : Un champ n'est mappé que si la valeur du champ d'alerte remplit une condition spécifiée.

      • Mapping table : Configure le mappage entre les niveaux de gravité de la source d'alerte et ceux d'ARMS. Cette méthode de mappage est requise uniquement pour le champ severity.

      Le tableau suivant décrit les champs d'alerte d'ARMS.

      |
      **Champ d'alerte**
      |
      **Description**
      | | --- | --- | |
      alertname
      |
      Nom de l'alerte personnalisée.
      | |
      severity
      |
      Niveau de gravité de l'alerte. Vous devez configurer des mappages pour ce champ. La méthode de mappage doit être définie sur Direct.
      | |
      message
      |
      Description de l'alerte. Elle sert de contenu au message d'alerte. La description ne peut pas dépasser 15 000 caractères.
      | |
      value
      |
      Valeur d'exemple d'une métrique.
      | |
      imageUrl
      |
      URL du graphique linéaire contenant les métriques Grafana. L'URL est utilisée pour mapper le graphique linéaire.
      | |
      check
      |
      Élément vérifié par l'alerte. Exemples : CPU, JVM, Application Crash et Deployment.
      | |
      source
      |
      Source de l'alerte.
      | |
      class
      |
      Type d'objet qui déclenche l'événement d'alerte, par exemple host.
      | |
      service
      |
      Service source de l'alerte. Exemple : Login Service.
      | |
      startat
      |
      Horodatage représentant l'heure de début de l'événement.
      | |
      endat
      |
      Horodatage représentant l'heure de fin de l'événement.
      | |
      generatorUrl
      |
      URL des détails de l'événement.
      |

      Sur la page Event Mapping, cliquez sur Send Test Data pour vérifier l'ingestion des données. La section Latest 10 Data Entries affiche les données source reçues et leur statut. Développez une entrée de données pour afficher sa structure JSON, qui inclut des champs tels que @timestamp, orgId, host et ruleName. Dans le volet droit, vous pouvez mapper ces champs source vers les champs d'alerte ARMS correspondants.

      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      

7. Configurez la déduplication des champs pour les événements d'alerte.

   Pour réduire les données en double, le système utilise des champs connexes comme critères de déduplication. La gestion des alertes ARMS vous permet de prévisualiser les résultats de regroupement par déduplication des données d'événements historiques dans la zone Event Mapping. Vous pouvez ajuster les champs de déduplication selon vos besoins.

   Remarque

   La déduplication des événements s'applique uniquement aux événements non résolus.

   1. Dans la section Event Deduplication de la page Edit Integration, sélectionnez les champs à utiliser pour la déduplication.

      Lorsque plusieurs événements présentent les mêmes valeurs pour les champs sélectionnés, ils sont fusionnés en une seule alerte.

      Par exemple, si vous définissez les champs ARMS metric et ruleName comme clé de déduplication, les événements provenant de la source Grafana ayant la même métrique et le même nom de règle sont fusionnés en un seul événement. Les événements avec des valeurs différentes restent distincts.

   2. Cliquez sur Deduplication Test pour prévisualiser les regroupements d'alertes après déduplication.

      Remarque

      Le test de déduplication s'exécute sur les 10 dernières entrées de données de test téléchargées dans le volet gauche de la section Event Mapping.

      Sélectionnez metric et ruleName comme champs de déduplication, puis cliquez sur Deduplication Test. Le système regroupe les événements en fonction des champs sélectionnés. Les événements partageant la même métrique et le même nom de règle sont groupés ensemble. Les résultats du regroupement s'affichent dans un tableau comprenant des colonnes telles que alertname, value, severity, startat, endat et message.

8. Une fois la configuration terminée, cliquez sur Save.

Afficher les détails d'un événement d'alerte

1. Dans le volet de navigation de gauche de la console ARMS, sélectionnez Alert Management > Alert Event History.

2. Sur la page Alert Event History, cliquez sur le nom de l'événement d'alerte pour afficher ses détails. Pour plus d'informations, consultez la rubrique View alert event history.

Gérer l'intégration

Dans le volet de navigation de gauche, sélectionnez Alert Management > Integrations. Sous l'onglet Alert Integration, vous pouvez effectuer les opérations suivantes sur les intégrations que vous avez créées :

• Afficher les détails d'une intégration : Localisez l'intégration, puis cliquez sur la ligne correspondante. Sur la page Integration Details, consultez les détails de l'intégration.

• Mettre à jour la clé : Pour modifier la clé d'une intégration, localisez l'intégration, sélectionnez More > Update Key dans la colonne Actions, puis cliquez sur Confirm dans la boîte de dialogue qui s'affiche.

  Important

  Après la mise à jour de la clé, vous devez également mettre à jour l'URL configurée à l'étape 2 avec le nouvel endpoint d'intégration.

• Modifier une intégration : Localisez l'intégration, puis cliquez sur Edit dans la colonne Actions. Sur la page Integration Details, modifiez les informations d'intégration, puis cliquez sur Save.

• Activer ou désactiver une intégration : Localisez l'intégration, puis cliquez sur Disable ou Enable dans la colonne Actions.

• Supprimer une intégration : Localisez l'intégration, puis cliquez sur Delete dans la colonne Actions. Dans le message qui s'affiche, cliquez sur OK.

• Ajouter un flux de traitement des événements à une intégration : Localisez l'intégration et cliquez sur Add Event Processing Flow dans la colonne Actions. Pour plus d'informations, consultez la rubrique Event processing flow.

• Créer une politique de notification : Localisez l'intégration pour laquelle vous souhaitez créer une politique de notification, puis cliquez sur More dans la colonne Actions. Dans la liste qui s'affiche, cliquez sur Create Notification Policy. Pour plus d'informations, consultez la rubrique Notification policies.

Étapes suivantes

Une fois la politique de notification créée, le système génère des alertes et envoie des notifications d'alerte pour les événements signalés, conformément à la politique configurée. Pour plus d'informations, consultez la rubrique Notification policies. Sur la page Alert Sending History, vous pouvez consulter les alertes générées en fonction de la politique de notification configurée. Pour plus d'informations, consultez la rubrique View alert sending history.