使用 Datadog 监控 APISIX 指标
监控网关流量有助于运维人员发现请求量、延迟和载荷大小的变化,这些变化可能影响 API 的可靠性。将这些指标发送到 Datadog 后,APISIX 活动便可与其他应用和基础设施遥测数据一起用于仪表板、监控和运营分析。
datadog 插件通过 UDP 将 APISIX 的请求、延迟和流量大小指标发送到 DogStatsD 代理,再由该代理将指标转发到 Datadog。
本 示例在 APISIX 快速入门网络中运行 DogStatsD 代理。APISIX 通过容器名称访问代理,并在 Datadog 中验证生成的路由指标。

前置条件
- 安装 Docker。
- 安装 cURL 以向服务发送请求进行验证。
- 按照快速入门教程在 Docker 中启动 APISIX。以下命令使用该教程创建的
apisix-quickstart-net网络。 - 创建一个 Datadog 账户并获取 API Key。
- 如果启用了 Admin API 身份认证,请将管理员角色的密钥导出为
ADMIN_API_KEY。Docker 快速入门为了便于本地评估而禁用了身份认证;生产环境中请保持启用。
启动 DogStatsD 代理
导出 Datadog API Key,然后设置 Datadog 站点和用于标识本示例的主机名:
export DD_API_KEY=replace-with-datadog-api-key
export DD_SITE=datadoghq.com
export DD_HOSTNAME=apisix-quickstart
在 APISIX 快速入门网络中启动 DogStatsD:
docker rm -f quickstart-dogstatsd 2>/dev/null || true
docker run -d --rm \
--name quickstart-dogstatsd \
--network apisix-quickstart-net \
-e DD_API_KEY \
-e DD_SITE \
-e DD_HOSTNAME \
-e DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true \
datadog/dogstatsd:7.81.2@sha256:475f87872f2847e1fe4e60370ad0b3a075726aa5b81f5f507f90ce53cecc7f6d
DD_DOGSTATSD_NON_LOCAL_TRAFFIC 允许代理接收来自 APISIX 容器的指标。由于 APISIX 和 DogStatsD 共享 apisix-quickstart-net,APISIX 可以通过容器名向代理发送指标,无需使用宿主机专用 IP 或发布 UDP 端口。
配置 DogStatsD 端点
该插件默认将指标发送到 127.0.0.1:8125。配置插件元数据,使其改用 DogStatsD 容器:
- Admin API
- ADC
curl "http://127.0.0.1:9180/apisix/admin/plugin_metadata/datadog" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"host": "quickstart-dogstatsd",
"port": 8125,
"namespace": "apisix"
}'
导出完整的插件元数据集合:
adc dump -o adc-plugin-metadata.yaml \
--include-resource-type plugin_metadata
ADC dump 可能包含 Admin API 返回的已解密敏感字段。请限制对导出文件的访问,并在完成变更后将其删除。
编辑导出的文件,在保留其他所有插件元数据的同时添加 Datadog 元数据:
plugin_metadata:
# Keep all other plugin metadata from the exported file.
datadog:
host: quickstart-dogstatsd
port: 8125
namespace: apisix
预览完整的插件元数据集合,并确认差异中没有非预期的变更或删除:
adc diff -f adc-plugin-metadata.yaml \
--include-resource-type plugin_metadata
同步已审查的插件元数据:
adc sync -f adc-plugin-metadata.yaml \
--include-resource-type plugin_metadata
配置指标收集
全局启用 datadog,然后创建一个用于产生监控流量的示例路由:
- Admin API
- ADC
将 datadog 配置为全局插件:
curl "http://127.0.0.1:9180/apisix/admin/global_rules/datadog" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"plugins": {
"datadog": {}
}
}'
创建一个你将收集指标的示例路由:
curl "http://127.0.0.1:9180/apisix/admin/routes/dd-route" -X PUT \
-H "X-API-KEY: ${ADMIN_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"uri": "/anything",
"upstream": {
"type": "roundrobin",
"scheme": "https",
"pass_host": "node",
"nodes": {
"httpbin.org:443": 1
}
}
}'
ADC 会将全局规则导出为一个以插件名为键的 map。导出内容不会保留原始规则 ID,也不会保留哪些插件曾归属于同一条规则。如果多条规则配置了同一个插件,导出结果只会保留一份配置。需要保留原始规则 ID 或分组时,请使用本节的 Admin API 标签页。
导出当前全局规则:
adc dump -o adc-global-rules.yaml \
--include-resource-type global_rule
ADC dump 可能包含 Admin API 返回的已解密敏感字段。请限制对导出文件的访问,并在完成变更后将其删除。
编辑导出的文件,在保留其他所有插件条目的同时添加 Datadog 插件:
global_rules:
# Keep every other global plugin entry from the exported file.
datadog: {}
在单独的文件中创建示例服务:
services:
- name: datadog-httpbin
labels:
docs-example: datadog
routes:
- name: dd-route
uris:
- /anything
upstream:
type: roundrobin
scheme: https
pass_host: node
nodes:
- host: httpbin.org
port: 443
weight: 1
预览全局规则,并确认差异中没有无关的插件变更或删除:
adc diff -f adc-global-rules.yaml \
--include-resource-type global_rule
预览该服务拥有的资源:
adc diff -f adc-route.yaml \
--include-resource-type service \
--label-selector docs-example=datadog
同步已审查的全局规则和服务:
adc sync -f adc-global-rules.yaml \
--include-resource-type global_rule
adc sync -f adc-route.yaml \
--include-resource-type service \
--label-selector docs-example=datadog
验证指标
通过路由发送若干请求以生成指标数据:
for _ in 1 2 3; do
curl -sS "http://127.0.0.1:9080/anything" > /dev/null
done
插件会批量提交指标,因此指标可能不会立即显示。在 Datadog 中打开 Metrics → Explorer,搜索 apisix 命名空间下的指标,包括:
apisix.request.counterapisix.request.latencyapisix.upstream.latencyapisix.apisix.latencyapisix.ingress.sizeapisix.egress.size
使用这些指标创建监控和仪表板。有关指标标签、批处理选项和其他配置,请参阅 datadog Plugin Hub 参考。