Graphite 输入插件

编辑
  • 插件版本:v3.0.6
  • 发布日期:2018-04-06
  • 更新日志

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

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛中发帖提问。如发现错误或有功能需求,请在 Github 上提交 issue。如需查看 Elastic 支持的插件列表,请参考 Elastic 支持矩阵

描述

编辑

接收 Graphite 指标。此插件理解基于文本的 Graphite carbon 协议。支持 Nspecific-timestamp 两种形式,例如:

    mysql.slow_query.count 204 N
    haproxy.live_backends 7 1364608909

N 表示时间戳为 now (现在)。此插件还支持在指标有效负载中指定时间。

对于从客户端接收到的每个指标,都会发出一个事件,该事件使用指标名称作为字段(例如 mysql.slow_query.count),并将指标值作为字段的值。

Graphite 输入配置选项

编辑

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

设置 输入类型 必填

host

字符串

mode

字符串,选择其中之一:["server", "client"]

port

数字

proxy_protocol

布尔值

ssl_cert

有效的系统文件路径

ssl_enable

布尔值

ssl_extra_chain_certs

数组

ssl_key

有效的系统文件路径

ssl_key_passphrase

密码

ssl_verify

布尔值

另请参阅 常用选项,了解所有输入插件支持的选项列表。

 

data_timeout (已弃用)

编辑
  • 弃用警告:此配置项已弃用,在未来版本中可能不可用。
  • 值类型为 数字
  • 默认值为 -1

host

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

通过 TCP 套接字读取事件。

与 stdin 和文件输入类似,每个事件都被假定为一行文本。

可以根据 mode 接受来自客户端的连接或连接到服务器。当 mode 为 server 时,为监听的地址。当 mode 为 client 时,为连接的地址。

mode

编辑
  • 值可以是:server, client
  • 默认值为 "server"

操作模式。server 监听客户端连接,client 连接到服务器。

port

编辑
  • 此设置是必需的。
  • 值类型为 数字
  • 此设置没有默认值。

当 mode 为 server 时,为监听的端口。当 mode 为 client 时,为连接的端口。

proxy_protocol

编辑

代理协议支持,目前仅支持 v1 http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt

ssl_cacert (已弃用)

编辑
  • 弃用警告:此配置项已弃用,在未来版本中可能不可用。
  • 值类型为 路径
  • 此设置没有默认值。

SSL CA 证书、链文件或 CA 路径。系统 CA 路径会自动包含。

ssl_cert

编辑
  • 值类型为 路径
  • 此设置没有默认值。

SSL 证书路径

ssl_enable

编辑

启用 SSL(必须设置才能使其他 ssl_ 选项生效)。

ssl_extra_chain_certs

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

要添加到证书链的额外 X509 证书数组。当系统存储区中不需要 CA 链时很有用。

ssl_key

编辑
  • 值类型为 路径
  • 此设置没有默认值。

SSL 密钥路径

ssl_key_passphrase

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

SSL 密钥密码

ssl_verify

编辑

根据 CA 验证 SSL 连接另一端的身份。对于输入,将字段 sslsubject 设置为客户端证书的字段。

常用选项

编辑

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

设置 输入类型 必填

add_field

哈希表

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑

向事件添加字段

codec

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

用于输入数据的编解码器。输入编解码器是在数据进入输入之前对其进行解码的便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

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

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

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

input {
  graphite {
    id => "my_plugin_id"
  }
}

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

tags

编辑
  • 值类型为 数组
  • 此设置没有默认值。

向您的事件添加任意数量的标签。

这可以帮助以后的处理。

type

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

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分,因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型(例如,当您从发件人将事件发送到索引器时),则新的输入将不会覆盖现有类型。即使发送到另一个 Logstash 服务器,在发件人处设置的类型也会一直保留在该事件中。