› ›

Websocket 输入插件

编辑

Websocket 输入插件

编辑

插件版本：v4.0.4
发布日期：2018-04-06
更新日志

其他版本，请参见版本化插件文档。

安装

编辑

对于非默认捆绑的插件，您可以轻松地运行 bin/logstash-plugin install logstash-input-websocket 命令进行安装。更多详情，请参见使用插件。

获取帮助

编辑

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

描述

编辑

通过 Websocket 协议读取事件。

Websocket 输入配置选项

编辑

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

设置	输入类型	必填
`mode`	字符串，值为 `["client"]` 之一	否
`url`	字符串	是

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

`mode`

编辑

值可以是：client
默认值为 "client"

选择插件的操作模式。目前仅支持客户端模式，即此插件连接到 Websocket 服务器并接收服务器作为 Websocket 消息发送的事件。

`url`

编辑

这是必填设置。
值类型为字符串
此设置没有默认值。

要连接的 URL。

通用选项

编辑

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

设置	输入类型	必填
`add_field`	哈希表	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

值类型为哈希表
默认值为 {}

向事件添加字段

`codec`

编辑

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

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

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这可以帮助以后的处理。

`type`

编辑

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

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

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

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

如果您尝试设置一个已经存在类型的事件（例如，当您从发件人将事件发送到索引器时），则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发件人处设置的类型也会在事件的整个生命周期中保留。

« Varnishlog 输入插件 Wmi 输入插件 »