Gemfire output plugin v2.0.5

  • 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

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

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.

Gemfire Output Configuration Options

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

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

 

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>

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

Common Options

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

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.

enable_metric

  • 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

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

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