logstash-docs-md
Loading

Juggernaut output plugin v3.0.5

  • Plugin version: v3.0.5
  • Released on: 2017-11-07
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

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

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.

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.

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

  • Value type is number
  • Default value is 0

The redis database number.

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

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

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

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

  • Value type is number
  • Default value is 6379

The port to connect on.

  • Value type is number
  • Default value is 5

Redis initial connection timeout in seconds.

These configuration options are supported by all output plugins:

Setting Input type Required
codec codec No
enable_metric boolean No
id string No
  • 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 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.

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