メタデータの追加

Docs > APM > Datadog サービスカタログ > メタデータの追加

概要

Datadog の UI や API を通じて、または GitHub インテグレーションや Terraform 経由で自動化パイプラインを使用することで、既存のサービスカタログにメタデータを追加することができます。

メタデータの構造とサポートされるバージョン

サービスカタログは、サービス定義スキーマを使用して、サービスに関連するメタデータを保存および表示します。スキーマには、有効な値のみが受け入れられるようにするための検証ルールが組み込まれており、選択したサービスのサイドパネルの Definition タブで警告を表示することができます。

スキーマのサポートバージョンは 2 つあります。

V2 は最も初期のバージョンで、dd-team などの実験的な機能が含まれていますが、これらは v2.1 では削除されています。
V2.1 では、サービスのグルーピングや application、tier、lifecycle などのフィールドなど、追加の UI 要素をサポートしています。Application は、Teams と一緒に、サービスカタログでグループ化変数として使用することができます。Lifecycle は、production、experimental、deprecated でサービスを区別して開発ステージを示し、信頼性と可用性に関して異なる要件を適用するのに役立ちます。Tier は、インシデントのトリアージ中に優先順位を決めるためのサービスの重要度を示します。例えば、tier 1 は通常、最も重要なサービスを表し、障害が発生すると顧客に深刻な影響を与えますが、tier 4 サービスは通常、実際のカスタマーエクスペリエンスに影響を及ぼしません。

最新の更新については、GitHub 上のスキーマをご覧ください。

サービス定義スキーマ (v2.1)

サービス定義スキーマは、サービスの基本情報を格納する構造です。GitHub 上の完全なスキーマを参照してください。

例

service.datadog.yaml

schema-version: v2.1
dd-service: web-store
team: shopist
contacts:
 - type: slack
   contact: https://datadogincidents.slack.com/archives/C01EWN6319S
application: shopist
description: shopist.com storefront
tier: tier1
lifecycle: production
links:
 - name: Demo Dashboard
   type: dashboard
   url: https://app.datadoghq.com/dashboard/krp-bq6-362
 - name: Common Operations
   type: runbook
   url: https://datadoghq.atlassian.net/wiki/
 - name: Disabling Deployments
   type: runbook
   url: https://datadoghq.atlassian.net/wiki/
 - name: Rolling Back Deployments
   type: runbook
   url: https://datadoghq.atlassian.net/wiki/
 - name: Source
   type: repo
   provider: github
   url: https://github.com/DataDog/shopist/tree/prod/rails-storefront
 - name: Deployment
   type: repo
   provider: github
   url: https://github.com/DataDog/shopist/blob/prod/k8s/dd-trace-demo/templates/rails-storefront-deployment.yaml
 - name: Deployment Information
   provider: link
   type: doc
   url: https://docs.datadoghq.com/
 - name: Service Documentation
   provider: link
   type: doc
   url: https://docs.datadoghq.com/
tags: []
integrations:
 pagerduty:
   service-url: https://datadog.pagerduty.com/service-directory/XXXXXXX
外部リソース (オプション)

サービス定義スキーマ (v2)

サービス定義スキーマは、サービスの基本情報を格納する構造です。GitHub 上の完全なスキーマを参照してください。

例

service.datadog.yaml

schema-version: v2
dd-service: web-store
team: shopist
contacts:
  - type: slack
    contact: https://exampleincidents.slack.com/archives/C01EWN6319S
links:
  - name: Demo Dashboard
    type: dashboard
    url: https://app.examplehq.com/dashboard/krp-bq6-362
  - name: Common Operations
    type: runbook
    url: https://examplehq.atlassian.net/wiki/
  - name: Disabling Deployments
    type: runbook
    url: https://examplehq.atlassian.net/wiki/
  - name: Rolling Back Deployments
    type: runbook
    url: https://examplehq.atlassian.net/wiki/
repos:
  - name: Source
    provider: github
    url: https://github.com/Example/shopist/tree/prod/rails-storefront
  - name: Deployment
    provider: github
    url: https://github.com/Example/shopist/blob/prod/k8s/dd-trace-demo/templates/rails-storefront-deployment.yaml
docs:
  - name: Deployment Information
    provider: link
    url: https://docs.datadoghq.com/
  - name: Service Documentation
    provider: link
    url: https://docs.datadoghq.com/
tags: []
integrations:
    pagerduty: https://example.pagerduty.com/service-directory/XYZYX
外部リソース (オプション)

Datadog UI からメタデータを追加する

サービスがサービスカタログにリストされ、すでにメタデータが関連付けられている場合、元のソースは、Ownership ビューの Metadata Source 列にリストされています。そのソースに戻り、必要な更新を行います。

サービスにサービス定義のメタデータが割り当てられていない場合、またはサービスがまだサービスカタログにリストされていない場合は、追加することができます。

サービスカタログページで、Setup & Config をクリックします。Manage Entries タブには、メタデータがないサービスの数が表示されます。
Create New Entry をクリックします。
メタデータを追加するサービスを指定します。これは、サービスカタログにすでにリストされている、まだサービス定義のメタデータが定義されていないサービスの名前、または、データを送信していないサービスの名前にすることができます。
チーム、オンコール、連絡先、ドキュメント、コードリポジトリ、その他のリンクの詳細を入力してください。
Code ビューに切り替えると、入力したメタデータに対して生成された JSON と cURL が表示されます。このコードをコピーすれば、サービス定義のスキーマを学ぶことなく、API や Terraform、GitHub でプログラム的にサービス定義を提供するための出発点として利用することができます。
Service Catalog Write 権限を持っている場合、Save Entry をクリックするか、Code ビューで提供される cURL コマンドを実行することで、メタデータを送信することができます。

メタデータ追加の自動化オプション

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

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

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

サービス定義 YAML ファイル

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

サービス定義の変更

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

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

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

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