Multistep API テスト

概要

Multistep API テストは、一度に複数の HTTP リクエストを連鎖させ、主要サービスの洗練されたジャーニーをいつでも、どこからでもプロアクティブに監視・確認できるようにするものです。サービスに対して単一のリクエストを実行したい場合は、API テストを活用してください。

以下が可能です。

  • 認証を必要とする API エンドポイントで HTTP リクエストを実行します (たとえば、トークンを介して)
  • API レベルで主要なビジネストランザクションを監視します
  • エンドツーエンドのモバイルアプリケーションのジャーニーをシミュレートします
Multistep API テストの概要

サービスの 1 つが応答遅延を起こしたり、予期しない方法 (たとえば、予期しない応答本文、ステータスコードなど) で応答を開始した場合、テストはチームに警告するCI パイプラインをブロックする、または障害のあるデプロイをロールバックすることができます。

Multistep API テストは、Datadog 管理ロケーションおよびプライベートロケーションから実行できるため、外部と内部の両方でシステムを完全にカバーできます。

コンフィギュレーション

テストに名前を付けてタグを付ける

  1. Multistep API テストに名前を付けます。
  2. Multistep API テストに env などのタグを追加します。これらのタグを使用して、Synthetic Monitoring ホームページで Synthetic テストをすばやくフィルタリングできます。

ロケーションを選択する

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

ステップを定義する

HTTP リクエストのステップを作成するには、Create Your First Step をクリックします。

Multistep API テストリクエストを作成する

注: デフォルトでは、最大 10 個のステップを作成できます。Datadog サポートチームに連絡して上限を増やしてください。

リクエストを定義する

  1. ステップに名前を付けます。

  2. HTTP Method を選択し、クエリする URL を指定します。使用可能なメソッドは、GETPOSTPATCHPUTHEADDELETEOPTIONS です。httphttps の両方の URL がサポートされています。

  3. Advanced Options を使用して HTTP リクエストを加工します (オプション)。

    • Follow redirects: チェックマークを付けると、リクエストを実行するときに HTTP テストで最大 10 個のリダイレクトをフォローします。
    • Request headers: HTTP リクエストに追加するヘッダーを定義します。デフォルトのヘッダー (たとえば、user-agent ヘッダー) をオーバーライドすることもできます。
    • Cookies: HTTP リクエストに追加するクッキーを定義します。<COOKIE_NAME1>=<COOKIE_VALUE1>; <COOKIE_NAME2>=<COOKIE_VALUE2> の形式を使用して複数のクッキーを設定します。
    • HTTP Basic Auth: HTTP 基本認証資格情報を追加します。
    • Digest Auth: ダイジェスト認証の資格情報を追加します。
    • NTLM: NTLM 認証の資格情報を追加します。NTLMv2 と NTLMv1 の両方をサポートします。
    • AWS Signature v4: Access Key ID と Secret Access Key を入力します。Datadog は、リクエストの署名を生成します。このオプションは、SigV4 の基本的な実装を使用します。AWS S3 などの特定の署名は実装されていません。
    • Encode parameters: エンコーディングが必要なクエリパラメーターの名前と値を追加します。
    • Body type: HTTP リクエストに追加するリクエスト本文のタイプ (text/plainapplication/jsontext/xmltext/htmlapplication/x-www-form-urlencoded、または None) を選択します。
    • Request body: HTTP リクエスト本文のコンテンツを追加します。リクエスト本文は最大サイズ 50 キロバイトに制限されています。
    • Ignore server certificate error: チェックマークを付けると、SSL 証明書の検証時にエラーが発生した場合でも、HTTP テストが接続を続行します。
    • Client certificate: クライアント証明書と関連する秘密キーをアップロードして、mTLS を介して認証します。
    • Proxy URL: HTTP リクエストが通過する必要があるプロキシの URL (http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>) を指定します。
    • Proxy Header: プロキシへの HTTP リクエストに含めるヘッダーを追加します。
    • Do not save response body: レスポンスの本文が実行時に保存されないようにするには、このオプションを選択します。これは、テスト結果に機密データが表示されないようにするために役立ちますが、障害のトラブルシューティングが困難になる可能性があります。セキュリティに関する推奨事項については、Synthetic Monitoring Security を参照してください。

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

Multistep API テストのリクエストを定義する

アサーションの追加

アサーションは、期待されるテスト結果が何であるかを定義します。Test URL をクリックすると、response timestatus codeheadercontent-type の基本的なアサーションが、取得された応答に基づいて追加されます。Multistep API テストでは、アサーションはオプションです。

タイプ演算子値の型
本文containsdoes not containisis not
matchesdoes not match
jsonpathxpath
String
Regex
StringRegex
ヘッダーcontainsdoes not containisis not
matchesdoes not match
String
Regex
response timeis less than整数 (ms)
ステータスコードisis not整数

: HTTP テストでは、brdeflategzipidentitycontent-encoding ヘッダーを使用して本文を解凍することが可能です。

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

Multistep API テストが成功または失敗するためのアサーションを定義する

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

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

実行パラメーターの追加

Continue with test if this step fails (このステップに失敗してもテストを続行する) をクリックすると、ステップに失敗しても次のステップに進むことができます。

これにより、テストが自身で後始末をすることができるようになります。たとえば、あるテストがリソースを作成し、そのリソースに対していくつかのアクションを実行した後、そのリソースを削除して終了することが考えられます。中間ステップのいずれかが失敗した場合、この設定をすべての中間ステップで有効にして、テストの終了時にリソースが削除されるようにし、誤検出を発生させないようにします。

中間ステップで Consider entire test as failed if this step fails (このステップが失敗した場合、テスト全体を失敗と見なす) をアクティブにして、エンドポイントの 1 つが期待どおりに応答しない場合でも、テスト全体でアラートが生成されるようにします。

リトライ

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

応答から変数を抽出する

オプションで、応答ヘッダーまたは本文をパースすることにより、HTTP リクエストの応答から変数を抽出することもできます。変数の値は、HTTP リクエストステップが実行されるたびに更新されます。

変数をパースするには

  1. Variable Name を入力します。変数名に使用できるのは大文字、数字、アンダースコアのみです。また、3 文字以上にする必要があります。

  2. 変数を応答ヘッダーから抽出するか、本文から抽出するか決定します。

    • 応答ヘッダーから値を抽出: HTTP リクエストの応答ヘッダー全体を変数値に使用するか、regex によりパースします。
    • 応答本文から値を抽出: HTTP リクエストの応答本文全体を変数値に使用し、regexJSONPath または XPath によりパースします。
Multistep API テストで HTTP リクエストから変数を抽出する

一度作成すると、この変数は Multistep API テストの次のステップで使用することができます。詳しくは、変数の使用を参照してください。

テストの頻度を指定する

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

  • On a schedule: 最も重要なエンドポイントにユーザーが常にアクセスできるようにします。Datadog で Multistep API テストを実行する頻度を選択します。
スケジュールどおりに API テストを実行する
  • 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}}テストがアラートから回復しない限り表示します。
  3. テストが失敗した場合に、テストで通知メッセージを再送信する頻度を指定します。テストの失敗を再通知しない場合は、Never renotify if the monitor has not been resolved オプションを使用してください。

Save をクリックしてテストを保存し、Datadog にテストの実行を開始させます。

変数

ローカル変数を作成する

抽出された変数

Multistep API テストの任意のステップから変数を抽出してから、テストの後続のステップでその値を再挿入することができます。

パターンからの変数

テストコンフィギュレーションフォームの右上隅にある Create Local Variable をクリックすると、ローカル変数を作成できます。以下の利用可能なビルトインのいずれかから値を定義できます。

{{ numeric(n) }}
n 桁の数字列を生成します。
{{ alphabetic(n) }}
n 文字のアルファベット文字列を生成します。
{{ alphanumeric(n) }}
n 文字の英数字文字列を生成します。
{{ date(n, format) }}
テストが開始された日付 + n 日の値を使用して、許容される形式のいずれかで日付を生成します。
{{ timestamp(n, unit) }}
テストが +/- n 選択単位で開始されたタイムスタンプの値を使用して、許容される単位のいずれかでタイムスタンプを生成します。

変数を使用する

HTTP テストの URL、高度なオプション、およびアサーションで、Settings で定義されたグローバル変数ローカルで定義された変数を使用できます。

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

テストの失敗

ステップが 1 つまたは複数のアサーションを満たさない場合、またはステップのリクエストが時期尚早に失敗した場合、テストは FAILED と見なされます。場合によっては、エンドポイントに対してアサーションをテストできずにテストが実際に失敗することがあります。これらの理由には次のものがあります。

CONNREFUSED
ターゲットマシーンが積極的に拒否したため、接続できませんでした。
CONNRESET
接続がリモートサーバーによって突然閉じられました。Web サーバーにエラーが発生した、応答中にシステムが停止した、Web サーバーへの接続が失われた、などの原因が考えられます。
DNS
テスト URL に対応する DNS エントリが見つかりませんでした。テスト URL の構成の誤りまたは DNS エントリの構成の誤りの原因が考えられます。
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 Multistep API テストを作成、編集、削除できます。Synthetic Multistep API テストの作成、編集、削除アクセスを取得するには、ユーザーをこれら 2 つのデフォルトのロールのいずれかにアップグレードします。

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

アクセス制限

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

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

テストのアクセス許可の設定

その他の参考資料