Configuración de alertas en Amazon OpenSearch Service

Configura alertas en Amazon OpenSearch Service para recibir notificaciones cuando los datos de uno o más índices cumplan 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 Elasticsearch OpenSearch 6.2 o una versión posterior.

nota

Esta documentación proporciona una breve descripció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 código abierto. OpenSearch Para obtener la documentación completa sobre las alertas, que incluye una referencia exhaustiva de la API, una lista de los campos de solicitud disponibles para los monitores compuestos y una descripción de las variables de activación y acción disponibles, consulte la sección Alertas en la documentación. OpenSearch

Permisos de alertas

Las alertas admiten el control de acceso detallado. Para obtener más información sobre cómo combinar y combinar permisos para adaptarlos a su caso de uso, consulte la seguridad de las alertas en la documentación. OpenSearch

Para acceder a la página de alertas en los OpenSearch paneles de control, debe estar asignado como mínimo a la función alerting_read_access predefinida o tener permisos equivalentes. Esta función otorga 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 un trabajo que se ejecuta según un cronograma definido y consulta OpenSearch los índices. 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. Elija Alertas en el menú principal del OpenSearch panel de mandos y elija 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, tu dominio de OpenSearch servicio debe poder conectarse a Internet para notificar a un canal de Slack o enviar un webhook personalizado a un servidor de terceros. El webhook personalizado debe tener una dirección IP pública para que un dominio de OpenSearch servicio 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 las notificaciones, que es un sistema unificado de OpenSearch notificaciones. 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 una documentación completa, consulte Notificaciones en la OpenSearch documentación.

Tu dominio debe tener la OpenSearch versión 2.3 o posterior para poder usar las notificaciones.

nota

OpenSearch las notificaciones son independientes de las notificaciones de OpenSearch servicio, que proporcionan detalles sobre las actualizaciones del software del servicio, las mejoras de Auto-Tune y otra información importante a nivel de dominio. OpenSearch las notificaciones son específicas del complemento.

Los canales de notificación sustituyeron a los destinos de alerta a partir de la versión 2.0. 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.

Cuando actualizas tus dominios a la versión 2.3 o posterior (dado que el soporte de OpenSearch servicio para la versión 2.x comienza con la 2.3), tus destinos actuales se migran automáticamente 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, consulta la sección Preguntas sobre los destinos en la OpenSearch documentación.

Para empezar con las notificaciones, inicia sesión en los OpenSearch paneles de control y selecciona Notificaciones, Canales y 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 El servicio te permite modificar la siguiente configuración 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 anteriormente creó monitores y desea detener la creación de índices de alertas diarios, elimine todos los índices del historial de alertas:

DELETE .plugins-alerting-alert-history-*

Para reducir el número de fragmentos de los índices de 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 sobre la creación y administración de plantillas de índice, consulte las plantillas de índice en la OpenSearch documentación.