Configura alertas de tráfico

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Usa una alerta de tráfico para informar una notificación cuando el tráfico de un entorno, proxy o región cambia según un porcentaje especificado durante un intervalo de tiempo.

Debes establecer el intervalo de tiempo en:

  • 1 hora
  • 1 día
  • 7 días
  • 15 días (solo API)
  • 30 días (solo API)

La alerta funciona comparando el tráfico del intervalo de tiempo actual con el del intervalo de tiempo anterior. Por ejemplo, puedes especificar un intervalo de tiempo de una hora. Luego, la alerta compara el tráfico de la hora más reciente en relación con el tráfico de la hora anterior para calcular el cambio porcentual en el tráfico:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Un valor positivo significa que el tráfico aumentó y un valor negativo significa que el tráfico disminuyó.

Luego, debes establecer el umbral que activa una alerta de tráfico como un porcentaje de aumento o disminución en el tráfico de la API. durante el período especificado.

Antes de establecer ese porcentaje, asegúrate de que concuerde con tu los patrones de tráfico. Por ejemplo, si el tráfico de tu API normalmente fluctúa durante el día con aumentos repentinos de tráfico por hora de hasta el 100% en ciertos momentos de mucha actividad, estos aumentos son normales y no deberían activar una alerta. Sin embargo, si configura una alerta para que se active con un aumento del 50% en el tráfico por hora recibirás alertas innecesarias sobre tu tráfico normal.

Para obtener más información sobre las alertas, consulta Configura alertas y notificaciones.

Agrega alertas y notificaciones de tráfico

Para agregar alertas y notificaciones de tráfico, haz lo siguiente:
  1. Haz clic en Analizar > Reglas de alerta en la IU de Edge.
  2. Haz clic en +Alerta.
  3. Ingresa la siguiente información general sobre la alerta:
    Campo Descripción
    Nombre de la alerta Nombre de la alerta. Usa un nombre que describa el activador y que sea significativo para ti. El nombre no puede superar los 128 caracteres.
    Descripción Descripción de la alerta.
    Tipo de alerta Selecciona Tráfico total. Consulta Acerca de los tipos de alertas para obtener más información.
    Entorno Selecciona el entorno de la lista desplegable.
    Estado Activa o desactiva la habilitación de la política.
  4. Define el umbral y la dimensión para la condición que activará la alerta.
    Campo de condición Descripción
    Umbral

    Especifica que se genere la alerta cuando el tráfico aumente un o disminuyó en un porcentaje específico en comparación con un intervalo de tiempo anterior.

    Establece el porcentaje de Increase by en un valor superior o igual a 0%. Establecer el porcentaje de disminuido en un valor superior o igual a 0% e inferior o igual al 100%.

    Puedes elegir un intervalo de tiempo:

    • 1 hora
    • 1 día
    • 1 semana
    Dimensión

    Haz clic en + Agregar dimensión (+Add Dimension) y especifica los detalles de la dimensión para la que se mostrarán resultados, incluidos los siguientes: el proxy de API y la región.

    Establecer una dimensión específica de la siguiente manera:

    • Proxy: establece un proxy específico o en Todos los proxies. Proxy no admite un valor de "Any". En cambio, puede agregar una alerta diferente para cada proxy que le interese.
    • Región: Se establece en una región específica o en Todas las regiones. Region no admite un valor de "Any". En cambio, puedes agregar una alerta diferente para cada región que te interese.
  5. Haz clic en + Notificación para agregar una notificación de alerta.
    Detalles de la notificación Descripción
    Canal Selecciona el canal de notificaciones que quieres usar y especifica el destino: Email, Slack, PagerDuty o Webhook.
    Destino Especifica el destino según el tipo de canal seleccionado:
    • Correo electrónico: Dirección de correo electrónico (por ejemplo, joe@company.com)
    • Slack: URL del canal de Slack, como https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty: código de PagerDuty, como abcd1234efgh56789
    • Webhook: URL de webhook, como https://apigee.com/test-webhook

      Nota: Solo puedes especificar un destino por notificación. Si quieres especificar varios destinos para el mismo tipo de canal, agrega notificaciones adicionales.
  6. Para agregar notificaciones adicionales, repite el paso anterior.
  7. Si agregaste una notificación, configura los siguientes campos:
    Campo Descripción
    Guía (Opcional) Campo de texto en formato libre para proporcionar una descripción breve de las acciones recomendadas para y resuelve las alertas cuando se activan. También puedes especificar un enlace a tu wiki interna o en la página de la Comunidad, en la que puedes consultar las prácticas recomendadas. La información de este campo se incluido en la notificación. El contenido de este campo no puede superar los 1,500 caracteres.
    Throttle La frecuencia con la que se envían las notificaciones. Selecciona un valor de la lista desplegable.
  8. Haz clic en Guardar.

Ver alertas en el panel Eventos

Cuando Edge detecta una condición de alerta, la registra automáticamente en la Panel Events en la IU de Edge. La lista de eventos que se muestra en el panel Eventos incluye todas las alertas, tanto fijas como certificadas.

Para ver una alerta, sigue estos pasos:

  1. Haz clic en Analizar > Eventos en la IU de Edge. Aparecerá el nuevo panel Eventos:

  2. Filtra el panel Eventos por:

    • Entorno
    • Región
    • Período
  3. Selecciona una fila en el panel Eventos para mostrar el almacén de claves que contiene el certificado que caducará para investigar la alerta en más detalle. En la página Almacén de claves, puedes subir un certificado nuevo y borrar el certificado por vencer.

Usa las APIs de alerta con alertas de tráfico

La mayoría de las APIs que usas para crear y administrar alertas de tráfico son las mismas que usas. con otros tipos de alerta:

Sin embargo, algunas API tienen propiedades adicionales que se usan para admitir alertas de anomalía, como las siguientes:

Crea o actualiza una alerta de tráfico

Usa las mismas APIs para crear o actualizar una alerta de tráfico, como lo hace actualmente con otros tipos de alertas. El cuerpo de la llamada a la API para crear o actualizar una alerta de tráfico es el mismo que se usa para otras alertas, con los siguientes cambios:

  • Agrega las siguientes propiedades nuevas para especificar que se trata de una alerta de tráfico:

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    Los valores predeterminados de estas propiedades son los siguientes:

    "alertType": "runtime"
"alertSubType": "fixed"
  • En el elemento dimensions del array conditions:
    • Debes establecer los valores de org, env, proxy y y region. Solo se admiten esas propiedades. Puedes establecer proxy y region en ALL.
    • Debes establecer el valor de la propiedad traffic como total.

  • En el arreglo conditions, sucede lo siguiente:

    • La propiedad metrics debe tener el valor trafficChange.
    • La propiedad comparator se debe configurar como increasedBy o decreasedBy.
    • La propiedad threshold contiene un valor positivo que especifica un porcentaje de aumento o disminución del tráfico en el que un valor de 1.0 corresponde al 100%. Para increasedBy, el valor debe ser mayor o igual que 0.0 (0%). Para decreasedBy, el valor debe ser mayor o igual que 0.0 (0%) y menor o igual que 1.0 (100%).
    • La propiedad durationSeconds se debe establecer en uno de los siguientes valores: 3600 (1 hora), 86400 (1 día), 604800 (7 días), 1296000 (15 días), 2592000 (30 días) .
  • La propiedad reportEnabled no es compatible con las alertas de tráfico.
En el siguiente ejemplo, se muestra cómo configurar una alerta que se activa cuando el tráfico de una organización y un entorno aumentan en un 50% en un período de una hora. Se envía una notificación al código de PagerDuty especificado cuando se activa la alerta. 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de cURL usadas en este ejemplo, consulta Cómo usar cURL.

Consulta Ver eventos para obtener más información sobre el uso de esta API.

Recibe alertas de tráfico

De forma predeterminada, la API de Obtener alertas muestra información sobre todas las alertas definidas. Esta API ahora toma parámetros de búsqueda que te permiten filtrar los resultados:

  • enabled: Si true especifica que solo se muestran alertas habilitadas. El valor predeterminado es false.
  • alertType: Especifica el tipo de alerta que se mostrará. Los valores permitidos son runtime, el predeterminado y cert.
  • alertSubType: Especifica el subtipo de alerta que se mostrará. El valor predeterminado no está establecido, lo que significa que se mostrarán todos los subtipos de alerta.

Por ejemplo, usa la siguiente llamada a la API para que muestre solo las alertas de la organización llamada myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

La siguiente llamada muestra solo alertas de tráfico, tanto habilitadas como inhabilitadas:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de cURL usadas en este ejemplo, consulta Cómo usar cURL.