APIテストをセットアップする 🔗
API テストは、API エンドポイントの機能とパフォーマンスをチェックする柔軟な方法を提供します。Splunk Synthetic Monitoring における API テストの概要については、API Tests for endpoint を参照してください。
APIテストをセットアップする 🔗
以下の手順に従って、APIテストをセットアップしてください：
Splunk Observability Cloud のランディングページから、Splunk Synthetic Monitoring に移動します。
Tests で Add new test を選択し、リストから API test を選択します。テスト作成ビューが開きます。
Name フィールドに、テストの名前を入力します。
Steps の横で、Add requests を選択し、APIテストにリクエストを追加します。リクエストのセットアップページが開きます。
セットアップと検証ステップを含め、テストに含めたい数のリクエストを追加します。
テストを構築するときに、Try now を使用して、テストの構成が有効であることを確認できます。Try now の結果は一時的であり、永続化された run メトリクスには影響しません。詳細については、try nowでテスト設定を検証する を参照してください。
(Optional) Turn on automatic test retry in the event a test initially fails.
Auto-retry 🔗
Run a test again automatically if it fails without any user intervention. It’s a best practice to turn on auto-retry to reduce unnecessary failures from temporary interruptions like a network issue, timeouts, or other issues. Auto-retry runs do not impact subscription usage, only the completed run result counts towards your subscription usage. Auto-retry requires at least runner version 0.9.29.
カスタムプロパティ 🔗
詳細設定のテスト作成ページでカスタム プロパティを追加します。キーと値のペアを使用してカスタムプロパティを作成し、ダッシュボード、チャートをフィルタリングおよびグループ化し、アラートを作成します。テストに関連付けられているタグに基づいて、テストごとにカスタムプロパティの候補リストが表示されます。例: env:test、role:developer、product:rum。複数のキーと値のペアがある場合、ロジックは結果間の AND になります。つまり、この場合、環境テストで開発者ロールを持つ RUM 製品のすべてのテストが結果に表示されます。
カスタムプロパティは単一値であり、region:eu, us のような複数値には対応していません。各テストで使用できるキーは一意です。例えば、env1:test と env:test を同じテスト内に持つことはできますが、env:test と env:prod を持つことはできません。
主な要件：
キーは大文字または小文字で始めなければなりません。特殊文字や数字でキーを始めることはできません。
キーの残りの部分には、文字、数字、アンダースコア、ハイフンを含めることができます。
キーに
test_idやtestという名前を付けることはできません。キーサイズは128文字以内です。
カスタムプロパティ を参照してください。
APIテストにリクエストを追加する 🔗
以下のステップに従って、APIテストにリクエストを追加してください：
「Request Auth Token」 のように、最初のリクエストの名前を入力します。
Setup セクションでは、セレクターを使用して、含めたいセットアップステップの数だけ追加します。オプションの詳細については、API Tests for endpoint を参照してください。
Request セクションで、リクエストの方法を選択してください。
httpまたはhttpsを含む、リクエストのURLを入力してください。(オプション) リクエストヘッダーを追加するには、Request Headers というラベルの付いた
+ボタンを選択し、タイプと内容を入力します。リクエストは複数のヘッダーを含むことができます。Validation セクションに、リクエストとレスポンスを検証するために使用したい検証ステップを入力します。
（オプション） + Request を選択して、テストに別のリクエストを追加します。
APIテストに含めたい数のリクエストを追加するまで、これを繰り返します。
Save steps & return to test を選択して、テストの作成を終了します。
テストの詳細をカスタマイズする 🔗
以下の手順を使用して、テスト設定をカスタマイズし、テストの作成を完了します：
Locations フィールドに、URLをテストする場所を入力します。1つまたは複数の場所を選択できます。
Device Type フィールドで、テストを実施するデバイスをリストから選択します。
Frequency フィールドで、希望するテスト頻度をリストから選択します。
（オプション） Round Robin セレクターを使用して、オプションを切り替えます。ラウンドロビンを有効にすると、選択した場所を1つずつテストが循環します。ラウンドロビン実行を無効にすると、選択した頻度で選択したすべての場所から同時にテストが実行されます。
このテストからアラートを受信したい場合は、+ Create detector を選択して、テストにディテクターを設定します。ダイアログボックスを使用してディテクターをカスタマイズします。
Submit を選択します。すると、新しいテストの「テスト履歴」ページにリダイレクトされます。このテストを作成したばかりの場合は、テストが合成データの収集を開始するまで、少なくとも1回のテスト頻度間隔を空けてください。
（オプション） Edit test またはテストの行にある3つのドットの Actions メニューを選択し、このテストの編集、一時停止、複製、削除を行います。
こちらも参照してください 🔗
テストを実行できる場所については、パブリックロケーション を参照してください。
ディテクターのオプションについては、Splunk Synthetic Monitoring でディテクターとアラートを設定する を参照してください。
例 🔗
例については、シナリオ：重要なワークフローのAPIパフォーマンスを監視する を参照してください。