› ›

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`

编辑

值类型是编解码器
默认值为"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 中搜索它。

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

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