« Versioned gemfire output plugin docs Gemfire output plugin v2.0.6 »

› › ›

Gemfire output plugin v2.0.7

edit

Gemfire output plugin v2.0.7

edit

Plugin version: v2.0.7
Released on: 2018-04-06
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.

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

Gemfire Output 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
`key_format`	string	No
`region_name`	string	No

Also see Common options for a list of options supported by all output 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">
           <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`

edit

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

A sprintf format to use when building keys

`region_name`

edit

Value type is string
Default value is "Logstash"

The region name

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`codec`

edit

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`

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

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

« Versioned gemfire output plugin docs Gemfire output plugin v2.0.6 »