Influxdb 输出插件

编辑
  • 插件版本: v5.0.6
  • 发布日期: 2021-06-07
  • 更新日志

对于其他版本,请参阅版本化插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-influxdb 轻松安装。有关详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开设一个主题。对于错误或功能请求,请在Github中开设一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述

编辑

此输出允许您将指标输出到 InfluxDB(>= 0.9.0-rc31)

此处的配置尝试尽可能友好,并尽量减少将多个定义写入多个度量标准的需求,并且仍然高效

InfluxDB API 允许您在每个 http 调用中执行某种形式的批量操作,但每个调用都是数据库特定的

您可以在InfluxDB 主页上了解更多信息

Influxdb 输出配置选项

编辑

此插件支持以下配置选项,以及稍后描述的常用选项

另请参阅常用选项,其中列出了所有输出插件支持的选项。

 

allow_time_override

编辑

允许覆盖事件中的time列吗?

默认情况下,任何名称为time的列都将被忽略,并且时间将由@timestamp的值确定。

将此设置为true允许您显式设置time列本身

注意:time 必须是以秒、毫秒或微秒为单位的纪元值

coerce_values

编辑
  • 值类型为哈希
  • 默认值为{}

允许值强制转换

这将尝试在发布之前将数据点值转换为适当的类型,否则 sprintf 过滤的数值可能会以字符串形式发送,格式为 {'column_name' => 'datatype'}

目前支持的数据类型为integerfloat

data_points

编辑
  • 这是一个必需的设置。
  • 值类型为哈希
  • 默认值为{}

表示要发送到指定数据库的数据点的键/值对的哈希。示例:{'column1' => 'value1', 'column2' => 'value2'}

相同度量标准的事件将在可能的情况下批量处理。键和值都支持 sprintf 格式化

  • 值类型为字符串
  • 默认值为"statistics"

要写入的数据库 - 支持 sprintf 格式化

exclude_fields

编辑
  • 值类型为数组
  • 默认值为 ["@timestamp", "@version", "sequence", "message", "type"]

一个数组,其中包含要从数据点中排除的事件字段的名称

一般来说,事件包含键“@version”和“@timestamp”。其他插件可能会添加您想要排除的其他键(例如,来自 exec 插件的“command”)。

这仅在 use_event_fields_for_data_points 为 true 时适用。

flush_size

编辑
  • 值类型为数字
  • 默认值为100

此设置控制在发送一批事件之前将缓冲多少个事件。请注意,这些仅针对同一度量标准进行批处理

host

编辑
  • 这是一个必需的设置。
  • 值类型为字符串
  • 此设置没有默认值。

连接 InfluxDB 实例的主机名或 IP 地址

idle_flush_time

编辑
  • 值类型为数字
  • 默认值为1

自上次刷新后强制刷新的时间量。

此设置有助于确保缓慢的事件速率不会卡在 Logstash 中。例如,如果您的 flush_size 为 100,并且您收到了 10 个事件,并且自上次刷新以来已经超过了 idle_flush_time 秒,则 logstash 将自动刷新这 10 个事件。

这有助于保持快速和缓慢的日志流以近乎实时的方式移动。

initial_delay

编辑
  • 值类型为数字
  • 默认值为1

在连接失败时延迟初始重试的时间(以秒为单位)。

对于每次重试尝试,延迟将呈指数级增长(最多 max_retries)。

max_retries

编辑
  • 值类型为数字
  • 默认值为3

在丢弃事件之前重试可恢复错误的次数。

值 -1 将导致插件无限期重试。值 0 将导致插件永不重试。否则,它将重试指定的次数。

measurement

编辑
  • 值类型为字符串
  • 默认值为"logstash"

度量标准名称 - 支持 sprintf 格式化

password

编辑
  • 值类型为密码
  • 默认值为nil

有权访问指定数据库的用户的密码

port

编辑
  • 值类型为数字
  • 默认值为8086

InfluxDB 的端口

retention_policy

编辑
  • 值类型为字符串
  • 默认值为"autogen"

要使用的保留策略

send_as_tags

编辑
  • 值类型为数组
  • 默认值为["host"]

一个数组,其中包含要作为标签而不是字段发送到 Influxdb 的字段的名称。Influxdb 0.9 的约定是不经常更改的值应被视为元数据并作为标签给出。仅当 data_points 中存在标签,或者 use_event_fields_for_data_pointstrue 时才发送标签。

启用与 InfluxDB 的 SSL/TLS 安全通信

time_precision

编辑
  • 值可以是:numssmh 中的任何一个
  • 默认值为"ms"

设置time的精度级别

仅在覆盖时间值时有用

use_event_fields_for_data_points

编辑

自动使用事件中的字段作为发送到 Influxdb 的数据点

user

编辑

有权访问指定数据库的用户

常用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为codec
  • 默认值为"plain"

用于输出数据的编解码器。输出编解码器是一种方便的方法,可以在数据离开输出之前对其进行编码,而无需在 Logstash 管道中设置单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用。例如,如果您有 2 个 influxdb 输出。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  influxdb {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。