• /
  • EnglishEspañolFrançais日本語한국어Português
  • Se connecterDémarrer

Cette traduction automatique est fournie pour votre commodité.

En cas d'incohérence entre la version anglaise et la version traduite, la version anglaise prévaudra. Veuillez visiter cette page pour plus d'informations.

Créer un problème

Actions de New Relic Synthetics

|View as Markdown (English)

Cette page fournit une référence pour les actions New Relic Synthetics disponibles dans le catalogue des actions d’automatisation des workflows. Ces actions vous permettent de déclencher des exécutions de tests à la demande pour les moniteurs existants, de gérer les temps d’arrêt des fenêtres de maintenance, et de lire les détails des moniteurs directement depuis une définition de workflow.

Prérequis

Avant d’utiliser les actions New Relic Synthetics dans l’automatisation de workflow, assurez-vous de disposer de :

  • Un compte New Relic avec les autorisations appropriées pour accéder aux moniteurs Synthetics.
  • Le GUID de l’entité de chaque moniteur que vous souhaitez cibler. Vous pouvez trouver le GUID d’un moniteur dans New Relic sous Synthetics > [nom du moniteur] > Settings.

Démarrez un test automatisé

L’identifiant de l’action est newrelic.synthetics.startAutomatedTest.

Déclenche une exécution de test automatisé Synthetics à la demande pour un ou plusieurs moniteurs et renvoie un batchId pour récupérer les résultats à l’aide de newrelic.synthetics.getAutomatedTestResult.

Important

Seuls les types de moniteurs d'API scriptées, navigateur scripté, étape, et navigateur simple sont pris en charge. Les moniteurs SIMPLE (ping) sont rejetés par l’API avec une erreur de type de moniteur incompatible.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

tests

List

Obligatoire. Liste des moniteurs à tester. Chaque entrée requiert un monitorGuid et accepte un objet config facultatif avec des surcharges par moniteur. Voir les champs ci-dessous.

[{"monitorGuid": "MTE5Mz..."}]

tests[].monitorGuid

Chaîne

Obligatoire. GUID d’entité du moniteur à exécuter. Doit être un type de moniteur scripté, ou basé sur un navigateur.

"MTE5MzMzNDd8U1lOVEh8..."

tests[].config.isBlocking

Booléen

Facultatif. Si true, un test en échec est traité comme bloquant, ce qui est utile pour contrôler un pipeline CI/CD en fonction du résultat.

true

tests[].config.overrides.location

Chaîne

Facultatif. Exécutez le test depuis cet emplacement au lieu des emplacements configurés du moniteur.

"US_EAST_1"

tests[].config.overrides.startingUrl

Chaîne

Facultatif. Remplacez l'URL de départ du moniteur, par exemple, pour faire pointer un moniteur de production vers un environnement de simulation pour cette exécution.

"https://staging.example.com"

tests[].config.overrides.domain

List

Facultatif. Redirigez les requests d’un domaine vers un autre pour cette exécution uniquement. Chaque entrée nécessite domain et override.

[{"domain": "example.com", "override": "staging.example.com"}]

tests[].config.overrides.secureCredential

List

Facultatif. Échangez l’identifiant sécurisé stocké vers lequel la référence $secure.KEY d’un script est résolue pour cette exécution. Chaque entrée nécessite key et overrideKey.

[{"key": "API_KEY", "overrideKey": "STAGING_API_KEY"}]

configuration

Carte

Facultatif. Métadonnées au niveau du lot associées à l’exécution du test. Tous les champs sont descriptifs uniquement et n’affectent pas l’exécution du test. Champs pris en charge : batchName, branch, commit, deepLink, platform, repository.

{"batchName": "release-1.2.3", "branch": "main", "commit": "a1b2c3d"}

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "batchId", "expression": ".data.syntheticsStartAutomatedTest.batchId"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"syntheticsStartAutomatedTest": {
"batchId": "bdf77c8d-1987-4488-ac7d-112836e5f610"
}
}
}

Transmettez le batchId à newrelic.synthetics.getAutomatedTestResult pour vérifier le résultat.

Exemple de workflow

name: start_synthetics_automated_test
description: Trigger an on-demand Synthetics test run after a deploy
steps:
- name: startAutomatedTest
type: action
action: newrelic.synthetics.startAutomatedTest
version: 1
inputs:
tests:
- monitorGuid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
config:
batchName: "release-1.2.3"
branch: "main"
selectors:
- name: batchId
expression: ".data.syntheticsStartAutomatedTest.batchId"
next: end

Obtenez le résultat du test automatisé

L’identifiant de l’action est newrelic.synthetics.getAutomatedTestResult.

Récupère le statut et les résultats par moniteur d’un lot de tests automatisés Synthetics par son batchId. L’interrogation immédiatement après startAutomatedTest peut renvoyer une erreur transitoire « No automated test results found » : ajoutez une courte étape d’attente avant l’interrogation.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

accountId

Entier

Obligatoire. ID de compte New Relic.

11933347

batchId

Chaîne

Obligatoire. L’ID de lot renvoyé par newrelic.synthetics.startAutomatedTest.

"bdf77c8d-1987-4488-ac7d-112836e5f610"

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "status", "expression": ".data.actor.account.synthetics.automatedTestResult.status"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"actor": {
"account": {
"synthetics": {
"automatedTestResult": {
"status": "IN_PROGRESS",
"startTimestamp": 1788519679406,
"finishTimestamp": null,
"tests": []
}
}
}
}
}
}

status est l’un de PASSED, FAILED, IN_PROGRESS, ou TIMEOUT.

Exemple de workflow

name: get_synthetics_test_result
description: Poll a Synthetics automated test batch for its outcome
steps:
- name: wait
type: wait
seconds: 15
- name: getAutomatedTestResult
type: action
action: newrelic.synthetics.getAutomatedTestResult
version: 1
inputs:
accountId: 11933347
batchId: "bdf77c8d-1987-4488-ac7d-112836e5f610"
selectors:
- name: status
expression: ".data.actor.account.synthetics.automatedTestResult.status"
- name: tests
expression: ".data.actor.account.synthetics.automatedTestResult.tests"
next: end

Créer un temps d’arrêt de moniteur

L’identifiant de l’action est newrelic.synthetics.createMonitorDowntime.

Planifie un temps d’arrêt (fenêtre de maintenance) unique du moniteur Synthetics pour un ou plusieurs moniteurs spécifiques. L’API renvoie un libellé de fuseau horaire résolu (tel que Pacific Standard Time) plutôt que le nom IANA soumis.

Important

monitorGuids est nullable dans le schéma GraphQL, mais requis en pratique : l’omettre déclenche une erreur de serveur. Il n’existe pas de mode de temps d’arrêt à l’échelle du compte ; les temps d’arrêt ont toujours pour cible des moniteurs spécifiques.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

accountId

Entier

Obligatoire. ID de compte New Relic.

11933347

name

Chaîne

Obligatoire. Nom d’affichage pour le temps d’arrêt.

"Deploy maintenance window"

startTime

Chaîne

Obligatoire. Heure de début sous forme de NaiveDateTime (sans décalage de fuseau horaire), interprétée à l’aide de l’entrée timezone. Format : YYYY-MM-DDTHH:MM:SS.

"2026-09-10T02:00:00"

endTime

Chaîne

Obligatoire. Heure de fin en tant que NaiveDateTime (sans décalage de fuseau horaire), interprétée à l’aide de l’entrée timezone.

"2026-09-10T04:00:00"

fuseau horaire

Chaîne

Obligatoire. Nom de fuseau horaire IANA utilisé pour interpréter startTime et endTime.

"America/Los_Angeles"

monitorGuids

List

Obligatoire. GUID d’entité des moniteurs à rendre silencieux pendant le temps d’arrêt. Doit inclure au moins un GUID.

["MTE5MzMzNDd8U1lOVEh8..."]

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "guid", "expression": ".data.syntheticsCreateOnceMonitorDowntime.guid"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"syntheticsCreateOnceMonitorDowntime": {
"accountId": 11933347,
"guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0...",
"monitorGuids": ["MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0..."],
"name": "Deploy maintenance window",
"startTime": "2026-09-10T02:00",
"endTime": "2026-09-10T04:00",
"timezone": "Pacific Standard Time"
}
}
}

Exemple de workflow

name: create_monitor_downtime
description: Schedule a maintenance window for a Synthetics monitor
steps:
- name: createMonitorDowntime
type: action
action: newrelic.synthetics.createMonitorDowntime
version: 1
inputs:
accountId: 11933347
name: "Deploy maintenance window"
startTime: "2026-09-10T02:00:00"
endTime: "2026-09-10T04:00:00"
timezone: "America/Los_Angeles"
monitorGuids:
- "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
selectors:
- name: guid
expression: ".data.syntheticsCreateOnceMonitorDowntime.guid"
next: end

Modifier un temps d'arrêt du moniteur

L’identifiant de l’action est newrelic.synthetics.editMonitorDowntime.

Modifie un temps d’arrêt de moniteur Synthetics existant identifié par son GUID d’entité.

Important

monitorGuids est requis à chaque appel de modification. L’API ne conserve pas la liste existante lorsque ce champ est omis ; elle la vide à la place. Transmettez toujours l’ensemble complet souhaité de GUID de moniteur.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

GUID

Chaîne

Obligatoire. GUID d’entité du temps d’arrêt à modifier.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz..."

monitorGuids

List

Obligatoire. Ensemble complet de GUID d’entité de moniteur auxquels le temps d’arrêt doit s’appliquer. L’API vide cette liste si elle est omise plutôt que de conserver la valeur existante.

["MTE5MzMzNDd8U1lOVEh8..."]

startTime

Chaîne

Obligatoire. Heure de début en tant que NaiveDateTime (sans décalage de fuseau horaire), interprétée à l’aide de l’entrée timezone.

"2026-09-10T02:00:00"

endTime

Chaîne

Obligatoire. Heure de fin en tant que NaiveDateTime (sans décalage de fuseau horaire), interprétée à l’aide de l’entrée timezone.

"2026-09-10T06:00:00"

fuseau horaire

Chaîne

Obligatoire. Nom de fuseau horaire IANA utilisé pour interpréter startTime et endTime.

"America/Los_Angeles"

name

Chaîne

Facultatif. Nouveau nom d’affichage pour le temps d’arrêt. Omettez pour laisser inchangé.

"Deploy maintenance window (extended)"

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "guid", "expression": ".data.syntheticsEditMonitorDowntime.guid"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"syntheticsEditMonitorDowntime": {
"accountId": 11933347,
"guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz...",
"name": "Deploy maintenance window (extended)",
"startTime": "2026-09-10T02:00",
"endTime": "2026-09-10T06:00",
"timezone": "Pacific Standard Time",
"monitorGuids": ["MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0..."]
}
}
}

Exemple de workflow

name: edit_monitor_downtime
description: Extend a Synthetics monitor downtime's end time
steps:
- name: editMonitorDowntime
type: action
action: newrelic.synthetics.editMonitorDowntime
version: 1
inputs:
guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz..."
name: "Deploy maintenance window (extended)"
monitorGuids:
- "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
startTime: "2026-09-10T02:00:00"
endTime: "2026-09-10T06:00:00"
timezone: "America/Los_Angeles"
selectors:
- name: guid
expression: ".data.syntheticsEditMonitorDowntime.guid"
next: end

Supprimer un moniteur temps d'arrêt

L’identifiant de l’action est newrelic.synthetics.deleteMonitorDowntime.

Supprime un temps d’arrêt de moniteur Synthetics identifié par le GUID de son entité.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

GUID

Chaîne

Obligatoire. GUID de l’entité du temps d’arrêt à supprimer.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "deletedGuid", "expression": ".data.syntheticsDeleteMonitorDowntime.guid"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"syntheticsDeleteMonitorDowntime": {
"guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."
}
}
}

Exemple de workflow

name: delete_monitor_downtime
description: Remove a Synthetics monitor downtime
steps:
- name: deleteMonitorDowntime
type: action
action: newrelic.synthetics.deleteMonitorDowntime
version: 1
inputs:
guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."
selectors:
- name: deletedGuid
expression: ".data.syntheticsDeleteMonitorDowntime.guid"
next: end

Obtenir un moniteur

L’identifiant de l’action est newrelic.synthetics.getMonitor.

Récupère les détails complets d’un moniteur Synthetics par son GUID d’entité, y compris l’état actuel, les percentiles de temps de chargement, et la configuration du moniteur.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

GUID

Chaîne

Obligatoire. GUID de l'entité du moniteur à récupérer.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2..."

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "status", "expression": ".data.actor.entity.monitorSummary.status"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"actor": {
"entity": {
"guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2...",
"name": "Homepage ping check",
"accountId": 123456,
"domain": "SYNTH",
"entityType": "SYNTHETIC_MONITOR_ENTITY",
"type": "MONITOR",
"alertSeverity": "NOT_ALERTING",
"permalink": "https://onenr.io/...",
"reporting": true,
"monitorType": "SIMPLE",
"monitorId": "1032899a-d2e6-4777-8b5f-5d3f7c9b6798",
"period": 5,
"monitoredUrl": "https://example.com",
"monitorSummary": {
"status": "SUCCESS",
"successRate": 1,
"locationsFailing": 0,
"locationsRunning": 1,
"loadTimeP50": 210,
"loadTimeP95": 480
}
}
}
}
}

Exemple de workflow

name: get_synthetics_monitor
description: Fetch a Synthetics monitor's current status and load time
steps:
- name: getMonitor
type: action
action: newrelic.synthetics.getMonitor
version: 1
inputs:
guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2LTQ3NzctOGI1Zi01ZDNmN2M5YjY3OTg"
selectors:
- name: status
expression: ".data.actor.entity.monitorSummary.status"
- name: successRate
expression: ".data.actor.entity.monitorSummary.successRate"
next: end

Listez les moniteurs

L’identifiant de l’action est newrelic.synthetics.listMonitors.

Recherche des moniteurs Synthetics pour un compte avec des filtres optionnels de nom, et de statut de rapport, et une pagination basée sur un curseur.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

accountId

Entier

Obligatoire. ID de compte New Relic dans lequel rechercher les moniteurs.

11933347

name

Chaîne

Facultatif. Correspondance de type « contient » insensible à la casse sur le nom du moniteur.

"Homepage"

reporting

Booléen

Facultatif. Filtrer les moniteurs qui transmettent (true), ou ne transmettent pas (false) actuellement des données. Omettre pour renvoyer les deux.

true

curseur

Chaîne

Facultatif. Curseur de pagination provenant de la sortie nextCursor d’un appel précédent. Omettre pour commencer à la 1re page.

"${{ .steps.listMonitors.outputs.nextCursor }}"

selectors

List

Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "monitors", "expression": ".data.actor.entitySearch.results.entities"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Exemple

success

Booléen

true lorsque l'étape s'est exécutée sans erreur.

errorMessage

Chaîne

Renseigné uniquement si l’appel échoue au niveau HTTP/transport. null en cas de réussite.

data

Objet

{
"data": {
"actor": {
"entitySearch": {
"count": 1,
"results": {
"nextCursor": null,
"entities": [
{
"guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0...",
"name": "Homepage ping check",
"domain": "SYNTH",
"type": "MONITOR",
"reporting": true
}
]
}
}
}
}
}

nextCursor est présent lorsque d'autres pages existent. Passez-le en tant que cursor dans l'appel suivant pour récupérer la page suivante.

Exemple de workflow

name: list_synthetics_monitors
description: Search for Synthetics monitors by name
steps:
- name: listMonitors
type: action
action: newrelic.synthetics.listMonitors
version: 1
inputs:
accountId: 11933347
name: "Homepage"
reporting: true
selectors:
- name: monitors
expression: ".data.actor.entitySearch.results.entities"
- name: nextCursor
expression: ".data.actor.entitySearch.results.nextCursor"
next: end
Droits d'auteur © 2026 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.