サービスカタログの設定

概要

サービスカタログには、サービスの一覧が表示されます。Ownership タブの Registered 列は、該当するサービスが登録されていることを緑色のチェックマークで表しています。

サービス定義の更新は、Service Definition API または Terraform を使用します。

すでに APM データを送信しているサービスの場合

Datadog APM にトレースデータを送信するサービスは、自動的にサービスカタログに登録されます。登録するまでは、カーソルを合わせるとグレーのチェックマークが表示されます。

サービスを登録し、所有者情報、ランブックなどの関連リンク、ソースコードリポジトリへのリンクを追加するには、サービス定義の更新を行ってください。

Service Catalog > Get Started から、API で投稿するための有効な JSON を作成するためのヘルプを得ることができます。

カタログにポストしたい他のすべてのサービスの場合

関心があるサービス、API、カスタムライブラリがカタログページに掲載されていない場合

  1. Get Started に移動します。

  2. Register Services フォームでは、Service Catalog API のエンドポイントにポストできる JSON を生成することができます。dd-service フィールドにサービス名を入力します。所有権、ソース、その他のサービス情報を、Service Definition スキーマに入力します。詳細については、GitHub の JSON スキーマの全容を参照してください。

  3. 生成された JSON をコピーするために、Copy ボタンをクリックします。これを Service Definition API を使って POST API 呼び出しの body として送信します。

他の Datadog テレメトリーデータで報告されているサービスを発見する

これはベータ版の機能です。

インフラストラクチャーメトリクスなど、既存の Datadog テレメトリーを通じて他のサービスを検出するには、Discover Services タブに移動し、そこにある指示に従ってください。ディスカバリーは、DD_SERVICE 統合サービスタグ付け規則を使用して、Datadog の組織にデータを送信するサービスを探します。

サービス定義の GitHub への保存と編集

GitHub Apps インテグレーションを構成し、Service Catalog でサービスの定義を表示する場所から、GitHub で保存・編集可能な場所に直接リンクするようにします。

GitHub Apps インテグレーションをインストールするには、インテグレーションタイルに移動し、Repo Configuration タブにある Link GitHub Account をクリックします。

サービス定義 YAML ファイル

Datadog は各リポジトリのルートにある service.datadog.yaml ファイルを読み取り権限でスキャンします。複数の YAML ドキュメントを作成することで、1 つの YAML ファイルに複数のサービスを登録することができます。各ドキュメントは 3 つのダッシュ (---) で区切ります。

サービス定義の変更

サービス定義に GitHub Apps インテグレーションを設定すると、サービスの Definition タブに Edit in Github ボタンが表示され、GitHub にリンクして変更をコミットすることができるようになります。

Service Catalog のサービスの Definition タブに Edit in Github ボタンが表示されるようになった

リポジトリの YAML ファイルを更新すると、その変更はサービスカタログに伝搬されます。

誤って上書きされることを防ぐため、サービス定義ファイルの作成と変更は、GitHub Apps インテグレーションまたは Service Definition API エンドポイントのどちらかを使用してください。GitHub と API の両方を使用して同じサービスを更新すると、意図しない上書きが発生する可能性があります。

Terraform でサービス定義の更新を自動化する

サービスカタログは、Terraform リソースとしてサービス定義を提供します。自動化されたパイプラインによるサービスカタログのサービスの作成と管理には、Datadog Provider v3.16.0 以降が必要です。

詳細については、Datadog Provider のドキュメントを参照してください。

その他の参考資料