Extract structured fields from an unstructured line
Java Ruby
Latest commit 39cd4a6 Jan 17, 2017 @guyboertje guyboertje committed on GitHub Merge pull request #6 from logstash-plugins/missing_some_thing
"Some" thing got omitted
Permalink
Failed to load latest commit information.
.github all files May 27, 2016
gradle/wrapper Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
lib "Some" thing got omitted Nov 11, 2016
spec Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
src Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
.gitignore Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
.travis.yml Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
BUILD_INSTRUCTIONS.md Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
CHANGELOG.md Add vendor/jars to gemspec require_paths, fix travis badge (#4) Oct 21, 2016
CONTRIBUTORS Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
DEVELOPER.md all files May 27, 2016
Gemfile Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
LICENSE all files May 27, 2016
NOTICE.TXT all files May 27, 2016
README.md Update README.md Oct 24, 2016
Rakefile Updated java source/tests, jars, ruby source and gradle (#1) Oct 15, 2016
VERSION Add vendor/jars to gemspec require_paths, fix travis badge (#4) Oct 21, 2016
build.gradle Add vendor/jars to gemspec require_paths, fix travis badge (#4) Oct 21, 2016
gradlew all files May 27, 2016
gradlew.bat all files May 27, 2016
logstash-filter-dissect.gemspec Add vendor/jars to gemspec require_paths, fix travis badge (#4) Oct 21, 2016
settings.gradle all files May 27, 2016

README.md

Description

Dissect filter is an alternative to Grok filter and can be used to extract structured fields from an unstructured line. However, if the structure of your text varies from line to line then Grok is more suitable. There is a hybrid case where Dissect can be used to de-structure the section of the line that is reliably repeated and then Grok can be used on the remaining field values with more regex predictability and less overall work to do.

A set of fields and delimiters is called a dissection.

The dissection is described using a set of %{} sections: .... %{a} - %{b} - %{c} ....

A field is the text from % to } inclusive.

A delimiter is the text between } and % characters. Delimiters can't contain these }{% characters.

The config might look like this:

 filter {
   dissect {
     mapping => {
       "message" => "%{ts} %{+ts} %{+ts} %{src} %{} %{prog}[%{pid}]: %{msg}"
     }
   }
 }

NOTE

Please read BUILD_INSTRUCTIONS.md

Logstash Plugin

Travis Build Status

This is a plugin for Logstash.

It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

Documentation

Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one central location.

Need Help?

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

Developing

1. Plugin Developement and Testing

Code

  • To get started, you'll need JRuby with the Bundler gem installed.

  • Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.

  • Install dependencies

bundle install

Test

  • Update your dependencies
bundle install
  • Run tests
bundle exec rspec

2. Running your unpublished Plugin in Logstash

2.1 Run in a local Logstash clone

  • Edit Logstash Gemfile and add the local plugin path, for example:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
  • Install plugin
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify

# Prior to Logstash 2.3
bin/plugin install --no-verify
  • Run Logstash with your plugin
bin/logstash -e 'filter {awesome {}}'

At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.

2.2 Run in an installed Logstash

You can use the same 2.1 method to run your plugin in an installed Logstash by editing its Gemfile and pointing the :path to your local plugin development directory or you can build the gem and install it using:

  • Build your plugin gem
gem build logstash-filter-awesome.gemspec
  • Install the plugin from the Logstash home
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify

# Prior to Logstash 2.3
bin/plugin install --no-verify
  • Start Logstash and proceed to test the plugin

Contributing

All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.

It is more important to the community that you are able to contribute.

For more information about contributing, see the CONTRIBUTING file.