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

« Irc output plugin Kafka output plugin »

› ›

Juggernaut output plugin

edit

Juggernaut output plugin

edit

Plugin version: v3.0.6
Released on: 2018-04-06
Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-juggernaut. See Working with plugins for more details.

Getting Help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

Push messages to the juggernaut websockets server:

https://github.com/maccman/juggernaut

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.

Juggernaut Output Configuration Options

edit

This plugin supports the following configuration options plus the Common Options described later.

Setting	Input type	Required
`channels`	array	Yes
`db`	number	No
`host`	string	No
`message_format`	string	No
`password`	password	No
`port`	number	No
`timeout`	number	No

Also see Common Options for a list of options supported by all output plugins.

`channels`

edit

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

`db`

edit

Value type is number
Default value is 0

The redis database number.

`host`

edit

Value type is string
Default value is "127.0.0.1"

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

`message_format`

edit

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

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

`password`

edit

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

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

`port`

edit

Value type is number
Default value is 6379

The port to connect on.

`timeout`

edit

Value type is number
Default value is 5

Redis initial connection timeout in seconds.

Common Options

edit

The following configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`codec`

edit

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.

`enable_metric`

edit

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.

`id`

edit

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

Add a unique ID 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 juggernaut outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  juggernaut {
    id => "my_plugin_id"
  }
}

« Irc output plugin Kafka output plugin »