New Relic vous permet d'utiliser NerdGraph pour créer un moniteur de ping (également appelé moniteur simple). Le moniteur Ping vérifie si une URL ou un point de terminaison est accessible en effectuant requests HTTP à intervalles réguliers. Ce tutoriel fournit des exemples d'utilisation de l'API NerdGraph pour automatiser la création d'un moniteur de ping.
Créer un moniteur de ping
Vous pouvez créer un moniteur de ping en utilisant la mutation syntheticsCreateSimpleMonitor. Cette mutation vous permet de configurer monitoring pour toute URL ou point de terminaison accessible publiquement.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Entier | Oui | Votre New Relic sur lequel le moniteur sera créé. |
| Array | Oui | éventail d'identifiants où le moniteur effectuera des vérifications (par exemple,
). |
| Chaîne | Oui | Nom d'affichage de votre moniteur de ping. |
| Énumération | Oui | Fréquence d'exécution du moniteur. Options :
,
,
,
,
,
,
,
,
. |
| Énumération | Oui | État du moniteur. Options :
(le moniteur est actif et effectue des vérifications),
(le moniteur est inactif). |
| Chaîne | Oui | L'URL ou le point de terminaison vers le moniteur (par exemple,
). |
| Chaîne | Non | Texte qui doit figurer dans la réponse pour que le contrôle soit réussi. Si cette option est spécifiée, le moniteur échouera si ce texte est introuvable dans le corps de la réponse. |
| Booléen | Non | Faut-il valider le protocole TLS/certificat SSL ? Définissez la valeur à
pour vérifier la validité de la chaîne SSL du certificat. |
| Virgule flottante | Non | L'Apdex cible du moniteur en secondes, utilisé pour alimenter les rapports SLA. Par défaut, 7,0 secondes. |
Demande d'échantillon
mutation { syntheticsCreateSimpleMonitor( accountId: ACCOUNT_ID monitor: { locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "YOUR_MONITOR_NAME" period: PERIOD status: STATUS uri: "MONITORED_URI" advancedOptions: { customHeaders: { name: "HEADER_NAME", value: "HEADER_VALUE" } redirectIsFailure: REDIRECT_IS_FAILURE responseValidationText: "VALIDATION_TEXT" shouldBypassHeadRequest: BYPASS_HEAD_REQUEST useTlsValidation: TLS_VALIDATION } apdexTarget: APDEX_TARGET } ) { errors { description type } }}Exemple de réponse
Une réponse positive renvoie null en cas d'erreur :
{ "data": { "syntheticsCreateSimpleMonitor": { "errors": null } }}En cas de problème lors de la création du moniteur, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.
Mettre à jour un moniteur de ping
Vous pouvez mettre à jour un moniteur de ping existant en utilisant la mutation syntheticsUpdateSimpleMonitor. Cela vous permet de modifier la configuration d'un moniteur de ping déjà créé.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | L'identifiant unique de l'entité du moniteur que vous souhaitez mettre à jour. |
| Array | Non | éventail d'identifiants où le moniteur effectuera des vérifications (par exemple,
). |
| Chaîne | Non | Le nom d'affichage mis à jour pour votre moniteur de ping. |
| Énumération | Non | Fréquence d'exécution du moniteur. Options :
,
,
,
,
,
,
,
,
. |
| Énumération | Non | État du moniteur. Options :
(le moniteur est actif et effectue des vérifications),
(le moniteur est inactif). |
| Chaîne | Non | L'URL ou le point de terminaison vers le moniteur (par exemple,
). |
| Objet | Non | En-têtes HTTP personnalisés à inclure dans la requête. Chaque en-tête possède une propriété
et
. |
| Booléen | Non | Si
, le moniteur traitera les redirections HTTP (codes d'état 3xx) comme des échecs. |
| Chaîne | Non | Texte qui doit figurer dans la réponse pour que le contrôle soit réussi. Si cette option est spécifiée, le moniteur échouera si ce texte est introuvable dans le corps de la réponse. |
| Booléen | Non | Si
, le moniteur ignorera la requête HEAD initiale et effectuera uniquement une requête GET. |
| Booléen | Non | Faut-il valider le protocole TLS/certificat SSL ? Définissez la valeur à
pour vérifier la validité de la chaîne SSL du certificat. |
| Virgule flottante | Non | L'Apdex cible du moniteur en secondes, utilisé pour alimenter les rapports SLA. Par défaut, 7,0 secondes. |
Demande d'échantillon
mutation { syntheticsUpdateSimpleMonitor( guid: "ENTITY_GUID" monitor: { locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "YOUR_MONITOR_NAME" period: PERIOD status: STATUS uri: "MONITORED_URI" advancedOptions: { customHeaders: { name: "HEADER_NAME", value: "HEADER_VALUE" } redirectIsFailure: REDIRECT_IS_FAILURE responseValidationText: "VALIDATION_TEXT" shouldBypassHeadRequest: BYPASS_HEAD_REQUEST useTlsValidation: TLS_VALIDATION } apdexTarget: APDEX_TARGET } ) { errors { description type } }}Exemple de réponse
Une réponse positive renvoie null en cas d'erreur :
{ "data": { "syntheticsUpdateSimpleMonitor": { "errors": null } }}En cas de problème lors de la mise à jour du moniteur, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.
Supprimer un moniteur Synthétique
Cette API vous permet de supprimer un moniteur existant en utilisant la mutation syntheticsDeleteMonitor avec le paramètre GUID.
Paramètres d'entrée
paramètres | Type de données | Est-ce obligatoire ? | Description |
|---|---|---|---|
| Chaîne | Oui | L'identifiant unique de l'entité de monitoring que vous souhaitez supprimer. |
Demande d'échantillon
mutation { syntheticsDeleteMonitor(guid: "ENTITY_GUID") { deletedGuid }}Exemple de réponse
Une suppression réussie renvoie le GUID du moniteur supprimé :
{ "data": { "syntheticsDeleteMonitor": { "deletedGuid": "ENTITY_GUID" } }}En cas de problème lors de la suppression du moniteur, une erreur sera renvoyée avec des détails sur ce qui s'est mal passé.