Luego de configurar su infraestructura de monitoreo, puede emplear consulta para recuperar información sobre su entidad Sintética. consulta realiza requests para obtener datos sobre monitores, ubicación privada, credenciales y tiempo de inactividad. Este tutorial proporciona ejemplos de cómo emplear la API de NerdGraph para consultar datos de monitoreo sintético.
Sugerencia
Quick Navigation: utilice los enlaces a continuación para ir a tipos de consulta específicos:
- Consultas generales de monitores: consultar todos los monitores o tipos específicos
- Consultas específicas del monitor: recupere el script de un monitor de script, o los pasos ordenados de un monitor de pasos
- Soporte para consultas de entidades: consulta de ubicaciones privadas, protección de credenciales y monitoreo de tiempos de inactividad
- Consultas avanzadas: mapear los ID de monitores legacy y comprobar el estado de actualización del entorno de ejecución
Para conocer capacidades de consulta adicionales disponibles para su entidad Sintética, consulte el tutorial API de entidad de NerdGraph.
Consultas generales de monitor
Esta consulta recupera todos los monitores Sintético en su cuenta, devolviendo información esencial, incluido el GUID del monitor, el nombre, el ID de la cuenta, el tipo de monitor y la etiqueta asociada. La etiqueta contiene detalles de configuración adicionales y metadatos sobre cada monitor.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La búsqueda consulta para filtrar entidad. Emplee
para recuperar todos los monitores Sintético. |
Consulta de muestra
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR'") { results { entities { ... on SyntheticMonitorEntityOutline { guid name accountId monitorType tags { key values } } } } } }}Consultas de soporte de entidades
Esta consulta recupera todas las ubicaciones privadas de su cuenta y devuelve información esencial, incluido el GUID de la ubicación, el nombre, el ID de la cuenta y la etiqueta asociada. La ubicación privada le permite monitorear la aplicación detrás de su firewall, y se puede acceder a sus detalles de configuración a través de la etiqueta.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La búsqueda consulta para filtrar entidad. Emplee
para recuperar toda la ubicación privada. |
Consulta de muestra
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'") { results { entities { accountId guid name tags { key values } } } } }}Esta consulta recupera todo el tiempo de inactividad del monitor en su cuenta y devuelve información esencial, incluido el GUID del tiempo de inactividad, el nombre, el ID de la cuenta y la etiqueta asociada. Los monitores de tiempo de inactividad son periodos programados en los que los monitores Sintético dejan de funcionar, útiles durante mantenimientos planeados o interrupciones conocidas. Los detalles de configuración, como el tipo de programación, la zona horaria y los patrones de recurrencia, se almacenan en la etiqueta.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La búsqueda consulta para filtrar entidad. Emplee
para recuperar todo el tiempo de inactividad del monitor. |
Consulta de muestra
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'") { results { entities { accountId guid name tags { key values } } } } }}Esta consulta recupera todas las credenciales seguras de su cuenta y devuelve información de metadatos, incluido el GUID de la credencial, el nombre, el ID de la cuenta, la etiqueta y timestamp de la última actualización. Las credenciales seguras ayudan a almacenar, proteger y gestionar de forma centralizada información confidencial, como contraseñas, claves de API o certificados codificados. Por razones de seguridad, la consulta de credenciales seguras solo devuelve metadatos, pero no los valores de las credenciales reales.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La búsqueda consulta para filtrar entidad. Emplee
para recuperar todas las credenciales seguras. |
Consulta de muestra
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'SECURE_CRED'") { results { entities { ... on SecureCredentialEntityOutline { accountId guid name tags { key values } updatedAt } } } } }}Consultas específicas del monitor
Esta consulta recupera el contenido del script usado en una API con script o en un monitor de browser con script. El script contiene el código JavaScript que define el comportamiento del monitor, como llamadas API, interacciones del navegador o lógica de validación personalizada. Esta consulta solo funciona con tipos de monitores de script: otros tipos de monitores (simple, ping, de pasos, verificación de certificados, enlaces rotos) devolverán un error, ya que no utilizan scripts personalizados.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
(cuenta) | Entero | Sí | El ID de la cuenta de New Relic que contiene el monitor. |
| Cadena | Sí | El GUID de entidad única del monitor con script cuyo script desea recuperar. |
Consulta de muestra
{ actor { account(id: ACCOUNT_ID) { synthetics { script(monitorGuid: "ENTITY_GUID") { text } } } }}Esta consulta recupera los pasos configurados para un monitor de pasos. Los monitores de pasos proporcionan un monitoreo basado en navegador, de varios pasos y sin código a través de una secuencia de acciones predefinidas como navegación, clics, entradas de formulario y aserciones. Cada paso tiene una posición ordinal, un tipo que define la acción y valores que contienen los datos de configuración del paso. Esta consulta solo funciona con monitores de pasos: otros tipos de monitores devolverán un error ya que no utilizan una configuración basada en pasos.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
(cuenta) | Entero | Sí | El ID de la cuenta de New Relic que contiene el monitor. |
| Cadena | Sí | El GUID de entidad única del monitor de pasos cuyos pasos desea recuperar. |
Consulta de muestra
{ actor { account(id: ACCOUNT_ID) { synthetics { steps(monitorGuid: "ENTITY_GUID") { ordinal type values } } } }}Consultas avanzadas
Esta consulta recupera el GUID de entidad para un monitor Sintético empleando el ID del monitor. Esto es útil cuando tiene el ID de monitor numérico legacy y necesita convertirlo al formato GUID de entidad requerido para la mayoría de las operaciones de NerdGraph. El GUID de entidad es el identificador moderno empleado para actualizaciones, eliminaciones y otras tareas de administración del monitor, mientras que el ID del monitor es el identificador numérico más antiguo que puede aparecer en las URL o en la integración legacy.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La consulta de búsqueda para encontrar el monitor. Use
donde
es el ID numérico del monitor que desea encontrar. |
Consulta de muestra
{ actor { entitySearch(query: "(domainId = 'MONITOR_ID')") { results { entities { ... on SyntheticMonitorEntityOutline { guid name monitorId } } } } }}Esta consulta recupera el estado de todas las pruebas de actualización en tiempo de ejecución para los monitores de tiempo de ejecución legacy en su cuenta. Estas pruebas validan si los monitores que emplean entornos de ejecución más antiguos (como Chrome 72 o Node.js API legacy) pueden ejecutar correctamente en entornos de ejecución más nuevos (Chrome 100+ o Node.js 16.10). Los resultados completan la UIde actualizaciones en tiempo de ejecución y lo ayudan a identificar qué monitores están listos para la actualización. El resultado de la prueba se almacena en la etiqueta validationStatus y, si la prueba de actualización falló, la información detallada del error está disponible en la etiqueta validationError.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La búsqueda consulta para filtrar entidad. Emplee
para recuperar todos los resultados de pruebas de actualización en tiempo de ejecución. |
Consulta de muestra
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'") { results { entities { accountId guid name tags { key values } } } } }}Esta consulta recupera el estado de una prueba de actualización en tiempo de ejecución para un monitor de tiempo de ejecución legacy específico empleando el ID del monitor. Esto es útil cuando desea verificar la preparación para la actualización de un monitor en individuo en lugar de todos los monitores de su cuenta. La prueba valida si el monitor puede ejecutar correctamente en entornos de ejecución más nuevos y estos resultados completan la UIde actualizaciones de entornos de ejecución. El resultado de la prueba se almacena en la etiqueta validationStatus y, si la prueba de actualización falló, la información detallada del error está disponible en la etiqueta validationError.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | La consulta de búsqueda para filtrar entidades. Use
donde
es el ID numérico del monitor específico. |
Consulta de muestra
{ actor { entitySearch( query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'" ) { results { entities { accountId guid name tags { key values } } } } }}