gemfire

Milestone: 1

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.

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

Synopsis

This is what it might look like in your config file:

output {
  gemfire {
    cache_name => ... # string (optional), default: "logstash"
    cache_xml_file => ... # string (optional), default: nil
    codec => ... # codec (optional), default: "plain"
    key_format => ... # string (optional), default: "%{host}-%{@timestamp}"
    region_name => ... # string (optional), default: "Logstash"
    workers => ... # number (optional), default: 1
  }
}

Details

cache_name

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

Your client cache name

cache_xml_file

• Value type is string
• Default value is nil

The path to a GemFire client cache XML file.

Example:

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

codec

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

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

key_format

• Value type is string
• Default value is "%{host}-%{@timestamp}"

A sprintf format to use when building keys

region_name

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

The region name

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

• Value type is number
• Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

---

This is documentation from lib/logstash/outputs/gemfire.rb