websocketedit

  • Version: 3.0.1
  • Released on: 2016-07-14
  • Changelog
Note

This plugin 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"

enable_metric

boolean

No

true

host

string

No

"0.0.0.0"

id

string

No

port

number

No

3232

workers

<<,>>

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.

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

hostedit

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

The address to serve websocket data from

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

portedit

  • Value type is number
  • Default value is 3232

The port to serve websocket data from

workersedit

  • Value type is string
  • Default value is 1