juggernautedit

  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-juggernaut.

Push messages to the juggernaut websockets server:

Wraps Websockets and supports other methods (including xhr longpolling) This is basically, just an extension of the redis output (Juggernaut pulls messages from redis). But it pushes messages to a particular channel and formats the messages in the way juggernaut expects.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

juggernaut {
    channels => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

channels

array

Yes

codec

codec

No

"plain"

db

number

No

0

enable_metric

boolean

No

true

host

string

No

"127.0.0.1"

id

string

No

message_format

string

No

password

password

No

port

number

No

6379

timeout

number

No

5

workers

<<,>>

No

1

Detailsedit

 

channelsedit

  • This is a required setting.
  • Value type is array
  • There is no default value for this setting.

List of channels to which to publish. Dynamic names are valid here, for example logstash-%{type}.

codecedit

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

  • Value type is number
  • Default value is 0

The redis database number.

enable_metricedit

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

hostedit

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

The hostname of the redis server to which juggernaut is listening.

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

message_formatedit

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

How should the message be formatted before pushing to the websocket.

passwordedit

  • Value type is password
  • There is no default value for this setting.

Password to authenticate with. There is no authentication by default.

portedit

  • Value type is number
  • Default value is 6379

The port to connect on.

timeoutedit

  • Value type is number
  • Default value is 5

Redis initial connection timeout in seconds.

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne