Websocket output plugin
- Plugin version: v3.1.0
- Released on: 2024-01-11
- Changelog
For other versions, see theVersioned plugin docs.
For plugins not bundled by default, it is easy to install by runningbin/logstash-plugin install logstash-output-websocket
. SeeWorking with plugins for more details.
For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.
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.
This plugin supports the following configuration options plus theCommon options described later.
Also seeCommon options for a list of options supported by all output plugins.
- Value type isstring
- Default value is
"0.0.0.0"
The address to serve websocket data from
- Value type isnumber
- Default value is
3232
The port to serve websocket data from
These configuration options are supported by all output plugins:
- Value type iscodec
- 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.
- Value type isboolean
- 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.
- Value type isstring
- There is no default value for this setting.
Add a uniqueID
to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 websocket outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { websocket { id => "my_plugin_id" }}
Variable substitution in theid
field only supports environment variables and does not support the use of values from the secret store.