« Gemfire input plugin v2.0.6 Versioned generator input plugin docs »

› › ›

Gemfire input plugin v2.0.5

edit

Gemfire input plugin v2.0.5

edit

Plugin version: v2.0.5
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

Push events to a GemFire region.

GemFire is an object database.

To use this plugin you need to add gemfire.jar to your CLASSPATH. Using format=json requires jackson.jar too; use of continuous queries requires antlr.jar.

Note: this plugin has only been tested with GemFire 7.0.

Gemfire Input Configuration Options

edit

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

Setting	Input type	Required
`cache_name`	string	No
`cache_xml_file`	string	No
`interest_regexp`	string	No
`query`	string	No
`region_name`	string	No
`serialization`	string	No
`threads`	number	No

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

`cache_name`

edit

Value type is string
Default value is "logstash"

Your client cache name

`cache_xml_file`

edit

Value type is string
Default value is nil

The path to a GemFire client cache XML file.

Example:

<client-cache>
  <pool name="client-pool" subscription-enabled="true" subscription-redundancy="1">
      <locator host="localhost" port="31331"/>
  </pool>
  <region name="Logstash">
      <region-attributes refid="CACHING_PROXY" pool-name="client-pool" >
      </region-attributes>
  </region>
</client-cache>

`interest_regexp`

edit

Value type is string
Default value is ".*"

A regexp to use when registering interest for cache events. Ignored if a :query is specified.

`query`

edit

Value type is string
Default value is nil

A query to run as a GemFire "continuous query"; if specified it takes precedence over :interest_regexp which will be ignore.

Important: use of continuous queries requires subscriptions to be enabled on the client pool.

`region_name`

edit

Value type is string
Default value is "Logstash"

The region name

`serialization`

edit

Value type is string
Default value is nil

How the message is serialized in the cache. Can be one of "json" or "plain"; default is plain

`threads`

edit

Value type is number
Default value is 1

Common options

edit

These 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

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

input {
  gemfire {
    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.

« Gemfire input plugin v2.0.6 Versioned generator input plugin docs »