概要

HTTP テストでは、アプリケーションの API エンドポイントに HTTP リクエストを送信し、応答時間、ステータスコード、ヘッダー、本文のコンテンツなど、定義された条件と応答を確認することができます。

HTTP テストは、ネットワークの外部または内部からのテストの実行の好みに応じて、管理ロケーションとプライベートロケーションの両方から実行することができます。HTTP テストは、スケジュール、オンデマンド、または CI/CD パイプライン内で直接実行することができます。

構成

HTTP テストの作成を選択した後、テストのリクエストを定義します。

リクエストを定義する

1. HTTP Method を選択し、クエリする URL を指定します。使用可能なメソッドは、GET、POST、PATCH、PUT、HEAD、DELETE、OPTIONS です。http と https の両方の URL がサポートされています。

   その他のオプションについては、高度なオプションをご覧ください。

2. HTTP テストに名前を付けます。

3. HTTP テストに env タグとその他のタグを追加します。次に、これらのタグを使用して、Synthetic Monitoring & Continuous Testing ページで Synthetic テストをフィルタリングできます。

Test URL をクリックして、リクエストのコンフィギュレーションをテストします。画面の右側に応答プレビューが表示されます。

高度なオプション

• HTTP バージョン: HTTP/1.1 のみ、HTTP/2 のみ、または HTTP/2 から HTTP/1.1 へのフォールバック を選択してください。
• Follow redirects: 選択すると、リクエストを実行するときに HTTP テストで最大 10 個のリダイレクトをフォローします。
• Ignore server certificate error: 選択すると、SSL 証明書の検証時にエラーが発生した場合でも、HTTP テストが接続を続行します。
• Timeout: テストがタイムアウトするまでの時間を秒単位で指定します。
• Request headers: HTTP リクエストに追加するヘッダーを定義します。デフォルトのヘッダー (たとえば、user-agent ヘッダー) をオーバーライドすることもできます。
• Cookies: HTTP リクエストに追加するクッキーを定義します。<COOKIE_NAME1>=<COOKIE_VALUE1>; <COOKIE_NAME2>=<COOKIE_VALUE2> の形式を使用して複数のクッキーを設定します。

• クライアント証明書: クライアント証明書 (.crt) と関連する秘密キー (.key) を PEM 形式でアップロードして、mTLS を介して認証します。openssl ライブラリを使用して証明書を変換することができます。たとえば、PKCS12 証明書を PEM 形式の秘密キーと証明書に変換します。

  openssl pkcs12 -in <CERT>.p12 -out <CERT_KEY>.key -nodes -nocerts
  openssl pkcs12 -in <CERT>.p12 -out <CERT>.cert -nokeys
  

• HTTP Basic Auth: HTTP 基本認証資格情報を追加します。

• Digest Auth: ダイジェスト認証の資格情報を追加します。

• NTLM: NTLM 認証の資格情報を追加します。NTLMv2 と NTLMv1 の両方をサポートします。

• AWS Signature v4: Access Key ID と Secret Access Key を入力します。Datadog は、リクエストの署名を生成します。このオプションは、SigV4 の基本的な実装を使用します。Amazon S3 などの特定の署名はそのままではサポートされていません。 Amazon S3 バケットへの “Single Chunk” 転送リクエストの場合、リクエストの本文を sha256 エンコードした値を含む x-amz-content-sha256 ヘッダーを追加します (本文が空の場合は、x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 を使用します)。

• OAuth 2.0: クライアント資格情報またはリソース所有者のパスワードのどちらかを付与するかを選択し、アクセストークンの URL を入力します。選択内容に応じて、クライアント ID とシークレット、またはユーザー名とパスワードを入力します。ドロップダウンメニューから、API トークンを基本認証ヘッダーとして送信するか、クライアント資格情報を本文に送信するかを選択します。オプションで、オーディエンス、リソース、スコープなどの追加情報を提供できます (Resource Owner Password を選択した場合は、クライアント ID とシークレットも提供します)。

• Encode parameters: エンコーディングが必要なクエリパラメーターの名前と値を追加します。

• Body type: HTTP リクエストに追加するリクエスト本文のタイプ (application/json、application/octet-stream、application/x-www-form-urlencoded、multipart/form-data、text/html、text/plain、text/xml、GraphQL、または None) を選択します。
• Request body: HTTP リクエスト本文の内容を追加します。
  • application/json、application/x-www-form-urlencoded、text/html、text/plain、text/xml、GraphQL では、リクエスト本文のサイズは最大 50 キロバイトに制限されます。
  • application/octet-stream では、リクエスト本文は 3 メガバイトのファイル 1 つに制限されます。
  • multipart/form-data では、リクエスト本文はそれぞれ 3 メガバイトのファイル 3 つに制限されます。

• Proxy URL: HTTP リクエストが通過する必要があるプロキシの URL (http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>) を指定します。
• Proxy header: プロキシへの HTTP リクエストに含めるヘッダーを追加します。

• Do not save response body: 応答の本文が実行時に保存されないようにするには、このオプションを選択します。テスト結果に機密データを含めたくない場合に有用です。障害発生時のトラブルシューティングに影響を及ぼす可能性があるため、慎重に使用してください。セキュリティに関する推奨の詳細は、Synthetic Monitoring Security をご確認ください。

JavaScript を使用して HTTP API テスト用の変数を定義します。

アサーションを定義する

アサーションは、期待されるテスト結果が何であるかを定義します。Test URL をクリックすると、response time、status code、header、content-type の基本的なアサーションが、取得された応答に基づいて追加されます。テストで監視するには、少なくとも 1 つのアサーションを定義する必要があります。

HTTP テストでは、br、deflate、gzip、identity の content-encoding ヘッダーを使用して本文を解凍することが可能です。

New Assertion をクリックするか、応答プレビューを直接クリックすることで、API テストごとに最大 20 個のアサーションを作成できます。

アサーションで OR ロジックを実行するには、matches regex コンパレータを使って (200|302) のように複数の期待値を持つ正規表現を定義します。たとえば、サーバーが 200 あるいは 302 というステータスコードで応答したときに HTTP テストを成功させたいことがあるでしょう。ステータスコードが 200 あるいは 302 であれば、 status code アサーションは成功します。body や header アサーションに OR ロジックを追加することもできます。

テストがレスポンス本文にアサーションを含まない場合、本文のペイロードはドロップし、Synthetics Worker で設定されたタイムアウト制限内でリクエストに関連するレスポンスタイムを返します。

テストがレスポンス本文に対するアサーションを含み、タイムアウトの制限に達した場合、Assertions on the body/response cannot be run beyond this limit というエラーが表示されます。

ロケーションを選択する

HTTP テストを実行するロケーションを選択します。HTTP テストは、ネットワークの外部または内部のどちらからテストを実行するかの好みによって、管理ロケーションとプライベートロケーションの両方から実行できます。

Datadog’s out-of-the-box managed locations allow you to test public-facing websites and endpoints from regions where your customers are located.

The Datadog for Government site (US1-FED) uses the following managed location:

テストの頻度を指定する

HTTP テストは次の頻度で実行できます。

• On a schedule: 最も重要なエンドポイントにユーザーが常にアクセスできるようにします。Datadog で HTTP テストを実行する頻度を選択します。
• Within your CI/CD pipelines: 欠陥のあるコードがカスタマーエクスペリエンスに影響を与える可能性があることを恐れずに出荷を開始します。
• On-demand: チームにとって最も意味のあるときにいつでもテストを実行します。

アラート条件を定義する

アラート条件で、テストが失敗しアラートをトリガーする状況を設定します。

アラート設定規則

アラートの条件を An alert is triggered if any assertion fails for X minutes from any n of N locations に設定すると、次の 2 つの条件が当てはまる場合にのみアラートがトリガーされます。

• 直近 X 分間に、最低 1 個のロケーションで失敗 (最低 1 つのアサーションが失敗)、
• 直近 X 分間に、ある時点で最低 n 個のロケーションで失敗。

高速再試行

テストが失敗した場合、Y ミリ秒後に X 回再試行することができます。再試行の間隔は、警告の感性に合うようにカスタマイズしてください。

ロケーションのアップタイムは、評価ごとに計算されます (評価前の最後のテスト結果がアップかダウンか)。合計アップタイムは、構成されたアラート条件に基づいて計算されます。送信される通知は、合計アップタイムに基づきます。

テストモニターを構成する

以前に定義されたアラート条件に基づいて、テストによって通知が送信されます。このセクションを使用して、チームに送信するメッセージの方法と内容を定義します。

1. モニターの構成方法と同様、メッセージに @notification を追加するか、ドロップダウンメニューでチームメンバーと接続されたインテグレーションを検索して、通知を受信するユーザーやサービスを選択します。

2. テストの通知メッセージを入力します。このフィールドでは、標準のマークダウン形式のほか、以下の条件付き変数を使用できます。

   条件付き変数	説明
   {{ #is_alert }}	テストがアラートを発する場合に表示します。
   {{ ^is_alert }}	テストがアラートを発しない限り表示します。
   {{ #is_recovery }}	テストがアラートから回復したときに表示します。
   {{ ^is_recovery }}	テストがアラートから回復しない限り表示します。
   {{ #is_renotify }}	モニターが再通知したときに表示します。
   {{ ^is_renotify }}	モニターが再通知しない限り表示します。
   {{ #is_priority }}	モニターが優先順位 (P1～P5) に一致したときに表示します。
   {{ ^is_priority }}	モニターが優先順位 (P1～P5) に一致しない限り表示します。

3. テストが失敗した場合に、テストで通知メッセージを再送信する頻度を指定します。テストの失敗を再通知しない場合は、Never renotify if the monitor has not been resolved オプションを使用してください。

4. Create をクリックすると、テストの構成とモニターが保存されます。

詳しくは、Synthetic テストモニターの使用をご覧ください。

ワンクリック

API テストの作成は、API カタログと既存の API テストからエンドポイントを提案し、テストフォームに関連するオプションを自動入力します。Datadog の既存データソースを使用してください (APM トレース、API カタログエンドポイントの発見、およびユーザーが作成した既存の同様の Synthetic テストなど)。

Synthetic Monitoring の API テスト URL 入力に入力を開始すると、エンドポイントの提案や類似テストを取得できます。

次に、提案を選択してテスト構成 (リクエストオプションとヘッダー、認証、変数) を自動入力します。

Create local variables

To create a local variable, click Create a Local Variable. You can select one of the following available builtins to add to your variable string:

{{ numeric(n) }}

Generates a numeric string with n digits.

{{ alphabetic(n) }}

Generates an alphabetic string with n letters.

{{ alphanumeric(n) }}

Generates an alphanumeric string with n characters.

{{ date(n unit, format) }}

Generates a date in one of Datadog’s accepted formats with a value corresponding to the UTC date the test is initiated at + or - n units.

{{ timestamp(n, unit) }}

Generates a timestamp in one of Datadog’s accepted units with a value corresponding to the UTC timestamp the test is initiated at +/- n units.

{{ uuid }}

Generates a version 4 universally unique identifier (UUID).

{{ public-id }}

Injects the Public ID of your test.

{{ result-id }}

Injects the Result ID of your test run.

To obfuscate local variable values in test results, select Hide and obfuscate variable value. Once you have defined the variable string, click Add Variable.

変数を使用する

HTTP テストの URL、高度なオプション、アサーションで、Settings ページで定義されたグローバル変数を使用することができます。

変数のリストを表示するには、目的のフィールドに {{ と入力します。

テストの失敗

テストが 1 つ以上のアサーションを満たさない場合、またはリクエストが途中で失敗した場合、テストは FAILED と見なされます。場合によっては、エンドポイントに対するアサーションをテストせずにテストが実際に失敗することがあります。

よくあるエラーは以下の通りです。

CONNREFUSED

ターゲットマシーンが積極的に拒否したため、接続できませんでした。

CONNRESET

接続がリモートサーバーによって突然閉じられました。Web サーバーにエラーが発生した、応答中にシステムが停止した、Web サーバーへの接続が失われた、などの原因が考えられます。

DNS

テスト URL に対応する DNS エントリが見つかりませんでした。原因としては、テスト URL の誤構成や DNS エントリの誤構成が考えられます。

Error performing HTTP/2 request

リクエストを実行できませんでした。詳細は専用のエラーページを参照してください。

INVALID_REQUEST

テストのコンフィギュレーションが無効です (URL に入力ミスがあるなど)。

SSL

SSL 接続を実行できませんでした。詳細については、個別のエラーページを参照してください。

TIMEOUT

リクエストを一定時間内に完了できなかったことを示します。TIMEOUT には 2 種類あります。

• TIMEOUT: The request couldn't be completed in a reasonable time. は、リクエストの持続時間がテスト定義のタイムアウト (デフォルトは 60 秒に設定されています) に当たったことを示します。 各リクエストについて、ネットワークウォーターフォールに表示されるのは、リクエストの完了したステージのみです。例えば、Total response time だけが表示されている場合、DNS の解決中にタイムアウトが発生したことになります。
• TIMEOUT: Overall test execution couldn't be completed in a reasonable time. は、テスト時間 (リクエスト＋アサーション) が最大時間 (60.5s) に達したことを示しています。

MALFORMED_RESPONSE

リモートサーバーが HTTP 仕様に準拠していないペイロードで応答しました。

権限

デフォルトでは、Datadog 管理者および Datadog 標準ロールを持つユーザーのみが、Synthetic HTTP テストを作成、編集、削除できます。Synthetic HTTP テストの作成、編集、削除アクセスを取得するには、ユーザーをこれら 2 つのデフォルトのロールのいずれかにアップグレードします。

カスタムロール機能を使用している場合は、synthetics_read および synthetics_write 権限を含むカスタムロールにユーザーを追加します。

アクセス制限

アカウントにカスタムロールを使用しているお客様は、アクセス制限が利用可能です。

組織内の役割に基づいて、HTTP テストへのアクセスを制限することができます。HTTP テストを作成する際に、(ユーザーのほかに) どのロールがテストの読み取りと書き込みを行えるかを選択します。

その他の参考資料

お役に立つドキュメント、リンクや記事:

Datadog Synthetic モニタリングの紹介ブログ Synthetic テストの紹介ラーニングセンター HTTP テストの概要DOCUMENTATION 内部エンドポイントで HTTP テストを実行するDOCUMENTATION マルチステップ HTTP テストドキュメント Synthetic テストモニターについてドキュメント