Configuração de alertas no Amazon OpenSearch Service

Configure alertas no Amazon OpenSearch Service para receber notificações quando os dados de um ou mais índices atendem a determinadas condições. Por exemplo, talvez você queira receber um e-mail se a aplicação registrar mais de cinco erros HTTP 503 em uma hora, ou talvez queira notificar um desenvolvedor caso nenhum documento novo tenha sido indexado nos últimos 20 minutos.

Os alertas exigem o OpenSearch ou Elasticsearch 6.2 ou posterior.

nota

Esta documentação fornece uma breve visão geral dos alertas e destaca como os alertas em um domínio do Amazon OpenSearch Service diferem dos alertas em um cluster OpenSearch de código aberto. Para obter a documentação completa de geração de alertas, incluindo uma referência abrangente de API, uma lista dos campos de solicitação disponíveis para monitores compostos e descrições das variáveis de acionamento e ações disponíveis, consulte Geração de alertas na documentação do OpenSearch.

Permissões de alertas

O recurso de alertas oferece suporte ao controle de acesso refinado. Para obter detalhes sobre combinação e correspondência de permissões de acordo com seu caso de uso, consulte Segurança dos alertas na documentação do OpenSearch.

Para acessar a página de Geração de alertas no OpenSearch Dashboards, você deve pelo menos estar mapeado para a função alerting_read_access predefinida ou receber permissões equivalentes. Essa função concede permissões para visualizar alertas, destinos e monitores, mas não para reconhecer alertas ou modificar destinos ou monitores.

Conceitos básicos dos alertas

Para criar um alerta, você configura um monitor, que é um trabalho executado em um cronograma definido, e consulta os índices do OpenSearch. Você também configura um ou mais acionadores, que definem as condições que geram os eventos. Finalmente, você configura ações, que é o que acontece depois que um alerta é acionado.

Para começar a usar alertas

1. Escolha Alerting (Geração de alertas) no menu principal do OpenSearch Dashboards e escolha Create monitor (Criar monitor).

2. Crie um monitor por consulta, por bucket, por métrica de cluster ou por documento. Para obter instruções, consulte Criar um monitor.

3. Em Triggers (Acionadores), crie um ou mais acionadores. Para obter instruções, consulte Criação de acionadores.

4. Em Actions (Ações), configure um canal de notificação para o alerta. Escolha entre Slack, Amazon Chime, um webhook personalizado ou Amazon SNS. Como você pode imaginar, as notificações exigem conectividade com o canal. Por exemplo, seu domínio do OpenSearch Service deve ser capaz de se conectar à Internet para notificar um canal Slack ou enviar um webhook personalizado para um servidor de terceiros. O webhook personalizado deve ter um endereço IP público para que um domínio do OpenSearch Service possa enviar alertas para ele.

   dica

   Após uma ação enviar uma mensagem com êxito, proteger o acesso a essa mensagem (por exemplo, acesso a um canal do Slack) é sua responsabilidade. Se o seu domínio contiver dados confidenciais, considere usar acionadores sem ações e verificar periodicamente o Dashboards em busca de alertas.

Notificações

O alerta se integra ao Notifications, que é um sistema unificado para notificações do OpenSearch. O Notifications permite que você configure qual serviço de comunicação você deseja usar e veja estatísticas relevantes e informações de solução de problemas. Para obter documentação abrangente, consulte Notifications na documentação do OpenSearch.

Para usar as notificações, o seu domínio deve executar o OpenSearch versão 2.3 ou posteriores.

nota

As notificações do OpenSearch são separadas das notificações do OpenSearch Service, que fornecem detalhes sobre atualizações de software de serviço, aprimoramentos do Auto-Tune e outras informações importantes em nível de domínio. As notificações do OpenSearch são específicas do plug-in.

A partir do OpenSearch versão 2.0, os destinos de alerta foram substituídos por canais de notificação. Os destinos foram oficialmente descontinuados e todas as notificações de alertas serão gerenciadas por meio de canais daqui para frente.

Quando você atualiza seus domínios para a versão 2.3 ou posterior (já que o suporte do OpenSearch Service para 2.x começa com o 2.3), seus destinos existentes são automaticamente migrados para canais de notificação. Se houver falha na migração deum destino, o monitor continuará a usá-lo até que o monitor seja migrado para um canal de notificação. Para obter mais informações, consulte Perguntas sobre destinos na documentação do OpenSearch.

Para começar a usar as notificações, entre no OpenSearch Dashboards e escolha Notifications (Notificações), Channels (Canais) e Create channel (Criar canal).

Amazon Simple Notification Service (Amazon SNS) é um tipo de canal com suporte para notificações. Para autenticar usuários, você precisa fornecer ao usuário acesso total ao Amazon SNS, ou permitir que ele assuma um perfil do IAM que tenha permissões para acessar o Amazon SNS. Para obter instruções, consulte Amazon SNS como um tipo de canal.

Diferenças

Em comparação com a versão de código aberto do OpenSearch, os alertas no Amazon OpenSearch Service apresentam algumas diferenças notáveis.

Configurações de alertas

O OpenSearch Service permite a você modificar as seguintes configurações 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 as outras configurações usam os valores padrão que não podem ser alterados.

Para desabilitar o alerta, envie a seguinte solicitação:

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

A solicitação a seguir configura o alerta para excluir automaticamente os índices de histórico após sete dias, em vez dos 30 dias padrão:

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

Se você criou monitores anteriormente e deseja interromper a criação de índices de alertas diários, exclua todos os índices de histórico de alertas:

DELETE .plugins-alerting-alert-history-*

Para reduzir a contagem de fragmentos para índices históricos, crie um modelo de índice. A solicitação a seguir define índices de histórico para alertas em um fragmento e uma réplica:

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

Dependendo da sua tolerância à perda de dados, você pode até considerar o uso de réplicas zero. Para obter mais informações sobre criação e gerenciamento de modelos de índice, consulte Modelos de índice na documentação do OpenSearch.