Configura alertas de tráfico

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Usa una alerta de tráfico para generar una notificación cuando el tráfico de un entorno, un proxy o una región cambie en un porcentaje específico durante un período.

Establece el intervalo de tiempo de la siguiente manera:

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

La alerta funciona comparando el tráfico del período actual con el del período anterior. Por ejemplo, especificas un intervalo de tiempo de una hora. Luego, la alerta compara el tráfico de la hora más reciente con el 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 disminuyó.

Luego, estableces el umbral que activa una alerta de tráfico como un aumento o una disminución porcentual del tráfico de la API para el período especificado.

Antes de establecer ese porcentaje, asegúrate de que se alinee con tus patrones de tráfico normales. Por ejemplo, si tu tráfico de la API suele fluctuar durante el día con picos de tráfico por hora de hasta el 100% en ciertos horarios pico, estos picos son normales y no deberían activar una alerta. Sin embargo, si luego configuras una alerta para que se active ante cualquier 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 en la lista desplegable.
    Estado Activa o desactiva la habilitación de la política.
  4. Define el límite y la dimensión de la condición que activará la alerta.
    Campo de condición Descripción
    Umbral

    Especifica que se genere la alerta cuando el tráfico haya aumentado en o disminuido en un porcentaje específico en comparación con un intervalo anterior.

    Establece el porcentaje de aumento en un valor mayor o igual que el 0%. Establece el porcentaje de disminución en un valor mayor o igual que el 0% y menor o igual que el 100%.

    Puedes elegir un intervalo de tiempo de:

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

    Haz clic en +Agregar dimensión y especifica los detalles de la dimensión para los que se muestran los resultados, incluido el proxy de API y la región.

    Establece una dimensión específica en:

    • Proxy: Se puede establecer en un proxy específico o en Todos los proxies. Proxy no admite el valor "Any". En su lugar, puedes agregar una alerta independiente para cada proxy que te interese.
    • Región: Se puede establecer en una región específica o en Todas las regiones. Region no admite el valor "Any". En cambio, puedes agregar una alerta separada 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 deseas usar y especifica el destino: correo electrónico, Slack, PagerDuty o webhook.
    Destino Especifica el destino según el tipo de canal seleccionado:
    • Correo electrónico: Dirección de correo electrónico, como 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. Para 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 de formato libre para proporcionar una breve descripción de las acciones recomendadas para resolver las alertas cuando se activan. También puedes especificar un vínculo a tu wiki interno o a la página de la comunidad en la que haces referencia a las prácticas recomendadas. La información de este campo se incluirá en la notificación. El contenido de este campo no puede superar los 1,500 caracteres.
    Throttle Frecuencia con la que se envían las notificaciones. Selecciona un valor de la lista desplegable.
  8. Haz clic en Guardar.

Cómo ver alertas en el panel Eventos

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

Para ver una alerta, sigue estos pasos:

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

  2. Filtra el panel de Eventos de la siguiente manera:

    • 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 está por vencer y, así, investigar más la alerta. En la página Keystore, puedes subir un certificado nuevo y borrar el certificado que vence.

Usa las APIs de alertas con las 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 alertas:

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 haces actualmente para 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 la alerta es 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, se muestra lo siguiente:
    • Debes establecer los valores de las propiedades org, env, proxy 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 debe establecerse en increasedBy o decreasedBy.
    • La propiedad threshold contiene un valor positivo que especifica un aumento o una disminución porcentual en el tráfico, donde un valor de 1.0 corresponde al 100%. Para increasedBy, el valor debe ser mayor o igual que 0.0 (0%). En el caso de decreasedBy, el valor debe ser mayor o igual que 0.0 (0%) y menor o igual que 1.0 (100%).
    • La propiedad durationSeconds debe establecerse 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 aumenta en un 50% durante 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 más información sobre las opciones cURL que se usaron en este ejemplo, consulta Usa cURL.

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

Cómo recibir alertas de tráfico

Según la configuración predeterminada, la API de Get Alerts 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 valor predeterminado, y cert.
  • alertSubType: Especifica el subtipo de alerta que se mostrará. El valor predeterminado no está configurado, lo que significa que se muestran todos los subtipos de alerta.

Por ejemplo, usa la siguiente llamada a la API para mostrar solo las alertas habilitadas para la organización llamada myorg:

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

En la siguiente llamada, solo se muestran 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 más información sobre las opciones cURL que se usaron en este ejemplo, consulta Usa cURL.