Influxdb 输出插件编辑

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

有关其他版本,请参阅 版本化插件文档.

安装编辑

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

获取帮助编辑

有关插件的问题,请在 讨论 论坛中创建一个主题。对于错误或功能请求,请在 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 格式化

db编辑

  • 值类型为 字符串
  • 默认值为 "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 时才会发送标签。

ssl编辑

启用到 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编辑

  • 值类型为 boolean
  • 默认值为 true

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

id编辑

  • 值类型为 string
  • 此设置没有默认值。

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

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

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