API のモニタリング

概要

エンドポイントを登録し、チーム所有権を割り当てた後、それらの管理と改善を開始できます。API カタログを使用して、以下のような活動を始めましょう。

  • パフォーマンスが低下している API の検出と調査。
  • レイテンシーやエラーレートなどの主要なパフォーマンスメトリクスに基づくアラートの作成。
  • トリガーされたアラート、テスト結果、セキュリティシグナルの観点から API の信頼性を追跡。
  • Synthetic Monitoring を使用して API テストを標準化し、テストカバレッジを向上。
エンドポイントを登録すると、Datadog はより優れたモニタリング機能のために新しいエンドポイントメトリクスの収集を開始します。登録されたエンドポイントのトラフィックによっては、メトリクスが表示されるまで時間がかかる場合があります。

期待されるパフォーマンスから逸脱するエンドポイントへのアラート

エンドポイントが予期せぬ動作をした場合 (例えば、時折のパフォーマンス低下)、外れ値データを報告した場合 (極端に遅いパフォーマンスやまれなエラーなど)、または望ましいしきい値を超えるメトリクスを達成した場合 (高いエラーレート) にアラートを受け取るよう、モニターをセットアップすることができます。

最新のモニターステータスは Explorer に表示され、モニターがなぜアラートを発しているのか、そしてそれに対処する方法についての詳細情報を確認できます。また、モニターをクリックして表示することで、調査を開始すべきかどうかを判断することもできます。

API Catalog Explorer におけるモニターステータスメニューと Create Monitor ボタン

MONITORS 列の + Monitor をクリックすることで、API カタログから直接 Latency または Error rate に対するモニターを作成することもできます。モニターアラートのセットアップと管理に関する追加情報については、アラートを参照してください。

API テストカバレッジの追跡と改善

Synthetic API テストを使用して、エンドポイントの自動スケジュールテストをセットアップし、テストが失敗した場合にアラートを受け取ることで、問題の診断と修正を行うことができます。

Explorer ページの API TESTS 列には、どのエンドポイントにテストが設定されており、どれが失敗しているかが表示されます。テストが失敗している場合は、そのテストステータスを調べて詳細を確認します。

API Catalog Explorer における API テストステータスメニューと Create Test ボタン

API TESTS 列の + API Test をクリックして、このエンドポイントに対する別の Synthetic API テストを作成します。テストのセットアップに関する詳細については、Synthetic HTTP API テストのドキュメントを参照してください。

セキュリティギャップの発見と解消

Datadog の Application Security Management (ASM) によって提供される Explorer の SECURITY SIGNALS 列では、ASM がエンドポイントに関連するサービスへの脅威を検出したかどうかが表示されます。この列でテーブルをソートして、最も影響を受けているエンドポイントを確認します。View in ASM をクリックして、コードや上流の依存関係における脅威と脆弱性を調査し、対処します。

API Catalog Explorer におけるセキュリティシグナルステータスメニューと View in ASM ボタン

参考資料