Sintético REST API versão 1 (obsoleto)

Para visualizar uma lista de todos os monitores da sua conta no New Relic, envie uma solicitação GET para https://synthetics.newrelic.com/synthetics/api/v1/monitors. Por exemplo:

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

Uma solicitação bem-sucedida retornará uma resposta 200 OK . Os dados retornados serão um objeto JSON no seguinte 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 visualizar um único monitor existente no New Relic, envie uma solicitação GET para https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Substitua {id} no exemplo a seguir pelo ID do monitor específico.

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

Uma solicitação bem-sucedida retornará uma resposta 200 OK . Os dados retornados serão um objeto JSON no seguinte formato:

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

Um ID de monitor inválido retornará o erro 404 Not Found: O monitor especificado não existe.

Para adicionar um novo monitor à sua conta no New Relic, envie uma solicitação POST para https://synthetics.newrelic.com/synthetics/api/v1/monitors com uma carga JSON que descreve o 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,
}

Além disso, para add a scripted monitor por meio da chamada de API REST, um endpoint adicional de API para enviar o script para o monitor recém-criado.

Substitua o atributo Sintético REST API no exemplo a seguir por seus 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"}'

Uma solicitação bem-sucedida retornará uma resposta 201 Created , com o URI do monitor recém-criado especificado no cabeçalho location . Os possíveis códigos de erro incluem:

• 400 Bad Request

  : um ou mais valores de monitor são inválidos ou o formato da solicitação é inválido. Por exemplo, a frequência está fora dos limites ou um ou mais dos locais especificados são inválidos (consulte a mensagem de erro no corpo da resposta).

• 402 Payment Required

  : a criação do monitor aumentará suas verificações programadas além do limite de verificações compradas da sua conta.

Para atualizar um monitor existente no New Relic, envie uma solicitação PUT para https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Além disso, para monitores com script, siga os procedimentos para atualizar o script codificado em BASE64.

Substitua o {id} no exemplo a seguir pelo ID do monitor específico e substitua o atributo da API REST Sintético pelos seus 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" }'

As solicitações PUT destinam-se a substituir a entidade alvo, portanto, todos os atributos necessários no payload JSON ao criar um novo monitor também são necessários ao atualizar um monitor existente.

Uma solicitação bem-sucedida retornará uma resposta 204 No Content , com corpo vazio. Os possíveis códigos de erro incluem:

• 400 Bad Request

  : um ou mais valores de monitor são inválidos ou o formato da solicitação é inválido. Por exemplo, a frequência está fora dos limites ou um ou mais dos locais especificados são inválidos (consulte a mensagem de erro no corpo da resposta).

• 404 Not Found

  : o monitor especificado não existe.

Para excluir um monitor existente no New Relic, envie uma solicitação DELETE para https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}. Substitua {id} no exemplo a seguir pelo ID do monitor específico.

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

Uma solicitação bem-sucedida retornará uma resposta 204 No Content , com corpo vazio. Uma solicitação malsucedida retornará a resposta 404 Not Found: O monitor especificado não existe.

Para recuperar a lista de locais válidos no New Relic, use o seguinte comando.

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

Para visualizar o script associado a um monitor SCRIPT_BROWSER ou SCRIPT_API específico no New Relic para sua conta, envie uma solicitação GET para https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script. Substitua {id} pelo ID do monitor específico. Por exemplo:

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

Uma solicitação bem-sucedida retornará uma resposta 200 OK . Os dados retornados serão um objeto JSON no seguinte formato:

{
  "scriptText": BASE64 encoded string
}

Os possíveis códigos de erro incluem:

• 403 Forbidden:

  O monitor especificado não é do tipo script ou script.

• 404 Not Found:

  O monitor especificado não existe ou o script associado ao monitor não existe.

Para adicionar um novo monitor com script ao New Relic com a API REST:

1. Siga os procedimentos padrão da API para adicionar um novo monitor e identifique o type como SCRIPT_BROWSER ou SCRIPT_API.

2. Atualize o novo monitor com uma versão do script codificada em BASE64 para o endpoint ${MONITOR_UUID}/script .

   Para obter mais informações, consulte o exemplo.

Para atualizar o script associado a um monitor SCRIPT_BROWSER ou SCRIPT_API específico no New Relic para sua conta, envie uma solicitação PUT para https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script com uma carga JSON que contém o scriptText (obrigatório). Os dados scriptLocations são necessários apenas para localização privada com Verified Script Execution ativado.

A senha utilizada para gerar a string HMAC deve corresponder à senha definida para a localização privada. Ao gerar a string HMAC, use o algoritmo SHA256.

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

Substitua {id} pelo ID do monitor específico. Aqui está um exemplo para o script:

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

Este exemplo usa password como senha 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"} ]}'

Uma solicitação bem-sucedida retornará uma resposta 204 No Content com corpo vazio. Os possíveis códigos de erro incluem:

• 400 Bad Request:

  Sequência codificada em BASE64 inválida para scriptText ou hmac.

• 403 Forbidden:

  O monitor especificado não é do tipo script ou script.

• 404 Not Found:

  O monitor especificado não existe.

O exemplo a seguir mostra o comando curl para criar um script com do monitor do browser.

• Na parte superior do script, substitua as variáveis pelos seus valores específicos.

• Para a variável scriptfile , identifique o nome do arquivo do script a ser criado. Aqui está um exemplo de script que pode ser salvo como sample_synth_script.js para usar no exemplo:

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

  Copiar

Este exemplo mostra o script bash que criará o 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