IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« webhdfs xmpp »

› ›

websocket

edit

websocket

edit

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.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

websocket {
}

Available configuration options:

Setting	Input type	Required	Default value
`codec`	codec	No	`"plain"`
`host`	string	No	`"0.0.0.0"`
`port`	number	No	`3232`
`workers`	number	No	`1`

Details

edit

`codec`

edit

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.

`host`

edit

Value type is string
Default value is "0.0.0.0"

The address to serve websocket data from

`port`

edit

Value type is number
Default value is 3232

The port to serve websocket data from

`workers`

edit

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.

« webhdfs xmpp »