Gemfire input pluginedit

Note

This plugin cannot be installed on the current version of Logstash. We are working on resolving this problem.

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.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

gemfire {
}

Available configuration options:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

cache_nameedit

  • Value type is string
  • Default value is "logstash"

Your client cache name

cache_xml_fileedit

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

codecedit

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

interest_regexpedit

  • Value type is string
  • Default value is ".*"

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

queryedit

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

  • Value type is string
  • Default value is "Logstash"

The region name

serializationedit

  • 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

tagsedit

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

threadsedit

  • Value type is number
  • Default value is 1

typeedit

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