websocketedit

Note

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-websocket.

This output runs a websocket server and publishes any messages to all connected websocket clients.

You can connect to it with ws://<host\>:<port\>/

If no clients are connected, any messages received are ignored.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

websocket {
}

Available configuration options:

Setting Input typeRequiredDefault value

codec

codec

No

"plain"

host

string

No

"0.0.0.0"

port

number

No

3232

workers

number

No

1

Detailsedit

 

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

hostedit

  • Value type is string
  • Default value is "0.0.0.0"

The address to serve websocket data from

portedit

  • Value type is number
  • Default value is 3232

The port to serve websocket data from

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.