mcpField
O
onboarding-summary

onboarding-summary

github.com/datadog-labsクラウド・DevOps180431 回インストール6 日前に更新
リポジトリ

onboarding-summary について

SSI の検証とトラブルシューティング後に、Datadog APM の導入状況を確認するスキルです。クラスターと Datadog の最新データを集め、サービスへのリンクを含む状況レポートにまとめます。

主な機能

  1. 01Agent Pod の状態確認
  2. 02SSI とトレーサー報告の確認
  3. 03トレースと任意の DSM データの照会
  4. 04リンク付き状況レポートの作成

活用シーン

  1. 01検証完了後の APM 設定確認
  2. 02トレースが Datadog に届くかの報告

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/datadog-labs/agent-skills --skill onboarding-summary

インストール後、Claude Code で/onboarding-summaryを入力して読み込まれたか確認します。

詳細

APM オンボーディングの概要

トリガー

次の場合にこのスキルを呼び出します。

  • verify-ssi のすべての手順が完了している
  • troubleshoot-ssi のすべてのチェックで問題が解決している
  • ユーザーが「すべて正常に動作していますか?」「ステータスを表示して」「APM の設定が完了していることを確認して」と尋ねた

検証またはトラブルシューティングのチェックに失敗しているものが残っている場合は、このスキルを呼び出さないでください。先に問題を解決してください。


実行前に解決するコンテキスト

変数解決方法
AGENT_NAMESPACEDatadog Agent がインストールされている名前空間
APP_NAMESPACEアプリケーションの名前空間
APP_LABELDeployment マニフェストの spec.selector.matchLabels.app を確認します
CLUSTER_NAMEdatadog-agent.yaml の spec.global.clusterName
SERVICE_NAMEDeployment の tags.datadoghq.com/service ラベル
ENVDeployment の tags.datadoghq.com/env ラベル
DD_SITEdatadog-agent.yaml の spec.global.site

前提条件

Claude で実行
pup auth status --site <DD_SITE>

トークンが有効な場合は、次に進みます。

エラー:認証されていません。

Claude で実行
pup auth login --site <DD_SITE>

OAuth 用のブラウザータブが開きます。そこでログインを完了してください。コマンドが終了すると、Claude が処理を続行します。


現在の確認データを収集する

以下をすべて実行します。それぞれの結果が最終レポートの各行に反映されます。

Claude で実行
# Agent pod count and status
kubectl get pods -n <AGENT_NAMESPACE> \
  -l app.kubernetes.io/component=agent \
  --no-headers

# SSI instrumentation config live in cluster
kubectl get datadogagent datadog -n <AGENT_NAMESPACE> \
  -o jsonpath='{.spec.features.apm.instrumentation}'

# Init container confirmed in app pod spec
kubectl get pod -l app=<APP_LABEL> -n <APP_NAMESPACE> \
  -o jsonpath='{.items[0].spec.initContainers[*].name}'

# Service visible and traced in APM
DD_SITE=<DD_SITE> pup apm services list --env <ENV> --from 1h

# Traces arriving in the last hour
DD_SITE=<DD_SITE> pup traces search --query "service:<SERVICE_NAME>" --from 1h --limit 5

enable-dsm で DSM を有効にした場合のみ:

# DSM pipeline data for the service
DD_SITE=<DD_SITE> pup metrics query \
  --query "avg:data_streams.latency{service:<SERVICE_NAME>,env:<ENV>} by {pathway_type}" \
  --from 15m --to now

レポートを提示する

現在のコマンド出力からすべての値を入力します。プレースホルダーを未入力のままにしないでください。値を確認できない場合は、その行を失敗としてマークし、troubleshoot-ssi へのリンクを記載します。


APM のオンボーディングが完了しました

チェック詳細ステータス
Datadog Agent<AGENT_NAMESPACE> で <N> 個の Pod が RunningOK
SSI の有効化名前空間 <APP_NAMESPACE>、言語 <LANGUAGE> v<MAJOR_VERSION> を対象にしていますOK
Init コンテナの注入Pod 仕様に datadog-lib-<language>-init がありますOK
トレーサーからのレポート<SERVICE_NAME> が pup apm services list に isTraced: true として表示されていますOK
APM サービスの表示環境 <ENV> の <SERVICE_NAME>OK
トレースの到着直近 1 時間に <N> 件のトレースが見つかりましたOK
Data Streams(有効な場合のみ)<SERVICE_NAME> の data_streams.latency シリーズ、または「最初のメッセージを待機中」OK

Datadog のサービス — クリックして開きます:

実際の値に置き換えて各 URL を作成します。プレースホルダーを含む URL は表示しないでください。

ビューURL
サービス概要https://app.<DD_SITE>/apm/services/<SERVICE_NAME>?env=<ENV>
トレースエクスプローラーhttps://app.<DD_SITE>/apm/traces?query=service:<SERVICE_NAME>%20env:<ENV>
サービスマップhttps://app.<DD_SITE>/apm/map?env=<ENV>&service=<SERVICE_NAME>
Agent フリートhttps://app.<DD_SITE>/fleet-automation
Data Streams(有効な場合のみ)https://app.<DD_SITE>/data-streams

セキュリティ上の制約

  • 生の API キーをファイルやチャットメッセージに書き込まないでください

コメント