Websocket 输出插件编辑

  • 插件版本:v3.1.0
  • 发布时间:2024 年 1 月 11 日
  • 更新日志

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

安装编辑

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

获取帮助编辑

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

描述编辑

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

您可以使用 ws://<主机>:<端口>/ 连接到它

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

Websocket 输出配置选项编辑

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

设置 输入类型 必需

主机

字符串

端口

数字

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

 

主机编辑

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

用于提供 websocket 数据的地址

端口编辑

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

用于提供 websocket 数据的端口

通用选项编辑

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

设置 输入类型 必需

启用指标

布尔值

ID

字符串

启用指标编辑

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

ID编辑

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

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

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

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