mcpField
D
datadog-cli

datadog-cli

github.com/softaworks云与 DevOps2.6k720 次安装34 周前更新
代码仓库

关于 datadog-cli

Datadog CLI 是供 AI Agent 查询和排查 Datadog 日志与指标的命令行工具,涵盖日志搜索分析、指标查询、错误摘要和仪表板管理。

主要功能

  1. 01搜索并实时读取日志
  2. 02关联日志与追踪
  3. 03归类并比较日志模式
  4. 04查询时间序列指标
  5. 05管理仪表板及列表

适用场景

  1. 01根据近期日志排查服务错误
  2. 02比较不同时段的错误数量
  3. 03调试时检查指标

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/softaworks/agent-toolkit --skill datadog-cli

安装后在 Claude Code 中输入/datadog-cli确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

README.md
references/
dashboards.md
logs-commands.md
metrics.md
query-syntax.md
workflows.md

详细介绍

Datadog CLI

供 AI Agent 使用 Datadog 日志和指标进行调试与问题排查的 CLI 工具。

必读文档

使用任何命令前,你必须阅读相关参考文档:

设置

环境变量(必需)
export DD_API_KEY="your-api-key"
export DD_APP_KEY="your-app-key"

从此处获取密钥:https://app.datadoghq.com/organization-settings/api-keys

运行 CLI
npx @leoflores/datadog-cli <command>

对于非美国地区的 Datadog 站点,请使用 --site 标志:

npx @leoflores/datadog-cli logs search --query "*" --site datadoghq.eu

命令概览

命令描述
logs search使用筛选条件搜索日志
logs tail实时流式传输日志
logs trace查找分布式跟踪对应的日志
logs context获取时间戳之前或之后的日志
logs patterns对相似的日志消息进行分组
logs compare比较不同时段的日志数量
logs multi并行运行多个查询
logs agg按 Facet 聚合日志
metrics query查询时间序列指标
errors按服务/类型快速汇总错误
services列出有日志活动的服务
dashboards管理仪表板(CRUD)
dashboard-lists管理仪表板列表

快速示例

搜索错误
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

事件排查工作流

# 1. Quick error overview
npx @leoflores/datadog-cli errors --from 1h --pretty

# 2. Is this new? Compare to previous period
npx @leoflores/datadog-cli logs compare --query "status:error" --period 1h --pretty

# 3. Find error patterns
npx @leoflores/datadog-cli logs patterns --query "status:error" --from 1h --pretty

# 4. Narrow down by service
npx @leoflores/datadog-cli logs search --query "status:error service:api" --from 1h --pretty

# 5. Get context around a timestamp
npx @leoflores/datadog-cli logs context --timestamp "2024-01-15T10:30:00Z" --service api --pretty

# 6. Follow the distributed trace
npx @leoflores/datadog-cli logs trace --id "TRACE_ID" --pretty

更多调试工作流请参阅 workflows.md。

评论

支持 Markdown