Tutorial NerdGraph: alerta de condição NRQL

Você pode gerenciar a condição do alerta usando nossa API NerdGraph.

Dica

Consulte a introdução do NerdGraph para obter ajuda para começar a usar o NerdGraph e o NerdGraph Explorer.

Etapas para criar uma condição NRQL

Siga esses passos:

Decida qual tipo de condição você deseja criar (consulte Tipos de limite de condição NRQL).
Encontre seu policyID relevante seguindo um destes procedimentos:
- Use a API de políticas do NerdGraph.
- Vá para
  one.newrelic.com > All capabilities > Alerts > Alert conditions (Policies)
  . Escolha uma política. Encontre o ID abaixo do nome da política.
Forneça a mutação apropriada para o seu tipo de condição NRQL e os valores relevantes.

Dica

O NerdGraph GraphiQL Explorer é o melhor lugar para encontrar documentação atualizada sobre as especificações por campo da API NerdGraph NRQL Conditions. Por exemplo, perguntas como "O que o campo valueFunction aceita?" são melhor respondidas com a documentação embutida do NerdGraph.

Condição estática NRQL

Aqui está um exemplo de criação de uma condição estática:

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
  }
}

NRQL baseline Condição

Aqui está um exemplo de criação de uma condição baseline :

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
  }
}

Atualizar uma condição

Complete o seguinte:

Determine o tipo da sua condição existente solicitando o campo type em uma consulta nrqlConditionsSearch como esta:
```
{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch {
          nrqlConditions {
            id
            type
          }
        }
      }
    }
  }
}
```
Dica
O type retornado é o que você usa para sua mutação de atualização. Por exemplo, se o tipo retornado for STATIC, use alertsNrqlConditionStaticUpdate. Se o tipo retornado for BASELINE, use alertsNrqlConditionBaselineUpdate.
Forneça o id da sua condição para a mutação do tipo de condição relevante. Observe que você só pode atualizar condições do tipo relevante.

Forneça mutações de atualização apenas para os campos que você deseja atualizar. Os campos que você não fornece na atualização não são alterados.

Atualizar mutações

Somente os campos fornecidos na atualização serão alterados. No exemplo a seguir, baselineDirection retorna inalterado, mas name é atualizado.

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

Listar e filtrar condições NRQL

Para listar ou filtrar suas condições NRQL, use a consulta nrqlConditionsSearch no NerdGraph.

A funcionalidade básica de lista para condições NRQL permite paginar suas condições NRQL, bem como solicitar a contagem total de condições por conta.

A consulta nrqlConditionsSearch utiliza paginação de cursor para paginar recursos. A ideia por trás da paginação do cursor é que o cliente solicite um cursor em um loop programático até que o cursor volte vazio.

Uma resposta de lista inicial será semelhante a esta:

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

Este exemplo retorna uma resposta JSON como esta:

{
  "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
          }
        }
      }
    }
  }
}

Para paginar as condições na resposta, faça com que o cliente solicite que o cursor seja retornado até que nextCursor retorne da resposta como null:

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

Determinados campos estão disponíveis apenas em tipos de condição NRQL específicos. A principal razão pela qual as mutações são divididas entre os diferentes tipos de condição é porque elas apresentam pequenas diferenças entre os campos que aceitam.

Por exemplo, valueFunction só é relevante para condições estáticas de NRQL e baselineDirection só é relevante em condições baseline de NRQL.

Mas se esses campos estão disponíveis apenas para determinados tipos de condição, como podemos retorná-los em uma lista de todos os nossos tipos de condição? A resposta é uma convenção GraphQL conhecida como fragmentos embutidos. Os fragmentos embutidos permitem acessar os dados em um tipo específico de condição NRQL:

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

No exemplo de consulta anterior, pedimos ao GraphQL que faça o trabalho árduo para determinar quais condições NRQL são do tipo correto.

Portanto, quando o tipo retornado for uma condição estática, ele retornará valueFunction no objeto e, quando o tipo retornado for uma condição baseline , retornará baselineDirection. Aqui está um exemplo de resposta:

{
  "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"
              }
            ]
          }
        }
      }
    }
  }
}

Você pode filtrar condições NRQL com o argumento searchCriteria da consulta nrqlConditionsSearch :

Aqui está um exemplo de filtragem de condições NRQL com correspondência por nome. Esta consulta retorna condições NRQL que correspondem ao nome fornecido. Observe que esta correspondência não diferencia maiúsculas de minúsculas.

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

Consulta de condição NRQL singular

Você pode usar a API de condição NRQL para consultar uma condição única. Execute a consulta nrqlCondition no namespace alerta.

Semelhante aos campos específicos de tipo na consulta nrqlConditionSearch , você também pode usar esses fragmentos embutidos para solicitar campos restritos a um tipo de condição NRQL.

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

Atualize a descrição

Isso orientará você no procedimento para criar uma descrição para uma condição de alerta NRQL.

Obtenha todas as condições de uma apólice:

{
  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
          }
        }
      }
    }
  }
}

Obtenha os detalhes de uma única condição:

{
  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
        }
      }
    }
  }
}

Crie uma mutação com a descrição.

Aqui está um modelo de mutação vazio:

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

Aqui está um exemplo de mutação com uma descrição de exemplo incluída:

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
  }
}

Excluir condições

Você pode usar a mutação alertsConditionDelete para excluir qualquer tipo de condição. Você só pode solicitar o campo id em uma mutação de exclusão; por exemplo:

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

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: alerta de condição NRQL

Dica

Etapas para criar uma condição NRQL

Dica

Condição estática NRQL

NRQL baseline Condição

Atualizar uma condição

Dica

Atualizar mutações

Listar e filtrar condições NRQL

Solicitar campos específicos do tipo

Filtrar condições NRQL

Consulta de condição NRQL singular

Atualize a descrição

Excluir condições

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: alerta de condição NRQL

Dica

Etapas para criar uma condição NRQL .css-21sua1{background:none;border:none;width:0;padding:0;}

Dica

Condição estática NRQL

NRQL baseline Condição

Atualizar uma condição

Dica

Atualizar mutações

Listar e filtrar condições NRQL

Solicitar campos específicos do tipo

Filtrar condições NRQL

Consulta de condição NRQL singular

Atualize a descrição

Excluir condições

Etapas para criar uma condição NRQL