Importante
Este documento está dirigido al tiempo de ejecución de API con script de Node.js 16.10 y versiones posteriores. Detalles para los tiempos de ejecución de Node.js 10 y anteriores basados en http-request
El monitor de API con secuencia de comandos verifica los extremos de API para asegurarse de que estén funcionando correctamente. Para crear un monitor API con secuencia de comandos, vaya a one.newrelic.com > Synthetic monitoring > Create a monitor y luego seleccione el icono Endpoint availability .
Sugerencia
Para ver y compartir otros ejemplos de pruebas de API, visite la sección de scripts de Sintético en el Foro de soporte o la biblioteca de inicios rápidos de Synthetic Monitoring.
Utilice el módulo API obtenido
Las pruebas de API funcionan con el módulo got, que está disponible a través del objeto $http
. El objeto $http
proporciona una experiencia personalizada similar a la request
con got
, lo que le brinda a su monitor compatibilidad con versiones anteriores para casos de uso básicos. La experiencia similar a request
proporcionada por el objeto $http
también se devolverá para cualquier cliente que intente usar request
directamente en Node.js 16 y tiempos de ejecución de API con script más recientes.
Se proporcionarán detalles sobre el tiempo de los resultados siempre que utilice el objeto $http
. Para casos de uso de API con secuencias de comandos que no están cubiertos por el objeto $http
, puede utilizar el objeto $har
para informar detalles de tiempo personalizados.
Importante
Después de un tiempo de ejecución máximo de tres minutos, New Relic detiene manualmente el script.
one.newrelic.com > Synthetic monitoring > Create monitor: El editor script sugiere funciones, selectores y otros elementos para simplificar los comandos del script (disponibles en GitHub).
Configurar opciones de solicitud
Para iniciar su script:
- Declare una variable (como
options
) para almacenar su objeto de opciones obtenidas. - Defina opciones de solicitud como el extremo de la URL y encabezados personalizados.
Sugerencia
Para obtener una lista completa de las opciones admitidas, consulte las opciones obtenidas en la documentación got
en GitHub.
A continuación se muestra un ejemplo de metadatos opcionales en el objeto de opciones:
Enviar una solicitud GET
Para realizar una solicitud GET, utilice el método $http.get
para enviar su solicitud. Defina las opciones de su solicitud, realice su solicitud usando $http.get
y luego valide la respuesta para asegurarse de que su extremo devuelva los resultados correctos.
Enviar una solicitud POST
Para realizar una solicitud POST, utilice el método $http.post
para enviar su solicitud. Defina las opciones de su solicitud, realice su solicitud usando $http.post
y luego valide la respuesta para asegurarse de que su extremo devuelva los resultados correctos.
Validar resultados
Para validar sus resultados, importe el módulo assert
para definir su caso de prueba. Llame a un método assert
para validar la respuesta de su extremo. Si alguna de las funciones assert
falla, todo el monitor se considerará una verificación fallida. Esto puede activar una notificación de alerta y afectar su métrica.
Importante
Monitoreo sintético no permite excepciones lanzadas. Las excepciones lanzadas provocan un error en el script. Utilice el módulo assert
para validar sus resultados y utilice console.log()
para log los resultados en la consola de Sintético.
Si aún no lo ha hecho, cree su cuenta New Relic gratuita a continuación para comenzar a monitorear sus datos hoy.