Skip to main content
Version: 3.11

datadog

简介#

datadog 是 Apache APISIX 内置的监控插件，可与 Datadog（云应用最常用的监控和可观测性平台之一）无缝集成。datadog 插件支持对每个请求和响应周期进行多种指标参数的获取，这些指标参数基本反映了系统的行为和健康状况。

datadog 插件通过 UDP 协议将其自定义指标推送给 DogStatsD 服务器，该服务器通过 UDP 连接与 Datadog Agent 捆绑在一起（关于如何安装 Datadog Agent，请参考Agent ）。DogStatsD 基本上是 StatsD 协议的实现，它为 Apache APISIX Agent 收集自定义指标，并将其聚合成单个数据点，发送到配置的 Datadog 服务器。更多关于 DogStatsD 的信息，请参考 DogStatsD 。

datadog 插件具有将多个指标参数组成一个批处理统一推送给外部 Datadog Agent 的能力，并且可以重复使用同一个数据包套接字。

此功能可以有效解决日志数据发送不及时的问题。在创建批处理器之后，如果对 inactive_timeout 参数进行配置，那么批处理器会在配置好的时间内自动发送日志数据。如果不进行配置，时间默认为 5s。

关于 Apache APISIX 的批处理程序的更多信息，请参考 Batch-Processor

APISIX-Datadog plugin 工作原理#

APISIX-Datadog 插件将其自定义指标推送到 DogStatsD server。而 DogStatsD server 通过 UDP 连接与 Datadog agent 捆绑在一起。DogStatsD 是 StatsD 协议的一个实现。它为 Apache APISIX agent 收集自定义指标，将其聚合成一个数据点，并将其发送到配置的 Datadog server。要了解更多关于 DogStatsD 的信息，请访问 DogStatsD 文档。

当你启用 APISIX-Datadog 插件时，Apache APISIX agent 会在每个请求响应周期向 DogStatsD server 输出以下指标：

参数名称StatsD 类型描述
Request CounterCounter收到的请求数量。
Request LatencyHistogram处理该请求所需的时间，以毫秒为单位。
Upstream latencyHistogram上游 server agent 请求到收到响应所需的时间，以毫秒为单位。
APISIX LatencyHistogramAPISIX agent 处理该请求的时间，以毫秒为单位。
Ingress SizeTimer请求体大小，以字节为单位。
Egress SizeTimer响应体大小，以字节为单位。

这些指标将被发送到 DogStatsD agent，并带有以下标签。如果任何特定的标签没有合适的值，该标签将被直接省略。

参数名称描述
route_name路由的名称，如果不存在，将显示路由 ID。
service_id如果一个路由是用服务的抽象概念创建的，那么特定的服务 ID 将被使用。
consumer如果路由有一个链接的消费者，消费者的用户名将被添加为一个标签。
balancer_ip处理了当前请求的上游复制均衡器的的 IP。
response_statusHTTP 响应状态代码。
scheme已用于提出请求的协议，如 HTTP、gRPC、gRPCs 等。

APISIX-Datadog 插件维护了一个带有 timer 的 buffer。当 timer 失效时，APISIX-Datadog 插件会将 buffer 的指标作为一个批量处理程序传送给本地运行的 DogStatsD server。这种方法通过重复使用相同的 UDP 套接字，对资源的占用较少，而且由于可以配置 timer，所以不会一直让网络过载。

如何使用插件#

前提：Datadog Agent#

  1. 首先你必须在系统中安装一个 Datadog agent。它可以是一个 docker 容器，一个 pod 或是一个二进制的包管理器。你只需要确保 Apache APISIX agent 可以到达 Datadog agent 的 8125 端口。
  2. 如果你从没使用过 Datadog
    1. 首先访问 www.datadoghq.com ，创建一个账户。
    2. 然后按照下图标注的步骤生成 API 密钥。
  3. APISIX-Datadog 插件只需要依赖 datadog/agent 的 dogstatsd 组件即可实现，因为该插件按照 statsd 协议通过标准的 UDP 套接字向 DogStatsD server 异步发送参数。我们推荐使用独立的 datadog/dogstatsd 镜像，而不是使用完整的datadog/agent ，因为 datadog/dogstatsd 的组件大小只有大约 11 MB，更加轻量化。而完整的 datadog/agent 镜像的大小为 2.8 GB。

运行以下命令，将它作为一个容器来运行：

# pull the latest image
docker pull datadog/dogstatsd:latest
# run a detached container
docker run -d --name dogstatsd-agent -e DD_API_KEY=<Your API Key from step 2> -p 8125:8125/udp datadog/dogstatsd

如果你在生产环境中使用 Kubernetes，你可以将 dogstatsd 作为一个 Daemonset 或 Multi-Container Pod 与 Apache APISIX agent 一起部署。

启用插件#

本小节介绍了如何在指定路由上启用 datadog 插件。进行以下操作之前请确认您的 Datadog Agent 已经启动并正常运行。

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
{
      "plugins": {
            "datadog": {}
       },
      "upstream": {
           "type": "roundrobin",
           "nodes": {
               "127.0.0.1:1980": 1
           }
      },
      "uri": "/hello"
}'

现在，任何对 uri /hello 的请求都会生成上述指标，并推送到 Datadog Agent 的 DogStatsD 服务器。

删除插件#

删除插件配置中相应的 JSON 配置以禁用 datadog。 APISIX 插件是支持热加载的，所以不用重新启动 APISIX，配置就能生效。

curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

补充：自定义配置#

在默认配置中，datadog 插件希望 Dogstatsd 服务在 127.0.0.1:8125 可用。如果你想更新配置，请更新插件的元数据。如果想要了解更多关于 datadog 插件元数据的字段，请参阅元数据。

向 /apisix/admin/plugin_metadata/datadog 发起请求，更改其元数据。操作示例如下：

curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/datadog -H "X-API-KEY: $admin_key" -X PUT -d '
{
    "host": "172.168.45.29",
    "port": 8126,
    "constant_tags": [
        "source:apisix",
        "service:custom"
    ],
    "namespace": "apisix"
}'

上述命令将会更新元数据，后续各指标将通过 UDP StatsD 推送到 172.168.45.29:8126 上对应的服务，并且配置将被热加载，不需要重新启动 APISIX 实例，就可以使配置生效。

如果你想把 datadog 插件的元数据 schema 恢复到默认值，只需向同一个服务地址再发出一个 Body 为空的 PUT 请求。示例如下：

curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/datadog \
-H "X-API-KEY: $admin_key" -X PUT -d '{}'

配置属性#

属性#

名称类型必选项默认值有效值描述
prefer_namebooleanoptionaltruetrue/false如果设置为 false，将使用路由/服务的 id 值作为插件的 route_name，而不是带有参数的标签名称。

该插件支持使用批处理程序来聚集和处理条目（日志/数据）的批次。这就避免了插件频繁地提交数据，默认情况下，批处理程序每 5 秒或当队列中的数据达到 1000 时提交数据。有关信息或自定义批处理程序的参数设置，请参阅批处理程序 配置部分。

元数据#

名称类型必选项默认值描述
hoststringoptional"127.0.0.1"DogStatsD 服务器的主机地址
portintegeroptional8125DogStatsD 服务器的主机端口
namespacestringoptional"apisix"由 APISIX 代理发送的所有自定义参数的前缀。对寻找指标图的实体很有帮助，例如：apisix.request.counter。
constant_tagsarrayoptional[ "source:apisix" ]静态标签嵌入到生成的指标中。这对某些信号的度量进行分组很有用。

要了解更多关于如何有效地编写标签，请访问这里

输出指标#

启用 datadog 插件之后，APISIX 就会按照下面的指标格式，将数据整理成数据包最终发送到 DogStatsD server。

Metric NameStatsD TypeDescription
Request CounterCounter收到的请求数量。
Request LatencyHistogram处理该请求所需的时间（以毫秒为单位）。
Upstream latencyHistogram代理请求到上游服务器直到收到响应所需的时间（以毫秒为单位）。
APISIX LatencyHistogramAPISIX 代理处理该请求的时间（以毫秒为单位）。
Ingress SizeTimer以字节为单位的请求体大小。
Egress SizeTimer以字节为单位的响应体大小。

这些指标会带有以下标签，并首先被发送到本地 DogStatsD Agent。

如果一个标签没有合适的值，该标签将被直接省略。

  • route_name：在路由模式定义中指定的名称，如果不存在或插件属性 prefer_name 被设置为 false，它将默认使用路由/服务的 id 值。
  • service_name：如果一个路由是用服务的抽象概念创建的，特定的服务 name/id（基于插件的 prefer_name 属性）将被使用。
  • consumer：如果路由有一个正在链接中的消费者，那么消费者的用户名将被添加为一个标签。
  • balancer_ip：处理当前请求的上游负载均衡器的 IP。
  • response_status：HTTP 响应状态代码。
  • scheme：已用于提出请求的协议，如 HTTP、gRPC、gRPCs 等。