合成APIテストを記述する

スクリプト化されたAPIモニターは、APIエンドポイントが正しく機能していることを確認します。スクリプト化されたAPIモニターを作成するには、 one.newrelic.com > Synthetic monitoring > Create a monitorに移動し、 Endpoint availabilityタイルを選択します。

ヒント

その他のAPIテスト例を表示して共有するには、サポートフォーラムの合成スクリプトセクションまたは合成モニタリングのクイックスタートライブラリを参照してください。

API gotモジュールを使用

APIテストは、$httpオブジェクトで使用できるgotモジュールによって作動します。$httpオブジェクトは、gotでrequestに似たカスタムエクスペリエンスを提供し、基本的なユースケースでモニターに下位互換性を提供します。$httpオブジェクトが提供するrequestのような体験は、Node.js 16以降のスクリプト化されたAPIランタイムで、requestを直接使用しようとする顧客にも返されます。

$httpオブジェクトを使用している限り、結果のタイミングの詳細が表示されます。$httpオブジェクトに含まれていないスクリプト化されたAPIユースケースでは、$harオブジェクトを使用してカスタムタイミングの詳細をレポートできます。

重要

最大で3分間のランタイム後、New Relicはスクリプトを手動で停止します。

one.newrelic.com > Synthetic monitoring > Create monitor：スクリプトエディターは、スクリプトコマンド（GitHubで使用可能）を単純化するために、関数、セレクター、その他の要素を提案します。

リクエストオプションを設定する

スクリプトを開始する場合は、以下の手順に従います。

変数（optionsなど）を宣言して、gotオプションオブジェクトを保存します。
URLエンドポイントやカスタムヘッダーなどのリクエストオプションを定義します。

ヒント

サポートされているオプションの完全なリストについては、GitHubのgotドキュメントにあるgotオプションを参照してください。

オプションオブジェクト内のオプションメタデータの例：

//Declare optional metadata
var options = {
        //Specify the endpoint URL
        url: 'https://api-endpoint.example.com',
        //Specify optional headers
        headers: {
                'Endpoint-Key': 'uqNTC57Phe72pnnB8JuJmwAr7b09nKSKSz',
                'Additional-Header': 'Additional-Header-Data'
        }
};

GETリクエストを送信する

GETリクエストをするには、$http.getメソッドを使用してリクエストを送信します。リクエストオプションを定義し、$http.getを使用してリクエストを行ってから、レスポンスを検証してエンドポイントが正しい結果を返していることを確認します。

次の例では、以下に方法を説明します。

GETリクエストの再試行とタイムアウトを処理する
json応答本文を解析する
アプリケーションの稼働ステータスをアサートする
結果をカスタムアトリビュートに保存する

/**
 * Script Name: Advanced Example - Node 16.10.0
 * Author:      New Relic
 * Version:     1.0
 */

const assert = require("assert")

// Get secure credentials
const applicationId = $secure.APP_ID
const apiKey = $secure.API_KEY

// The URL for the API endpoint to get information about a specific application
const URL = `https://api.newrelic.com/v2/applications/${applicationId}.json`

// Define headers, including the API key for authentication
const headers = {
  "X-Api-Key": apiKey,
  "Custom-Header": "CustomValue", // Example of a custom header
}

// Define got options for retries and timeouts
const options = {
  headers: headers,
  timeout: {
    request: 10000, // Set a global timeout of 10000 milliseconds for the request
  },
  retry: {
    limit: 3, // Retry a failed request up to 3 times
    statusCodes: [408, 413, 429, 500, 502, 503, 504], // Common status codes to retry on
    errorCodes: [
      "ETIMEDOUT",
      "ECONNRESET",
      "EADDRINUSE",
      "ECONNREFUSED",
      "EPIPE",
      "ENOTFOUND",
      "ENETUNREACH",
      "EAI_AGAIN",
    ],
    methods: ["GET"], // Only retry for GET requests
  },
  hooks: {
    beforeRetry: [
      (options, error, retryCount) => {
        console.error(
          `Retrying after error ${error.code}, retry #: ${retryCount}`
        )
      },
    ],
  },
}

// Make the GET request with a callback
$http.get(URL, options, function (error, response, body) {
  if (error) {
    // Handle the error case
    console.error(`Request failed: ${error.message}`)
    return
  }

  // Assert the response status code is 200
  assert.equal(response.statusCode, 200, "Expected HTTP status code 200")

  // Log the status code to the console
  console.log("Request Status Code:", response.statusCode)

  // If further processing of the response body is needed, it can be done here
  // For example, parsing JSON response (if response is in JSON format)
  const jsonData = typeof body === "string" ? JSON.parse(body) : body

  // Log the parsed JSON to the console
  console.log("Parsed JSON data:", jsonData)

  // Check the application's health status
  const healthStatus = jsonData.application.health_status
  assert.equal(healthStatus, "green", "Expected the application's health status to be 'green'")

  // If the assertion passes, the script will continue; otherwise, it will fail the monitor

  // This shows up in SyntheticCheck as `custom.healthStatus`
  $util.insights.set("healthStatus", healthStatus)
})

POSTリクエストを送信する

POSTリクエストをするには、$http.postメソッドを使用してリクエストを送信します。リクエストオプションを定義し、$http.postを使用してリクエストを行ってから、レスポンスを検証してエンドポイントが正しい結果を返していることを確認します。

この例では、NerdGraph APIをクエリします。

// Define your authentication credentials
const myAccountId = '{YOUR_ACCOUNT_ID}';
const myAPIKey = '{YOUR_API_KEY}';

const options = {
  // Define endpoint URI, https://api.eu.newrelic.com/graphql for EU accounts
  uri: 'https://api.newrelic.com/graphql',
  headers: {
    'API-key': myAPIKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: `
      query getNrqlResults($accountId: Int!, $nrql: Nrql!) {
        actor {
          account(id: $accountId) {
            nrql(query: $nrql) {
              results
            }
          }
        }
      }
    `,
    variables: {
      accountId: Number(myAccountId),
      nrql: 'SELECT average(duration) FROM Transaction',
    },
  }),
};

// Define expected results using callback function
function callback(err, response, body) {
  // Log JSON results from endpoint to Synthetics console
  console.log(body);
  console.log('Script execution completed');
}

// Make POST request, passing in options and callback
$http.post(options, callback);

この例は、静的な整数を含むカスタムイベントをイベントAPIにPOSTします。

//Define your authentication credentials.
var myAccountID = '{YOUR_ACCOUNT_ID}';
var myAPIKey = '{YOUR_API_KEY}';
//Import the 'assert' module to validate results.
var assert = require('assert');

var options = {
    //Define endpoint URL.
    url: "https://insights-collector.newrelic.com/v1/accounts/"+myAccountID+"/events",
    //Define body of POST request.
    body: '[{"eventType":"SyntheticsEvent","integer1":1000,"integer2":2000}]',
    //Define New Relic API key and expected data type.
    headers: {
        'Api-Key': myAPIKey,
        'Content-Type': 'application/json'
        }
};

//Define expected results using callback function.
function callback(error, response, body) {
    //Log status code to Synthetics console.
    console.log(response.statusCode + " status code")
    //Verify endpoint returns 200 (OK) response code.
    assert.ok(response.statusCode == 200, 'Expected 200 OK response');
    //Verify that `body` contains element named `success` with a value of `true`.
    assert.ok(body.success == true, 'Expected True results in Response Body, result was ' + body.success);
    //Log end of script.
    console.log("End reached");
}

//Make POST request, passing in options and callback.
$http.post(options, callback);

結果を検証する

結果を検証するには、assertモジュールをインポートして、テストケースを定義します。assertメソッドを呼び出して、エンドポイントのレスポンスを検証します。assert関数のいずれかが失敗する場合、モニター全体が失敗したチェックとみなされます。これにより、アラート通知がトリガされ、メトリクスに影響する場合があります。

重要

合成モニタリングは例外のスローを許可しません。例外がスローされると、スクリプトが失敗します。assertモジュールを使用して結果を検証し、console.log()を使用して合成コンソールに結果をログします。

この例は、イベントAPIに投稿してから、レスポンスが{"success":true}であることを検証します。

//Define your authentication credentials.
var myAccountID = '{YOUR_ACCOUNT_ID}';
var myAPIKey = '{YOUR_API_KEY}';
//Import the `assert` module to validate results.
var assert = require('assert');

var options = {
    //Define endpoint URL.
    url: "https://insights-collector.newrelic.com/v1/accounts/"+myAccountID+"/events",
    //Define body of POST request.
    body: '[{"eventType":"SyntheticsEvent","integer1":1000,"integer2":2000}]',
    //Define New Relic API key and expected data type.
    headers: {
        'Api-Key': myAPIKey,
        'Content-Type': 'application/json'
        }
};

$http.post(options, function(error, response, body) {
    //Log status code to Synthetics console. The status code is logged before the `assert` function,
    //because a failed assert function ends the script.
    console.log(response.statusCode + " status code")
    //Call `assert` method, expecting a `200` response code.
    //If assertion fails, log `Expected 200 OK response` as error message to Synthetics console.
    assert.ok(response.statusCode == 200, 'Expected 200 OK response');
    //Call `assert` method, expecting body to return `{"success":true}`.
    //If assertion fails, log `Expected True results in Response Body,` plus results as error message to Synthetics console.
    assert.ok(body.success == true, 'Expected True results in Response Body, result was ' + body.success);
});

ヒント

API gotモジュールを使用

重要

リクエストオプションを設定する

ヒント

オプションのメタデータの使用

GETリクエストを送信する

POSTリクエストを送信する

NerdGraphの例

イベントAPI POSTの例

結果を検証する

重要

イベントAPIの検証例

合成APIテストを記述する

ヒント

API gotモジュールを使用 .css-21sua1{background:none;border:none;width:0;padding:0;}

重要

リクエストオプションを設定する

ヒント

GETリクエストを送信する

POSTリクエストを送信する

NerdGraphの例

イベントAPI POSTの例

結果を検証する

重要

イベントAPIの検証例

API gotモジュールを使用