Importante
A partir de 26 de agosto de 2024, você não poderá mais criar novos monitores usando tempos de execução legados em locais públicos ou privados.
No dia 22 de outubro de 2024, encerraremos a vida útil das versões conteinerizadas minion privado (chamadas por minuto) e legado runtime do Synthetics. Para localização pública, use a interface de atualização de tempo de execução para atualizar seu monitor para os tempos de execução mais recentes. Para localização privada, revise nossas etapas de migração recomendadas para evitar a degradação monitor .
Use testes de API de monitoramento sintético para monitor seus endpoints de API e garantir que estejam funcionando corretamente. A New Relic usa o módulo http-request internamente para fazer chamadas HTTP para seu endpoint e validar os resultados.
Consulte os [exemplos de tempo de execução API do Node 16.10 ou mais recente](Detalhes para escrever o script do tempo de execução do Node 16.10 para criar o monitor usando nosso tempo de execução mais recente do Synthetics.
Apresentamos aqui alguns exemplos de funções que mostram como usar o objeto $http
para enviar sua solicitação. Para obter documentação detalhada sobre as opções disponíveis para este objeto, consulte o readme da solicitação http. (Observe que Request está obsoleto, mas essas opções ainda se aplicam.)
Dica
Para visualizar e compartilhar outros exemplos de testes de API, visite a seção de script Sintético do Fórum de Suporte ou a biblioteca de início rápido de monitoramento sintético.
Use o módulo de solicitação http da API
Os testes de API são desenvolvidos pelo módulo http-request , que está disponível por meio do objeto $http
. A cada intervalo de frequência, a New Relic consulta seu endpoint em cada um dos locais selecionados. Para obter instruções sobre como criar um monitor, consulte Adicionando monitores.
Continue lendo para saber como definir metadados para sua solicitação, fazer uma solicitação GET, fazer uma solicitação POST e como validar os resultados.
Importante
Após um tempo de execução máximo de três minutos, o New Relic interrompe manualmente o script.
one.newrelic.com > Synthetic monitoring > Create monitor: o editor script sugere funções, seletores e outros elementos para simplificar comandos de script (disponíveis no GitHub).
Configurar opções de solicitação
Para iniciar seu script:
- Declare uma variável (como
options
) para armazenar seu objeto de opções de solicitação. - Defina opções de solicitação, como endpoint de URL e cabeçalhos personalizados.
- Se você estiver configurando opções de SSL ou de agente, consulte Requisitos de SSL e AgentOptions. Recomendamos o uso de SSL para evitar a exposição de credenciais de texto simples em seus cabeçalhos.
Dica
Para obter uma lista completa de opções de solicitação compatíveis, consulte request(options, retorno de chamada) na documentação http-request
no GitHub.
Aqui está um exemplo de metadados opcionais no objeto de opções:
For SSL and agentOptions: Se você estiver configurando opções de SSL ou fornecendo um objeto agentOptions
, a propriedade agent
no objeto de solicitação options
precisará ser definida como $globalAgents.https
ou $globalAgents.http
para garantir que suas solicitações HTTP usem o agente global instrumentado.
Aqui está um exemplo de uso de uma opção SSL ou agentOptions
:
Envie uma solicitação GET
Para fazer uma solicitação GET, use o método $http.get
para enviar sua solicitação. Defina suas opções de solicitação, faça sua solicitação usando $http.get
e valide a resposta para garantir que seu endpoint esteja retornando os resultados corretos.
Envie uma solicitação POST
Para fazer uma solicitação POST, use o método $http.post
para enviar sua solicitação. Defina suas opções de solicitação, faça sua solicitação usando $http.post
e valide a resposta para garantir que seu endpoint esteja retornando os resultados corretos.
Validar resultados
Para validar seus resultados, importe o módulo assert
para definir seu caso de teste. Chame um método assert
para validar a resposta do seu endpoint. Se alguma função assert
falhar, todo o monitor será considerado uma verificação com falha. Isto pode acionar a notificação de alerta e afetar sua métrica.
Importante
O monitoramento sintético não permite exceções lançadas. Exceções lançadas resultam em falha de script. Use o módulo assert
para validar seus resultados e use console.log()
para log os resultados no console do Sintético.