Configuration des alertes dans Amazon OpenSearch Service

Configurez des alertes dans Amazon OpenSearch Service pour être averti lorsque les données d'un ou de plusieurs index répondent à certaines conditions. Par exemple, vous pouvez souhaiter recevoir un e-mail si votre application journalise plus de cinq erreurs HTTP 503 en une heure, ou souhaiter appeler un développeur si aucun nouveau document n'a été indexé au cours des 20 dernières minutes.

Les alertes nécessitent Elasticsearch 6.2 OpenSearch ou version ultérieure.

Note

Cette documentation fournit un bref aperçu des alertes et explique en quoi les alertes sur un domaine Amazon OpenSearch Service diffèrent des alertes sur un cluster open source. OpenSearch Pour obtenir une documentation complète sur les alertes, y compris une référence complète sur les API, une liste des champs de requête disponibles pour les moniteurs composites et les descriptions des variables de déclenchement et d'action disponibles, consultez la section Alertes dans la OpenSearch documentation.

Autorisations relatives aux alertes

La fonctionnalité d'alerte prend en charge le contrôle précis des accès. Pour en savoir plus sur le mixage et l'appariement des autorisations en fonction de votre cas d'utilisation, consultez la section Sécurité des alertes dans la OpenSearch documentation.

Pour accéder à la page d'alerte dans les OpenSearch tableaux de bord, vous devez au moins être mappé au rôle alerting_read_access prédéfini ou disposer d'autorisations équivalentes. Ce rôle accorde des autorisations pour afficher les alertes, les destinations et les moniteurs, mais pas pour accuser réception des alertes ou modifier les destinations ou les moniteurs.

Démarrer avec les alertes

Pour créer une alerte, vous configurez un moniteur, c'est-à-dire une tâche exécutée selon un calendrier défini et interrogeant OpenSearch des index. Vous configurez également un ou plusieurs déclencheurs, qui définissent les conditions qui génèrent des événements. Enfin, vous configurez des actions, c'est-à-dire ce qu'il se passe lorsqu'une alerte se déclenche.

Pour commencer à utiliser des alertes

1. Choisissez Alertes dans le menu principal OpenSearch des tableaux de bord, puis choisissez Créer un moniteur.

2. Créez un moniteur par requête, par compartiment, par métrique de cluster ou par document. Pour plus d'instructions, veuillez consulter la rubrique Créer un moniteur (langue française non garantie).

3. Dans Triggers (Déclencheurs), créez un ou plusieurs déclencheurs. Pour consulter les instructions, veuillez consulter la rubrique Créer des déclencheurs (langue française non garantie).

4. Pour Actions, configurez un canal de notification pour l'alerte. Choisissez Slack, Amazon Chime, un webhook personnalisé ou Amazon SNS. Comme vous pouvez vous en douter, les notifications nécessitent une connectivité au canal. Par exemple, votre domaine de OpenSearch service doit pouvoir se connecter à Internet pour envoyer une notification à une chaîne Slack ou envoyer un webhook personnalisé à un serveur tiers. Le webhook personnalisé doit avoir une adresse IP publique pour qu'un domaine de OpenSearch service puisse lui envoyer des alertes.

   Astuce

   Une fois qu'une action a réussi à envoyer un message, la sécurisation de l'accès à ce message (par exemple, l'accès à un canal Slack) est de votre responsabilité. Si votre domaine contient des données sensibles, vous pouvez utiliser des déclencheurs sans actions et rechercher périodiquement les alertes dans Dashboards.

Notifications

Les alertes s'intègrent aux notifications, qui constituent un système unifié de OpenSearch notifications. Les notifications vous permettent de configurer le service de communication que vous souhaitez utiliser et de consulter les statistiques pertinentes et les informations de dépannage. Pour une documentation complète, voir Notifications dans la OpenSearch documentation.

Votre domaine doit exécuter OpenSearch la version 2.3 ou ultérieure pour utiliser les notifications.

Note

OpenSearch les notifications sont distinctes des notifications de OpenSearch service, qui fournissent des détails sur les mises à jour du logiciel de service, les améliorations apportées à Auto-Tune et d'autres informations importantes au niveau du domaine. OpenSearch les notifications sont spécifiques au plugin.

Les canaux de notification ont remplacé les destinations d'alerte à partir de OpenSearch la version 2.0. Les destinations sont officiellement obsolètes et toutes les notifications d'alerte seront désormais gérées via des canaux.

Lorsque vous mettez à niveau vos domaines vers la version 2.3 ou ultérieure (puisque le support de OpenSearch service pour 2.x commence avec 2.3), vos destinations existantes sont automatiquement migrées vers les canaux de notification. Si la migration d'une destination échoue, le moniteur continuera à l'utiliser jusqu'à ce qu'il soit migré vers un canal de notification. Pour plus d'informations, consultez la section Questions sur les destinations dans la OpenSearch documentation.

Pour commencer à utiliser les notifications, connectez-vous aux OpenSearch tableaux de bord et choisissez Notifications, Canaux et Créer un canal.

Amazon Simple Notification Service (Amazon SNS) est un type de canal pris en charge pour les notifications. Afin d'authentifier les utilisateurs, vous devez soit leur fournir un accès complet à Amazon SNS, soit les laisser endosser un rôle IAM autorisé à accéder à Amazon SNS. Pour obtenir des instructions, veuillez consulter la rubrique Amazon SNS en tant que type de canal (langue française non garantie).

Différences

Par rapport à la version open source de OpenSearch, les alertes d'Amazon OpenSearch Service présentent des différences notables.

Paramètres d'alerte

OpenSearch Le service vous permet de modifier les paramètres d'alerte suivants :

• 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

Tous les autres paramètres utilisent les valeurs par défaut que vous ne pouvez pas modifier.

Pour désactiver les alertes, envoyez la requête suivante :

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

La demande suivante configure les alertes pour supprimer automatiquement les index d'historique après sept jours, au lieu des 30 jours par défaut :

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

Si vous avez déjà créé des moniteurs et que vous souhaitez arrêter la création d'index d'alertes quotidiens, supprimez tous les index de l'historique des alertes :

DELETE .plugins-alerting-alert-history-*

Pour réduire le nombre de partitions pour les index historiques, créez un modèle d'index. La requête suivante définit les index d'historique pour les alertes sur une partition et un réplica :

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

En fonction de votre tolérance à la perte de données, vous pouvez même envisager de n'utiliser aucun réplica. Pour plus d'informations sur la création et la gestion de modèles d'index, consultez la section Modèles d'index dans la OpenSearch documentation.