Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
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 en un intervalo de tiempo.
Establece el intervalo de tiempo de la siguiente manera:
- 1 hora
- 1 día
- 7 días
- 15 días (solo API)
- 30 días (solo API)
La alerta compara el tráfico del intervalo de tiempo actual con el del intervalo de tiempo anterior. Por ejemplo, si especificas un intervalo de tiempo de una hora. Luego, la alerta compara el tráfico de la hora más reciente 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ó, mientras que uno negativo significa que disminuyó.
Luego, configura el umbral que activa una alerta de tráfico como un aumento o una disminución del porcentaje en el 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 el tráfico de tu API suele fluctuar durante el día con aumentos de tráfico por hora de hasta el 100% en determinados horarios pico, estos aumentos son normales y no deberían activar una alerta. Sin embargo, si luego configuras una alerta para que se active cuando se produzca un aumento del 50% en el tráfico por hora, recibirás alertas innecesarias para el tráfico normal.
Para obtener más información sobre las alertas, consulta Configura alertas y notificaciones.
Agrega alertas de tráfico y notificaciones
Para agregar alertas de tráfico y notificaciones, sigue estos pasos:- Haz clic en Analizar > Reglas de alerta en la IU de Edge.
- Haz clic en +Alerta.
- 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 opción para habilitar o inhabilitar la alerta. - Define el umbral y la dimensión de la condición que activará la alerta.
Campo Condición Descripción Umbral Especifica que se genere la alerta cuando el tráfico aumente en o disminuya en un porcentaje específico en comparación con un intervalo de tiempo anterior.
Establezca el porcentaje aumentado por en un valor mayor o igual que 0%. Establece disminuido por el porcentaje a un valor mayor o igual que 0%, e inferior o igual al 100%.
Puedes elegir uno de los siguientes intervalos de tiempo:
- 1 hora
- 1 día
- 1 semana
Dimensión Haz clic en +Agregar dimensión y especifica los detalles de la dimensión para mostrar resultados, incluidos el proxy de API y la región.
Establece una dimensión específica de la siguiente manera:
- Proxy: Establece esta opción como un proxy específico o 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: Establece una región específica o como Todas las regiones. Región no admite el valor “Cualquiera”. En su lugar, puedes agregar una alerta independiente para cada región que te interese.
- 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, 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. Si quieres especificar varios destinos para el mismo tipo de canal, agrega notificaciones adicionales.
- Correo electrónico: dirección de correo electrónico, como
- Para agregar notificaciones adicionales, repite el paso anterior.
- Si agregaste una notificación, configura los siguientes campos:
Campo Descripción Playbook (Opcional) Campo de texto de formato libre que proporciona una descripción breve de las acciones recomendadas para resolver las alertas cuando se activan. También puedes especificar un vínculo a tu wiki o página de la comunidad interna donde puedes consultar 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. Limitar La frecuencia con la que se envían notificaciones. Selecciona un valor de la lista desplegable. - Haz clic en Guardar.
Ver alertas en el panel Eventos
Cuando Edge detecta una condición de alerta, la registra de forma automática en el panel Events en la IU de Edge. En la lista de eventos que se muestra en el panel de eventos, se incluyen todas las alertas, tanto fijas como certificadas.
Para ver una alerta, sigue estos pasos:
Haz clic en Analyze > Events en la IU de Edge. Aparecerá el nuevo panel de Eventos:
Filtra el panel de eventos por:
- Entorno
- Región
- Período
- Selecciona una fila en el panel Event para mostrar el almacén de claves que contiene el certificado por vencer y, así, investigar la alerta en profundidad. En la página del Almacén de claves, puedes subir un certificado nuevo y borrar el que vence.
Usa las APIs de alertas 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 alertas:
- Recibe una alerta: Obtén una definición de alerta fija o de anomalía.
- Obtener historial de alertas: Obtén métricas del historial de alertas.
- Borrar una alerta: Borra una definición de alerta corregida o de anomalía.
- Obtener instancia de alerta: Obtén información sobre una alerta activada.
- Obtener la cantidad de alertas: Obtén el recuento total de alertas.
Sin embargo, algunas API tienen propiedades adicionales que se usan para admitir alertas de anomalía, como las siguientes:
- Recibir alertas: Enumera todas las alertas, incluidas las fijas y de anomalías.
- Crear una alerta: Crea una alerta fija o de anomalía.
- Actualizar una alerta: Actualiza una definición de alerta corregida o de anomalía.
Crea o actualiza una alerta de tráfico
Usa las mismas APIs para crear o actualizar una alerta de tráfico que usas 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 en 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 arrayconditions
, haz lo siguiente:- Debes configurar los valores de las propiedades
org
,env
,proxy
yregion
. Solo se admiten esas propiedades. Puedes establecerproxy
yregion
enALL
. - Debes establecer el valor de la propiedad
traffic
comototal
.
- Debes configurar los valores de las propiedades
En el arreglo
conditions
, sucede lo siguiente:- La propiedad
metrics
debe tener el valor detrafficChange
. - La propiedad
comparator
debe establecerse comoincreasedBy
odecreasedBy
. - La propiedad
threshold
contiene un valor positivo que especifica un porcentaje de aumento o disminución del tráfico, donde un valor de1.0
corresponde al 100%. ParaincreasedBy
, el valor debe ser mayor o igual que 0.0 (0%). ParadecreasedBy
, el valor debe ser mayor o igual que 0.0 (0%) e 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) o2592000
(30 días) .
- La propiedad
- La propiedad
reportEnabled
no es compatible con las alertas de tráfico.
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 que se usan en este ejemplo, consulta Usa cURL.
Consulta Visualiza eventos para obtener más información sobre el uso de esta API.
Recibe 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
: Sitrue
especifica que solo se muestran alertas habilitadas. El valor predeterminado esfalse
.alertType
: Especifica el tipo de alerta que se mostrará. Los valores permitidos sonruntime
, el predeterminado ycert
.alertSubType
: Especifica el subtipo de alerta que se mostrará. El valor predeterminado no está establecido, lo que significa que se muestran todos los subtipos de alerta.
Por ejemplo, usa la siguiente llamada a la API a fin de mostrar solo alertas de habilitación para la organización llamada myorg
:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'
La siguiente llamada solo muestra 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 que se usan en este ejemplo, consulta Usa cURL.