Contents

# Logstash Merge Filter Documentation

[![Travis Build Status](https://travis-ci.org/tiwilliam/logstash-filter-merge.svg)](https://travis-ci.org/tiwilliam/logstash-filter-merge)
[![Gem Version](https://badge.fury.io/rb/logstash-filter-merge.svg)](https://badge.fury.io/rb/logstash-filter-merge)

This filter helps you to merge your fields.

## Merge with root

```
merge {
    field => "something"
}
```

## Only merge new fields to root

```
merge {
    field => "something"
    overwrite => false
}
```

## Merge with custom target

```
merge {
    field => "something"
    target => "something_else"
}
```

## Merge only whitelisted keys

```
merge {
	field => "something"
	whitelist => ["user_agent", "browser_family"]
}
```

## Filter options

* **field**

  The source field to read data from.

* **target**

  The field to merge source field with. Defaults to event root.

* **overwrite**

  Overwrite target fields with source field. Defaults to `true`.

* **whitelist**

  If source is a hash, only merge keys listed in this array. Disabled by default.

## Changelog

You can read about all changes in [CHANGELOG.md](CHANGELOG.md).

## Need help?

Need help? Try #logstash on freenode IRC or the [Logstash discussion forum](https://discuss.elastic.co/c/logstash).

## Want to contribute?

Get started by reading [BUILD.md](BUILD.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
logstash-filter-merge-1.0.1	README.md
logstash-filter-merge-1.0.0	README.md