Tutoriel NerdGraph : alertes de condition NRQL

Vous pouvez gérer les conditions d'alerte à l'aide de notre API NerdGraph.

Conseil

Consultez l’ introduction de NerdGraph pour obtenir de l’aide sur la mise en route de NerdGraph et de l’explorateur NerdGraph.

Étapes pour créer une condition NRQL

Suivez ces étapes :

Décidez quel type de condition vous souhaitez créer (voir Types de seuil de condition NRQL).
Trouvez votre policyID pertinent en effectuant l'une des opérations suivantes :
- Utilisez l'API des politiques NerdGraph.
- Allez à one.newrelic.com > All capabilities > Alerts > Alert conditions (Policies). Choisissez une politique. Recherchez l’ID sous le nom de la politique.
Fournissez la mutation appropriée pour votre type de condition NRQL et les valeurs pertinentes.

Conseil

L'explorateur NerdGraph GraphiQL est le meilleur endroit pour trouver une documentation à jour sur les spécificités par champ de l'API NerdGraph NRQL Conditions. Par exemple, des questions telles que « Qu'accepte le champ valueFunction ? » trouvent une meilleure réponse dans la documentation NerdGraph en ligne.

Condition statique NRQL

Voici un exemple de création d’une condition statique :

mutation {
  alertsNrqlConditionStaticCreate(
    accountId: YOUR_ACCOUNT_ID
    policyId: YOUR_POLICY_ID
    condition: {
      name: "Low Host Count - Catastrophic"
      enabled: true
      nrql: {
        query: "SELECT uniqueCount(host) FROM Transaction WHERE appName='my-app-name'"
      }
      signal: {
        aggregationWindow: 60
        aggregationMethod: EVENT_FLOW
        aggregationDelay: 120
      }
      terms: {
        threshold: 2
        thresholdOccurrences: AT_LEAST_ONCE
        thresholdDuration: 600
        operator: BELOW
        priority: CRITICAL
      }
      valueFunction: SINGLE_VALUE
      violationTimeLimitSeconds: 86400
    }
  ) {
    id
    name
  }
}

Condition de base de référence NRQL

Voici un exemple de création d'une condition de base de référence :

mutation {
  alertsNrqlConditionBaselineCreate(
    accountId: YOUR_ACCOUNT_ID
    policyId: YOUR_POLICY_ID
    condition: {
      name: "Baseline Condition"
      enabled: true
      baselineDirection: UPPER_ONLY
      nrql: { query: "SELECT average(duration) FROM Transaction" }
      signal: {
        aggregationWindow: 60
        aggregationMethod: EVENT_FLOW
        aggregationDelay: 120
      }
      terms: {
        threshold: 13
        thresholdDuration: 180
        thresholdOccurrences: ALL
        operator: ABOVE
        priority: CRITICAL
      }
      violationTimeLimitSeconds: 86400
    }
  ) {
    id
    name
    baselineDirection
  }
}

Créer une alerte inter-comptes

Voici un exemple de création d’une condition statique :

mutation {
  alertsNrqlConditionStaticCreate(
    accountId: YOUR_ACCOUNT_ID
    policyId: YOUR_POLICY_ID
    condition: {
      name: "Low Host Count - Catastrophic"
      enabled: true
      nrql: {
        query: "SELECT uniqueCount(host) FROM Transaction WHERE appName='my-app-name'"
        dataAccountId: YOUR_DATA_ACCOUNT_ID
      }
      signal: {
        aggregationWindow: 60
        aggregationMethod: EVENT_FLOW
        aggregationDelay: 120
      }
      terms: {
        threshold: 2
        thresholdOccurrences: AT_LEAST_ONCE
        thresholdDuration: 600
        operator: BELOW
        priority: CRITICAL
      }
      violationTimeLimitSeconds: 86400
    }
  ) {
    id
    name
  }
}

Mettre à jour une condition

Complétez les éléments suivants :

Déterminez le type de votre condition existante en demandant le champ type dans une requête nrqlConditionsSearch comme ceci :
```
{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch {
          nrqlConditions {
            id
            type
          }
        }
      }
    }
  }
}
```
Conseil
Le type renvoyé est ce que vous utilisez pour votre mutation de mise à jour. Par exemple, si le type renvoyé est STATIC, utilisez alertsNrqlConditionStaticUpdate. Si le type renvoyé est BASELINE, utilisez alertsNrqlConditionBaselineUpdate.
Fournissez le id de votre condition à votre mutation de type de condition pertinente. Notez que vous ne pouvez mettre à jour que les conditions du type concerné.

Fournissez uniquement des mutations de mise à jour pour les champs que vous souhaitez mettre à jour. Les champs que vous ne fournissez pas dans la mise à jour ne sont pas touchés.

Mettre à jour les mutations

Seuls les champs que vous fournissez dans la mise à jour sont modifiés. Dans l'exemple suivant, baselineDirection renvoie inchangé, mais name est mis à jour.

mutation {
  alertsNrqlConditionBaselineUpdate(
    id: YOUR_CONDITION_ID
    accountId: YOUR_ACCOUNT_ID
    condition: { name: "Your updated name" }
  ) {
    id
    name
    baselineDirection
  }
}

Lister et filtrer les conditions NRQL

Pour répertorier ou filtrer vos conditions NRQL, utilisez la requête nrqlConditionsSearch dans NerdGraph.

La fonctionnalité de base de la liste pour les conditions NRQL vous permet de parcourir vos conditions NRQL ainsi que de demander le nombre total de conditions par compte.

La requête nrqlConditionsSearch utilise la pagination du curseur pour parcourir les ressources. L’idée derrière la pagination du curseur est que le client demandera un curseur dans une boucle programmatique jusqu’à ce que le curseur revienne vide.

Une liste de réponses initiale ressemblera à ceci :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch {
          nextCursor
          nrqlConditions {
            id
            name
            type
          }
          totalCount
        }
      }
    }
  }
}

Cet exemple renvoie une réponse JSON comme celle-ci :

{
  "data": {
    "actor": {
      "account": {
        "alerts": {
          "nrqlConditionsSearch": {
            "nextCursor": "WOwfJ4+TWm9QTFeKMGyg+w==:QqkI8S4+Wwnpno6z+uk8kQ==",
            "nrqlConditions": [
              {
                "id": "4432",
                "name": "Baseline Condition",
                "type": "BASELINE"
              },
              {
                "id": "443",
                "name": "A static condition",
                "type": "STATIC"
              }
              // more conditions here in reality
            ],
            "totalCount": 435
          }
        }
      }
    }
  }
}

Afin de parcourir les conditions dans la réponse, demandez au client de demander que le curseur soit renvoyé jusqu'à ce que le nextCursor revienne de la réponse sous la forme null:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch(
          cursor: "WOwfJ4+TWm9QTFeKMGyg+w==:QqkI8S4+Wwnpno6z+uk8kQ=="
        ) {
          nextCursor
          nrqlConditions {
            id
            name
            type
          }
          totalCount
        }
      }
    }
  }
}

Certains champs ne sont disponibles que sur des types de conditions NRQL spécifiques. La principale raison pour laquelle les mutations sont réparties entre les différents types de conditions est qu’elles présentent des différences mineures entre les champs qu’elles acceptent.

Par exemple, valueFunction n'est pertinent que pour les conditions NRQL statiques et baselineDirection n'est pertinent que pour les conditions NRQL de base de référence.

Mais si ces champs ne sont disponibles que sur ces types de conditions spécifiques, comment les renvoyer dans une liste de tous nos types de conditions ? La réponse est une convention GraphQL connue sous le nom de fragments en ligne. Les fragments en ligne vous permettent d'accéder aux données sur un type spécifique de condition NRQL :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch {
          nrqlConditions {
            id
            name
            type
            ... on AlertsNrqlStaticCondition {
              valueFunction
            }
            ... on AlertsNrqlBaselineCondition {
              baselineDirection
            }
          }
        }
      }
    }
  }
}

Dans l'exemple de requête précédent, nous demandons à GraphQL d'effectuer le travail difficile pour nous afin de déterminer quelles conditions NRQL sont du type correct.

Ainsi, lorsque le type renvoyé est une condition statique, il renverra le valueFunction dans l'objet, et lorsque le type renvoyé est une condition de base de référence, il renverra baselineDirection à la place. Voici un exemple de réponse :

{
  "data": {
    "actor": {
      "account": {
        "alerts": {
          "nrqlConditionsSearch": {
            "nrqlConditions": [
              {
                "baselineDirection": "UPPER_ONLY",
                "id": "342",
                "name": "My baseline condition",
                "type": "BASELINE"
              },
              {
                "id": "553",
                "name": "My static condition",
                "type": "STATIC",
                "valueFunction": "SINGLE_VALUE"
              }
            ]
          }
        }
      }
    }
  }
}

Vous pouvez filtrer les conditions NRQL avec l'argument searchCriteria de la requête nrqlConditionsSearch :

Voici un exemple de filtrage des conditions NRQL avec correspondance par nom. Cette requête renvoie les conditions NRQL qui correspondent au nom fourni. Notez que cette correspondance n'est pas sensible à la casse.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch(searchCriteria: { name: "Baseline Condition" }) {
          nrqlConditions {
            id
            name
            type
          }
        }
      }
    }
  }
}

Requête de condition NRQL singulière

Vous pouvez utiliser l'API de condition NRQL pour interroger une condition singulière. Exécutez la requête nrqlCondition dans l'espace de nommage des alertes.

Similaires aux champs de type spécifiques sur la requête nrqlConditionSearch , vous pouvez également utiliser ces fragments en ligne pour demander des champs limités à un type de condition NRQL.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlCondition(id: YOUR_CONDITION_ID) {
          id
          name
          ... on AlertsNrqlStaticCondition {
            valueFunction
          }
        }
      }
    }
  }
}

Mettre à jour la description

Cela vous guidera tout au long de la procédure de création d’une description pour une condition d’alerte NRQL.

Obtenez toutes les conditions pour une politique :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch(searchCriteria: { policyId: YOUR_POLICY_ID }) {
          nrqlConditions {
            id
            name
            description
            enabled
            nrql {
              query
            }
            signal {
              aggregationWindow
              aggregationMethod
              aggregationDelay
              aggregationTimer
            }
            policyId
            runbookUrl
            terms {
              operator
              thresholdDuration
              threshold
              priority
              thresholdOccurrences
            }
            type
            violationTimeLimitSeconds
          }
        }
      }
    }
  }
}

Obtenez les détails pour une seule condition :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlCondition(id: "YOUR_CONDITION_ID") {
          description
          id
          enabled
          name
          nrql {
            query
          }
          signal {
            aggregationWindow
            aggregationMethod
            aggregationDelay
            aggregationTimer
          }
          policyId
          runbookUrl
          terms {
            operator
            priority
            threshold
            thresholdDuration
            thresholdOccurrences
          }
          type
          violationTimeLimitSeconds
        }
      }
    }
  }
}

Créez une mutation avec la description.

Voici un modèle de mutation vide :

mutation {
  alertsNrqlConditionStaticUpdate(
    accountId: YOUR_ACCOUNT_ID
    id: "YOUR_CONDITION_ID"
    condition: { description: "" }
  ) {
    description
  }
}

Voici un exemple de mutation avec une description d'exemple incluse :

mutation {
  alertsNrqlConditionStaticUpdate(
    accountId: 123456
    id: "123456"
    condition: {
      description: "timestamp : {{timestamp}} \n accountId : {{accountId}} \n type : {{type}} \n event : {{event}} \n description : {{description}} \n policyId : {{policyId}} \n policyName: {{policyName}} \n conditionName : {{conditionName}} \n conditionId : {{conditionId}} \n product : {{product}} \n conditionType : {{conditionType}} \n RunbookUrl : {{runbookUrl}} \n nrqlQuery : {{nrqlQuery}} \n nrqlEventType : {{nrqlEventType}} \n targetID : {{targetId}} \n targetName : {{targetName}} \n commandLine : {{tag.commandLine}} \n entityGuid : {{tag.entityGuid}} \n entityName : {{tag.entityName}} \n fullHostname : {{tag.fullHostname}} \n instanceType : {{tag.instanceType}} \n processDisplayName : {{tag.processDisplayName}}"
    }
  ) {
    description
  }
}

Supprimer les conditions

Vous pouvez utiliser la mutation alertsConditionDelete pour supprimer tout type de condition. Vous ne pouvez demander que le champ id lors d'une mutation de suppression ; par exemple :

mutation {
  alertsConditionDelete(accountId: YOUR_ACCOUNT_ID, id: YOUR_CONDITION_ID) {
    id
  }
}

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : alertes de condition NRQL

Conseil

Étapes pour créer une condition NRQL

Conseil

Condition statique NRQL

Condition de base de référence NRQL

Créer une alerte inter-comptes

Mettre à jour une condition

Conseil

Mettre à jour les mutations

Lister et filtrer les conditions NRQL

Champs spécifiques au type de demande

Filtrer les conditions NRQL

Requête de condition NRQL singulière

Mettre à jour la description

Supprimer les conditions

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : alertes de condition NRQL

Conseil

Étapes pour créer une condition NRQL .css-21sua1{background:none;border:none;width:0;padding:0;}

Conseil

Condition statique NRQL

Condition de base de référence NRQL

Créer une alerte inter-comptes

Mettre à jour une condition

Conseil

Mettre à jour les mutations

Lister et filtrer les conditions NRQL

Champs spécifiques au type de demande

Filtrer les conditions NRQL

Requête de condition NRQL singulière

Mettre à jour la description

Supprimer les conditions

Étapes pour créer une condition NRQL