ダイナミックインスツルメンテーション

Docs > APM > Datadog API カタログ > ダイナミックインスツルメンテーション

概要

API カタログは、Datadog 組織のすべての環境内のエンドポイントを自動検出するための分散型トレーシングに、APM インスツルメンテーションを利用します。インスツルメンテーションされたサービスおよびサポートされているライブラリのエンドポイントは、API Explorer に自動で入力されます。

設定

すでに APM データを消費している Datadog 組織では、追加の設定なしで API カタログを有効にすることができます。APM によってインスツルメンテーションされたサービスやサポートされているライブラリは、自動検出されます。

API カタログ内にいずれかの API やエンドポイントが見当たらない場合は、インスツルメンテーションされていることを確認してください。必要であれば、Setup ページの手順に従って、サービスを発見できるようにします。

Java サービスのインスツルメンテーション手順が表示された API Catalog Setup ページ

または、OpenAPI 定義をインポートすることで、API カタログに API を追加することができます。API をインスツルメンテーションしたくない場合や、インスツルメンテーションと自動検出をサポートしていないフレームワークで書かれている場合は、このアプローチが必要です。YAML または JSON の OpenAPI 定義ファイルをインポートするには、Catalog ページの Add an API をクリックします。

OpenAPI 定義ファイルをインポートするための API Catalog Setup ページ。

API やエンドポイントを登録して API カタログを設定できたら、API Catalog Explorer ページでカタログメタデータの確認や追加を開始します。

重要な用語

API: 2 つのアプリケーションが通信できるようにするためのプロトコルとツールのセット。
API エンドポイント: API で定義された一連のルールを実装するサーバーやサービスのリソースのアドレス (URL) で、多くの場合、HTTP、RESTful API インターフェイスを通じて提供されます。API エンドポイントは、API 呼び出しの応答を行う責任を負っています。

API カタログでは、API エンドポイントを、HTTP メソッド (例: GET)、URL パス (例: /payment/{shop_id}/purchase)、このリソースが提供するサービスの名前 (例: Payments) として表示します。

ベータ版の API カタログは、HTTP エンドポイントのみをサポートしています。
公開 API: インターネットからアクセス可能な顧客向け API エンドポイント。
非公開 API: 内部 API とも呼ばれます。組織内の内部利用のみを目的とし、主にバックエンドサービスの通信に使用されます。最も一般的な API の種類です。
パートナー API: サードパーティ API とも呼ばれます。組織がサービスを提供するために使用する他の組織の公開エンドポイントです (例: Stripe、Google、Facebook)。