概要
API カタログは、Datadog 組織内のエンドポイントを自動的に発見するために、分散型トレーシング用の APM インスツルメンテーションを使用します。サポートされているライブラリでインスツルメントされたサービスの場合、エンドポイントは自動的に API カタログに入力されます。
自動検出されたエンドポイントを登録するか、OpenAPI ファイルをアップロードして API カタログの全機能を活用してください。
自動検出されたエンドポイントの登録
自動検出されたエンドポイントを API にグループ化して、使用状況を追跡し、所有権を設定し、中央から監視ポリシーを管理します。
エンドポイントを登録するには
- Explorer ページから、登録するエンドポイントを選択します。
- Register Endpoints をクリックします。
- エンドポイントをグループ化したい API を選択します。
- Apply をクリックします。
エンドポイントが登録されると、Datadog はモニタリング機能の向上のために新しいエンドポイントメトリクスの収集を開始します。
オートディスカバリーは、一部のフレームワークでは使用できません。Datadog の Learn More ボタンをクリックして、互換性のステータスを確認してください。それでもエンドポイントが見つからない場合は、エンドポイントを含む定義ファイルをアップロードしてみてください。Datadog は、アップロードされた後にそのエンドポイント定義のデータ収集を自動的に開始します。
OpenAPI/Swagger ファイルのインポート
すでに所有している API 定義をインポートして、トラフィックを受信しているエンドポイントを確認し、API 定義に基づいてパフォーマンスとデプロイメント情報を取得します。
サポートされているフォーマットは OpenAPI 2 と 3 です。
OpenAPI/Swagger ファイルをインポートするには
- Catalog ページに移動します。
- Add API をクリックします。
- Import an API を選択します。
- デバイスからインポートする OpenAPI ファイルを選択します。
参考資料
