API REST Synthetics version 1 (obsolète)

Pour afficher une liste de tous les moniteurs dans New Relic pour votre compte, envoyez une requête GET à https://synthetics.newrelic.com/synthetics/api/v1/monitors. Par exemple:

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/monitors

Une demande réussie renverra une réponse 200 OK . Les données renvoyées seront un objet JSON au format suivant :

{
  "count": integer,
  "monitors": [
    {
      "id": UUID,
      "name": string,
      "type": string,
      "frequency": integer,
      "uri": string,
      "locations": array of strings,
      "status": string,
      "slaThreshold": double,
      "userId": integer,
      "apiVersion": string
    }
  ]
}

Pour afficher un seul moniteur existant dans New Relic, envoyez une requête GET à https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID. Remplacez le MONITOR_ID dans l’exemple suivant par l’ID du moniteur spécifique.

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID

Une demande réussie renverra une réponse 200 OK . Les données renvoyées seront un objet JSON au format suivant :

{
  "id": UUID,
  "name": string,
  "type": string,
  "frequency": integer,
  "uri": string,
  "locations": array of strings,
  "status": string,
  "slaThreshold": double,
  "userId": integer,
  "apiVersion": string
}

Un ID de moniteur non valide renverra l'erreur 404 Not Found: le moniteur spécifié n'existe pas.

Pour ajouter un nouveau moniteur à votre compte dans New Relic, envoyez une requête POST à https://synthetics.newrelic.com/synthetics/api/v1/monitors avec une charge JSON qui décrit le moniteur :

{
  "name": string [required],
  "type": string (SIMPLE, BROWSER, SCRIPT_API, SCRIPT_BROWSER) [required],
  "frequency": integer (minutes) [required, must be one of 1, 5, 10, 15, 30, 60, 360, 720, or 1440],
  "uri": string [required for SIMPLE and BROWSER type],
  "locations": array of strings (send a GET request to https://synthetics.newrelic.com/synthetics/api/v1/locations to get a list of valid locations) [at least one required],
  "status": string (ENABLED, DISABLED) [required],
  "slaThreshold": double,
}

De plus, add a scripted monitor via l'appel d'API REST un point de terminaison d'API supplémentaire pour envoyer le script pour le moniteur qui vient d'être créé.

Remplacez l’ attribut REST de l’APISynthetics dans l’exemple suivant par vos valeurs spécifiques.

$
curl -v \
>
     -X POST -H 'X-Api-Key:API_KEY' \
>
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors \
>
     -d \
>
'{
$
  "name": "monitor1",
$
  "frequency": 15,
$
  "uri": "http://my-uri.com",
$
  "locations": ["AWS_US_WEST_1"],
$
  "type": "browser"
$
}'

Une requête réussie renverra une réponse 201 Created , avec l'URI du moniteur nouvellement créé spécifié dans l'en-tête location . Les codes d’erreur possibles incluent :

• 400 Bad Request:Une ou plusieurs valeurs du moniteur ne sont pas valides, ou le format de la demande n'est pas valide. Par exemple, la fréquence est hors limites ou un ou plusieurs des emplacements spécifiés ne sont pas valides (voir le message d'erreur dans le corps de la réponse).
• 402 Payment Required:La création du moniteur augmentera vos contrôles programmés au-delà de la limite de contrôles achetés de votre compte.

Pour mettre à jour un moniteur existant dans New Relic, envoyez une requête PUT à https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID. De plus, pour le moniteur scripté, suivez les procédures pour mettre à jour le scriptcodé en BASE64.

Remplacez le MONITOR_ID dans l’exemple suivant par l’ID du moniteur spécifique et remplacez l’ attribut REST de l’APISynthetics par vos valeurs spécifiques.

$
curl -v \
>
     -X PUT -H 'X-Api-Key:API_KEY' \
>
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID \
>
     -d \
>
'{
$
  "name": "updated monitor name",
$
  "type": "simple",
$
  "frequency": 15,
$
  "uri": "http://my-uri.com/",
$
  "locations": ["AWS_US_WEST_1"],
$
  "status": "enabled",
$
  "slaThreshold": "7.0"
$
}'

Requests PUT sont destinées à remplacer l'entité cible, donc tous les attributs requis dans la charge JSON lors de la création d'un nouveau moniteur sont également requis lors de la mise à jour d'un moniteur existant.

Une requête réussie renverra une réponse 204 No Content , avec un corps vide. Les codes d’erreur possibles incluent :

• 400 Bad Request:Une ou plusieurs valeurs du moniteur ne sont pas valides, ou le format de la demande n'est pas valide. Par exemple, la fréquence est hors limites ou un ou plusieurs des emplacements spécifiés ne sont pas valides (voir le message d'erreur dans le corps de la réponse).
• 404 Not Found: Le moniteur spécifié n'existe pas.

Pour supprimer un moniteur existant dans New Relic, envoyez une requête DELETE à https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID. Remplacez le MONITOR_ID dans l’exemple suivant par l’ID du moniteur spécifique.

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' \
>
     -X DELETE https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID

Une requête réussie renverra une réponse 204 No Content , avec un corps vide. Une demande infructueuse renverra la réponse 404 Not Found: le moniteur spécifié n'existe pas.

Pour récupérer la liste des emplacements valides dans New Relic, utilisez la commande suivante.

$
curl -v \
>
     -X GET -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/locations

Pour afficher le script associé à un moniteur SCRIPT_BROWSER ou SCRIPT_API spécifique dans New Relic pour votre compte, envoyez une requête GET à https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script. Remplacez le MONITOR_ID par l’ID du moniteur spécifique. Par exemple:

$
curl -v
$
     -H 'X-Api-Key: API_KEY'
$
     https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script

Une demande réussie renverra une réponse 200 OK . Les données renvoyées seront un objet JSON au format suivant :

{
  "scriptText": BASE64 encoded string
}

Les codes d’erreur possibles incluent :

• 403 Forbidden: Le moniteur spécifié n'est pas de type SCRIPT_BROWSER ou SCRIPT_API.
• 404 Not Found: Le moniteur spécifié n'existe pas ou le script associé au moniteur n'existe pas.

Pour ajouter un nouveau moniteur scripté à New Relic avec l'API REST :

1. Suivez les procédures API standard pour ajouter un nouveau moniteur et identifiez le type comme SCRIPT_BROWSER ou SCRIPT_API.

2. Mettez à jour le nouveau moniteur avec une version codée en BASE64 du script au point de terminaison $MONITOR_UUID/script.

   Pour plus d'informations, reportez-vous à l'exemple.

Pour mettre à jour le script associé à un moniteur SCRIPT_BROWSER ou SCRIPT_API spécifique dans New Relic pour votre compte, envoyez une requête PUT à https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script avec une charge JSON contenant le scriptText (obligatoire). Les données scriptLocations sont requises uniquement pour le site privé avec Verified Script Execution activé.

Le mot de passe utilisé pour générer la chaîne HMAC doit correspondre au mot de passe défini pour le site privé. Lors de la génération de la chaîne HMAC, utilisez l'algorithme SHA256.

{
  "scriptText": BASE64 encoded String,
  "scriptLocations": [
    {
      "name": Location name,
      "hmac" BASE64 encoded String of SHA256 HMAC for location
    }
  ]
}

Remplacez MONITOR_ID par l’ID du moniteur spécifique. Voici un exemple de script :

var assert = require('assert');
assert.equal('1', '1');

Cet exemple utilise password comme mot de passe pour scriptLocation.

$
curl -v \
>
     -H "X-Api-Key:'API_KEY'" \
>
     -H 'content-type: application/json' \
>
    'https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script' \
>
     -d \
>
'{ 
$
  "scriptText": "dmFyIGFzc2VydCA9IHJlcXVpcmUoJ2Fzc2VydCcpOw0KYXNzZXJ0LmVxdWFsKCcxJywgJzEnKTs=",
$
  "scriptLocations": [{
$
    "name": "my_vse_enabled_location", 
$
    "hmac": "MjhiNGE4MjVlMDE1N2M4NDQ4MjNjNDFkZDEyYTRjMmUzZDE3NGJlNjU0MWFmOTJlMzNiODExOGU2ZjhkZTY4"
$
  }]
$
}'

Une requête réussie renverra une réponse 204 No Content avec un corps vide. Les codes d’erreur possibles incluent :

• 400 Bad Request: Chaîne codée BASE64 non valide pour scriptText ou hmac.
• 403 Forbidden: Le moniteur spécifié n'est pas du type SCRIPT_BROWSER ou SCRIPT_API.
• 404 Not Found: Le moniteur spécifié n'existe pas.

L'exemple suivant montre la commande cURL pour créer un moniteur de navigateur scripté.

• En haut du script, remplacez les variables par vos valeurs spécifiques.

• Pour la variable scriptfile , identifiez le nom de fichier du script à créer. Voici un exemple de script qui peut être enregistré sous sample_synth_script.js pour être utilisé dans l'exemple :

  var assert = require("assert");
  $browser
    .get("http://example.com")
    .then(function () {
      // Check the H1 title matches "Example Domain"
      return $browser.findElement($driver.By.css("h1")).then(function (element) {
        return element.getText().then(function (text) {
          assert.equal("Example Domain", text, "Page H1 title did not match");
        });
      });
    })
    .then(function () {
      // Check that the external link matches "http://www.iana.org/domains/example"
      return $browser
        .findElement($driver.By.css("div > p > a"))
        .then(function (element) {
          return element.getAttribute("href").then(function (link) {
            assert.equal(
              "http://www.iana.org/domains/example",
              link,
              "More information link did not match"
            );
          });
        });
    });

  Copier

Cet exemple montre le script bash qui créera le moniteur SCRIPTED_BROWSER.

$
#!/bin/bash
$

$
# Admin API key from your account settings
$
adminAPIKey=''
$
# Other attributes found at https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/attributes-synthetics-rest-api#api-attributes
$
monitorName='Test API Script'
$
monitorType='SCRIPT_BROWSER'
$
frequency=1440
$
locations='"AWS_US_WEST_1", "AWS_US_EAST_1"'
$
slaThreshold=7.0
$
# Location of the file with your script
$
scriptfile=sample_synth_script.js
$

$
# Test that the script file exists (does not validate content)
$
if [ -e "$scriptfile" ]
$
then
$
  script=$(cat "$scriptfile")
$

$
  payload="{  \"name\" : \"$monitorName\", \"frequency\" : $frequency,    \"locations\" : [ $locations ],   \"status\" : \"ENABLED\",  \"type\" : \"$monitorType\", \"slaThreshold\" : $slaThreshold, \"uri\":\"\"}"
$
  echo "Creating monitor"
$

$
  # Make cURL call to API and parse response headers to get monitor UUID
$
  shopt -s extglob # Required to trim whitespace; see below
$
  while IFS=':' read key value; do
$
    # trim whitespace in "value"
$
    value=${value##+([[:space:]])}; value=${value%%+([[:space:]])}
$
    case "$key" in
$
        location) LOCATION="$value"
$
                ;;
$
        HTTP*) read PROTO STATUS MSG <<< "$key{$value:+:$value}"
$
                ;;
$
    esac
$
  done < <(curl -sS -i  -X POST -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors -d "$payload")
$

$
  # Validate monitor creation & add script unless it failed
$
  if [ $STATUS = 201 ]; then
$
    echo "Monitor created, $LOCATION "
$
    echo "Uploading script"
$
      # base64 encode script
$
      encoded=`echo "$script" | base64`
$
      scriptPayload='{"scriptText":"'$encoded'"}'
$
        curl -s -X PUT -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' "$LOCATION/script" -d $scriptPayload
$
        echo "Script uploaded"
$
  else
$
    echo "Monitor creation failed"
$
  fi
$

$
else
$
  echo "script file not found, not creating monitor"
$
fi