Influxdb 输出插件

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

其他版本,请参见 版本化插件文档.

安装

编辑

对于默认情况下未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-influxdb 来轻松安装。更多详情,请参见 使用插件

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发帖提问。如有错误或功能请求,请在 Github 中提交 issue。如需查看 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。当您有两个或多个相同类型的插件时,这一点尤其有用。例如,如果您有两个 influxdb 输出。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

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