Désactiver et activer la condition d'alerte à l'aide de l'API

Dans une politique, une condition identifie ce qui déclenche une alerte. Vous pouvez utiliser la REST API pour désactiver et activer des conditions. Vous pouvez également désactiver et activer des conditions dans l'UI.

Les politiques ne peuvent pas être activées ou désactivées, que ce soit via l'API ou l'UI. Les politiques peuvent uniquement être créées, supprimées ou leurs conditions peuvent être modifiées.

Avant d'utiliser l'API REST

L'API REST n'est plus le moyen privilégié pour gérer vos alertes par programmation. Pour plus de contexte, lisez l'introduction aux API pour alertes.

Exigences

La modification de n’importe quel attribut dans une condition à l’aide de l’API nécessite :

• Une clé API et des autorisations pour gérer les alertes
• La condition id (disponible depuis API Explorer : Alerts Conditions > GET > List)
• Si votre organisation héberge des données dans un data center de l'UE, assurez-vous d'utiliser les points de terminaison d'API appropriés pour les comptes de la région de l'UE.

Activer et désactiver une condition

Le processus de désactivation ou d’activation d’une condition est le même processus général de modification de n’importe quel attribut d’une condition. Un exemple plus détaillé vient après cette procédure générale :

1. Recherchez l’ID de la politique qui contient la condition que vous souhaitez modifier.

   Si l'ID de la politique est inconnu, utilisez le nom ou le type de la politique pour faire un appel à l'API et trouver l'ID de la politique. Pour en savoir plus sur ce processus, voir Lister une seule politique.

2. Avec l'ID de politique, faites un appel d'API qui renvoie les conditions associées à cette politique. Il existe quatre catégories de conditions différentes. Si vous ne connaissez pas la catégorie, cela peut nécessiter de faire jusqu'à quatre appels d'API afin de trouver la condition.

   Détails sur la recherche d'un identifiant de condition

   Si vous ne connaissez pas la catégorie de la condition que vous souhaitez modifier, vous devez la rechercher en faisant appel à API en utilisant les quatre catégories de conditions. Voici les différents formats d'appel d'API pour les différentes catégories de conditions.

   • APM, monitoring de navigateursetmonitoring d'applications mobiles\ Conditions disponibles : apm_app_metric, apm_kt_metric, browser_metric et mobile_metric\ API Explorer link Get>List
   • Services externes\ Conditions disponibles : apm_external_service, mobile_external_service\ API Explorer link Get>List
   • Monitoring synthétique\ API Explorer link Get>List

3. Pour le JSON renvoyé, recherchez l’objet JSON de la condition que vous souhaitez modifier.

4. Copiez et collez le JSON de la condition dans un éditeur de texte de votre choix et modifiez le JSON. Pour activer la condition, définissez "enabled" sur true. Pour désactiver la condition, définissez "enabled" sur false.

5. Mettez à jour la condition en soumettant votre JSON modifié via une demande d'API de mise à jour. Nos différents produits nécessitent API requests différentes.

   Détails sur de mise à jour API requests

   Utilisez la requête API de mise à jour qui correspond au produit en question :

   • Conditions pour APM, navigateur et mobile\ Conditions disponibles : apm_app_metric, apm_kt_metric, browser_metric et mobile_metric\ API Explorer PUT>Update link

   • Conditions pour les prestations externes\ Conditions disponibles : apm_external_service, mobile_external_service\ API Explorer PUT>Update

   • Conditions de monitoring synthétique)\ API Explorer PUT>Update

     Conseil

     Une demande d'API de mise à jour ne peut modifier qu'une seule condition à la fois, elle ne peut pas mettre à jour un vecteur d'objets. Par exemple, pour modifier trois conditions, vous devrez faire trois requests distinctes.

Exemple : Désactiver une condition APM

L'exemple suivant montre comment désactiver une condition pour une condition apm_app_metric . À l'exception des types d'appel d'API requis, le processus est similaire au processus de modification d'autres types de conditions.

1. Obtenez le policy_id de la politique que vous souhaitez mettre à jour. Pour une politique imaginaire nommée Logjam Alert, la commande serait :

   bash

   Copier

   $
   curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \
   >
       -H "X-Api-Key:$API_KEY" -i \
   >
       -G --data-urlencode 'filter[name]= Logjam Alert'  # policy_name

   Le résultat de cette requête pourrait ressembler à :

   {
     "policies": [
       {
         "id": 85, // policy_id
         "incident_preference": "PER_POLICY",
         "name": "Logjam Alert",
         "created_at": 1461176510393,
         "updated_at": 1461176510393
       }
     ]
   }

   Copier

2. Énumérez toutes les conditions de cette politique et localisez le condition_id:

   bash

   Copier

   $
   curl -X GET 'https://api.newrelic.com/v2/alerts_conditions.json' \
   >
        -H "X-Api-Key:$API_KEY" -i \
   >
        -G -d 'policy_id=85'

   Le résultat de cette requête pourrait ressembler à :

   {
     "conditions": [
       {
         "id": 12345,               // condition_id
         "type": "apm_app_metric",
         "name": "Apdex (Low)",
         "enabled": true,           // Note the condition is enabled
         "entities": [
           "8288171"
         ],
         "metric": "apdex",
         "terms": [
           {
             "duration": "5",
             "operator": "below",
             "priority": "critical",
             "threshold": "1",
             "time_function": "any"
           }
         ]
       },
       {
         "id": 2468,                // another condition_id
         "type": "apm_app_metric",
         "name": "Throughput (Low)",
         ...
       }
     ]
   }

   Copier

3. Copiez le JSON uniquement pour la condition en question et collez-le dans un éditeur de texte. Remplacez "enabled": true par "enabled": false. Le JSON édité ressemblerait à :

   bash

   Copier

   $
   curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/12345.json' \
   >
        -H "X-Api-Key:$API_KEY" -i \
   >
        -H 'Content-Type: application/json' \
   >
        -d \
   >
   '{
   $
     "condition": {
   $
       "type": "apm_app_metric",
   $
       "name": "Apdex (Low)",
   $
       "enabled": false,
   $
       "entities": [
   $
         "8288171"
   $
       ],
   $
       "metric": "apdex",
   $
       "terms": [
   $
         {
   $
           "duration": "5",
   $
           "operator": "below",
   $
           "priority": "critical",
   $
           "threshold": "1",
   $
           "time_function": "any"
   $
         }
   $
       ]
   $
     }
   $
   }'

4. Mettez à jour la condition en soumettant la condition JSON modifiée via une demande d'API de mise à jour. Pour cette condition spécifique, vous devez suivre les étapes décrites dans Mettre à jour les conditions pour les politiques APM. D'autres conditions de produit nécessiteraient d'autres API requests, comme détaillé dans Mettre à API requests jour .