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

« wmi 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-input-websocket.

Read events over the websocket protocol.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

websocket {
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`codec`	codec	No	`"json"`
`mode`	string, one of `["server", "client"]`	No	`"client"`
`tags`	array	No
`type`	string	No
`url`	string	No	`"0.0.0.0"`

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "json"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

`mode`

edit

Value can be any of: server, client
Default value is "client"

Operate as a client or a server.

Client mode causes this plugin to connect as a websocket client to the URL given. It expects to receive events as websocket messages.

(NOT IMPLEMENTED YET) Server mode causes this plugin to listen on the given URL for websocket clients. It expects to receive events as websocket messages from these clients.

`tags`

edit

Value type is array
There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

`url`

edit

Value type is string
Default value is "0.0.0.0"

The url to connect to or serve from

« wmi xmpp »