Après avoir configuré votre infrastructure monitoring, vous pouvez utiliser une requête pour récupérer des informations sur votre entité Synthétique. Les requêtes effectues des requests pour récupérer des données sur le moniteur, le site privé, les informations d'identification et le temps d'arrêt. Ce tutoriel fournit des exemples d'utilisation de l'API NerdGraph pour interroger des données synthétiques monitoring.
Conseil
Quick Navigation: utilisez les liens ci-dessous pour accéder à des types de requêtes spécifiques :
- Requêtes générales de monitorer: requête de tous les monitorer ou de types spécifiques
- Requêtes spécifiques au monitorer: récupérer le script d'un monitorer scripté, ou les étapes ordonnées d'un monitorer par étapes
- Prise en charge des requêtes d’entité: requêter les sites privés, sécuriser les identifiants, et monitorer les temps d’arrêt
- Requêtes avancées: mapper les ID de monitorer legacy et vérifier le statut de mise à niveau du runtime
Pour découvrir les fonctionnalités de requête supplémentaires disponibles pour votre entité Synthétique, consultez le didacticiel API de l'entité NerdGraph.
Requêtes générales pour monitorer
Cette requête récupère tous les moniteurs Synthétique de votre compte, en renvoyant les informations essentielles, notamment le GUID du moniteur, son nom, l'ID du compte, le type de moniteur et l'étiquette associée. L'étiquette contient des détails configuration supplémentaires et des métadonnées sur chaque moniteur.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer l'entité. Utilisez
pour récupérer tous les moniteurs Synthétique. |
Exemple de requête
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR'") { results { entities { ... on SyntheticMonitorEntityOutline { guid name accountId monitorType tags { key values } } } } } }}Requêtes de prise en charge des entités
Cette requête récupère tous les sites privés de votre compte, en renvoyant les informations essentielles, notamment le GUID du site, son nom, l'identifiant du compte et l'étiquette associée. Les sites privés vous permettent de monitorer les applications derrière votre pare-feu, et leurs détails configuration sont accessibles via la balise.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer l'entité. Utilisez
pour récupérer tous les sites privés. |
Exemple de requête
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'PRIVATE_LOCATION'") { results { entities { accountId guid name tags { key values } } } } }}Cette requête récupère tous les temps d'arrêt de monitoring de votre compte, en renvoyant les informations essentielles, notamment le GUID du temps d'arrêt, son nom, l'ID du compte et l'étiquette associée. Les monitorer temps d'arrêt sont des périodes programmées pendant lesquelles le moniteur Synthétique s'arrête de fonctionner, utiles lors de la maintenance planifiée ou de pannes connues. Les détails de configuration tels que le type de planification, le fuseau horaire et les modèles de récurrence sont stockés dans l'étiquette.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer l'entité. Utilisez
pour récupérer tous les temps d'arrêt du moniteur. |
Exemple de requête
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'MONITOR_DOWNTIME'") { results { entities { accountId guid name tags { key values } } } } }}Cette requête récupère toutes les informations d'identification sécurisées de votre compte, en renvoyant les métadonnées, notamment le GUID de l'identifiant, son nom, l'identifiant du compte, son étiquette et sa date de dernière mise à jour. Les identifiants sécurisés permettent de stocker, de protéger et de gérer de manière centralisée des informations sensibles telles que les mots de passe, les clés API ou les certificats chiffrés. Pour des raisons de sécurité, l'interrogation des identifiants sécurisés ne renvoie que les métadonnées, et non les valeurs des identifiants eux-mêmes.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer l'entité. Utilisez
pour récupérer toutes les informations d'identification sécurisées. |
Exemple de requête
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'SECURE_CRED'") { results { entities { ... on SecureCredentialEntityOutline { accountId guid name tags { key values } updatedAt } } } } }}Requêtes spécifiques aux monitors
Cette requête récupère le contenu du script utilisé dans une API scriptée ou un moniteur de navigateur scripté. Le script contient le code JavaScript qui définit le comportement du monitor, comme les appels d'API, les interactions avec le navigateur ou la logique de validation personnalisée. Cette requête ne fonctionne qu'avec les types de monitorer scriptés : les autres types de monitorer (simple, ping, step, certificate check, broken links) renverront une erreur car ils n'utilisent pas de scripts personnalisés.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
(compte) | Entier | Oui | L'identifiant du compte New Relic qui contient le moniteur. |
| Chaîne | Oui | L'identifiant unique GUID de l'entité du moniteur scripté dont vous souhaitez récupérer script. |
Exemple de requête
{ actor { account(id: ACCOUNT_ID) { synthetics { script(monitorGuid: "ENTITY_GUID") { text } } } }}Cette requête récupère les étapes configurées pour un monitor d'étape. Les outils pour monitorer par étapes fournissent un monitoring basé sur le navigateur, sans code, et à plusieurs étapes, grâce à une séquence d'actions prédéfinies telles que la navigation, les clics, les saisies de formulaires, et les assertions. Chaque étape a une position ordinale, un type qui définit l'action, et des valeurs qui contiennent les données de configuration de l'étape. Cette requête ne fonctionne qu’avec les monitorer d’étape : les autres types de monitorer renverront une erreur puisqu’ils n’utilisent pas de configuration par étapes.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
(compte) | Entier | Oui | L'identifiant du compte New Relic qui contient le moniteur. |
| Chaîne | Oui | L'identifiant unique GUID de l'entité du moniteur de pas dont vous souhaitez récupérer les pas. |
Exemple de requête
{ actor { account(id: ACCOUNT_ID) { synthetics { steps(monitorGuid: "ENTITY_GUID") { ordinal type values } } } }}Requêtes avancées
Cette requête récupère le GUID d'entité pour un moniteur Synthétique à l'aide de l'ID du moniteur. Ceci est utile lorsque vous disposez de l' legacy identifiant numérique de monitoring et que vous devez le convertir au format GUID d'entité requis pour la plupart des opérations NerdGraph. L'identifiant GUID de l'entité est l'identifiant moderne utilisé pour les mises à jour, les suppressions et autres tâches de gestion du moniteur, tandis que l'identifiant du moniteur est l'ancien identifiant numérique qui peut apparaître dans les URL ou les intégrations legacy.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour trouver le monitor. Utilisez
où
est l'ID numérique du monitorer que vous souhaitez trouver. |
Exemple de requête
{ actor { entitySearch(query: "(domainId = 'MONITOR_ID')") { results { entities { ... on SyntheticMonitorEntityOutline { guid name monitorId } } } } }}Cette requête récupère l'état de tous les tests de mise à niveau d'exécution pour legacy moniteur d'exécution de votre compte. Ces tests permettent de vérifier si un moniteur utilisant des environnements d'exécution plus anciens (comme Chrome 72 ou legacy API Node.js ) peut fonctionner avec succès sur des environnements d'exécution plus récents (Chrome 100+ ou Node.js 16.10). Les résultats alimentent l' interface utilisateur des mises à niveau en cours d'exécution et vous aident à identifier les moniteurs prêts à être mis à niveau. Le résultat du test est stocké dans la tag validationStatus et si le test de mise à niveau a échoué, des informations d'erreur détaillées sont disponibles dans la tag validationError.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer l'entité. Utilisez
pour récupérer tous les résultats des tests de mise à niveau en cours d'exécution. |
Exemple de requête
{ actor { entitySearch(query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION'") { results { entities { accountId guid name tags { key values } } } } }}Cette requête récupère l'état d'un test de mise à niveau d'exécution pour un moniteur d'exécution legacy spécifique à l'aide de l'ID du moniteur. Ceci est utile lorsque vous souhaitez vérifier l'état de préparation à la mise à niveau d'un moniteur particulier plutôt que de tous les moniteurs de votre compte. Le test vérifie si le moniteur peut s'exécuter avec succès sur les environnements d'exécution plus récents et ces résultats alimentent l' interface utilisateur des mises à niveau de l'environnement d'exécution. Le résultat du test est stocké dans la tag validationStatus et si le test de mise à niveau a échoué, des informations d'erreur détaillées sont disponibles dans la tag validationError.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | La requête de recherche pour filtrer les entités. Utilisez
où
est l'ID numérique du monitor spécifique. |
Exemple de requête
{ actor { entitySearch( query: "domain = 'SYNTH' AND type = 'RUNTIME_VALIDATION' AND domainId = 'MONITOR_ID'" ) { results { entities { accountId guid name tags { key values } } } } }}