Guia Configuração do Monitoring via API na Elven Platform

Com a funcionalidade de monitoramento via API da Elven Platform, seus servidores podem enviar dados diretamente para nossa API de forma prática, utilizando comandos cURL ou bibliotecas de comunicação HTTP. Essa integração dispensa a necessidade de instalar agentes, garantindo flexibilidade e agilidade na conexão dos seus serviços com nossa plataforma. Tudo isso para oferecer uma gestão mais precisa e eficiente dos seus recursos.

Essa abordagem permite que você configure alertas e incidentes automáticos com base nos sinais específicos da sua aplicação ou serviço. É como ter um “guarda-costas digital” sempre atento, pronto para avisar sua equipe sobre qualquer comportamento inesperado. Assim, você economiza tempo, evita interrupções e mantém o foco no que realmente importa: oferecer uma experiência impecável para seus usuários.

Acessando o Monitoring via API

Navegue até o menu principal e clique em Services Hub.

Em, Internet Services, selecione item Monitoring via API.

Configuração de Monitoramento por API

Comece configurando o monitoramento do seu recurso de forma prática e direta. Escolha um nome claro e descritivo para o recurso (Resource Name), que facilite a identificação no futuro. Isso ajuda a manter tudo organizado, especialmente se você gerencia múltiplos serviços.

Abertura de Alerta Automático de Timeout

A funcionalidade de Alerta Automático de Timeout permite que você configure limites específicos (thresholds) para monitorar o desempenho de um recurso. Caso o tempo limite de resposta (Timeout) definido seja ultrapassado, um alerta é disparado automaticamente, notificando as equipes responsáveis. Isso garante uma resposta rápida e proativa para problemas relacionados à indisponibilidade ou lentidão. Você pode personalizar a gravidade do alerta (Severity) e determinar o tempo máximo permitido antes de acionar a notificação. Além disso, é possível atribuir um time pré-definido de respondentes, garantindo que as pessoas certas sejam avisadas no momento certo. Essa funcionalidade é essencial para minimizar impactos e manter a qualidade do serviço. Ainda, selecione o time que será notificado sempre que um incidente ocorrer e ative a opção Enable to set up automatic alert timeout para garantir que a configuração esteja habilitada.

Abertura de Incidentes Automáticos

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.

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.

API Token

Para utilizar a API da Elven Platform e enviar sinais (Hit/Failure), é necessário criar um Token de API do tipo hits/failures. Esse token exclusivo garante uma comunicação segura entre as partes, proporcionando uma troca de informações autenticada e confiável. Para gerá-lo, basta acessar as Configurações da Organização na Elven Platform, procurar pela seção de API e criar um novo token.

Lembre-se de que, por questões de segurança, o token gerado tem um tempo de validade e precisa ser renovado periodicamente.

Criando um API Token

No menu superior na parte de configuração de seu usuário, clique em Organization Settings.
Na aba API, clique no botão + para criar um novo API Token

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.

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.

Application Opening Hours

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.

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.

Glossário de Termos Técnicos

API (Application Programming Interface): Conjunto de regras e protocolos que permite a comunicação entre diferentes sistemas e aplicações.

cURL: Ferramenta de linha de comando utilizada para transferir dados com URLs, frequentemente usada para interagir com APIs.

HTTP (Hypertext Transfer Protocol): Protocolo de comunicação utilizado na transferência de dados na web.

Resource Name: Nome claro e descritivo atribuído a um recurso monitorado, facilitando sua identificação futura.

Thresholds (Limites): Valores pré-definidos que, quando ultrapassados, acionam alertas ou notificações.

Timeout: Tempo limite de resposta definido para um recurso. Se o tempo de resposta exceder esse limite, um alerta é gerado.

Severity (Gravidade): Nível de urgência atribuído a um alerta ou incidente, permitindo priorização na resposta.

Check Interval: Intervalo de tempo, em segundos, entre as verificações de monitoramento de um recurso.

API Token: Código exclusivo gerado para autenticar e garantir a comunicação segura entre a API da Elven Platform e os servidores do usuário.

Hits/Failures: Sinais enviados para a API que indicam o sucesso (hit) ou falha (failure) de um recurso monitorado.

Maintenance Window: Período de manutenção planejada durante o qual as verificações de monitoramento são suspensas para evitar alertas desnecessários.

Application Opening Hours: Configuração que define os horários em que uma aplicação está ativa, permitindo personalizar o monitoramento e evitar notificações fora do horário de operação.

Incident: Evento que requer atenção e resposta, geralmente relacionado a problemas críticos que afetam o desempenho ou a disponibilidade de um serviço.

Automatic Alerts: Notificações que são geradas automaticamente com base em condições predefinidas, como limites de desempenho ou falhas.

Time(Team): Grupo de pessoas designadas para receber notificações sobre alertas ou incidentes, garantindo que as respostas sejam rápidas e eficazes.