APIテストをセットアップする

Splunk Synthetic Monitoring で API テストをセットアップし、API エンドポイントの機能とパフォーマンスをチェックするステップ。

APIテストは、APIエンドポイントの機能とパフォーマンスをチェックする柔軟な方法を提供します。Splunk Synthetic Monitoring での API テストの概要については「エンドポイントの API テスト」を参照してください。

APIテストをセットアップする

以下の手順に従って、APIテストをセットアップしてください：

  1. Splunk Observability Cloud のランディングページから、Splunk Synthetic Monitoring に移動します。

  2. [Tests] で [Add new test] を選択し、リストから [API test] を選択します。テスト作成ビューが開きます。

  3. Name フィールドに、テストの名前を入力します。

  4. [Steps] の横の [Add requests] を選択し、API テストにリクエストを追加します。リクエストのセットアップページが開きます。

  5. セットアップと検証ステップを含め、テストに含めたいリクエストの数だけ追加します。

  6. テストを構築する際に、[Try now] を使用して、テストの構成が有効であることを確認できます。[Try now] の結果は一時的なものであり、永続的な実行メトリクスには影響しません。詳しくは「Try now でテスト設定を検証する」を参照してください。

  7. （オプション）テストが最初に失敗した場合に自動テスト再試行をオンにします。

自動再試行

テストが失敗した場合、ユーザーの介入なしに自動的に再実行します。ベストプラクティスは、ネットワークの問題やタイムアウトなど、一時的な中断による不要な失敗を減らすために自動再試行をオンにすることです。自動再試行の実行はサブスクリプションの使用量には影響しません。サブスクリプションの使用量にカウントされるのは、完了した実行結果のみです。自動再試行には、ランナーバージョン 0.9.29 以降が必要です。

カスタムプロパティ

詳細設定のテスト作成ページでカスタムプロパティを追加します。キーと値のペアを使用してカスタムプロパティを作成し、ダッシュボードとチャートをフィルタリングおよびグループ化し、アラートを作成します。テストに関連付けられているタグに基づいて、推奨されるカスタムプロパティのリストを各テストに使用できます。例：env:test、role:developer、product:rum。複数のキーと値のペアがある場合、結果間の論理は AND です。そのためこの場合、結果には、環境テストの開発者ロールを持つ RUM 製品のすべてのテストが表示されます。

env:prod と role:developer という 2 つのカスタムプロパティキー値のペアのスクリーンショットです。

カスタムプロパティは単一値であり、region:eu, us のような複数値はサポートしません。各テストで使用できるキーは 1 つのみで、一意です。たとえば、同じテスト内に env1:test と env:test を使用することはできますが、env:test と env:prod を使用することはできません。

主な要件：

  • キーは大文字または小文字で始める必要があります。特殊文字または数字でキーを始めることはできません。

  • キーの残りの部分には、文字、数字、アンダースコア、ハイフンを含めることができます。

  • キーに test_id や test という名前を付けることはできません。

  • キーサイズは 128 文字以内です。

「カスタムプロパティ」を参照してください。

APIテストにリクエストを追加する

以下のステップに従って、APIテストにリクエストを追加してください：

  1. Request Auth Token のように、最初のリクエストの名前を入力します。

  2. [Setup] セクションでは、セレクターを使用して、含めたいセットアップステップの数だけ追加します。オプションの詳細については「エンドポイントの API テスト」を参照してください。

  3. Request セクションで、リクエストの方法を選択してください。

  4. http または https を含む、リクエストのURLを入力してください。

  5. （オプション）リクエストヘッダーを追加するには、Request Headers というラベルの付いた + ボタンを選択し、タイプと内容を入力します。リクエストには複数のヘッダーを含めることができます。

  6. Validation セクションに、リクエストとレスポンスを検証するために使用したい検証ステップを入力します。

  7. （オプション） + Request を選択して、テストに別のリクエストを追加します。

  8. API テストにすべてのリクエストを追加するまで、これを繰り返します。

  9. Save steps & return to test を選択して、テストの作成を終了します。

テストの詳細をカスタマイズする

以下の手順を使用して、テスト設定をカスタマイズし、テストの作成を完了します：

  1. [Locations] フィールドに、URL をテストする場所を入力します。1 つまたは複数の場所を選択できます。

  2. [Device Type] フィールドで、テストを実施するデバイスをリストから選択します。

  3. Frequency フィールドで、希望するテスト頻度をリストから選択します。

  4. （オプション） Round Robin セレクタを使用してオプションを切り替えます。Round Robin をオンにすると、選択した場所を 1 件ずつテストが循環します。Round Robin をオフにすると、選択した頻度で選択したすべての場所から同時にテストが実行されます。

  5. このテストからアラートを受信したい場合は、[+ Create detector] を選択して、テストにディテクタを設定します。ダイアログボックスを使用してディテクタをカスタマイズします。

  6. Submit を選択します。この操作により、新しいテストの [Test History] ページにリダイレクトされます。このテストを作成したばかりの場合は、テストが合成データの収集を開始するまで、少なくとも 1 回のテスト頻度間隔を空けてください。

  7. （オプション） Edit test またはテストの行にある3つのドットの Actions メニューを選択し、このテストの編集、一時停止、複製、削除を行います。

こちらも参照してください

例

例については「重要なワークフローの API パフォーマンスをモニタリングする」を参照してください。