datadog-automation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Datadog Automation via Rube MCP

通过Rube MCP实现Datadog自动化

Automate Datadog monitoring and observability operations through Composio's Datadog toolkit via Rube MCP.

Toolkit docs: composio.dev/toolkits/datadog

通过Composio的Datadog工具包，借助Rube MCP自动化Datadog监控与可观测性操作。

工具包文档：composio.dev/toolkits/datadog

Prerequisites

前提条件

Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
Active Datadog connection via
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
datadog
```
Always call
```
RUBE_SEARCH_TOOLS
```
first to get current tool schemas

必须已连接Rube MCP（需具备RUBE_SEARCH_TOOLS权限）
通过
```
RUBE_MANAGE_CONNECTIONS
```
激活Datadog连接，并使用工具包
```
datadog
```
请始终先调用
```
RUBE_SEARCH_TOOLS
```
以获取最新的工具模式

Setup

设置步骤

Get Rube MCP: Add

https://rube.app/mcp

as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

Verify Rube MCP is available by confirming
```
RUBE_SEARCH_TOOLS
```
responds
Call
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
datadog
```
If connection is not ACTIVE, follow the returned auth link to complete Datadog authentication
Confirm connection status shows ACTIVE before running any workflows

获取Rube MCP：在客户端配置中添加

https://rube.app/mcp

作为MCP服务器。无需API密钥 — 只需添加端点即可使用。

确认
```
RUBE_SEARCH_TOOLS
```
可响应，以此验证Rube MCP是否可用
调用
```
RUBE_MANAGE_CONNECTIONS
```
并指定工具包
```
datadog
```
如果连接未处于ACTIVE状态，请按照返回的认证链接完成Datadog身份验证
在运行任何工作流之前，确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. Query and Explore Metrics

1. 查询与探索指标

When to use: User wants to query metric data or list available metrics

Tool sequence:

```
DATADOG_LIST_METRICS
```
- List available metric names [Optional]
```
DATADOG_QUERY_METRICS
```
- Query metric time series data [Required]

Key parameters:

```
query
```
: Datadog metric query string (e.g.,
```
avg:system.cpu.user{host:web01}
```
)
```
from
```
: Start timestamp (Unix epoch seconds)
```
to
```
: End timestamp (Unix epoch seconds)
```
q
```
: Search string for listing metrics

Pitfalls:

Query syntax follows Datadog's metric query format:
```
aggregation:metric_name{tag_filters}
```
```
from
```
and
```
to
```
are Unix epoch timestamps in seconds, not milliseconds
Valid aggregations:
```
avg
```
,
```
sum
```
,
```
min
```
,
```
max
```
,
```
count
```
Tag filters use curly braces:
```
{host:web01,env:prod}
```
Time range should not exceed Datadog's retention limits for the metric type

适用场景：用户需要查询指标数据或列出可用指标

工具执行顺序：

```
DATADOG_LIST_METRICS
```
- 列出可用指标名称（可选）
```
DATADOG_QUERY_METRICS
```
- 查询指标时间序列数据（必填）

关键参数：

```
query
```
：Datadog指标查询字符串（例如：
```
avg:system.cpu.user{host:web01}
```
）
```
from
```
：起始时间戳（Unix纪元秒）
```
to
```
：结束时间戳（Unix纪元秒）
```
q
```
：用于列出指标的搜索字符串

注意事项：

查询语法需遵循Datadog的指标查询格式：
```
aggregation:metric_name{tag_filters}
```
```
from
```
和
```
to
```
为Unix纪元秒级时间戳，而非毫秒
支持的聚合函数：
```
avg
```
、
```
sum
```
、
```
min
```
、
```
max
```
、
```
count
```
标签筛选器使用大括号：
```
{host:web01,env:prod}
```
时间范围不应超过Datadog对该指标类型的保留期限

2. Search and Analyze Logs

2. 搜索与分析日志

When to use: User wants to search log entries or list log indexes

Tool sequence:

```
DATADOG_LIST_LOG_INDEXES
```
- List available log indexes [Optional]
```
DATADOG_SEARCH_LOGS
```
- Search logs with query and filters [Required]

Key parameters:

```
query
```
: Log search query using Datadog log query syntax
```
from
```
: Start time (ISO 8601 or Unix timestamp)
```
to
```
: End time (ISO 8601 or Unix timestamp)
```
sort
```
: Sort order ('asc' or 'desc')
```
limit
```
: Number of log entries to return

Pitfalls:

Log queries use Datadog's log search syntax:
```
service:web status:error
```
Search is limited to retained logs within the configured retention period
Large result sets require pagination; check for cursor/page tokens
Log indexes control routing and retention; filter by index if known

适用场景：用户需要搜索日志条目或列出日志索引

工具执行顺序：

```
DATADOG_LIST_LOG_INDEXES
```
- 列出可用日志索引（可选）
```
DATADOG_SEARCH_LOGS
```
- 使用查询语句与筛选条件搜索日志（必填）

关键参数：

```
query
```
：使用Datadog日志查询语法的搜索语句
```
from
```
：起始时间（ISO 8601或Unix时间戳）
```
to
```
：结束时间（ISO 8601或Unix时间戳）
```
sort
```
：排序顺序（'asc'或'desc'）
```
limit
```
：返回的日志条目数量

注意事项：

日志查询使用Datadog的日志搜索语法：
```
service:web status:error
```
搜索范围仅限于配置保留期内的已留存日志
大型结果集需要分页；请检查游标/页码令牌
日志索引控制路由与保留策略；若已知索引可按其筛选

3. Manage Monitors

3. 管理监控

When to use: User wants to create, update, mute, or inspect monitors

Tool sequence:

```
DATADOG_LIST_MONITORS
```
- List all monitors with filters [Required]
```
DATADOG_GET_MONITOR
```
- Get specific monitor details [Optional]
```
DATADOG_CREATE_MONITOR
```
- Create a new monitor [Optional]
```
DATADOG_UPDATE_MONITOR
```
- Update monitor configuration [Optional]
```
DATADOG_MUTE_MONITOR
```
- Silence a monitor temporarily [Optional]
```
DATADOG_UNMUTE_MONITOR
```
- Re-enable a muted monitor [Optional]

Key parameters:

```
monitor_id
```
: Numeric monitor ID
```
name
```
: Monitor display name
```
type
```
: Monitor type ('metric alert', 'service check', 'log alert', 'query alert', etc.)
```
query
```
: Monitor query defining the alert condition
```
message
```
: Notification message with @mentions
```
tags
```
: Array of tag strings
```
thresholds
```
: Alert threshold values (
```
critical
```
,
```
warning
```
,
```
ok
```
)

Pitfalls:

Monitor
```
type
```
must match the query type; mismatches cause creation failures
```
message
```
supports @mentions for notifications (e.g.,
```
@slack-channel
```
,
```
@pagerduty
```
)
Thresholds vary by monitor type; metric monitors need
```
critical
```
at minimum
Muting a monitor suppresses notifications but the monitor still evaluates
Monitor IDs are numeric integers

适用场景：用户需要创建、更新、静音或查看监控

工具执行顺序：

```
DATADOG_LIST_MONITORS
```
- 按筛选条件列出所有监控（必填）
```
DATADOG_GET_MONITOR
```
- 获取特定监控的详细信息（可选）
```
DATADOG_CREATE_MONITOR
```
- 创建新监控（可选）
```
DATADOG_UPDATE_MONITOR
```
- 更新监控配置（可选）
```
DATADOG_MUTE_MONITOR
```
- 临时静音监控（可选）
```
DATADOG_UNMUTE_MONITOR
```
- 重新启用已静音的监控（可选）

关键参数：

```
monitor_id
```
：数字型监控ID
```
name
```
：监控显示名称
```
type
```
：监控类型（'metric alert'、'service check'、'log alert'、'query alert'等）
```
query
```
：定义告警条件的监控查询语句
```
message
```
：包含@提及的通知消息
```
tags
```
：标签字符串数组
```
thresholds
```
：告警阈值（
```
critical
```
、
```
warning
```
、
```
ok
```
）

注意事项：

监控
```
type
```
必须与查询类型匹配；不匹配会导致创建失败
```
message
```
支持@提及以发送通知（例如：
```
@slack-channel
```
、
```
@pagerduty
```
）
阈值因监控类型而异；指标监控至少需要设置
```
critical
```
阈值
静音监控会抑制通知，但监控仍会继续评估
监控ID为数字整数

4. Manage Dashboards

4. 管理仪表板

When to use: User wants to list, view, update, or delete dashboards

Tool sequence:

```
DATADOG_LIST_DASHBOARDS
```
- List all dashboards [Required]
```
DATADOG_GET_DASHBOARD
```
- Get full dashboard definition [Optional]
```
DATADOG_UPDATE_DASHBOARD
```
- Update dashboard layout or widgets [Optional]
```
DATADOG_DELETE_DASHBOARD
```
- Remove a dashboard (irreversible) [Optional]

Key parameters:

```
dashboard_id
```
: Dashboard identifier string
```
title
```
: Dashboard title
```
layout_type
```
: 'ordered' (grid) or 'free' (freeform positioning)
```
widgets
```
: Array of widget definition objects
```
description
```
: Dashboard description

Pitfalls:

Dashboard IDs are alphanumeric strings (e.g., 'abc-def-ghi'), not numeric
```
layout_type
```
cannot be changed after creation; must recreate the dashboard
Widget definitions are complex nested objects; get existing dashboard first to understand structure
DELETE is permanent; there is no undo

适用场景：用户需要列出、查看、更新或删除仪表板

工具执行顺序：

```
DATADOG_LIST_DASHBOARDS
```
- 列出所有仪表板（必填）
```
DATADOG_GET_DASHBOARD
```
- 获取完整的仪表板定义（可选）
```
DATADOG_UPDATE_DASHBOARD
```
- 更新仪表板布局或组件（可选）
```
DATADOG_DELETE_DASHBOARD
```
- 删除仪表板（不可撤销）（可选）

关键参数：

```
dashboard_id
```
：仪表板标识符字符串
```
title
```
：仪表板标题
```
layout_type
```
：'ordered'（网格布局）或'free'（自由定位）
```
widgets
```
：组件定义对象数组
```
description
```
：仪表板描述

注意事项：

仪表板ID为字母数字字符串（例如：'abc-def-ghi'），而非数字
```
layout_type
```
创建后无法更改；必须重新创建仪表板才能修改
组件定义为复杂的嵌套对象；请先获取现有仪表板以了解其结构
DELETE操作是永久性的；无法撤销

5. Create Events and Manage Downtimes

5. 创建事件与管理停机时间

When to use: User wants to post events or schedule maintenance downtimes

Tool sequence:

```
DATADOG_LIST_EVENTS
```
- List existing events [Optional]
```
DATADOG_CREATE_EVENT
```
- Post a new event [Required]
```
DATADOG_CREATE_DOWNTIME
```
- Schedule a maintenance downtime [Optional]

Key parameters for events:

```
title
```
: Event title
```
text
```
: Event body text (supports markdown)
```
alert_type
```
: Event severity ('error', 'warning', 'info', 'success')
```
tags
```
: Array of tag strings

Key parameters for downtimes:

```
scope
```
: Tag scope for the downtime (e.g.,
```
host:web01
```
)
```
start
```
: Start time (Unix epoch)
```
end
```
: End time (Unix epoch; omit for indefinite)
```
message
```
: Downtime description
```
monitor_id
```
: Specific monitor to downtime (optional, omit for scope-based)

Pitfalls:

Event
```
text
```
supports Datadog's markdown format including @mentions
Downtimes scope uses tag syntax:
```
host:web01
```
,
```
env:staging
```
Omitting
```
end
```
creates an indefinite downtime; always set an end time for maintenance
Downtime
```
monitor_id
```
narrows to a single monitor; scope applies to all matching monitors

适用场景：用户需要发布事件或安排维护停机时间

工具执行顺序：

```
DATADOG_LIST_EVENTS
```
- 列出现有事件（可选）
```
DATADOG_CREATE_EVENT
```
- 发布新事件（必填）
```
DATADOG_CREATE_DOWNTIME
```
- 安排维护停机时间（可选）

事件关键参数：

```
title
```
：事件标题
```
text
```
：事件正文（支持Markdown）
```
alert_type
```
：事件严重级别（'error'、'warning'、'info'、'success'）
```
tags
```
：标签字符串数组

停机时间关键参数：

```
scope
```
：停机时间的标签范围（例如：
```
host:web01
```
）
```
start
```
：开始时间（Unix纪元）
```
end
```
：结束时间（Unix纪元；省略则表示无限期）
```
message
```
：停机时间描述
```
monitor_id
```
：需设置停机的特定监控（可选，省略则基于范围应用）

注意事项：

事件
```
text
```
支持Datadog的Markdown格式，包括@提及
停机时间范围使用标签语法：
```
host:web01
```
、
```
env:staging
```
省略
```
end
```
会创建无限期停机时间；维护时请务必设置结束时间
停机时间
```
monitor_id
```
仅针对单个监控；范围则应用于所有匹配的监控

6. Manage Hosts and Traces

6. 管理主机与追踪

When to use: User wants to list infrastructure hosts or inspect distributed traces

Tool sequence:

```
DATADOG_LIST_HOSTS
```
- List all reporting hosts [Required]
```
DATADOG_GET_TRACE_BY_ID
```
- Get a specific distributed trace [Optional]

Key parameters:

```
filter
```
: Host search filter string
```
sort_field
```
: Sort hosts by field (e.g., 'name', 'apps', 'cpu')
```
sort_dir
```
: Sort direction ('asc' or 'desc')
```
trace_id
```
: Distributed trace ID for trace lookup

Pitfalls:

Host list includes all hosts reporting to Datadog within the retention window
Trace IDs are long numeric strings; ensure exact match
Hosts that stop reporting are retained for a configured period before removal

适用场景：用户需要列出基础设施主机或查看分布式追踪

工具执行顺序：

```
DATADOG_LIST_HOSTS
```
- 列出所有上报的主机（必填）
```
DATADOG_GET_TRACE_BY_ID
```
- 获取特定的分布式追踪（可选）

关键参数：

```
filter
```
：主机搜索筛选字符串
```
sort_field
```
：主机排序字段（例如：'name'、'apps'、'cpu'）
```
sort_dir
```
：排序方向（'asc'或'desc'）
```
trace_id
```
：用于查找追踪的分布式追踪ID

注意事项：

主机列表包含所有在保留期内向Datadog上报的主机
追踪ID为长数字字符串；请确保完全匹配
停止上报的主机会在配置的保留期后被移除

Common Patterns

通用模式

Monitor Query Syntax

监控查询语法

Metric alerts:

avg(last_5m):avg:system.cpu.user{env:prod} > 90

Log alerts:

logs("service:web status:error").index("main").rollup("count").last("5m") > 10

指标告警：

avg(last_5m):avg:system.cpu.user{env:prod} > 90

日志告警：

logs("service:web status:error").index("main").rollup("count").last("5m") > 10

Tag Filtering

标签筛选

Tags use
```
key:value
```
format:
```
host:web01
```
,
```
env:prod
```
,
```
service:api
```
Multiple tags:
```
{host:web01,env:prod}
```
(AND logic)
Wildcard:
```
host:web*
```

标签使用
```
key:value
```
格式：
```
host:web01
```
、
```
env:prod
```
、
```
service:api
```
多标签：
```
{host:web01,env:prod}
```
（逻辑与）
通配符：
```
host:web*
```

Pagination

分页

Use
```
page
```
and
```
page_size
```
or offset-based pagination depending on endpoint
Check response for total count to determine if more pages exist
Continue until all results are retrieved

根据端点不同，使用
```
page
```
和
```
page_size
```
或基于偏移量的分页
检查响应中的总计数以确定是否存在更多页面
持续请求直至获取所有结果

Known Pitfalls

已知注意事项

Timestamps:

Most endpoints use Unix epoch seconds (not milliseconds)
Some endpoints accept ISO 8601; check tool schema
Time ranges should be reasonable (not years of data)

Query Syntax:

Metric queries:
```
aggregation:metric{tags}
```
Log queries:
```
field:value
```
pairs
Monitor queries vary by type; check Datadog documentation

Rate Limits:

Datadog API has per-endpoint rate limits
Implement backoff on 429 responses
Batch operations where possible

时间戳：

大多数端点使用Unix纪元秒（而非毫秒）
部分端点接受ISO 8601格式；请查看工具模式
时间范围应合理（不要跨数年数据）

查询语法：

指标查询：
```
aggregation:metric{tags}
```
日志查询：
```
field:value
```
键值对
监控查询因类型而异；请查阅Datadog文档

速率限制：

Datadog API对每个端点都有速率限制
收到429响应时请实现退避机制
尽可能批量操作

Quick Reference

快速参考

Task	Tool Slug	Key Params
Query metrics	DATADOG_QUERY_METRICS	query, from, to
List metrics	DATADOG_LIST_METRICS	q
Search logs	DATADOG_SEARCH_LOGS	query, from, to, limit
List log indexes	DATADOG_LIST_LOG_INDEXES	(none)
List monitors	DATADOG_LIST_MONITORS	tags
Get monitor	DATADOG_GET_MONITOR	monitor_id
Create monitor	DATADOG_CREATE_MONITOR	name, type, query, message
Update monitor	DATADOG_UPDATE_MONITOR	monitor_id
Mute monitor	DATADOG_MUTE_MONITOR	monitor_id
Unmute monitor	DATADOG_UNMUTE_MONITOR	monitor_id
List dashboards	DATADOG_LIST_DASHBOARDS	(none)
Get dashboard	DATADOG_GET_DASHBOARD	dashboard_id
Update dashboard	DATADOG_UPDATE_DASHBOARD	dashboard_id, title, widgets
Delete dashboard	DATADOG_DELETE_DASHBOARD	dashboard_id
List events	DATADOG_LIST_EVENTS	start, end
Create event	DATADOG_CREATE_EVENT	title, text, alert_type
Create downtime	DATADOG_CREATE_DOWNTIME	scope, start, end
List hosts	DATADOG_LIST_HOSTS	filter, sort_field
Get trace	DATADOG_GET_TRACE_BY_ID	trace_id

Powered by Composio

任务	工具标识	关键参数
查询指标	DATADOG_QUERY_METRICS	query, from, to
列出指标	DATADOG_LIST_METRICS	q
搜索日志	DATADOG_SEARCH_LOGS	query, from, to, limit
列出日志索引	DATADOG_LIST_LOG_INDEXES	无
列出监控	DATADOG_LIST_MONITORS	tags
获取监控	DATADOG_GET_MONITOR	monitor_id
创建监控	DATADOG_CREATE_MONITOR	name, type, query, message
更新监控	DATADOG_UPDATE_MONITOR	monitor_id
静音监控	DATADOG_MUTE_MONITOR	monitor_id
取消静音监控	DATADOG_UNMUTE_MONITOR	monitor_id
列出仪表板	DATADOG_LIST_DASHBOARDS	无
获取仪表板	DATADOG_GET_DASHBOARD	dashboard_id
更新仪表板	DATADOG_UPDATE_DASHBOARD	dashboard_id, title, widgets
删除仪表板	DATADOG_DELETE_DASHBOARD	dashboard_id
列出事件	DATADOG_LIST_EVENTS	start, end
创建事件	DATADOG_CREATE_EVENT	title, text, alert_type
创建停机时间	DATADOG_CREATE_DOWNTIME	scope, start, end
列出主机	DATADOG_LIST_HOSTS	filter, sort_field
获取追踪	DATADOG_GET_TRACE_BY_ID	trace_id

由Composio提供支持