Tutorial de NerdGraph: alerta de condición NRQL

Puede administrar la condición de alerta utilizando nuestra API NerdGraph.

Sugerencia

Consulte la introducción a NerdGraph para obtener ayuda para comenzar con NerdGraph y el explorador NerdGraph.

Pasos para crear una condición NRQL

Sigue estos pasos:

Decida qué tipo de condición desea crear (consulte Tipos de umbral de condición NRQL).
Encuentre su policyID relevante realizando una de las siguientes acciones:
- Utilice la API de políticas de NerdGraph.
- Vaya a
  one.newrelic.com > All capabilities > Alerts & AI > Alert conditions (Policies)
  . Elija una póliza. Busque la identificación debajo del nombre de la póliza.
Proporcione la mutación adecuada para su tipo de condición NRQL y los valores relevantes.

Sugerencia

El explorador NerdGraph GraphiQL es el mejor lugar para encontrar documentación actualizada sobre las especificaciones por campo de la API de condiciones NerdGraph NRQL. Por ejemplo, preguntas como "¿Qué acepta el campo valueFunction ?" se responden mejor con la documentación en línea de NerdGraph.

Condición estática de NRQL

A continuación se muestra un ejemplo de cómo crear una condición 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
  }
}

Condición de línea base NRQL

A continuación se muestra un ejemplo de cómo crear una condición de línea de base:

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

Actualizar una condición

Complete lo siguiente:

Determine el tipo de su condición existente solicitando el campo de tipo en una consulta nrqlConditionsSearch como esta:
```
{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      alerts {
        nrqlConditionsSearch {
          nrqlConditions {
            id
            type
          }
        }
      }
    }
  }
}
```
Sugerencia
El type devuelto es lo que usa para su mutación de actualización. Por ejemplo, si el tipo devuelto es STATIC, utilice alertsNrqlConditionStaticUpdate. Si el tipo devuelto es BASELINE, utilice alertsNrqlConditionBaselineUpdate.
Proporcione el id de su condición a la mutación del tipo de condición relevante. Tenga en cuenta que solo puede actualizar condiciones del tipo relevante.

Proporcione únicamente mutaciones de actualización para los campos que desea actualizar. Los campos que no proporcione en la actualización no se modifican.

Actualizar mutaciones

Solo se cambian los campos que usted proporciona en la actualización. En el siguiente ejemplo, baselineDirection devuelve sin cambios, pero name está actualizado.

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

Listar y filtrar condiciones NRQL

Para enumerar o filtrar sus condiciones NRQL, utilice la consulta nrqlConditionsSearch en NerdGraph.

La funcionalidad básica de lista para condiciones NRQL le permite paginar sus condiciones NRQL, así como solicitar el recuento total de condiciones por cuenta.

La consulta nrqlConditionsSearch utiliza la paginación del cursor para paginar los recursos. La idea detrás de la paginación del cursor es que el cliente solicitará un cursor en un bucle programático hasta que el cursor vuelva a estar vacío.

Una respuesta de lista inicial se verá así:

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

Este ejemplo devuelve una respuesta 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 las condiciones en la respuesta, haga que el cliente solicite que se devuelva el cursor hasta que nextCursor regrese de la respuesta como null:

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

Ciertos campos solo están disponibles en tipos de condiciones NRQL específicos. La razón principal por la que las mutaciones se dividen entre los diferentes tipos de condiciones es porque tienen diferencias menores entre los campos que aceptan.

Por ejemplo, valueFunction solo es relevante para condiciones NRQL estáticas y baselineDirection solo es relevante para condiciones NRQL en línea de base.

Pero si estos campos solo están disponibles en ciertos tipos de condiciones, ¿cómo los devolvemos en una lista de todos nuestros tipos de condiciones? La respuesta es una convención GraphQL conocida como fragmentos en línea. Los fragmentos en línea le permiten acceder a los datos sobre un tipo específico de condición NRQL:

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

En la consulta de ejemplo anterior, le pedimos a GraphQL que haga el trabajo duro por nosotros para determinar qué condiciones NRQL son del tipo correcto.

Entonces, cuando el tipo devuelto es una condición estática, devolverá el valueFunction en el objeto, y cuando el tipo devuelto es una condición de línea de base, devolverá baselineDirection en su lugar. Aquí hay un ejemplo de respuesta:

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

Puede filtrar las condiciones NRQL con el argumento searchCriteria de la consulta nrqlConditionsSearch :

A continuación se muestra un ejemplo de cómo filtrar condiciones NRQL con coincidencias por nombre. Esta consulta devuelve condiciones NRQL que coinciden con el nombre proporcionado. Tenga en cuenta que esta coincidencia no distingue entre mayúsculas y minúsculas.

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

Consulta de condición NRQL singular

Puede utilizar la API de condición NRQL para consultar una condición singular. Ejecute la consulta nrqlCondition en el namespace de alerta.

De manera similar a escribir campos específicos en la consulta nrqlConditionSearch , también puede usar estos fragmentos en línea para solicitar campos que están restringidos a un tipo de condición NRQL.

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

Actualiza la descripción

Esto le guiará por el procedimiento para crear una descripción para una condición de alerta NRQL.

Obtenga todas las condiciones para una póliza:

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

Obtenga los detalles de una sola condición:

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

Crea una mutación con la descripción.

Aquí hay una plantilla de mutación vacía:

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

Aquí hay un ejemplo de mutación con una descripción de ejemplo incluida:

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

Eliminar condiciones

Puede utilizar la mutación alertsConditionDelete para eliminar cualquier tipo de condición. Solo puede solicitar el campo id en una mutación de eliminación; Por ejemplo:

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

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial de NerdGraph: alerta de condición NRQL

Sugerencia

Pasos para crear una condición NRQL

Sugerencia

Condición estática de NRQL

Condición de línea base NRQL

Actualizar una condición

Sugerencia

Actualizar mutaciones

Listar y filtrar condiciones NRQL

Solicitar campos específicos del tipo

Filtrar condiciones NRQL

Consulta de condición NRQL singular

Actualiza la descripción

Eliminar condiciones

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial de NerdGraph: alerta de condición NRQL

Sugerencia

Pasos para crear una condición NRQL .css-21sua1{background:none;border:none;width:0;padding:0;}

Sugerencia

Condición estática de NRQL

Condición de línea base NRQL

Actualizar una condición

Sugerencia

Actualizar mutaciones

Listar y filtrar condiciones NRQL

Solicitar campos específicos del tipo

Filtrar condiciones NRQL

Consulta de condición NRQL singular

Actualiza la descripción

Eliminar condiciones

Pasos para crear una condición NRQL