community.general.influxdb_write 模块 – 将数据点写入 InfluxDB

注意

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

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

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

要在剧本中使用它，请指定：community.general.influxdb_write。

概要

  • 将数据点写入 InfluxDB。

要求

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

  • influxdb >= 0.9

参数

参数

注释

data_points

列表 / 元素=字典 / 必需

作为字典写入数据库的数据点。

database_name

字符串 / 必需

数据库的名称。

hostname

字符串

InfluxDB 服务器正在侦听的主机名或 IP 地址。

默认值： "localhost"

password

别名：login_password

字符串

将用于向 InfluxDB 服务器进行身份验证的密码。

默认值： "root"

path

字符串

在 community.general 0.2.0 中添加

可以访问 InfluxDB 服务器的路径。

仅在使用 python-influxdb >= 5.1.0 时可用。

默认值： ""

port

整数

InfluxDB 服务器正在侦听的端口。

默认值： 8086

proxies

字典

用于 Requests 连接到 InfluxDB 服务器的 HTTP(S) 代理。

默认值： {}

retries

整数

客户端在中止之前将尝试的重试次数。

0 表示尝试直到成功。

仅在使用 python-influxdb >= 4.1.0 时可用。

默认值： 3

ssl

布尔值

使用 https 而不是 http 连接到 InfluxDB 服务器。

选择

  • false ←（默认）

  • true

timeout

整数

Requests 将等待客户端建立连接的秒数。

udp_port

整数

连接到 InfluxDB 服务器的 UDP 端口。

默认值： 4444

use_udp

布尔值

使用 UDP 连接到 InfluxDB 服务器。

选择

  • false ←（默认）

  • true

username

别名：login_username

字符串

将用于向 InfluxDB 服务器进行身份验证的用户名。

默认值： "root"

validate_certs

布尔值

如果设置为 false，则不会验证 SSL 证书。

只有在使用自签名证书的个人控制站点上时，才应将其设置为 false。

选择

  • false

  • true ←（默认）

属性

属性

支持

描述

check_mode

支持：无

可以在 check_mode 中运行，并返回更改状态预测，而无需修改目标。

diff_mode

支持：无

当处于差异模式时，将返回有关已更改内容（或在 check_mode 中可能需要更改的内容）的详细信息。

示例

- name: Write points into database
  community.general.influxdb_write:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      data_points:
        - measurement: connections
          tags:
            host: server01
            region: us-west
          time: "{{ ansible_date_time.iso8601 }}"
          fields:
            value: 2000
        - measurement: connections
          tags:
            host: server02
            region: us-east
          time: "{{ ansible_date_time.iso8601 }}"
          fields:
            value: 3000

作者

  • René Moser (@resmo)