API REST de sintéticos versión 1 (en desuso)

Para ver una lista de todos los monitores en New Relic para su cuenta, envíe una solicitud GET a https://synthetics.newrelic.com/synthetics/api/v1/monitors. Por ejemplo:

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/monitors

Una solicitud exitosa devolverá una respuesta 200 OK . Los datos devueltos serán un objeto JSON en el siguiente formato:

{
  "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
    }
  ]
}

Para ver un único monitor existente en New Relic, envíe una solicitud GET a https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Reemplace {id} en el siguiente ejemplo con el ID del monitor específico.

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}

Una solicitud exitosa devolverá una respuesta 200 OK . Los datos devueltos serán un objeto JSON en el siguiente formato:

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

Una ID de monitor no válida devolverá el error 404 Not Found: el monitor especificado no existe.

Para agregar un nuevo monitor a su cuenta en New Relic, envíe una solicitud POST a https://synthetics.newrelic.com/synthetics/api/v1/monitors con una carga útil JSON que describa el monitor:

{
  "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,
}

Además, a add a scripted monitor a través de la API REST se llama a extremos de API adicionales para enviar el script para el monitor recién creado.

Reemplace el atributo API REST de sintéticos en el siguiente ejemplo con sus valores específicos.

curl -v \
     -X POST -H 'X-Api-Key:{Admin_User_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"}'

Una solicitud exitosa devolverá una respuesta 201 Created , con el URI del monitor recién creado especificado en el encabezado location . Los posibles códigos de error incluyen:

• 400 Bad Request

  : Uno o más de los valores del monitor no son válidos o el formato de la solicitud no es válido. Por ejemplo, la frecuencia está fuera de los límites o una o más de las ubicaciones especificadas no son válidas (consulte el mensaje de error en el cuerpo de la respuesta).

• 402 Payment Required

  : La creación del monitor aumentará sus checks programados más allá del límite de checks comprados de su cuenta.

Para actualizar un monitor existente en New Relic, envíe una solicitud PUT a https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Además, para monitores con script, siga los procedimientos para actualizar el script codificado en BASE64.

Reemplace {id} en el siguiente ejemplo con el ID del monitor específico y reemplace el atributo API REST de sintéticos con sus valores específicos.

curl -v \
     -X PUT -H 'X-Api-Key:{Admin_User_Key}' \
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors/{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" }'

Las solicitudes PUT están destinadas a reemplazar la entidad objetivo, por lo que todos los atributos necesarios en la carga útil JSON al crear un nuevo monitor también se requieren al actualizar un monitor existente.

Una solicitud exitosa devolverá una respuesta 204 No Content con un cuerpo vacío. Los posibles códigos de error incluyen:

• 400 Bad Request

  : Uno o más de los valores del monitor no son válidos o el formato de la solicitud no es válido. Por ejemplo, la frecuencia está fuera de los límites o una o más de las ubicaciones especificadas no son válidas (consulte el mensaje de error en el cuerpo de la respuesta).

• 404 Not Found

  : El monitor especificado no existe.

Para eliminar un monitor existente en New Relic, envíe una solicitud DELETE a https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Reemplace {id} en el siguiente ejemplo con el ID del monitor específico.

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' \
     -X DELETE https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}

Una solicitud exitosa devolverá una respuesta 204 No Content con un cuerpo vacío. Una solicitud fallida devolverá la respuesta: 404 Not Found: el monitor especificado no existe.

Para recuperar la lista de ubicaciones válidas en New Relic, use el siguiente comando.

curl -v \
     -X GET -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/locations

Para ver el script asociado con un monitor SCRIPT_BROWSER o SCRIPT_API específico en New Relic para su cuenta, envíe una solicitud GET a https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script. Reemplace el {id} con la ID del monitor específico. Por ejemplo:

curl -v
     -H 'X-Api-Key: {Admin_User_Key}'
     https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script

Una solicitud exitosa devolverá una respuesta 200 OK . Los datos devueltos serán un objeto JSON en el siguiente formato:

{
  "scriptText": BASE64 encoded string
}

Los posibles códigos de error incluyen:

• 403 Forbidden:

  El monitor especificado no es de tipo script o script.

• 404 Not Found:

  El monitor especificado no existe o el script asociado con el monitor no existe.

Para agregar un nuevo monitor con script a New Relic con la API REST:

1. Siga los procedimientos API estándar para agregar un nuevo monitor e identifique el type como SCRIPT_BROWSER o SCRIPT_API.

2. Actualice el nuevo monitor con una versión codificada en BASE64 del script hasta el extremo ${MONITOR_UUID}/script .

   Para obtener más información, consulte el ejemplo.

Para actualizar la script asociada con un monitor SCRIPT_BROWSER o SCRIPT_API específico en New Relic para su cuenta, envíe una solicitud PUT a https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script con una carga útil JSON que contenga scriptText (obligatorio). Los datos scriptLocations son necesarios solo para la ubicación privada con Verified Script Execution activado.

La contraseña utilizada para generar la cadena HMAC debe coincidir con la contraseña establecida para la ubicación privada. Al generar la cadena HMAC, utilice el algoritmo SHA256.

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

Reemplace el {id} con la ID del monitor específico. Aquí hay un ejemplo del script:

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

Este ejemplo utiliza password como contraseña para scriptLocation.

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

Una solicitud exitosa devolverá una respuesta 204 No Content con un cuerpo vacío. Los posibles códigos de error incluyen:

• 400 Bad Request:

  Cadena codificada en BASE64 no válida para scriptText o hmac.

• 403 Forbidden:

  El monitor especificado no es del tipo script o script.

• 404 Not Found:

  El monitor especificado no existe.

El siguiente ejemplo muestra el comando curl para crear un script de monitor de navegador.

• En la parte superior del script, reemplace las variables con sus valores específicos.

• Para la variable scriptfile , identifique el nombre de archivo del script que se creará. A continuación se muestra un script de muestra que se puede guardar como sample_synth_script.js para utilizarlo en el ejemplo:

  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");
      });
    });
  });

  Copia

Este ejemplo muestra el script bash que creará el monitor 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