« Google_pubsub 输入插件 Heartbeat 输入插件 »
Elastic 文档 ›Logstash 参考 [8.17] ›输入插件

Graphite 输入插件

编辑

Graphite 输入插件

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

有关其他版本，请参阅版本化插件文档。

获取帮助

编辑

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

描述

编辑

接收 Graphite 指标。此插件理解基于文本的 Graphite Carbon 协议。支持 N 和 特定时间戳 两种形式，例如

    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

编辑

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

enable_metric

编辑

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

id

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

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

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

id 字段中的变量替换仅支持环境变量，不支持使用 secret store 中的值。

tags

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

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

这可以帮助以后的处理。

type

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型（例如，当您将事件从托运人发送到索引器时），则新输入将不会覆盖现有类型。在托运人处设置的类型将始终伴随该事件，即使将其发送到另一个 Logstash 服务器也是如此。

« Google_pubsub 输入插件 Heartbeat 输入插件 »