Contents

:plugin: websocket
:type: input
:default_codec: json

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Websocket input plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Read events over the websocket protocol.

[id="plugins-{type}s-{plugin}-options"]
==== Websocket Input Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["client"]`|No
| <<plugins-{type}s-{plugin}-url>> |<<string,string>>|Yes
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-mode"]
===== `mode` 

  * Value can be any of: `client`
  * Default value is `"client"`

Select the plugin's mode of operation. Right now only client mode
is supported, i.e. this plugin connects to a websocket server and
receives events from the server as websocket messages.

[id="plugins-{type}s-{plugin}-url"]
===== `url` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The URL to connect to.



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!:

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
logstash-input-websocket-4.0.4	docs/index.asciidoc