• /
  • ログイン
  • 無料アカウント

合成APIテストを記述する

正しく機能することを確認するために、合成モニタリングのAPIテストを使用してAPIエンドポイントを監視します。New Relicは、http-requestモジュールを使用してエンドポイントへHTTPコールをして、結果を検証します。

ここには、リクエストを送信するために$httpオブジェクトを使用する方法を示すサンプル関数が記載されています。このオブジェクトで使用できるオプションの詳細については、http-request readmeを参照してください。(リクエストは廃止されていますが、これらのオプションは適用されます。)

ヒント

他のAPIテストの例を表示して共有するには、Explorers Hubの合成スクリプトセクションを参照してください。

API http-requestモジュールを使用する

APIテストは、$httpオブジェクトで使用できるhttp-requestモジュールによって作動します。New Relicは、各周波数間隔ごとに、選択した各位置からエンドポイントをクエリします。モニターの作成方法については、モニターの追加を参照してください。

リクエストのためのメタデータの定義方法GETリクエストの作成方法POSTリクエストの作成方法、および結果の検証方法を読んでください。

重要

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

api-test-snap.png

one.newrelic.com > 合成 > モニター作成: スクリプトエディタは、スクリプトコマンド (GitHubで使用可能) を単純化するために、関数、セレクタ、その他の要素を提案します。

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

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

  • 変数(optionsなど)を宣言して、リクエストオプションオブジェクトを保存します。
  • URLエンドポイントやカスタムヘッダーなどのリクエストオプションを定義します。
  • SSLまたはエージェントオプションを設定する場合は、SSLおよびagentOptionsの要件を参照してください。ヘッダにプレーンテキストの資格情報が公開されないように、SSLを使用することをお勧めします。

ヒント

サポートされているリクエストオプションの完全なリストについては、GitHubのhttp-requestドキュメントにあるリクエスト(オプション、コールバック)を参照してください。

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

SSLおよびagentOptionsの場合: SSLSSLオプションを設定、またはagentOptionsオブジェクトを提供する場合は、リクエストのoptionsオブジェクトのagentプロパティを$globalAgents.httpsまたは$globalAgents.httpに設定して、インストゥルメントされたグローバルエージェントをHTTPリクエストが確実に使用するようにする必要があります。

SSLオプションまたはagentOptionsの使用の例:

GETリクエストを送信する

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

POSTリクエストを送信する

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

結果を検証する

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

重要

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

その他のヘルプ

さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください:

問題を作成するこのページを編集する
Copyright © 2020 New Relic Inc.