概要
カタログエンティティは、Kubernetes スタイルの YAML 構成ファイルであるエンティティ定義により定義されます。
カタログにデータを入力するには、以下の方法があります。
- Datadog Application Performance Monitoring (APM)、Universal Service Monitoring (USM)、Real User Monitoring (RUM)、インフラストラクチャーメトリクス、またはログをセットアップすると、エンティティデータがカタログに自動的にフィードされます。
- エンティティ定義を手動または自動化によって作成します。
- サードパーティから既存のエンティティ定義をインポートします。
Datadog からエンティティを自動的に検出する
デフォルトでは、APM、USM、RUM から検出されたエントリがカタログに自動的に入力されます。ログなど、他の Datadog テレメトリからエントリを手動でインポートすることもできます。
APM
Datadog SDK または OpenTelemetry を使用してアプリケーションコードをインスツルメンテーションすると、アプリケーションはトレースを出力し、サンプリングされていないトレースメトリクスを生成します。これらのトレースとメトリクスは、IDP のエンティティ検出および依存関係マッピング機能の入力になります。インスツルメンテーションの選択 (Datadog Agent のバージョン、SDK のバージョン、カスタムインスツルメンテーションやサービスオーバーライドを使用するかどうかなど) は、依存関係マッピングの品質と精度に影響します。詳細については、「APM、USM、RUM からの検出」を参照してください。
USM
USM は、ゴールデンシグナルメトリクス (リクエスト数、エラー数、処理時間など) を検出し、eBPF に基づいてアプリケーションの依存関係をマッピングします。アプリケーションコードのインスツルメンテーションは必要ありません。
RUM
RUM は、ページパフォーマンス、エラー、セッションイベント、ビューなどのフロントエンドのユーザーエクスペリエンスデータを提供します。RUM アプリケーションがある場合、それらはコンポーネントセレクターの Frontend Apps としてカタログに表示されます。
その他の Datadog テレメトリ
ログ、ホストメトリクス、コンテナメトリクス、ネットワークメトリクス、プロセスメトリクスなどの Datadog テレメトリから識別されるエンティティをインポートすることもできます。
エンティティのインポートを使用してデータソースを選択すると、Datadog はそのソースをクエリし、有効な DD_SERVICE タグを検索します。エンティティには kind:service 属性がマークされます。
注: これを実行するのは、DD_SERVICE タグが適切に管理されており、無関係または不正確なタグ値が含まれていない場合のみにしてください。
エンティティを作成する
エンティティ YAML ファイルで定義されるエンティティ定義 は、カタログの信頼できる情報源です。以下が可能です。
- Datadog を使用してエンティティ定義を手動で作成する。
- 定義を GitHub または GitLab リポジトリに保存し、ソースコード統合を設定して定義を IDP と同期する。ファイルに加えられた変更は、数分以内に Datadog に反映されます。
注: エンティティをそのテレメトリに自動的に関連付けるには、定義内の name フィールドがテレメトリデータのプライマリ識別子と正確に一致している必要があります。ほとんどのサービスでは、これは Datadog の unified service tagging で定義されている service タグです。kind:datastore、kind:queue、およびその他の entity types の例を参照してください。
エンティティをインポートする
Backstage または ServiceNow CMDB でソフトウェアインベントリを管理している場合は、これらのインベントリを Datadog のカタログに同期できます。
Backstage
Backstage エンティティを Datadog の IDP に取り込むには、次の 2 つの方法があります。
- Datadog の Backstage プラグインをインストールする。
- Datadog API、Terraform、または Datadog の GitHub インテグレーションを使用して、エンティティ記述子ファイルを Backstage から IDP にインポートする。
ServiceNow
ServiceNow CI テーブルに対する定期的なクエリを設定することで、ServiceNow CMDB インベントリを Datadog のカタログと同期します。
エンティティ所有権を定義する
エンティティをチームにリンクすることで、Datadog 製品全体でのチームベースのフィルタリングを有効にし、適切な所有者に通知をルーティングし、Scorecards やキャンペーンを通じて説明責任を促進します。詳細については、カタログエンティティの所有権の定義を参照してください。
構成の完全性を検証する
トレーシング、ロギング、コードプロファイリングなどの監視のベストプラクティスに従うことは、インシデントのトリアージ中に必要なすべてのデータを確実に取得する上で役立ちます。カタログは、これらの推奨設定に対する自動チェックを提供します。
エンティティの構成の完全性を確認するには、カタログでエンティティをクリックし、[Setup Guidance] (セットアップガイダンス) タブを見つけます。
[Setup Guidance] テーブルは、必ずしも個々の製品の請求を反映するものではなく、現在調査中のエンティティのアクティビティを反映するものです。たとえば、インフラストラクチャー監視を実行しているホストやコンテナがあっても、サービスが長期間インフラストラクチャー メトリクスを出力しない場合や、Infrastructure Monitoring に Not Detected が指定されている場合です。
一般的な情報は、ロールベースアクセスコントロールおよびロール権限を参照してください。
読み取り権限
カタログの読み取り権限により、ユーザーはカタログデータを読み取ることができ、以下の機能が有効になります。
- カタログ一覧表示
- Discover UI
- サービス定義エンドポイント:
/api/v2/services/definition/<service_name>
Datadog Read Only Role および Datadog Standard Role の場合、この権限はデフォルトで有効になっています。
書き込み権限
カタログの書き込み権限により、ユーザーはカタログデータを変更できます。書き込み権限は、以下の機能に必要です。
POST /api/v2/services/definitions エンドポイントを使用したサービス定義の挿入または更新DELETE /api/v2/services/definition/<service_name> エンドポイントを使用したサービス定義の削除- Discover Services UI でのオンボーディングプロセスの完了
- UI でのサービスメタデータの更新
Datadog Admin Role および Datadog Standard Role の場合、この権限はデフォルトで有効になっています。
参考資料