このページでは、API モニタリングジョブの設定方法について説明します。
API モニタリングジョブには、以下の詳細を設定できます。
- ジョブをいつ、どこで、どの程度の頻度で実行するかのスケジュール
- タイムアウトの設定
- 警告イベントおよび重大イベントをトリガーするパフォーマンスしきい値の設定
- コントローラ UI で、[User Experience] > [API Monitoring] をクリックします。
- [Add Collection] をクリックしてコレクション名を指定します。
- [Add] をクリックします。
- 新しく作成されたコレクションを選択し、ジョブを追加します。
新しいジョブの設定ページが表示されたら、以下の手順に進みます。
API ジョブの名前を指定してから、ジョブの JavaScript を作成して、[Script Editor] に入力します。
API モニタリングのサンプル JavaScript については、「JavaScript」を参照してください。
ジョブを実行する 1 つ以上の場所を選択できます。毎回すべての場所をテストするようにジョブを構成することも、ジョブが実行されるたびに 1 つの場所をテストするように構成することもできます。合成エージェントの場所の完全なリストについては、「Synthetic Agent Locations」を参照してください。
ホステッドエージェントを使用して、パブリック API エンドポイントをモニタリングします。ホステッドエージェントを使用して、実際の API トラフィックまたはリクエストが生成された場所からの API ジョブをモニタリングできます。
プライベートエージェントを使用して、プライベート API をモニタリングします。たとえば、顧客ネットワーク内で使用される API などがあります。
[Hosted Agent Locations] は、AppDynamics がパブリック合成エージェントをホストする場所です。AppDynamics には、17 か所（AWS の場所のみ）にホステッドエージェントがあります。これらの 17 のホステッドエージェントの場所から API モニタリングジョブを実行できます。
- API モニタリングプライベート合成エージェントを展開している場合は、[Hosted Agent Locations] または [Private Agent Locations] から選択できます。
[Private Agent Locations] は、プライベート合成エージェントをホストしている場所です。これらの環境のいずれかでプライベート合成エージェントを設定できます。
ジョブを作成または編集するときに、ジョブスケジュールを定義できます。設定された場所から定期的に実行するように API ジョブを設定できます。サポートされている最小頻度は 1 分です。
ジョブは、任意のタイムゾーンで、任意の曜日および日付範囲に実行するように設定できます。ジョブは、指定されたタイムゾーン内で実行されます。タイムゾーンを選択すると、ジョブスケジュールはサマータイムなどの他のタイムゾーンにおける時間変更の影響を受けません。デフォルトのタイムゾーンは GMT です。
ジョブの実行時間が一定の期間を超えた場合にジョブが失敗するようにタイムアウトを設定できます。デフォルトでは、ジョブの実行が 5 分以内に完了しない場合に API ジョブがタイムアウトします。
タイムアウトのために失敗したジョブは、可用性の問題と見なされます。
この手順は任意です。しきい値を超えたときに警告合成イベントまたは重大な合成イベントをトリガーするパフォーマンスしきい値を設定できます。
API ジョブの失敗は、理由（無効なステータスコード、応答コンテンツの検証、応答サイズの検証など）に関係なく、デフォルトでは可用性イベントとして報告されるように設定されています。誤検出を避けるために、イベントをトリガーする前に特定の回数だけジョブを再テストするように設定することもできます。
API ジョブの応答時間に基づいて、警告または重大なエラーのイベントをトリガーするように API ジョブを設定することができます。誤検出を避けるために、イベントをトリガーする前に特定の回数だけジョブを再テストするように設定することもできます。
