Configuración de alertas en Amazon OpenSearch Service - Amazon OpenSearch Service
Permisos de alertasIntroducción a las alertasNotificacionesDiferencias

Configuración de alertas en Amazon OpenSearch Service

Configure alertas en Amazon OpenSearch Service para recibir notificaciones cuando los datos de uno o varios índices cumplen determinadas condiciones. Por ejemplo, es posible que desee recibir un email si la aplicación registra más de cinco errores HTTP 503 en una hora o tal vez desee avisar a un desarrollador si no se indexaron nuevos documentos en los últimos 20 minutos.

Las alertas requieren OpenSearch o Elasticsearch 6.2 o posterior.

nota

Esta documentación proporciona una breve información general de las alertas y destaca en qué se diferencian las alertas en un dominio de Amazon OpenSearch Service de las alertas en un clúster de OpenSearch de código abierto. Para obtener la documentación completa sobre alertas, lo que incluye una referencia de la API exhaustiva, una lista de los campos de solicitud disponibles para monitores compuestos y descripciones de variables de acciones y desencadenadores válidos, consulte Alerting en la documentación de OpenSearch.

Permisos de alertas

Las alertas admiten el control de acceso detallado. Para obtener más información sobre la combinación y la coincidencia de permisos para adaptarlos al caso de uso, consulte Alertas de seguridad en la documentación de OpenSearch.

Para acceder a la página alertas de OpenSearch Dashboards, debe estar asignado al menos al rol alerting_read_access predefinido o disponer de permisos equivalentes. Este rol concede permisos para ver alertas, destinos y monitores, pero no para reconocer alertas ni modificar destinos o monitores.

Introducción a las alertas

Para crear una alerta, debe configurar un monitor, que es una tarea que se ejecuta según un cronograma definido y consulta los índices de OpenSearch. También puede configurar disparadores, que definen las condiciones que generan los eventos. Por último, se configuran las acciones, lo que ocurre después de que se activa una alerta.

Para comenzar a trabajar con alertas

  1. Seleccione Alerting (Alertas) en el menú principal de OpenSearch Dashboards y, a continuación, Seleccione Create monitor (Crear monitor).

  2. Cree un monitor por consulta, por bucket, por métricas de clúster o por documento. Para obtener instrucciones, consulte Create a monitor (Crear un monitor).

  3. En Triggers (Disparadores), cree uno o más disparadores. Para obtener instrucciones, consulte Create triggers (Creación de disparadores).

  4. En Actions (Acciones), configure un notification channel (canal de notificación) para la alerta. Seleccione entre Slack, Amazon Chime, un webhook personalizado o Amazon SNS. Como puede imaginar, las notificaciones requieren conectividad con el canal. Por ejemplo, para notificar a un canal de Slack o enviar un webhook personalizado a un servidor de terceros, su dominio de OpenSearch Service necesita la conectividad de red apropiada. El webhook personalizado debe tener una dirección IP pública para que un dominio de OpenSearch Service pueda enviarle alertas.

    sugerencia

    Después de que una acción envíe correctamente un mensaje, tiene la responsabilidad de asegurar el acceso a ese mensaje (por ejemplo, el acceso a un canal de Slack). Si el dominio contiene información confidencial, considere utilizar desencadenadores sin acciones y verificar periódicamente si hay alertas en Dashboards.

Notificaciones

Las alertas se integran con Notifications (Notificaciones), que es un sistema unificado para las notificaciones de OpenSearch. Las notificaciones le permiten configurar el servicio de comunicación que desea utilizar y ver las estadísticas pertinentes y la información para la solución de problemas. Para obtener documentación completa, consulte Notifications (Notificaciones) en la documentación de OpenSearch.

Su dominio debe ejecutarse en una versión de OpenSearch 2.3 o posterior para utilizar notificaciones.

nota

Las notificaciones de OpenSearch son independientes de las notificaciones de OpenSearch Service, que proporcionan detalles sobre las actualizaciones del software del servicio, las mejoras de ajuste automático y otra información importante a nivel de dominio. Las notificaciones de OpenSearch son específicas del complemento.

Los canales de notificación sustituyeron a los destinos de alerta a partir de la versión 2.0 de OpenSearch. Los destinos quedaron obsoletos de forma definitiva y, a partir de ahora, todas las notificaciones de alertas se gestionarán a través de los canales.

Al actualizar sus dominios a la versión 2.3 o posterior (dado que la compatibilidad de OpenSearch Service para la versión 2.x comienza con la versión 2.3), sus destinos existentes se migran de forma automática a los canales de notificación. Si un destino no se migra, el monitor seguirá usándolo hasta que el monitor se migre a un canal de notificación. Para obtener más información, consulte Questions about destinations (Preguntas sobre destinos) en la documentación de OpenSearch.

Para empezar con las notificaciones, inicie sesión en OpenSearch Dashboards y seleccione Notifications (Notificaciones), Channels (Canales) y Create channel (Crear canal).

Amazon Simple Notification Service (Amazon SNS) es un tipo de canal compatible para las notificaciones. Para autenticar a los usuarios, debe proporcionar al usuario acceso completo a Amazon SNS o dejar que asuma un rol de IAM con permisos para acceder a Amazon SNS. Para obtener instrucciones, consulte Amazon SNS as a channel type (Amazon SNS como un tipo de canal).

Diferencias

En comparación con la versión de código abierto de OpenSearch, las alertas en Amazon OpenSearch Service presentan algunas diferencias notables.

Configuración de alertas

OpenSearch Service permite modificar las siguientes Configuraciones de alertas:

  • plugins.scheduled_jobs.enabled

  • plugins.alerting.alert_history_enabled

  • plugins.alerting.alert_history_max_age

  • plugins.alerting.alert_history_max_docs

  • plugins.alerting.alert_history_retention_period

  • plugins.alerting.alert_history_rollover_period

  • plugins.alerting.filter_by_backend_roles

Todas las demás configuraciones utilizan los valores predeterminados que no se pueden cambiar.

Para deshabilitar las alertas, envíe la siguiente solicitud:

PUT _cluster/settings
{
  "persistent" : {
    "plugins.scheduled_jobs.enabled" : false
  }
}

La siguiente solicitud configura las alertas para eliminar automáticamente los índices del historial después de siete días, en lugar de los 30 días predeterminados:

PUT _cluster/settings
{
  "persistent": {
    "plugins.alerting.alert_history_retention_period": "7d"
  }
}

Si previamente creó monitores y desea detener la creación de índices de alerta diaria, elimine todos los índices del historial de alertas:

DELETE .plugins-alerting-alert-history-*

Para reducir el recuento de particiones de los índices del historial, cree una plantilla de índice. La siguiente solicitud establece índices de historial para las alertas y administración de estados de índice para una partición y una réplica:

PUT _index_template/template-name
{
  "index_patterns": [".opendistro-alerting-alert-history-*"],
  "template": {
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1
    }
  }
}

En función de la tolerancia a la pérdida de datos, incluso podría considerar no utilizar ninguna réplica. Para obtener más información acerca de cómo crear y administrar plantillas de índice, consulte Plantillas de índice en la documentación de OpenSearch.