Websocket 输入插件编辑

  • 插件版本:v4.0.4
  • 发布日期:2018-04-06
  • 变更日志

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

安装编辑

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

获取帮助编辑

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

描述编辑

通过 websocket 协议读取事件。

Websocket 输入配置选项编辑

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

设置 输入类型 必需

mode

字符串,其中之一为 ["client"]

url

字符串

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

 

mode编辑

  • 值可以是以下任何一个:client
  • 默认值为 "client"

选择插件的操作模式。目前只支持客户端模式,即此插件连接到 websocket 服务器,并从服务器接收 websocket 消息作为事件。

url编辑

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

要连接的 URL。

通用选项编辑

以下配置选项受所有输入插件支持

设置 输入类型 必需

add_field

hash

codec

codec

enable_metric

boolean

id

字符串

tags

array

type

字符串

详细信息编辑

 

add_field编辑

  • 值类型为 hash
  • 默认值为 {}

向事件添加字段

codec编辑

  • 值类型为 codec
  • 默认值为 "json"

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

enable_metric编辑

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

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

id编辑

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

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

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

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

tags编辑

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

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

这可以帮助以后处理。

type编辑

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

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

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

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

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