Datadog CLI 是一款供 AI 智能体使用的命令行工具,用于借助 Datadog 的日志和指标进行调试与故障分诊。
用途 该工具面向需要排查生产问题的场景,让智能体能够直接查询 Datadog 中的日志与指标数据,完成错误概览、时段对比、模式识别、服务定位、上下文获取和分布式追踪关联等操作。
主要能力 日志相关命令包括:logs search(带过滤条件搜索日志)、logs tail(实时流式查看日志)、logs trace(查找某个分布式追踪对应的日志)、logs context(获取某时间戳前后的日志)、logs patterns(对相似日志消息分组)、logs compare(比较两个时段的日志数量)、logs multi(并行运行多个查询)、logs agg(按 facet 聚合日志)。 指标与概览命令包括:metrics query(查询时序指标)、errors(按服务或类型快速生成错误摘要)、services(列出有日志活动的服务)。 仪表盘管理命令包括:dashboards(仪表盘的增删改查)和 dashboard-lists(仪表盘列表管理)。
使用方式 使用前必须阅读相关参考文档,包括日志命令、指标、查询语法、工作流和仪表盘等部分。 需要设置环境变量: export DD_API_KEY="your-api-key" export DD_APP_KEY="your-app-key" 密钥可从 https://app.datadoghq.com/organization-settings/api-keys 获取。 运行命令:npx @leoflores/datadog-cli <command> 对于非美国 Datadog 站点,使用 --site 标志,例如:npx @leoflores/datadog-cli logs search --query "*" --site datadoghq.eu
常用示例 搜索错误:npx @leoflores/datadog-cli logs search --query "status:error" --from 1h --pretty 实时跟踪日志:npx @leoflores/datadog-cli logs tail --query "service:api status:error" --pretty 错误摘要:npx @leoflores/datadog-cli errors --from 1h --pretty 追踪关联:npx @leoflores/datadog-cli logs trace --id "abc123def456" --pretty 查询指标:npx @leoflores/datadog-cli metrics query --query "avg:system.cpu.user{*}" --from 1h --pretty 时段对比:npx @leoflores/datadog-cli logs compare --query "status:error" --period 1h --pretty
全局标志 --pretty:带颜色的可读输出 --output <file>:将结果导出为 JSON 文件 --site <site>:指定 Datadog 站点(如 datadoghq.eu)
时间格式 支持相对时间:30m、1h、6h、24h、7d;也支持 ISO 8601 格式:2024-01-15T10:30:00Z。
事件分诊工作流示例
- 快速错误概览:npx @leoflores/datadog-cli errors --from 1h --pretty
- 判断是否为新问题,与上一时段对比:npx @leoflores/datadog-cli logs compare --query "status:error" --period 1h --pretty
- 查找错误模式:npx @leoflores/datadog-cli logs patterns --query "status:error" --from 1h --pretty
- 按服务缩小范围:npx @leoflores/datadog-cli logs search --query "status:error service:api" --from 1h --pretty
- 获取某时间戳附近的上下文:npx @leoflores/datadog-cli logs context --timestamp "2024-01-15T10:30:00Z" --service api --pretty
- 跟踪分布式追踪:npx @leoflores/datadog-cli logs trace --id "TRACE_ID" --pretty 更多调试工作流可参见 workflows.md。
适用场景 适用于生产环境问题调试、事件分诊、错误排查、日志与指标分析等运维与开发场景。
限制 使用前必须配置 DD_API_KEY 和 DD_APP_KEY 环境变量;非美国站点需通过 --site 指定。其余关于收费、价格、平台支持范围等信息暂未提供。