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"
    }
  }