websocket
editwebsocket
edit- Version: 3.0.1
- Released on: 2016-07-14
- Changelog
- Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4
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.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
websocket {
}
Available configuration options:
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.
enable_metric
edit- 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.
id
edit- 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.