mcpField
O
onboarding-summary

onboarding-summary

github.com/datadog-labs云与 DevOps180431 次安装6 天前更新
代码仓库

关于 onboarding-summary

用于在 SSI 验证和故障排查完成后确认 Datadog APM 配置的技能。它收集集群与 Datadog 的实时数据，并整理状态报告和服务链接。

主要功能

  1. 01检查 Agent Pod 状态
  2. 02确认 SSI 和追踪器报告情况
  3. 03查询 Trace 和可选 DSM 数据
  4. 04生成状态报告及服务链接

适用场景

  1. 01验证通过后确认 APM 配置
  2. 02报告 Trace 是否已到达 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_LABEL检查 Deployment 清单中的 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 正在运行正常
SSI 已启用目标命名空间为 <APP_NAMESPACE>，语言为 <LANGUAGE> v<MAJOR_VERSION>正常
已注入 Init 容器Pod 规格中包含 datadog-lib-<language>-init正常
Tracer 正在报告服务 <SERVICE_NAME> 出现在 pup apm services list 中，且 isTraced: true正常
APM 服务可见<ENV> 环境中的 <SERVICE_NAME>正常
收到 Trace最近一小时内找到 <N> 条 Trace正常
Data Streams（仅在启用时）<SERVICE_NAME> 的 data_streams.latency 序列，或“等待首条消息”正常

在 Datadog 中查看你的服务——点击打开：

将实际值代入以构造各个 URL。请勿输出包含占位符的 URL。

视图URL
服务概览https://app.<DD_SITE>/apm/services/<SERVICE_NAME>?env=<ENV>
Trace 浏览器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 密钥写入任何文件或聊天消息

评论

支持 Markdown