community.general.statsd 模块 – 发送指标到 StatsD

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 Playbook 中使用它，请指定：community.general.statsd。

community.general 2.1.0 中的新增功能

概要 

statsd 模块将指标发送到 StatsD。
有关更多信息，请参阅 https://statsd-metrics.readthedocs.io/en/latest/。
支持的指标类型是 counter 和 gauge。当前不支持的指标类型是 timer、set 和 gaugedelta。

要求 

在执行此模块的主机上需要以下要求。

statsd

参数 

参数	注释
delta 布尔值	如果指标的类型为 `gauge`，则按 `delta` 更改值。选择 `false` ← (默认) `true`
host 字符串	要将指标发送到的 StatsD 主机（主机名或 IP）。默认： `"localhost"`
metric 字符串 / 必需	指标的名称。
metric_prefix 字符串	要添加到指标的前缀。默认： `""`
metric_type 字符串 / 必需	指标的类型。选择 `"counter"` `"gauge"`
port 整数	StatsD 正在监听的 `host` 上的端口。默认： `8125`
protocol 字符串	用于发送指标的传输协议。选择 `"udp"` ← (默认) `"tcp"`
state 字符串	检查的状态，只有 `present` 有意义。选择 `"present"` ← (默认)
timeout 浮点数	发送方超时，仅当 `protocol` 为 `tcp` 时适用。默认： `1.0`
value 整数 / 必需	指标的值。

属性 

属性	支持	描述
check_mode	支持：无	可以在 `check_mode` 中运行并返回已更改的状态预测，而无需修改目标。
diff_mode	支持：无	在 diff 模式下运行时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: Increment the metric my_counter by 1
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_counter
    metric_type: counter
    value: 1

- name: Set the gauge my_gauge to 7
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_gauge
    metric_type: gauge
    value: 7

作者

Mark Mercado (@mamercad)