Deshabilitar y habilitar condición de alerta usando la API

En una política, una condición identifica qué desencadena una alerta. Puede utilizar la API REST para deshabilitar y habilitar condiciones. También puede deshabilitar y habilitar condiciones en la UI.

Las políticas no se pueden habilitar ni deshabilitar, ya sea a través de la API o la UI. Las políticas sólo se pueden crear, eliminar o cambiar sus condiciones.

Antes de usar la API REST

La API REST ya no es la forma preferida de administrar su alerta mediante programación. Para obtener más contexto, lea la Introducción a las API de alertasy la inteligencia aplicada.

Requisitos

Modificar cualquier atributo en una condición usando la API requiere:

• Una clave de API y permisos para gestionar alerta

• La condición es id (disponible en API Explorer:

  Alerts Conditions > GET > List

  )

• Si su organización aloja datos en el centro de datos de la UE, asegúrese de utilizar los extremos de API adecuados para las cuentas de la región de la UE.

Activar y desactivar una condición

El proceso para deshabilitar o habilitar una condición es el mismo proceso general para cambiar cualquier atributo en una condición. Un ejemplo más detallado viene después de este procedimiento general:

1. Busque el ID de la póliza que contiene la condición que desea cambiar.

   Si se desconoce el ID de la política, utilice el nombre o tipo de la política para realizar una llamada API y encontrar el ID de la política. Para obtener más información sobre este proceso, consulte Listar una única política.

2. Con el ID de la política, realice una llamada API que devuelva las condiciones asociadas con esa política. Hay cuatro categorías de condiciones diferentes. Si no conoce la categoría, es posible que sea necesario realizar hasta cuatro API de llamadas para encontrar la condición.

   Detalles sobre la búsqueda de ID de condición

   Si no conoce la categoría de la condición que desea cambiar, debe buscarla realizando una llamada API utilizando las cuatro categorías de condición. Estos son los diferentes formatos de API de llamada para las distintas categorías de condiciones.

   • APM

     ,

     monitoreo de browser

     y

     monitoreo de aplicaciones móviles

     Condiciones disponibles: apm_app_metric, apm_kt_metric, browser_metric y mobile_metric
     API Explorer link Get>List

   • Servicios externos
     Condiciones disponibles: apm_external_service, mobile_external_service
     API Explorer link Get>List

   • monitoreo sintetico
     API Explorer link Get>List

3. Para el JSON devuelto, busque el objeto JSON de la condición que desea cambiar.

4. Copie y pegue el JSON de la condición en un editor de texto de su elección y edite el JSON. Para habilitar la condición, establezca "enabled" en true. Para deshabilitar la condición, establezca "enabled" en false.

5. Actualice la condición enviando su JSON editado mediante una solicitud de Actualización de API. Nuestros diferentes productos requieren diferentes solicitudes de API.

   Detalles sobre las solicitudes de actualización de API

   Utilice la solicitud de Actualización de API que corresponda al producto en cuestión:

   • Condiciones para APM, browser y móvil
     Condiciones disponibles: apm_app_metric, apm_kt_metric, browser_metric y mobile_metric
     API Explorer PUT>Update link

   • Condiciones para servicios externos.
     Condiciones disponibles: apm_external_service, mobile_external_service
     API Explorer PUT>Update link

   • Condiciones para el monitoreo sintético)
     API Explorer PUT>Update link

     Sugerencia

     Una solicitud de Actualización de API solo puede cambiar una condición a la vez, no puede actualizar un vector de objetos. Por ejemplo, para cambiar tres condiciones, deberá realizar tres solicitudes por separado.

Ejemplo: deshabilitar una condición APM

El siguiente ejemplo muestra cómo deshabilitar una condición para una condición apm_app_metric . Con la excepción de los tipos de API de llamada requeridos, el proceso es similar al proceso para cambiar otros tipos de condiciones.

1. Obtenga el policy_id de la política que desea actualizar. Para una política imaginaria denominada Logjam Alert, el comando sería:

   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}

   Copia

   El resultado de esta solicitud podría verse así:

   {
     "policies": [
       {
         "id": 85,      <---<<<  $POLICY_ID
         "incident_preference": "PER_POLICY",
         "name": "Logjam Alert",
         "created_at": 1461176510393,
         "updated_at": 1461176510393
       }
     ]
   }

   Copia

2. Enumere todas las condiciones de esta política y localice el {condition_id}:

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

   Copia

   El resultado de esta solicitud podría verse así:

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

   Copia

3. Copie el JSON solo para la condición en cuestión y péguelo en un editor de texto. Cambie "enabled": true a "enabled": false. El JSON editado se vería así:

   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,       <---<<<  Changed to false
       "entities": [
         "8288171"
       ],
       "metric": "apdex",
       "terms": [
         {
           "duration": "5",
           "operator": "below",
           "priority": "critical",
           "threshold": "1",
           "time_function": "any"
         }
       ]
     }
   }'

   Copia

4. Actualice la condición enviando el JSON de condición editado mediante una solicitud de Actualización de API. Para esta condición específica, debe seguir los pasos en Actualizar condiciones para políticas de APM. Otras condiciones del producto tendrían otras solicitudes de API, como se detalla en Actualizar solicitudes de API.