Creación de Nuevas Alertas (Runtime Alerts)

Para configurar una nueva alerta, haga clic en el botón + NEW DEFINITION situado en la esquina superior derecha de la página Runtime Alerts.

La creación de una alerta se realiza a través de un wizard con tres pasos, especificados en el resto de esta página:

EVENT para insertar qué será monitoreado y con qué frecuencia;
ACTIONS, para configurar los medios utilizados para enviar la notificación; y
REVIEW, que muestra la información registrada para la alerta creada.

Event

El paso EVENT comprende la definición de lo que debe ser monitoreado y con qué frecuencia. Incluye estas secciones de registro: OVERVIEW, EVENT DETAILS, COMPARE WITH PAST PERIOD, SILENT INTERVAL y SCHEDULE.

El registro de alertas por defecto se realiza a partir de valores absolutos que, al ser superados o no en un período determinado (dependiendo de la configuración), activarán una notificación.

Pero también es posible incluir alertas que activen las notificaciones cuando se alcancen los valores registrados para un período pasado. En este caso, los valores no son absolutos, sino que indican una referencia de comparación entre el rendimiento actual y el pasado. Esta comparação se configura en el campo COMPARE WITH PAST PERIOD.

Overview

La primera sección de inscripción es OVERVIEW, que comprende tres datos iniciales que deben completarse:

Name: nombre para ayudar a identificar la alerta (no necesita ser único).
Notification Type: tipo de notificación. Opciones: Total Calls (llamadas totales), Availability (disponibilidad), Latency (latencia) y HTTP Response Status (códigos de estado de respuesta HTTP).
Classification: clasificación, que representa el nivel de criticidad. Opciones: neutral, success (éxito), warning (atención) y critical (crítico).

La clasificación no tiene un significado predefinido. El usuario puede definir la criticidad de cada acción según juzgue mejor, siguiendo sus reglas de negocio.

Después de elegir el objeto, se muestran las secciones restantes de la inscripción.

Event Details

Los campos de la sección EVENT DETAILS comprenden la información central del evento que se va a supervisar. Aquí, debe informar el recurso y la operación de la API que desea monitorear y los valores de referencia que dispararán la notificación.

Con el fin de mantener el monitoreo lo más enfocado posible y así poder visualizar los puntos de atención, las alertas se configuran a nivel de operación HTTP. Pero recuerde que puede crear alertas para todas las operaciones que necesite (así como para tantos recursos de una API como desee).

Los campos forman el mensaje predeterminado enviado en la notificación y varían según el tipo de alerta configurado:

Total Calls

Esta alerta se activa cuando se alcanza o no se alcanza un número total de llamadas en un período determinado, dependiendo de la configuración.

API Name: campo para introducir el nombre de la API que desea supervisar, con función de autocompletar desde sus APIs en la Sensedia API Platform.
Environment: entorno donde se implementa la API elegida.
Resource: recurso de la API a monitorear.
Operation: operación de la API a monitorear para el recurso elegido.

returned <Operator> <Call Qty> requests over the last <Period> <Unit>: campo para establecer el número total de llamadas por período a considerar para la alerta. Consiste en:

Operator: califica el valor introducido con las opciones «más que» («more than») o «menos que» («fewer than»).

Call Qty: campo para introducir el valor de la cantidad de llamadas cuyo desbordamiento (o no desbordamiento, consulte el operador elegido en el ítem anterior) disparará la alerta.

Este campo tiene una variación si el usuario habilita la comparación regresiva en la configuración de alertas. En este caso, incluirá la elección del número total de llamadas o variación porcentual como unidad de referencia para establecer la comparación de rendimiento. Vea más en la sección Compare with Past Period.

Period / Unit: campos que componen el período de tiempo que debe tenerse en cuenta para la contabilidad del valor consignado. En Period, incluir el número y en Unit la unidad de tiempo (opciones: minutos y horas).

Tiempo máximo que se puede configurar: 24 horas (o 1440 minutos).

Availability

Este tipo hace referencia a la disponibilidad de una dada operación a un recurso (en porcentaje).

API Name: campo para introducir el nombre de la API que desea supervisar, con función de autocompletar desde sus APIs en la Sensedia API Platform.
Environment: entorno donde se implementa la API elegida.
Resource: recurso de la API a monitorear.
Operation: operación de la API a monitorear para el recurso elegido.
availability was <Operator> <Percentage> % over the last <Period> <Unit>: campo para establecer el porcentaje de disponibilidad por período a considerar para la alerta. Consiste en:
- Operator: califica el valor introducido con las opciones «más que» («more than») o «menos que» («less than»).
- Porcentage: valor de disponibilidad porcentual cuyo desbordamiento (o no desbordamiento, consulte el operador elegido en el ítem anterior) disparará la alerta.
- Period / Unit: campos que componen el período de tiempo que debe tenerse en cuenta para la contabilidad del valor consignado. En Period, incluir el número y en Unit la unidad de tiempo (opciones: minutos y horas).
  
  Tiempo máximo que se puede configurar: 24 horas (o 1440 minutos).

Latency

Este tipo se refiere a la latencia media (en milisegundos) en un período determinado.

API Name: campo para introducir el nombre de la API que desea supervisar, con función de autocompletar desde sus APIs en la Sensedia API Platform.
Environment: entorno donde se implementa la API elegida.
Resource: recurso de la API a monitorear.
Operation: operación de la API a monitorear para el recurso elegido.

average latency was <Operator> <Latency> ms over the last <Period> <Unit>: campo para establecer la latencia media en ms por período que se debe tener en cuenta para la alerta. Consiste en:

Operator: califica el valor introducido con las opciones «más que» («more than») o «menos que» («less than»).

Latency: valor de latencia media en ms cuyo desbordamiento (o no desbordamiento, consulte el operador elegido en el ítem anterior) disparará la alerta.

Este campo tiene una variación si el usuario habilita la comparación regresiva en la configuración de alertas. En este caso, incluirá la elección entre un valor en ms o una variación porcentual de latencia para establecer la comparación de rendimiento. Vea más en la sección Compare with Past Period.

Period / Unit: campos que componen el período de tiempo que debe tenerse en cuenta para la contabilidad del valor consignado. En Period, incluir el número y en Unit la unidad de tiempo (opciones: minutos y horas).

Tiempo máximo que se puede configurar: 24 horas (o 1440 minutos).

HTTP Response Status

El tipo hace referencia a la cantidad devuelta de un código de estado HTTP determinado (en porcentaje o número total).

API Name: campo para introducir el nombre de la API que desea supervisar, con función de autocompletar desde sus APIs en la Sensedia API Platform.
Environment: entorno donde se implementa la API elegida.
Resource: recurso de la API a monitorear.
Operation: operación de la API a monitorear para el recurso elegido.
returned <Operator> <Quantity> <Unit> with <Response Status> over the last <Period> <Unit>: campo para establecer el número total o porcentaje de devoluciones de un código de estado HTTP determinado por período a considerar para la alerta. Consiste en:
- Operator: califica el valor introducido con las opciones «más que» («more than») o «menos que» («less than»).
- Quantity: valor de cantidad total o porcentaje de respuestas cuyo desbordamiento (o no desbordamiento, consulte el operador elegido en el ítem anterior) activará la alerta.
- Unit: unidad seleccionable del valor anterior. Opciones: porcentaje o número de llamadas.
- Response Status: código HTTP que debe ser considerado. Puede incluir un código específico (por ejemplo, 504) o una familia, utilizando xx (por ejemplo, 5xx).
- Period / Unit: campos que componen el período de tiempo que debe tenerse en cuenta para la contabilidad del valor consignado. En Period, incluir el número y en Unit la unidad de tiempo (opciones: minutos y horas).
  
  Tiempo máximo que se puede configurar: 24 horas (o 1440 minutos).

Compare with Past Period (comparación regresiva)

La sección COMPARE WITH PAST PERIOD le permite comparar los valores de referencia registrados con períodos pasados para la activación de notificaciones. En este caso, los valores introducidos en los campos de la sección EVENT DETAILS no activarán una notificación cuando se logren absolutamente, sino cuando se alcancen en relación con un rendimiento pasado.

Ejemplo

Imagine una alerta de cantidad total de llamadas (Total Calls) que envía una notificación cuando hay más de 100 peticiones utilizando una operación determinada a un recurso determinado durante un período de un minuto. Si no activamos la comparación con un período pasado, la notificación se enviará cada vez que se realicen más de 100 peticiones en un minuto.

Sin embargo, si configuramos una comparación con el mismo período la semana pasada, la notificación solo se enviará cuando se hayan contado más de 100 peticiones por minuto em comparación con el mismo período de la semana anterior.

Esto significa que si se contabilizan 120 peticiones en un minuto determinado, pero en el mismo período hace una semana se contabilizaron 80 peticiones por minuto, no habrá activación de notificación porque la comparación de peticiones revela 40 peticiones más, menos que el valor de referencia configurado (que es de 100 peticiones).

Hay tres opciones disponibles para la comparación, en este orden: último <período> <unidad> (si el período es 2 y la unidad de referencia es minutos tal como se ha definido anteriormente, los últimos 2 minutos, si el período es 5 y la unidad es horas, últimas 5 horas); el mismo período del día anterior; y el mismo período en la semana anterior.

Cuando se habilita la comparación regresiva de rendimiento, las alertas Total Calls y Latency tienen opciones añadidas al registro de la sección EVENT DETAILS. Para configurar valores de referencia, tiene la adición de unidad de porcentaje como opción.

En el caso de Total Calls, los campos de valor de referencia, en lugar de Call Qty, serán:

Quantity / Unit: campos para introducir la cantidad de más o menos llamadas (dependiendo del operador elegido) durante un período pasado, que, si se alcanza, disparará la alerta.
- Hay dos opciones de unidad: llamadas (calls) o porcentaje (percent).

En el caso de Latency, los campos de valor de referencia, en lugar de Latency, se convierten en:

Latency / Unit: campos para introducir el valor de latencia media mayor o menor (dependiendo del operador elegido) que el de un período anterior, que, si se alcanza, disparará la alerta.
- Hay dos opciones de unidad: milisegundos (ms) o porcentaje (percent).

Dado que los otros tipos (Availability e HTTP Response Status) ya ofrecen un porcentaje como unidad de contabilidad para los valores de referencia, no hay cambios en los campos cuando la comparación regresiva está habilitada.

Silent Interval (silenciar temporalmente una notificación)

Puede silenciar una notificación durante un tiempo predeterminado activando la opción SILENT INTERVAL. Esto resulta útil, por ejemplo, cuando sabe que hay un problema de indisponibilidad con su API y desea deshabilitar una notificación solo durante un período de tiempo específico, sin desactivar completamente la alerta (ver sobre la desactivación de alertas aquí).

Para establecer el tiempo de silencio, rellene el campo que aparecerá con el intervalo deseado, que consta de un número y una unidad (minutos u horas).

El tiempo máximo que se puede configurar es de 24 horas (o 1440 minutos).

Si la opción permanece siempre activada, la alerta se habilita después del intervalo configurado. Entonces, la próxima notificación disparada por un evento se enviará normalmente y desencadenará un nuevo período de silencio.

Un ejemplo para aclarar esta operación:

Imagine que establece un período de silencio de 4 horas para una alerta que envía una notificación cuando más del 20% de las peticiones a una API determinada devuelven un estado HTTP de error. Durante 4 horas, su alerta no generará notificaciones. Imagine que después de 5 horas, el campo SILENT INTERVAL permanece habilitado y el 30% de las peticiones obtienen respuesta de error. En este caso, se enviará una notificación y esa notificación desencadenará un nuevo período de silencio de cuatro horas (a partir de esta última notificación).

Schedule (programar la frecuencia de monitoreo)

La sección SCHEDULE define la frecuencia de comprobación de estado para generar alertas. Ella contiene dos opciones:

Pre-defined (predefinido). En este caso, complete el campo Check every <Period> con la frecuencia deseada. Opciones: 1 minuto; 5, 10 o 30 minutos; 1 hora; o todos los días a las 00:00.
Cron Expression. En este caso, se debe insertar una expresión de programación de tipo Cron (ver tabla a continuación) en el campo Expression.

Una Cron Expression es una cadena que define una programación periódica siguiendo un formato específico. El campo Cron Expression acepta programaciones compuestas de cinco campos:

<minuto> <hora> <día del mes> <mes> <día de la semana>

Se pueden utilizar números y algunos caracteres especiales para completar los campos:

* significa «todos»;
? significa «cualquiera», y puede utilizarse en el mes y en el día de la semana;
L significa «último», y se puede utilizar en el mes y en el día de la semana;
las tres letras iniciales de los días de la semana en inglés (como MON y TUE);
, y - para indicar rangos (el primero considerando solo los puntos indicados y el segundo considerando todo el intervalo entre ellos).

Algunos ejemplos:

30 10 ? * *: comprobación de estado todos los días a las 10:30 de la mañana.
0 14 ? * MON-FRI: comprobación de estado de lunes a viernes a las 2:00 de la tarde.
0 14 ? * MON,FRI: comprobación de estado a las 2:00 de la tarde, solo los lunes y viernes.
0 8 * JUN ?: comprobación de estado a las 8:00 de la mañana, todos los días del mes de junio.
10 17 L * ?: comprobación de estado a las 5:10 de la tarde en el último día de cada mes.

Después de incluir los datos requeridos, el botón NEXT en la esquina inferior derecha de la pantalla se activará y le llevará al siguiente paso.

Actions

ACTIONS comprende los canales para el envío de notificaciones:

Para agregar una acción y configurarla, haga clic en icon add .

Se debe configurar al menos una acción para poder guardar/crear la alerta.

E-mail

Cuando se configura esta acción, se envía un correo electrónico de notificación cada vez que se dispara la alerta.

Para incluir destinatarios, introduzca la dirección de correo electrónico en el campo E-mails, dentro de la sección RECEIVERS. Puede agregar tantos destinatarios como desee, escribiendo las direcciones de correos electrónicos individualmente o introduciendo varias al mismo tiempo, separando cada una con comas.

Después de que un destinatario haya sido incluido en el campo anterior, recibirá un correo electrónico, como el que aparece en la siguiente captura de pantalla, para permitirle recibir notificaciones. Para confirmar, haga clic en el botón YES, I WANT TO SEE EVERYTHING!. El enlace de confirmación contenido en el correo electrónico será válido durante 24 horas después del envío.
receivers email

Si un destinatario aún no ha confirmado su suscripción, su dirección de correo electrónico se resaltará en amarillo en la pantalla de edición de alertas (consulte más sobre la edición de alertas aquí).

Puede enviar un nuevo correo electrónico de confirmación haciendo clic en el icono junto a la lista ( icon new email ), como en la imagen de abajo:
actions email

En la sección ADD CUSTOM MESSAGE puede añadir un mensaje personalizado adicional que se enviará con la notificación. Para esto, active el botón e incluya el mensaje en el campo de edición que se abrirá, como en el ejemplo siguiente:

El mensaje se puede escribir en formato de texto o en HTML.

Al hacer clic en SAVE volverá al marco de acciones, y ahora la acción de E-mail contendrá iconos para ver los detalles ( icon more ), editar ( icon edit ) y eliminar ( icon delete ). Al hacer clic en , verá la información configurada:

Ahora puede configurar otra acción o guardar la alerta, procediendo al paso REVIEW.

Slack

Cuando se configura esta acción, se envía una notificación a un canal de Slack cada vez que se dispara la alerta.

En primer lugar, seleccione el workspace de Slack que se utilizará. Si no ha incluido un workspace en la pantalla Integrations, puede hacerlo a través del botón + ADD WORKSPACE. Los pasos son los mismos (vea más sobre esto aquí). Después de elegir el workspace, se abrirá el campo Channel para elegir el canal, como en el ejemplo siguiente:

Por defecto, solo se mostrarán los canales públicos, pero también puede añadir un canal privado. vea sobre esta configuración aquí.

Solo se puede seleccionar un canal por alerta.

El mensaje se puede escribir en formato de texto o utilizando el formato aceptado por Slack. Vea más sobre esto en la documentación de Slack.

Al hacer clic en SAVE volverá al marco de acciones, y ahora la acción de Slack contendrá iconos para ver los detalles ( icon more ), editar ( icon edit ) y eliminar ( icon delete ). Al hacer clic en , verá la información configurada:

Si lo desea, puede enviar un mensaje de prueba al canal configurado haciendo clic en SEND TEST MESSAGE.

Ahora puede configurar otra acción o guardar la alerta, procediendo al paso REVIEW.

Webhook

Cuando se configura una acción de Webhook, Flexible Actions envía una petición HTTP POST cada vez que se activa la alerta. Esto le permite activar una API específica desde el monitoreo de Flexible Actions. El payload de la petición incluirá los parámetros supervisados de la alerta y el mensaje adicional, si lo incluye.

Estos son los campos necesarios para configurar un webhook:

ENDPOINT: incluya el endpoint al qué se enviará la peticion en el campo Url.
AUTHENTICATION: sección opcional para establecer credenciales que Flexible Actions debe incluir en la petición. Cada credencial se compone de un client ID acompañado o no de un client secret e identifica dónde se traficarán las informaciones en la petición (header o query param). Todas las credenciales registradas se muestran en la pantalla Integrationsy puede seleccionar una credencial existente en el campo Credential. Si no ha registrado la credencial que desea utilizar en la pantalla Integrations, puede hacer clic en el botón + NEW CREDENTIAL para incluirla. Los pasos son los mismos (vea más sobre esto aquí).

En la sección ADD CUSTOM MESSAGE puede añadir un mensaje personalizado adicional que se incluirá en la petición. Para esto, active el botón e incluya el mensaje en el campo de edición que se abrirá, como en este ejemplo:

El mensaje se incluirá en el payload de la petición, identificado por "customMessage".

Al hacer clic en SAVE volverá al marco de acciones, y ahora la acción de Webhook contendrá iconos para ver los detalles ( icon more ), editar ( icon edit ) y eliminar ( icon delete ). Al hacer clic en , verá la información configurada:

Si lo desea, puede ver el esquema JSON y una muestra del payload que se enviará haciendo clic en el botón {…} VIEW SAMPLE.

Ahora puede configurar otra acción o guardar la alerta, procediendo al paso REVIEW.

Review

El paso REVIEW muestra los detalles configurados de su nueva alerta, como en el ejemplo siguiente:

Las acciones registradas contendrán el icono icon more para más informaciones. Además, para Slack es posible enviar un mensaje de prueba haciendo clic en SEND TEST MESSAGE; y para Webhook es posible ver el esquema JSON y una muestra del payload que se enviará haciendo clic en el botón {…} VIEW SAMPLE.

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]