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.

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

juggernaut {
    channels => ...
}

Available configuration options:

Setting Input type Required Default value

channels

array

Yes

codec

codec

No

"plain"

db

number

No

0

host

string

No

"127.0.0.1"

message_format

string

No

password

password

No

port

number

No

6379

timeout

number

No

5

workers

number

No

1

Details

 

channels

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

codec

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

db

  • Value type is number
  • Default value is 0

The redis database number.

exclude_tags (DEPRECATED)

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

host

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

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

message_format

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

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

password

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

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

port

  • Value type is number
  • Default value is 6379

The port to connect on.

tags (DEPRECATED)

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

timeout

  • Value type is number
  • Default value is 5

Redis initial connection timeout in seconds.

type (DEPRECATED)

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.