Logstash 参考指南（Websocket输出插件）

Websocket输出插件

• 插件版本：v3.0.5
• 发布于：2018-04-06
• 更新日志

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

安装

对于没有默认绑定的插件，通过运行bin/logstash-plugin install logstash-output-websocket很容易安装，有关更多细节，请参阅使用插件。

获取帮助

有关插件的问题，请在讨论论坛中打开一个主题，对于bug或特性请求，在Github中打开一个issue，关于Elastic支持的插件列表，请考虑Elastic支持矩阵。

描述

这个输出运行一个websocket服务器，并将任何消息发布到所有连接的websocket客户端。

你可以使用ws://<host\>:<port\>/连接到它。

如果没有客户端连接，则忽略接收到的任何消息。

Websocket输出配置选项

这个插件支持以下配置选项以及后面描述的通用选项。

设置	输入类型	要求
host	string	No
port	number	No

还可以查看所有输出插件支持的通用选项列表。

host

• 值类型为string
• 默认值为"0.0.0.0"
• 服务websocket数据的地址

port

• 值类型为number
• 默认值为3232
• 服务websocket数据的端口

通用选项

所有输出插件都支持以下配置选项：

设置	输入类型	要求
codec	codec	No
enable_metric	boolean	No
id	string	No

codec

• 值类型为codec
• 默认值为"plain"
• 用于输出数据的编解码器，输出编解码器是一种方便的方法，可以在数据离开输出之前对其进行编码，而不需要在你的Logstash管道中使用单独的过滤器。

enable_metric

• 值类型为boolean
• 默认值为true
• 为这个特定的插件实例禁用或启用指标日志记录，默认情况下，我们记录了所有我们可以记录的指标，但是你可以禁用特定插件的指标集合。

id

• 值类型为string
• 此设置没有默认值

• 在插件配置中添加唯一的ID，如果没有指定ID，则Logstash将生成一个，强烈建议在配置中设置此ID，当你有两个或多个相同类型的插件时，这一点特别有用。例如，如果你有两个电子邮件输出，在本例中添加一个命名ID将有助于在使用监控API时监控Logstash。

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