以下の機能を使って、Software Catalog におけるエンジニアリング チームの体験をカスタマイズできます。
プレビュー中の Developer Homepage で、チーム専用のランディング ページを作成します。
“
Join the Preview!
Developer Homepage は、優先度付きのタスクや Pull Request、Alert、インサイトなどに 1 か所からアクセスできる、開発者向けのパーソナライズされたダッシュボードです。アクセス リクエスト をクリックして、利用をリクエストしてください。
Request Access”
自動検出されたサービスにメタデータを追加
サービスのオンコール情報、ソース コード、ドキュメントを指定するには、UI や API、または その他の自動化 を使って、既存のサービスにメタデータを追加できます。v3 が推奨バージョンです。
Entity Definition Schema (v3) (推奨)
エンティティ定義スキーマは、ソフトウェア コンポーネントに関する基本情報を保持するための構造です。
詳細については、Definition Schema v3.0 を参照してください。
Service Definition Schema (v2.2)
Service Definition Schema は、サービスの基本情報を格納する構造体です。GitHub にあるフルスキーマを参照してください。
例
schema-version: v2.2
dd-service: shopping-cart
team: e-commerce
application: shopping-app
tier: "1"
type: web
languages:
- go
- python
contacts:
- type: slack
contact: https://yourorg.slack.com/archives/e-commerce
- type: email
contact: ecommerce@example.com
- type: microsoft-teams
contact: https://teams.microsoft.com/example
links:
- name: Runbook
type: runbook
url: http://runbook/shopping-cart
- name: Source
type: repo
provider: github
url: https://github.com/shopping-cart
- name: Deployment
type: repo
provider: github
url: https://github.com/shopping-cart
- name: Config
type: repo
provider: github
url: https://github.com/consul-config/shopping-cart
- name: E-Commerce Team
type: doc
provider: wiki
url: https://wiki/ecommerce
- name: Shopping Cart Architecture
type: doc
provider: wiki
url: https://wiki/ecommerce/shopping-cart
- name: Shopping Cart RFC
type: doc
provider: google doc
url: https://doc.google.com/shopping-cart
tags:
- business-unit:retail
- cost-center:engineering
integrations:
pagerduty:
service-url: https://www.pagerduty.com/service-directory/PSHOPPINGCART
opsgenie:
service-url: "https://www.opsgenie.com/service/uuid"
region: "US"
ci-pipeline-fingerprints:
- id1
- id2
extensions:
additionalProperties:
customField1: customValue1
customField2: customValue2
Software Catalog アクションを探す
Software Catalog に関連するアクションを一覧で確認するには、Datadog Action Catalog を開きます。必要なアクションに絞り込むには、次の方法を使います。
- アクションカタログにアクセス: Datadog Workflow Automation 環境内でアクションカタログを探します。
- Search Functionality: search bar を使って “Software Catalog” のようなキーワードや、目的のアクションに関連するより具体的な用語 (例: “get service dependencies”) を検索します。
Available Software Catalog Actions
以下は、Datadog Workflow Automation で Software Catalog に対して利用できるアクションの一覧です。新しいアクションの追加に伴い、この一覧は今後変更される可能性があります。
- サービス情報の取得
- “Get service definition” (サービス定義の取得) で単一のサービスの定義を取得します
- “List service definitions” to get all definitions from Datadog Software Catalog
- “Get service dependencies” (サービスの依存関係を取得) でサービスの直接の上流および下流のサービスを取得します
- インシデントのトリアージ
- “Get service PagerDuty on call” (サービスの PagerDuty オンコールを取得)
- 他のアクションと連携させることで、重大なイベントに基づいたワークフローをトリガーできます (例: ランブックの実行)。
サービスの色を変更する
サービスの色は、トレースの視覚化に使用されます。サービスタイプのアイコンをクリックして変更できます。
サービスタイプと言語を更新する
Software Catalog メタデータ スキーマ 2.2 を使うと、ユーザー定義のサービスについて、サービスの種類と使用言語を指定したり、計測済みサービスに対して自動検出された種類と使用言語を上書きしたりできます。サービスの種類と言語を正しくラベル付けすることで、他のチームがそのサービスの役割や連携方法をよりよく理解できるようになります。
参考資料
