Esta seção auxilia desenvolvedores de software que desejam desenvolver aplicativos usando ferramentas de monitoramento Dotcom-Monitor.
Existem várias maneiras de visualizar e interagir com dados de monitoramento além da interface do site Dotcom-Monitor, incluindo o uso do feed XML para consumir dados e interagir com a API do Dotcom-Monitor para monitorar e atualizar os agentes de monitoramento instalados.
Com o feed XML, os desenvolvedores podem subscrever os dados desejados e apresentá-los em seu próprio formato usando seus próprios relatórios personalizados. Consulte Usando a ferramenta XML Reporting Service (XRS) para obter detalhes.
Os usuários de API Dotcom-Monitor podem criar seus próprios scripts ou aplicativos personalizados para interagir com as configurações e visualizar os dados monitorados em seu próprio ambiente personalizado. Nosso sistema usa a API REST que permite a interação com o site do Dotcom-Monitor programáticamente usando os métodos mais populares para trabalhar com dados através de solicitações HTTP(S) (GET, POST, PUT, DELETE). Quase todos os objetos do Dotcom-Monitor podem ser acessados via API REST e quase todos os aspectos da funcionalidade de serviço Dotcom-Monitor podem ser gerenciados. Usando chamadas de API, os desenvolvedores podem criar e remover dispositivos e tarefas, adiar e iniciá-los, criar e gerenciar grupos de alerta, modelos, filtros e agendadores, obter informações de status do dispositivo, além de muitas outras opções.
Em geral, a API Dotcom-Monitor pode ser usada nas seguintes tarefas:
- Integração de terceiros com a solução Dotcom-Monitor Monitoring.
- Download e upload de dados.
- Modificação de dados.
As ações mais comuns executadas através da API REST:
- Acessando listas de plataformas de monitoramento, dispositivos, alvos, agendadores, locais, grupos de alerta, filtros, modelos de alerta.
- Acessando informações detalhadas em plataformas, dispositivos e alvos.
- Editando dispositivos, alvos, agendadores, grupos de alerta e modelos, filtros.
- Criando um novo objeto dotcom-Monitor (dispositivos, alvos, agendadores, etc.).
- Gerenciamento de objetos de auditoria.
API de colecionador personalizado
A API MetricsView separada é um conjunto de métodos para carregar quaisquer métricas de qualquer fonte, independentemente de uma plataforma no Dotcom-Monitor inc. para processamento e análise posteriores.
A API do Dotcom-Monitor é dividida em 10 tipos de recursos:
- Plataforma: Todas as tarefas de monitoramento caem em uma das cinco plataformas diferentes.
- Dispositivos: Um dispositivo monitorado é um “conjunto” organizado de tarefas de monitoramento que contém uma única tarefa de monitoramento, uma sequência de tarefas de monitoramento, um script de monitoramento que inclui tarefas ou uma combinação de todas as três.
- Tarefas: Uma tarefa é qualquer atividade de monitoramento único, como monitorar um alvo (URL, Mail Server, FTP Server, etc.).
- Frequência: Define com que frequência as sessões de monitoramento serão executadas.
- Agendador: Um agendador detalha quando uma tarefa será ou não executada.
- Localização: Um local de monitoramento disponível dentro da rede mundial de monitoramento Dotcom-Monitor.
- Grupo de Alerta: A criação de um grupo coloca os destinatários de um relatório e/ou alerta em um grupo. Cada destinatário do grupo pode ter um modelo de alerta exclusivo.
- Modelo de alerta: O modelo define o formato de alertas.
- Filtro: Um filtro é um conjunto de regras, que determinam como as respostas de monitoramento são processadas e exibidas.
- Auditoria: Fornece informações históricas sobre qualquer modificação de conta.
Você precisa ser autenticado no Dotcom-Monitor antes de qualquer solicitação de API. A autenticação expira após 60 segundos de inatividade.
A tabela abaixo mostra qual tipo de solicitação e ação são suportadas por cada tipo de recurso. Consulte a seção Métodos de Monitoramento para obter descrições detalhadas.
| Tipo de recurso | Método de solicitação | URI(s) | descrição |
|---|---|---|---|
| plataforma | Obter | /plataformas | Lista de retorno das plataformas disponíveis |
| dispositivo | Obter | /dispositivos/{platform} | Obtenha lista de dispositivos por plataforma. |
| Obter | /dispositivo/{deviceId} | Obter informações do dispositivo | |
| Postar | /dispositivos?verb=PUT | Criar novo dispositivo | |
| pôr | /dispositivos | ||
| Postar | /dispositivo/ {deviceId} /DesativarAlert/ | Desativar alertas | |
| Postar | /dispositivo/{deviceId} | Editar dispositivo | |
| Postar | /dispositivo/ {deviceId} ?verb=delete | Excluir dispositivo | |
| excluir | /dispositivo/{deviceId} | ||
| tarefa | Obter | /dispositivo/ {deviceid} /tarefas | Obtenha lista de tarefas sob um dispositivo |
| Postar | /tasks?verb=PUT | Criar uma nova tarefa | |
| pôr | /tarefas | ||
| Obter | /tarefa/{TaskId} | Obter informações da tarefa | |
| Postar | /tarefa/{TaskId} | Editar tarefa | |
| Postar | /tarefa/ {TaskId} ?verb=delete | Excluir tarefa | |
| excluir | /tarefa/{TaskId} | ||
| frequência | Obter | /frequências/{platform_name} | Fique disponível freq. por plataforma. |
| Agendador | Obter | /agendadores | Obter lista de agendadores |
| Obter | /Agendador/{Scheduler_ID} | Obtenha informações específicas do programador | |
| Postar | /agendadores?verb=PUT | Criar novo agendador | |
| pôr | Agendadores | ||
| Postar | /scheduler/{ scheduler ID} | Editar agendador | |
| Postar | /Agendador/ {Scheduler_Id} ?verb=delete | Excluir agendar | |
| excluir | /Agendador/{Scheduler_Id} | ||
| localização | Obter | /localizações/{platform_name} | Obtenha lista de locais disponíveis |
| Grupo de Alerta | Obter | /grupos | Obtenha lista de grupos de alerta |
| Postar | /groups?verb=PUT/groups | Criar grupo de alerta | |
| pôr | grupos/grupos | ||
| Obter | /Grupo/{Group_ID} | Obter informações do grupo de alerta | |
| Postar | /Grupo/{Group_ID} | Editar grupo de alerta | |
| Postar | /Grupo/ {Group_Id} ?verb=delete | Excluir grupo | |
| excluir | Grupo/{Group_Id} | ||
| Modelo de alerta | Obter | /modelos | Obtenha lista de modelos de alerta |
| Postar | /modelos?verb=PUT/templates | Criar novo modelo de alerta | |
| pôr | /modelos/modelos | ||
| Obter | /modelo/{Template_ID} | Obter informações sobre modelo de alerta | |
| Postar | /modelo/{Template_ID} | Editar modelo de alerta | |
| Postar | /modelo/ {Template_Id} ?verb=delete | Excluir modelo | |
| excluir | /modelo/{Template_Id} | ||
| filtro | Obter | /filtros | Obter lista de filtros |
| Postar | /filtros?verb=PUT | Criar novo filtro | |
| pôr | /filtros | ||
| Obter | /filtro/{filter_ID} | Obtenha informações específicas do filtro | |
| Postar | /filtro/{filter_ID} | Editar filtro | |
| Postar | /filtro/ {filter_ID} ?verb=delete | Excluir filtro | |
| excluir | /filtro/{filter_ID} | ||
| auditoria | Obter | /auditoria/lista | Obtenha lista de objetos auditados para o usuário atual para as últimas 24h. |
| Obter | /auditoria/objeto/{ID de amostra} | Obtenha conteúdo de auditoria para o ID específico | |
| Postar | /auditoria/lista | Obtenha lista filtrada de objetos auditados. |
-
Web API Monitoring: How to Start and What Approach to Use
Antes de começarmos com o tópico de monitoramento da API da Web, vamos falar brevemente sobre as abordagens que são comumente usadas para trocar dados entre diferentes tipos de software.
É difícil imaginar uma empresa moderna onde todos os processos de negócios estão sendo executados em um único produto de software. Geralmente, existem vários aplicativos de desktop e web usados para suportar operações de negócios durante todo o seu ciclo de vida. Alguns aplicativos fora da caixa são capazes de interagir com produtos de software relacionados, enquanto outros precisam de alguma configuração adicional ou serviços de terceiros. Por exemplo, as práticas comuns que foram introduzidas no mercado de software para apoiar a integração de software são:
- Serviços web.
- Troca de arquivos via FTP.
- Pedidos HTTP não estruturados.
- Outras abordagens, como tomadas web, portas dedicadas, etc.
Embora todas as outras abordagens de integração de software não tenham processos padronizados de troca de dados, os serviços web fornecem uma forma padronizada de integração. Um serviço web é uma tecnologia que permite que os aplicativos se comuniquem entre si por uma rede. Simplificando, um serviço web é um endereço na Internet, um link que pode ser acessado para obter dados ou realizar uma ação. Normalmente, os serviços web que atropelam http são chamados de API da Web. A vantagem de usar http como um protocolo de transporte é que ele torna os serviços web independentes de linguagens de programação. No caso dos serviços web, o cliente que faz a solicitação ao recurso e ao servidor API que fornece a resposta pode usar qualquer linguagem de programação ou estrutura. Dessa forma, não importa se as aplicações que queremos conectar são desenvolvidas usando as mesmas linguagens de programação ou não.
As APIs web geralmente são implementadas usando as seguintes tecnologias:
- XML-RPC (eXtensible Markup Language Remote Procedure Call) – o protocolo que usa HTTP como protocolo de transporte e XML para codificar chamadas.
- JSON-RPC (JSON Remote Procedure Call) – um análogo de XML-RPC exceto que as mensagens são transferidas no formato JSON.
- SOAP (Simple Object Access Protocol) – o protocolo padronizado que usa WSDL (Web Services Description Language) baseado em XML para descrever uma estrutura de mensagem.
- REST (Representational State Transfer) – não um protocolo, mas uma arquitetura de interação de software em uma rede baseada nos métodos do protocolo HTTP.
- Protocolos especializados projetados para trabalhar em uma tarefa específica, como o GraphQL, que é usado para criar uma consulta a um servidor de API e carregar dados dessa API para um aplicativo cliente.
O que é o monitoramento da API?
Uma vez que você implementou uma API web para o seu aplicativo e considere ir a público, você precisa ter certeza de que todas as funções de API funcionam de acordo com a lógica de negócios do seu aplicativo. Além disso, manter o controle sobre o desempenho da API da Web é crucial, independentemente se você é um consumidor do serviço de API ou você mesmo fornece o serviço para aplicativos de terceiros. Qualquer degradação no desempenho do serviço de API pode causar perdas significativas para empresas relacionadas e afetar a experiência de seus usuários.
O principal objetivo do Monitoramento de API é encontrar e corrigir proativamente todos os erros dentro de sua API à medida que ocorrem e mesmo antes que seus usuários os notem.
Por que precisamos monitorar a API do seu aplicativo ou site? Por que o teste de interface do usuário não é suficiente para ter certeza de que seu aplicativo web funciona corretamente? O teste de interface do usuário é realmente a melhor maneira de simular o comportamento real do usuário (veja as vantagens do teste de aplicativos da Web em um navegador real com a Ferramenta de Scripting Dotcom-Monitor EveryStep). No entanto, a funcionalidade do site que tendemos a monitorar através da Interface do Usuário geralmente já pode ser verificada por testes de monitoramento de API. Por exemplo, uma chamada de API que carrega a lista de itens em estoque na loja online foi alterada no back-backend, mas permaneceu a mesma na Interface do Usuário e o sistema não retornará a lista sobre a ação correspondente do usuário no site. Neste caso, o monitoramento da interface do usuário retornará o erro, mas a verdadeira fonte do erro não será detectada (pode ser um problema de conectividade, sobrecarga de servidor, erros de interface do usuário, chamada de API incorreta, etc.). Por outro lado, o monitoramento da API da Web mostrará que a chamada para o ponto final da API de destino não retorna a resposta. Para verificação adicional do resultado da chamada de API, a validação do conteúdo de resposta pode ser usada.
Como funciona o monitoramento da API?
O monitoramento da API web se concentra em recursos e acesso a esses recursos. Na API web, os recursos apresentam diferentes tipos de informações. Os recursos podem ser acessados através de URLs (Localizadores de Recursos Uniformes). Quando você navega para uma URL específica no seu navegador, você se conecta ao recurso que corresponde a essa URL. O mesmo acontece quando você envia uma solicitação de API para um endereço url do recurso de tais aplicativos como Carteiro ou usando CURL. Para deixar claro para o serviço web que ação que você deseja executar no recurso, os métodos HTTP são usados incluindo GET (read), POST (create), PUT (update) e DELETE (delete). Consulte REST Payload – Como empurrar para a API da Web para obter uma explicação detalhada sobre como usar o Dotcom-Monitor para monitorar APIs RESTful.
Cada solicitação será seguida por uma resposta do servidor API. A resposta são os dados que são devolvidos da API em resposta à solicitação. As respostas podem retornar dados diferentes, incluindo um objeto JSON.
Todo o caminho para o recurso que inclui os parâmetros de solicitação e fornece acesso ao recurso é chamado de ponto final de API da Web. Por exemplo, o ponto final para enviar uma chamada de API pode ser assim:
http://example.com/wp-json/wp/v2/tests
Simplificando, os pontos finais são o que verificamos ao executar chamadas de monitoramento de API da Web para nossos sites e aplicativos. Em geral, as etapas de monitoramento do ponto final da API incluem:
- Solicite um ponto final.
- Resposta do servidor API.
- Verificação e análise de resposta.
Benefícios do uso do Dotcom-Monitor como sua ferramenta de monitoramento de API
O Dotcom-Monitor é uma solução abrangente que pode ser usada para todos os tipos de monitoramento de API da Web (veja como configurar o Monitoramento de Serviços Web soap e o monitoramento de API da Web REST). Além do monitoramento da API, o Dotcom-Monitor fornece ferramentas de monitoramento para aplicativos web, sites, páginas web únicas, servidores web e outros tipos de recursos web.
Para levar o processo de monitoramento a um novo nível, o Dotcom-Monitor permite que os usuários testem seus aplicativos da Web de destino em uma janela real do navegador. Os testes baseados no navegador garantem que o teste de monitoramento seja executado o mais próximo possível de um cenário da vida real e repita a experiência real do usuário. Você pode escolher entre uma série de mecanismos de navegador para executar seu aplicativo ou site em incluindo motores de desktop e navegador móvel.
Relatórios de desempenho detalhados com gráficos de cachoeira elemento por elemento, capturas de tela e vídeo gravados enquanto as sessões de monitoramento dão a você uma compreensão completa sobre o que exatamente acontece atrás da cena da interface do usuário – quais elementos retardam sua aplicação e causam os erros e gargalos em seu desempenho.
O sistema de alerta Dotcom-Monitor altamente personalizado fornece um serviço eficiente de notificação de alerta. O sistema pode ser configurado para enviar notificações de alerta para os endereços dedicados quando erros são detectados durante o monitoramento. Consulte os mecanismos de alerta suportados no artigo Mecanismos de Alerta-Entrega da nossa Base de Conhecimento.