名称: datadog-cli 描述: Datadog CLI 用于搜索日志、查询指标、追踪请求和管理仪表板。在调试生产问题或使用 Datadog 可观察性时使用此工具。
Datadog CLI
一个供 AI 代理使用的 CLI 工具,用于利用 Datadog 日志和指标进行调试和排查。
必读
在使用任何命令前,您必须阅读相关参考文档:
设置
环境变量(必需)
export DD_API_KEY="您的API密钥"
export DD_APP_KEY="您的应用密钥"
从以下网址获取密钥:https://app.datadoghq.com/organization-settings/api-keys
运行 CLI
npx @leoflores/datadog-cli <命令>
对于非美国 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 |
按维度聚合日志 |
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 <文件> |
将结果导出到 JSON 文件 |
--site <站点> |
Datadog 站点(如 datadoghq.eu) |
时间格式
- 相对格式:
30m,1h,6h,24h,7d - ISO 8601:
2024-01-15T10:30:00Z
事件排查工作流
# 1. 快速错误概览
npx @leoflores/datadog-cli errors --from 1h --pretty
# 2. 这是新问题吗?与前一个时期比较
npx @leoflores/datadog-cli logs compare --query "status:error" --period 1h --pretty
# 3. 查找错误模式
npx @leoflores/datadog-cli logs patterns --query "status:error" --from 1h --pretty
# 4. 按服务缩小范围
npx @leoflores/datadog-cli logs search --query "status:error service:api" --from 1h --pretty
# 5. 获取时间戳周围上下文
npx @leoflores/datadog-cli logs context --timestamp "2024-01-15T10:30:00Z" --service api --pretty
# 6. 跟随分布式追踪
npx @leoflores/datadog-cli logs trace --id "TRACE_ID" --pretty
更多调试工作流,请参阅 workflows.md。