Websocket 输出插件

编辑
  • 插件版本:v3.1.0
  • 发布日期:2024-01-11
  • 更新日志

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

此输出运行一个 WebSocket 服务器,并将任何消息发布到所有已连接的 WebSocket 客户端。

您可以使用 ws://<host>:<port>/ 连接到它

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

Websocket 输出配置选项

编辑

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

设置 输入类型 必需

host

字符串

port

数字

另请参阅通用选项,查看所有输出插件支持的选项列表。

 

host

编辑
  • 值类型为字符串
  • 默认值为"0.0.0.0"

从中提供 WebSocket 数据的地址

port

编辑
  • 值类型为数字
  • 默认值为3232

从中提供 WebSocket 数据的端口

通用选项

编辑

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

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为codec
  • 默认值为"plain"

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

enable_metric

编辑

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

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

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

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

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