« Jms output plugin v3.0.3 Versioned juggernaut output plugin docs »

› › ›

Jms output plugin v3.0.1

edit

Jms output plugin v3.0.1

edit

Plugin version: v3.0.1
Released on: 2017-06-23
Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

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

Write events to a Jms Broker. Supports both Jms Queues and Topics.

For more information about Jms, see http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html For more information about the Ruby Gem used, see http://github.com/reidmorrison/jruby-jms Here is a config example : jms { include_header ⇒ false include_properties ⇒ false include_body ⇒ true use_jms_timestamp ⇒ false queue_name ⇒ "myqueue" yaml_file ⇒ "~/jms.yml" yaml_section ⇒ "mybroker" }

Jms Output Configuration Options

edit

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

Setting	Input type	Required
`broker_url`	string	No
`delivery_mode`	string	No
`destination`	string	No
`factory`	string	No
`jndi_context`	hash	No
`jndi_name`	string	No
`password`	string	No
`pub_sub`	boolean	No
`require_jars`	array	No
`username`	string	No
`yaml_file`	string	No
`yaml_section`	string	No

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

`broker_url`

edit

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

Url to use when connecting to the JMS provider

`delivery_mode`

edit

Value type is string
Default value is nil

Name of delivery mode to use Options are "persistent" and "non_persistent" if not defined nothing will be passed.

`destination`

edit

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

Name of the destination queue or topic to use. Mandatory

`factory`

edit

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

Name of JMS Provider Factory class

`jndi_context`

edit

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

Mandatory if jndi lookup is being used, contains details on how to connect to JNDI server

`jndi_name`

edit

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

Name of JNDI entry at which the Factory can be found

`password`

edit

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

Password to use when connecting to the JMS provider

`pub_sub`

edit

Value type is boolean
Default value is false

If pub-sub (topic) style should be used or not. Mandatory

`require_jars`

edit

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

If you do not use an yaml configuration use either the factory or jndi_name. An optional array of Jar file names to load for the specified JMS provider. By using this option it is not necessary to put all the JMS Provider specific jar files into the java CLASSPATH prior to starting Logstash.

`username`

edit

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

Username to connect to JMS provider with

`yaml_file`

edit

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

Yaml config file

`yaml_section`

edit

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

Yaml config file section name For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)

Common options

edit

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

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

« Jms output plugin v3.0.3 Versioned juggernaut output plugin docs »