:plugin: metricize
:type: filter

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]

=== Metricize filter plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

The metricize filter takes complex events containing a number of metrics
and splits these up into multiple events, each holding a single metric.

Example:

    Assume the following filter configuration:

    filter {
      metricize {
        metrics => [ "metric1", "metric2" ]
      }
    }

    Assuming the following event is passed in:

    {
         type => "type A"
         metric1 => "value1"
         metric2 => "value2"
    }

    This will result in the following 2 events being generated in addition to the original event:

    {                               {
        type => "type A"                type => "type A"
        metric => "metric1"             metric => "metric2"
        value => "value1"               value => "value2"
    }                               }


[id="plugins-{type}s-{plugin}-options"]
==== Metricize Filter Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-drop_original_event>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-metric_field_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-metrics>> |<<array,array>>|Yes
| <<plugins-{type}s-{plugin}-value_field_name>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
filter plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-drop_original_event"]
===== `drop_original_event` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Flag indicating whether the original event should be dropped or not.

[id="plugins-{type}s-{plugin}-metric_field_name"]
===== `metric_field_name` 

  * Value type is <<string,string>>
  * Default value is `"metric"`

Name of the field the metric name will be written to.

[id="plugins-{type}s-{plugin}-metrics"]
===== `metrics` 

  * This is a required setting.
  * Value type is <<array,array>>
  * There is no default value for this setting.

A new matrics event will be created for each metric field in this list.
All fields in this list will be removed from generated events.

[id="plugins-{type}s-{plugin}-value_field_name"]
===== `value_field_name` 

  * Value type is <<string,string>>
  * Default value is `"value"`

Name of the field the metric value will be written to.



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]