Configurando alertas no Amazon Service OpenSearch

Configure alertas no Amazon OpenSearch Service para ser notificado quando os dados de um ou mais índices atenderem 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.

O alerta requer o Elasticsearch 6.2 OpenSearch 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 são diferentes dos alertas em um cluster de código aberto. OpenSearch Para obter a documentação completa de alertas, incluindo uma referência abrangente da API, uma lista dos campos de solicitação disponíveis para monitores compostos e descrições das variáveis de gatilho e ações disponíveis, consulte Alertas na documentação. OpenSearch

Permissões de alertas

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

Para acessar a página de alertas nos OpenSearch painéis, 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 uma programação definida e consulta OpenSearch índices. 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 Alertas no menu principal OpenSearch Painéis e escolha 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 Serviço precisa ser capaz de se conectar à Internet para notificar um canal do 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 OpenSearch de serviço envie 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 OpenSearch notificações. 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 uma documentação abrangente, consulte Notificações na OpenSearch documentação.

Seu domínio deve estar executando a OpenSearch versão 2.3 ou posterior para usar as notificações.

nota

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

Os canais de notificação substituíram os destinos de alerta a partir da OpenSearch versão 2.0. 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 2.3), seus destinos existentes são migrados automaticamente para os 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 OpenSearch documentação.

Para começar a usar as notificações, faça login nos OpenSearch painéis e escolha Notificações, Canais e Criar canal.

Amazon Simple Notification Service (Amazon SNS) é um tipo de canal compatível com 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 têm algumas diferenças notáveis.

Configurações de alertas

OpenSearch O serviço permite que você modifique as seguintes configurações de alerta:

• 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 do 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 do histórico de alertas:

DELETE .plugins-alerting-alert-history-*

Para reduzir a contagem de fragmentos dos índices de histórico, 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 como criar e gerenciar modelos de índice, consulte Modelos de índice na OpenSearch documentação.