API REST de sintéticos

Para ver una lista de todos los monitores en su cuenta New Relic, envíe una solicitud GET a $API_ENDPOINT/v3/monitors. Por ejemplo:

curl -v \
     -H "Api-Key:$API_KEY" $API_ENDPOINT/v3/monitors

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

{
    "monitors": [
        {
        "id": "2a1bc369-7654-489d-918e-f6g135h7i2jk",
        "name": "monitor1",
        "type": "BROWSER",
        "frequency": 60,
        "uri": "http://example.com",
        "locations": [
            "AWS_US_WEST_1"
                ],
        "status": "DISABLED",
        "slaThreshold": 7,
        "options": {},
        "modifiedAt": "2016-09-26T23:12:46.981+0000",
        "createdAt": "2016-09-26T23:12:46.981+0000",
        "userId": 0,
        "apiVersion": "0.2.2"
        }
    ],
    "count": 1
}

Argumentos de consulta:

• offset: La compensación del recuento del monitor. El valor predeterminado es 0. Por ejemplo, si tiene 40 monitores y usa un valor de compensación de 20, devolverá el monitor 21-40.
• limit: El número de resultados por página, máximo 100. El valor predeterminado es 50.

Puede incluirlos en su comando curl de la siguiente manera:

curl -v \
     -H "Api-Key:$API_KEY" $API_ENDPOINT/v3/monitors \
     -G -d 'offset=20&limit=100'

Los encabezados incluyen un Link para ayudarle a localizar fácilmente su monitor. Por ejemplo:

<https://synthetics.newrelic.com/synthetics/api/v3/monitors/?offset=0&limit=20>; rel="first", <https://synthetics.newrelic.com/synthetics/api/v3/monitors/?offset=40&limit=20>; rel="last"

Para ver un único monitor de monitoreo sintético, envíe una solicitud GET a $API_ENDPOINT/v3/monitors/$MONITOR_ID.

curl -v \
     -H "Api-Key:$API_KEY" $API_ENDPOINT/v3/monitors/$MONITOR_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á 404 Not Found: The specified monitor doesn't exist.

Para agregar un nuevo monitor a su cuenta de monitoreo sintético, envíe una solicitud POST a $API_ENDPOINT/v3/monitors con una carga útil JSON que describa el monitor.

Todos los campos del siguiente ejemplo son obligatorios a menos que se indique lo contrario:

{
"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 [at least one required],
"status": string (ENABLED, DISABLED) [required],
"slaThreshold": double,
"options": {
  "validationString": string [only valid for SIMPLE and BROWSER types],
  "verifySSL": boolean (true, false) [only valid for SIMPLE and BROWSER types],
  "bypassHEADRequest": boolean (true, false) [only valid for SIMPLE types],
  "treatRedirectAsFailure": boolean (true, false) [only valid for SIMPLE types]
  }
}

Además, a add the script for 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. Si está utilizando la ubicación privada con la ejecución de script verificada habilitada, consulte Ubicaciones de script con ejecución de script verificada.

Reemplace el atributo de API REST de monitoreo sintético en el siguiente ejemplo con sus valores específicos:

curl -v \
     -X POST -H "Api-Key:$API_KEY" \
     -H 'Content-Type: application/json' $API_ENDPOINT/v3/monitors \
     -d '{ "name" : "monitor1", "frequency" : 15, "uri" : "http://my-uri.com", "locations" : [ "AWS_US_WEST_1" ], "type" : "browser", "status" : "enabled", "slaThreshold" : "1.0"}'

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 $API_ENDPOINT/v3/monitors/$MONITOR_ID. Además, para monitores con script, siga los procedimientos para actualizar el script codificado en BASE64.

Todos los campos son obligatorios. Sin embargo, se cambiará el TYPE del monitor cannot .

Utilice un ID de monitor específico y reemplace el atributo de API REST de monitoreo sintético con sus valores específicos.

curl -v \
     -X PUT -H "Api-Key:$API_KEY" \
     -H 'Content-Type: application/json' $API_ENDPOINT/v3/monitors/$MONITOR_ID \
     -d '{ "name" : "updated monitor name", "type": "monitor type", "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 parchear un monitor existente en New Relic, envíe una solicitud PATCH a $API_ENDPOINT/v3/monitors/$MONITOR_ID.

Utilice un ID de monitor específico y reemplace el atributo de API REST de monitoreo sintético con sus valores específicos.

curl -v \
     -X PATCH -H "Api-Key:$API_KEY" \
     -H 'Content-Type: application/json' $API_ENDPOINT/v3/monitors/$MONITOR_ID \
     -d '{ "name" : "updated monitor name" }'

Las solicitudes de PATCH están destinadas a actualizar un atributo individual de su monitor de monitoreo sintético en lugar de actualizar la entidad completa, por lo que puede proporcionar solo el atributo que desea actualizar.

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 monitoreo sintético, envíe una solicitud DELETE al extremo/v3/monitors/$MONITOR_ID:

curl -v \
     -H "Api-Key:$API_KEY" \
     -X DELETE $API_ENDPOINT/v3/monitors/$MONITOR_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 su monitor de monitoreo sintético, use el siguiente comando:

curl -v \
     -X GET -H "Api-Key:$API_KEY" $API_ENDPOINT/v1/locations

Para ver el script asociado con un SCRIPT_BROWSER o SCRIPT_API específico en el monitor de monitoreo sintético de su cuenta, envíe una solicitud GET al extremo/v3/monitors/$MONITOR_ID/script. Por ejemplo:

curl -v
     -H "Api-Key:$API_KEY"
     $API_ENDPOINT/v3/monitors/$MONITOR_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 sus monitores de monitoreo sintético 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.

   Si está utilizando la ubicación privada con la ejecución de script verificada habilitada, consulte Ubicaciones de script con ejecución de script verificada.

Para actualizar el script asociado con un monitor SCRIPT_BROWSER o SCRIPT_API específico, envíe una solicitud PUT al extremo/v3/monitors/$MONITOR_ID/script con una carga útil JSON que contenga scriptText (obligatorio).

scriptPayload='{"scriptText":BASE64 encoded string}'


curl -v -X PUT \
     -H "Api-Key:$API_KEY" \
     -H 'Content-Type: application/json' \
     $API_ENDPOINT/v3/monitors/$MONITOR_UUID/script \
     -d $scriptPayload

Si está utilizando la ubicación privada con la ejecución de script verificada habilitada, consulte Ubicaciones de script con ejecución de script verificada.

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_BROWSER o SCRIPT_API.
• 404 Not Found: El monitor especificado no existe.

Al crear o actualizar un monitor para ubicación privada que tiene activada la ejecución de script verificada , debe usar scriptLocations para establecer la contraseña:

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

La contraseña utilizada para generar la cadena HMAC debe coincidir con la contraseña establecida para la ubicación privada. Si tiene varias ubicaciones con la ejecución de script verificada habilitada, cada ubicación debe tener calculado el HMAC . Al generar la cadena HMAC, utilice el algoritmo SHA256 con el script y la contraseña.

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
    -X PUT -H "Api-Key:$API_KEY"
    -H 'content-type: application/json'
    $API_ENDPOINT}/v3/monitors/$MONITOR_ID/script
    -d '{ "scriptText": "dmFyIGFzc2VydCA9IHJlcXVpcmUoJ2Fzc2VydCcpOw0KYXNzZXJ0LmVxdWFsKCcxJywgJzEnKTs=","scriptLocations": [ { "name": "my_vse_enabled_location", "hmac": "MjhiNGE4MjVlMDE1N2M4NDQ4MjNjNDFkZDEyYTRjMmUzZDE3NGJlNjU0MWFmOTJlMzNiODExOGU2ZjhkZTY4ZQ=="} ]}'

Pasos de cálculo:

1. Calcule el valor HMAC del script. Una forma es utilizar: cat script | openssl dgst -sha256 -hmac "password" > hmac
2. Elimine el carácter de nueva línea si openssl agregó uno.
3. Codifique el HMAC en BASE64 sin saltos de línea.

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

# API key from your account settings
API_KEY=''
# 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 "Api-Key:$API_KEY" -H 'Content-Type:application/json' https://synthetics.newrelic.com/synthetics/api/v3/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 "Api-Key:$API_KEY" -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