# Guia Configuração do Monitor Elastic Search na Elven Platform

O **Monitor Elastic Search** da **Elven Platform** permite verificações baseadas em consultas chaves em índices do Elasticsearch. Essa funcionalidade ajuda a configurar verificações contínuas, definir alertas e criar limites para abertura de incidentes automáticos, garantindo que você seja informado rapidamente sobre quaisquer irregularidades na conectividade ou desempenho dos serviços. 

**Elasticsearch** é uma solução de busca e análise de dados altamente escalável e eficiente, projetada para processar grandes volumes de informações em tempo real. Ele permite indexar, pesquisar e visualizar dados com rapidez e precisão, sendo amplamente utilizado em casos de uso como monitoramento de logs, análise de dados de aplicação, busca em websites e muito mais. 

## **Acessando o Monitoramento Elastic Search**

* Navegue até o menu principal e clique em **Services Hub**. 
* Em **Search Engine**, selecione o item **Elastic Search**. 

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2Frjf5z9G9h9seWOY8lUPN%2Felatisearch01.png?alt=media&#x26;token=a9b1648b-60c1-4dcf-93a2-e9c47714be69" alt=""><figcaption></figcaption></figure>

## **Configuração do Monitoramento**

Monitorar a disponibilidade dos seus serviços nunca foi tão simples. Comece dando um nome claro ao recurso que deseja acompanhar (**Resource Name**) para facilitar a identificação. Depois, ajuste o intervalo entre as verificações (**Interval**) e o tempo limite para respostas (**Timeout**).    &#x20;

Selecione onde está o agente de monitoramento (**Checkpoint Cloud**), escolhendo Environment, se não existir você pode criar em **+ Checkpoint**.  Em seguida,escolha o **tipo de autenticação** no campo **Monitoring Type**. Aqui, você define como a Elven Platform vai se conectar ao Elasticsearch. Se o seu ambiente não exige autenticação, selecione **No Auth**. Mas, se ele estiver protegido por **usuário e senha**, ou se você utiliza **API Key** para autenticação, escolha a opção correspondente. Essas configurações garantem que a comunicação seja segura e personalizada para o seu ambiente.&#x20;

Depois disso, é hora de configurar o **Protocolo**, o **Host** e a **Porta**. Se o seu Elasticsearch estiver configurado para HTTPS, selecione essa opção para que as informações trocadas estejam protegidas por criptografia. No campo **Host**, insira o endereço do servidor, na **Porta**, coloque o número usado pelo seu serviço – o valor padrão é 9200, mas pode variar dependendo das configurações do seu ambiente. Esses dados são essenciais para que a Elven Platform encontre o seu Elasticsearch e estabeleça a conexão correta.&#x20;

Lembre-se de que estes campos de **Host**  aceita apenas **URLs**; caso precise utilizar um endereço **IP**, será necessário criá-lo em um **secret** para garantir a segurança e organização das informações.  &#x20;

Por fim, no campo **Index**, informe o nome do índice que deseja monitorar.. Isso permite que a Elven Platform foque exatamente nos dados que importam para você. Depois de preencher tudo, salve sua configuração e deixe a Elven Platform cuidar do resto. &#x20;

### Sem Autenticação

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FQ9N9iZMCBZ7bQJHFMvrf%2Felasticsearch02.png?alt=media&#x26;token=10798655-94bc-4181-8ee4-cc74152f7422" alt=""><figcaption></figcaption></figure>

### Autenticação com Usuário e Password

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FIpsZ2Iv4do6NoO2r9Tg1%2Felasticsearch03.png?alt=media&#x26;token=247ba245-01e5-49e4-acef-81266db46475" alt=""><figcaption></figcaption></figure>

### Autenticação por API Key

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FBVTKWvWNxotTiHQgzNba%2Felasticsearch04.png?alt=media&#x26;token=84a7ff83-4968-4e57-b507-2c3d0190f90c" alt=""><figcaption></figcaption></figure>

## **Abertura de Incidentes Automáticos**&#x20;

Você pode configurar a abertura automática de incidentes para garantir uma resposta rápida a problemas críticos. Para começar, defina a severidade do incidente, permitindo que você priorize de acordo com a urgência. Em seguida, ajuste o **Check Interval**, especificando o intervalo de checagem em segundos para monitorar continuamente o recurso. Isso ajuda a garantir que você esteja sempre um passo à frente, detectando problemas assim que eles surgem.  &#x20;

Além disso, selecione o time que será notificado sempre que um incidente ocorrer e ative a opção **Enable to set up automatic incidents opening** para garantir que a configuração esteja habilitada. Com essa configuração, a plataforma automatiza a gestão de incidentes, tornando o processo de resposta mais ágil e eficiente, sem a necessidade de intervenção manual. Isso garante que sua equipe esteja sempre pronta para resolver qualquer questão com rapidez e precisão.

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FkuPfDLIu0Bcg4stw1Vam%2Felasticsearch05.png?alt=media&#x26;token=ef4868e8-2f35-454a-9b14-320ebfbea58f" alt=""><figcaption></figcaption></figure>

## **Maintenance Window**

Ainda  temos **Maintenance Window** que é uma funcionalidade essencial para gerenciar períodos de manutenção planejada na sua aplicação. Durante esse intervalo, as verificações são temporariamente pausadas, evitando que o monitoramento, alertas e notificações sejam acionados enquanto você realiza ajustes ou atualizações. Isso permite que a manutenção ocorra de maneira tranquila, sem gerar notificações desnecessárias ou alarmes falsos, garantindo que sua operação siga de forma ordenada e sem interrupções inesperadas nos relatórios de desempenho.    \
&#x20;\
Por exemplo, imagine que você precise atualizar o sistema de pagamento de um e-commerce, realizando ajustes no backend, como a instalação de novos certificados de segurança. Para isso, você pode configurar a **Maintenance Window** para um horário específico, como 13/12/2024, das 14:00 às 14:30. Durante esse período, a Elven Platform suspende as verificações, evitando que o monitoramento registre falhas temporárias ou dispare alertas falsos. Assim, você consegue fazer as alterações necessárias com calma, sabendo que o sistema de monitoramento não será impactado durante a manutenção. Essa abordagem garante que a atualização seja feita de maneira organizada, sem afetar a experiência dos usuários ou gerar notificações indesejadas.&#x20;

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2Frk4IuoXDf1NVXmjexpm4%2Felasticsearch06.png?alt=media&#x26;token=d74299cf-9b7e-49e9-a979-55cf43a12e8d" alt=""><figcaption></figcaption></figure>

## **Application Opening Hours**&#x20;

Ainda, você pode contar com a funcionalidade **Application Opening Hours**, que permite configurar os horários de funcionamento da sua aplicação. Essa funcionalidade é essencial para personalizar o monitoramento com base nos períodos em que sua aplicação está realmente ativa, evitando alertas e notificações fora do horário de operação. Assim, o monitoramento se torna mais alinhado com as necessidades reais do seu negócio, garantindo relatórios mais precisos e uma gestão eficiente.   &#x20;

Por exemplo, imagine que sua aplicação funcione apenas de segunda a sexta-feira, das 09:00 às 18:00. Você pode configurar o **Application Opening Hours** para refletir esse horário, especificando os dias e períodos de funcionamento. Com isso, a Elven Platform desativa automaticamente as verificações fora desses horários, evitando registros de falhas que não afetam os usuários finais e prevenindo alertas desnecessários. Essa abordagem otimiza a análise de desempenho, focando somente nos períodos relevantes e proporcionando uma visão mais clara sobre a saúde da sua aplicação durante seu horário de operação.&#x20;

<figure><img src="https://1787513308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjv1RurNOS0w2Y9bpxizM%2Fuploads%2FyP0hJD4C3cRq13JVbj8b%2Felasticsearch07.png?alt=media&#x26;token=86f136ab-054d-4333-a153-3e648e0a0d88" alt=""><figcaption></figcaption></figure>

## **Glossário de Termos Técnicos**

**Elasticsearch:** O Elasticsearch é um mecanismo de busca e análise de código aberto, amplamente utilizado para armazenar, buscar e analisar grandes volumes de dados em tempo real. Ele é ideal para casos de uso como monitoramento de logs, análises de segurança, motores de busca personalizados e visualização de dados. O Elasticsearch permite consultas rápidas e escaláveis sobre grandes quantidades de informações estruturadas e não estruturadas, utilizando índices otimizados e uma linguagem de consulta poderosa (DSL). Com integração nativa a ferramentas como Kibana e Logstash, ele é parte essencial do Elastic Stack, fornecendo uma solução robusta para análise de dados em tempo real. \
&#x20;\
**Timeout:** Tempo limite para que o monitoramento receba uma resposta do recurso monitorado antes de registrar uma falha. **Checkpoint Cloud:** Local onde o agente de monitoramento está localizado, podendo ser um ambiente preexistente ou criado pelo usuário. &#x20;

**Monitoring Type:** Campo que permite definir o método de autenticação que a Elven Platform usará para se conectar ao Elasticsearch. As opções disponíveis são:&#x20;

* No Auth: Sem autenticação, para ambientes abertos.&#x20;
* User and Password: Autenticação baseada em usuário e senha.&#x20;
* API Key: Autenticação via chave de API, garantindo maior segurança em ambientes protegidos.&#x20;

**Protocolo:** Define o protocolo de comunicação entre a Elven Platform e o Elasticsearch. As opções são HTTP ou HTTPS, sendo o HTTPS recomendado para assegurar a criptografia dos dados transmitidos.&#x20;

**Host:** Campo onde deve ser inserido o endereço do servidor Elasticsearch. Ele aceita apenas URLs, garantindo organização e segurança. Caso precise utilizar um endereço IP, recomenda-se configurá-lo como um secret para maior segurança.&#x20;

**Porta:** Define o número da porta usada para acessar o serviço Elasticsearch. O valor padrão é 9200, mas pode variar conforme as configurações do ambiente.&#x20;

**Index:** Campo para especificar o nome do índice do Elasticsearch que será monitorado. Um índice é uma coleção de documentos no Elasticsearch, e esta configuração permite que a Elven Platform foque apenas nos dados relevantes.&#x20;

**Secret:** Recurso utilizado para armazenar informações sensíveis, como endereços IP ou credenciais, de forma segura e organizada dentro da plataforma. \
&#x20;\
**Enable to set up automatic incidents opening:** Opção que, quando ativada, habilita a abertura automática de incidentes na detecção de problemas críticos. &#x20;

**Severity (Severidade):** Grau de criticidade atribuído a um incidente, permitindo sua priorização conforme a urgência. &#x20;

**Check Interval:**  \
Intervalo de tempo, em segundos, para realizar verificações contínuas do recurso monitorado. &#x20;

**Maintenance Window:** Funcionalidade que pausa temporariamente o monitoramento, alertas e notificações durante os períodos de manutenção planejada. &#x20;

**Application Opening Hours:** Configuração que define os horários de funcionamento da aplicação, alinhando o monitoramento aos períodos ativos e evitando alertas fora desses horários.