Esta página se ha traducido con Cloud Translation API.

Configuración de alertas y notificaciones
Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Esta página se aplica a Apigee y Apigee híbrido .

Ver la documentación de Apigee Edge .

Uno de los principales objetivos de la monitorización de API es mantenerte informado sobre eventos o patrones inusuales, como picos de tráfico o latencias. Para rastrear eventos como estos, puedes configurar alertas , que se activan cuando ocurre un evento específico. Un evento que activa una alerta se denomina incidente .

Puede establecer reglas específicas para una alerta; por ejemplo, podría activarse por un código de respuesta 500 (Error de servicio interno) en un proxy. Cuando se produce un incidente relacionado con la alerta, puede ver sus detalles en el panel Incidentes del... Google Cloud console Página de alerta.

Si desea recibir notificaciones cuando se active una alerta específica, puede configurar una notificación para la alerta. Cuando ocurre un incidente, Apigee le envía una notificación con un resumen del evento, incluyendo enlaces a... Google Cloud console y la interfaz de usuario de Apigee, para una mayor investigación.

Hay dos tipos de alertas en API Monitoring:

Alertas basadas en métricas , que se activan por cambios en las métricas de API .
Alertas basadas en registros , que se basan en datos de API almacenados por el registro en la nube .

Alertas basadas en métricas

Las alertas basadas en métricas se activan cuando una métrica de los datos de la API alcanza un nivel específico o comienza a cambiar rápidamente. Una regla de alerta se define mediante dos propiedades principales:

La métrica : la cantidad que activa la alerta, por ejemplo, la cantidad de solicitudes.
El umbral : el nivel que debe alcanzar la métrica para activar la alerta.

Las siguientes secciones proporcionan ejemplos de alertas basadas en métricas.

Alerta de código de respuesta 500 en un proxy

El siguiente ejemplo crea una alerta cuando se devuelve el código de respuesta 500 (Error interno del servidor). Puede crear una alerta similar para cualquier código de respuesta.

Para crear la alerta, comience realizando los siguientes pasos:

Abra la página Crear política de alerta en el Google Cloud console.
Haga clic en Seleccionar una métrica .
Deseleccione el botón Activo .
Nota: Si no hay datos recientes de tráfico de API en su organización, la métrica en el siguiente paso no se mostrará a menos que esta opción no esté seleccionada.
Seleccione una métrica de la siguiente manera:
1. Si está utilizando Apigee hybrid v1.12, copie y pegue lo siguiente en el campo Seleccionar una métrica :
```
apigee.googleapis.com/proxy/response_count
```
  Nota: Si está utilizando Apigee híbrido v1.10 o v1.11, utilice la siguiente métrica en su lugar:
```
apigee.googleapis.com/proxyv2/response_count
```
2. Seleccione Apigee Proxy .
3. En el panel que se abre a la derecha, seleccione Proxy .
4. En el siguiente panel a la derecha, seleccione Recuento de respuestas del proxy de Apigee .
5. Haga clic en Aplicar .
Agregue un filtro para el código de respuesta de la siguiente manera:
1. Haga clic en Agregar filtro .
2. Haga clic en el campo Filtro y seleccione response_code en el menú desplegable.
3. En el Comparador , seleccione = .
4. En el campo Valor , escriba 500 .
5. Haga clic en Listo .

Configurar el disparador de alerta

Para configurar el evento que activa la alerta, primero haga clic en "Configurar activador" en el panel izquierdo. A continuación, siga estos pasos:

En Tipo de condición , seleccione Umbral .
En el campo Desencadenante de alerta , seleccione Cualquier serie temporal que viole .
En el campo Posición del umbral , seleccione Por encima del umbral .
En el campo Valor de umbral , ingrese 1 .

Con esta configuración, se activará una alerta cada vez que se devuelva una respuesta con el código 500.

Haga clic en Siguiente para abrir el panel Configurar notificaciones y finalizar alertas .

Configurar una notificación para la alerta

En el panel Configurar notificaciones y finalizar alertas , puede configurar una notificación que se enviará cuando se active una alerta. Para ello:

Haz clic en el campo Canales de notificación . Si ya has creado un canal para la notificación, como una dirección de correo electrónico o un número de SMS, puedes seleccionarlo en Canales de notificación .
De lo contrario, debe agregar un canal seleccionando "Administrar canales de notificación" . Esto abrirá el panel "Canales de notificación" , donde puede agregar uno o más canales. Consulte "Administrar canales de notificación" para obtener más información. Al terminar, regrese al panel " Configurar notificaciones y finalizar alertas" .
Nota: Es posible que necesites hacer clic en el botón actualizar junto a Administrar canales de notificación para mostrar un nuevo canal después de crearlo.
Una vez que haya seleccionado uno o más canales de notificación, haga clic en Aceptar .
En el campo Documentación , puede agregar un mensaje que se enviará junto con la notificación. Por ejemplo, el mensaje podría describir el motivo de la alerta e incluir enlaces a la documentación que explica cómo responder.
Haga clic en Siguiente para revisar los detalles de la alerta. Si está satisfecho con ellos, haga clic en Crear política para crear la política de alertas.

Agregar una condición: Alerta para el código de respuesta 500 para solicitudes HTTP POST en un proxy

Puede crear varias condiciones para una alerta. Por ejemplo, en la alerta para el código de respuesta 500 en un proxy descrita en la sección anterior, podría querer agregar la condición de que la alerta solo se active para solicitudes HTTP POST. Para ello, simplemente siga los mismos pasos que en el ejemplo anterior , pero después del paso 8, agregue otro filtro como se indica a continuación:

Haga clic en Agregar filtro .
Haga clic en el campo Filtro y seleccione el método HTTP en la lista desplegable.
En el campo Comparador , seleccione = .
En el campo Valor , ingrese POST .
Haga clic en Listo .

Luego, continúe con los pasos de "Configurar el disparador de alerta" . Al finalizar, la alerta se activará cuando el proxy reciba un código de respuesta 500 de una solicitud HTTP POST.

Consulte Alerta para combinaciones de códigos de respuesta y métodos HTTP para ver un ejemplo relacionado.

Visualización de detalles del incidente

Un evento de API que activa una alerta se denomina incidente . Puede ver los detalles de los incidentes recientes en Google Cloud consolePágina de alerta .

Métricas y filtros

Una métrica es la cantidad que activa una alerta, por ejemplo, el número de solicitudes. Esta sección describe las métricas y los filtros que puede usar para crear alertas basadas en métricas. Existen dos tipos de métricas:

Nuevas métricas : Nuevas versiones de las métricas de Apigee con rendimiento y fiabilidad mejorados. Estas métricas están disponibles actualmente para Apigee y Apigee híbrido v1.12 y versiones posteriores. Recomendamos usar las nuevas métricas siempre que sea posible.
Métricas originales : Las métricas originales aún son compatibles con el uso de Apigee hybrid v1.10 y v1.11.

Nuevas métricas

La siguiente tabla enumera las nuevas métricas.

Métrico	Descripción
`apigee.googleapis.com/proxy/details`	Detalles relevantes al proxy que se implementa en un entorno Apigee.
`apigee.googleapis.com/proxy/request_count`	Número de solicitudes al proxy Apigee desde que se registró la última muestra.
`apigee.googleapis.com/proxy/response_count`	Número de respuestas enviadas por el proxy API de Apigee.
`apigee.googleapis.com/proxy/latencies`	Distribución de latencias, que se calculan desde el momento en que el proxy Apigee recibe la solicitud hasta el momento en que el proxy Apigee envía la respuesta al cliente.
`apigee.googleapis.com/target/request_count`	Número de solicitudes enviadas al destino Apigee desde que se registró la última muestra.
`apigee.googleapis.com/target/response_count`	Número de respuestas recibidas del objetivo Apigee desde que se registró la última muestra.
`apigee.googleapis.com/target/latencies`	Distribución de latencias, calculada desde el momento en que se envía la solicitud al destino de Apigee hasta que el proxy de Apigee recibe la respuesta. Este tiempo no incluye la sobrecarga del proxy de la API de Apigee.

Métricas originales

La siguiente es una lista de las versiones originales de las métricas que se muestran en la tabla anterior, que aún son compatibles para su uso solo con Apigee hybrid v1.10 y v1.11.

Métrico	Descripción
`apigee.googleapis.com/proxyv2/details`	Detalles relevantes al proxy que se implementa en un entorno Apigee.
`apigee.googleapis.com/proxyv2/request_count`	Número total de solicitudes recibidas por el proxy API de Apigee.
`apigee.googleapis.com/proxyv2/response_count`	Número total de respuestas devueltas por el proxy API de Apigee.
`apigee.googleapis.com/proxyv2/latencies_percentile`	Porcentaje de todas las respuestas del proxy API a una solicitud.
`apigee.googleapis.com/targetv2/request_count`	Número total de solicitudes recibidas por el objetivo de la API de Apigee.
`apigee.googleapis.com/targetv2/response_count`	Número total de respuestas devueltas por el objetivo de la API de Apigee.
`apigee.googleapis.com/targetv2/latencies_percentile`	Porcentaje de todas las respuestas de destino de API a una solicitud.

Filtros

Los filtros permiten crear alertas para subconjuntos de datos de API. Un filtro especifica una condición que define el subconjunto. Por ejemplo, se puede crear una alerta basada en los datos de un único proxy.

Puede elegir entre los siguientes filtros:

Filtrar	Descripción	Métricas para las que se puede aplicar el filtro
`env`	Entorno para los datos.	Todo
`location`	Ubicación de los datos.	Todo
`proxy_name`	Proxy de los datos.	Todo
`proxy_deployment_type`	Tipo de implementación del proxy Apigee	`apigee.googleapis.com/proxy/details` `apigee.googleapis.com/proxyv2/details`
`runtime_version`	Versión de tiempo de ejecución de los datos.	Métricas originales
`instance_id`	ID de instancia de los datos.	Métricas originales
`method`	Método HTTP para los datos.	Todo
`response_code`	Código de respuesta HTTP para los datos.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_code`	Código de error de los datos.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_source`	Fuente de falla de los datos. Si desea detectar errores generales que pueden ocurrir en cualquier parte de una red API, configure `fault_source` en `proxy` .	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`percentile`	Percentil de latencias de respuesta del proxy de Apigee.	`apigee.googleapis.com/proxyv2/latencies_percentile`

Alertas basadas en registros

Además de las alertas basadas en métricas descritas en la sección anterior, también puedes crear alertas basadas en registros , que monitorean los datos de API almacenados por Cloud Login .

Configuración de una alerta basada en registros

El siguiente ejemplo muestra cómo configurar una alerta basada en registros. Consulte "Crear consultas en el Explorador de registros" para obtener más información.

Abra el Explorador de registros en el Google Cloud console.
Seleccione Mostrar consulta en el lado derecho del Explorador de registros.
En el panel Consulta , ingrese una consulta como el ejemplo que se muestra a continuación.
```
resource.type="apigee.googleapis.com/Environment"
logName="projects/<project_id>/logs/apigee.googleapis.com%2Fanomaly_event"
```
Nota: El valor / antes anomaly_event (el [LOG_ID]) debe estar codificado en URL como %2F . Consulte la página de referencia de LogEntry .
Haga clic en "Ejecutar consulta" . Los resultados se muestran en la sección "Verifique que la consulta devuelva las entradas de registro sobre las que desea generar alertas".
Haga clic en Crear alerta debajo del panel Consulta .
Siga el procedimiento del cuadro de diálogo "Crear política de alertas basadas en registros" para crear la alerta. Consulte "Configurar alertas basadas en registros" para obtener más información.