websocket

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

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

This is what it might look like in your config file: 
output {
  websocket {
    codec => ... # codec (optional), default: "plain"
    host => ... # string (optional), default: "0.0.0.0"
    port => ... # number (optional), default: 3232
    workers => ... # number (optional), default: 1
  }
}

Details

codec

  • 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.

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host

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

The address to serve websocket data from

port

  • Value type is number
  • Default value is 3232

The port to serve websocket data from

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

  • 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.

This is documentation from lib/logstash/outputs/websocket.rb