跳到主要内容

参数​

请参阅插件通用配置，了解所有插件通用的配置选项。

  • prefer_name

    boolean

    默认值：true

    如果为 true 且已配置路由或服务名称，则在指标标签中使用该名称；否则使用其 ID。

  • include_path

    boolean

    默认值：false

    如果为 true，则在指标标签中包含匹配的路由路径。API7 企业版 3.9.0、3.10.0 和 APISIX 3.14.0 引入此选项。

  • include_method

    boolean

    默认值：false

    如果为 true，则在指标标签中包含 HTTP 方法。API7 企业版 3.9.0、3.10.0 和 APISIX 3.14.0 引入此选项。

  • constant_tags

    array[string]

    附加到所有指标的静态键值标签。这些标签可用于添加团队归属或环境等元数据，从而更容易在相关端点之间进行筛选、聚合和告警。自 APISIX 3.14.0 和 API7 企业版 3.9.0 起可用。

  • name

    string

    默认值：datadog

    批处理器中的插件唯一标识符。如果使用 Prometheus 监控 APISIX 指标，该名称会导出到 apisix_batch_process_entries 中。

  • batch_max_size

    integer

    默认值：1000

    有效值：

    大于 0

    单个批次允许的最大指标条目数。达到该数量后，批次将发送到 DogStatsD Agent。将此参数设置为 1 会立即处理每个条目。

  • inactive_timeout

    integer

    默认值：5

    有效值：

    大于 0

    将批次发送到 DogStatsD Agent 前等待新指标条目的最长时间（秒）。该值应小于 buffer_duration。

  • buffer_duration

    integer

    默认值：60

    有效值：

    大于 0

    在将批次发送到日志服务之前，允许的最早条目的最大存在时间（秒）。

  • retry_delay

    integer

    默认值：1

    有效值：

    大于或等于 0

    批次发送失败后，重试投递到 DogStatsD Agent 前的等待时间（秒）。

  • max_retry_count

    integer

    默认值：0

    有效值：

    大于或等于 0

    允许的最大重试次数，超过此次数将丢弃日志条目。

插件元数据​

  • host

    string

    默认值：127.0.0.1

    网关可访问的 DogStatsD 服务器主机名或 IP 地址。

  • port

    integer

    默认值：8125

    DogStatsD 服务器端口。

  • namespace

    string

    默认值：apisix

    所有指标的前缀。例如，将命名空间配置为 apisix 后，导出到 Datadog 的 request.counter 指标将显示为 apisix.request.counter。

  • constant_tags

    array[string]

    默认值：[source:apisix]

    指标标签。

  • max_pending_entries

    integer

    默认值：在 APISIX 3.18.0 与 API7 企业版 3.9.19、3.10.6 中为 `8192`

    有效值：

    大于或等于 1

    批处理器中等待处理的最大条目数。当积压达到此限制时，新条目会被丢弃。

    此参数在 API7 企业版 3.9.x 系列中自 3.9.19 起可用，在 3.10.x 系列中自 3.10.6 起可用，并且在 APISIX 中自 3.18.0 起可用。

    有关容量规划和验证指南，请参见批处理器。