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

› ›

Jms input plugin

edit

Jms input plugin

edit

Plugin version: v3.0.5
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-input-jms. 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

Read events from 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 to pull from a queue: jms { include_header ⇒ false include_properties ⇒ false include_body ⇒ true use_jms_timestamp ⇒ false interval ⇒ 10 destination ⇒ "myqueue" pub-sub ⇒ false yaml_file ⇒ "~/jms.yml" yaml_section ⇒ "mybroker" }

Jms Input Configuration Options

edit

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

Setting	Input type	Required
`broker_url`	string	No
`destination`	string	Yes
`factory`	string	No
`include_body`	boolean	No
`include_header`	boolean	No
`include_properties`	boolean	No
`interval`	number	No
`jndi_context`	hash	No
`jndi_name`	string	No
`password`	string	No
`pub_sub`	boolean	No
`require_jars`	array	No
`runner`	string, one of `["consumer", "async", "thread"]`	No
`selector`	string	No
`threads`	number	No
`timeout`	number	No
`use_jms_timestamp`	boolean	No
`username`	string	No
`yaml_file`	string	No
`yaml_section`	string	No

Also see Common Options for a list of options supported by all input 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

`destination`

edit

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

Name of the destination queue or topic to use.

`factory`

edit

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

Name of JMS Provider Factory class

`include_body`

edit

Value type is boolean
Default value is true

Include JMS Message Body in the event Supports TextMessage, MapMessage and ByteMessage If the JMS Message is a TextMessage or ByteMessage, then the value will be in the "message" field of the event If the JMS Message is a MapMessage, then all the key/value pairs will be added in the Hashmap of the event StreamMessage and ObjectMessage are not supported

`include_header`

edit

Value type is boolean
Default value is true

A JMS message has three parts : Message Headers (required) Message Properties (optional) Message Bodies (optional) You can tell the input plugin which parts should be included in the event produced by Logstash

Include JMS Message Header Field values in the event

`include_properties`

edit

Value type is boolean
Default value is true

Include JMS Message Properties Field values in the event

`interval`

edit

Value type is number
Default value is 10

Polling interval in seconds. This is the time sleeping between asks to a consumed Queue. This parameter has non influence in the case of a subcribed Topic.

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

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

`runner`

edit

Value can be any of: consumer, async, thread
Default value is "consumer"

Choose an implementation of the run block. Value can be either consumer, async or thread

`selector`

edit

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

Set the selector to use to get messages off the queue or topic

`threads`

edit

Value type is number
Default value is 1

`timeout`

edit

Value type is number
Default value is 60

Initial connection timeout in seconds.

`use_jms_timestamp`

edit

Value type is boolean
Default value is false

Convert the JMSTimestamp header field to the @timestamp value of the event

`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

The following configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, 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 inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

`tags`

edit

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

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« Jdbc input plugin Jmx input plugin »