logstash-filter-grok 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27006dbd92d0134cef4e01124e2ed8300134aeac
-  data.tar.gz: d571e84744111378dcae55c24293e6fdcd4590d0
+  metadata.gz: 214248989cc378b5b01f4e9b6c41fa35e96fd1c6
+  data.tar.gz: 5a4c985d51c98a2826ae0e76e035d995fb6345b6
 SHA512:
-  metadata.gz: 6c8f3172eddad9922c166ee17849475408e4f298f394d0a4672353b56ead744b5c80f4f8080f1c26bb2ed9242b9f7ef4309c66ca66f402d4c22c27f933daf655
-  data.tar.gz: d2cbe6637bb17b6707578c506cdc51ac64aa7720914fb01289b06cc95f456a8d7ed9cb204c88f03b544155a153b8063b85430cc18e0dadf7c70e30778acf250e
+  metadata.gz: 0d044b8680cd9a1c38a3f2a9d1bcb4e219a560abe7e6e5ff54847e96c2b0734a1f6a688cc4297f142b4efbde12397271a55a1af3a1305b3a7a19078f06014539
+  data.tar.gz: c6d2856873a1df6d354112d0f13e9e1a5c8bb3cfbc6a7923b32a262ac7c1312729676643203fddda488753aa7869c7e4505c236f84f1e78498e6f3d02e541a12

data/CONTRIBUTORS

@@ -0,0 +1,39 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Brad Fritz (bfritz)
+* Colin Surprenant (colinsurprenant)
+* Dr. Alexander Papaspyrou (lxndrp)
+* Ehtesh Choudhury (shurane)
+* Greg Brockman (gdb)
+* Guillaume ESPANEL (quatre)
+* Hugo Lopes Tavares (hltbra)
+* Jake Crosby (jakecr)
+* James Turnbull (jamtur01)
+* Jason Kendall (coolacid)
+* Jeff Forcier (bitprophet)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Justin Lambert (jlambert121)
+* Kurt Hurtado (kurtado)
+* Martijn Heemels (Yggdrasil)
+* Neil Prosser (neilprosser)
+* Nick Ethier (nickethier)
+* Pete Fritchman (fetep)
+* Peter Fern (pdf)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+* Yanis Guenane (Spredzy)
+* debadair
+* piavlo
+* yjpa7145
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## 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](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+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
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- 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 me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/grok.rb

@@ -15,7 +15,7 @@
   # and not computer consumption.
   #
   # Logstash ships with about 120 patterns by default. You can find them here:
-  # <https://github.com/logstash/logstash/tree/v%VERSION%/patterns>. You can add
+  # <https://github.com/logstash-plugins/logstash-patterns-core/tree/master/patterns>. You can add
   # your own trivially. (See the `patterns_dir` setting)
   #
   # If you need help building patterns to match your logs, you will find the
@@ -138,7 +138,6 @@
   # `SYSLOGBASE` pattern which itself is defined by other patterns.
   class LogStash::Filters::Grok < LogStash::Filters::Base
     config_name "grok"
-    milestone 3
   
     # Specify a pattern to parse with. This will match the `message` field.
     #
@@ -213,10 +212,12 @@
     # will be parsed and `hello world` will overwrite the original message.
     config :overwrite, :validate => :array, :default => []
   
-    # Detect if we are running from a jarfile, pick the right path.
+    # Register default pattern paths
     @@patterns_path ||= Set.new
-  #@@patterns_path += [LogStash::Environment.pattern_path("*")]
-    @@patterns_path += [LogStash::Patterns::Core.path]
+    @@patterns_path += [
+      LogStash::Patterns::Core.path,
+      LogStash::Environment.pattern_path("*")
+    ]
   
     public
     def initialize(params)

data/logstash-filter-grok.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-grok'
-  s.version         = '0.1.2'
+  s.version         = '0.1.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parse arbitrary text and structure it."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/grok_spec.rb

@@ -644,5 +644,55 @@ describe LogStash::Filters::Grok do
     end
   end
 
+  describe "patterns in the 'patterns/' dir override core patterns" do
+    require 'tmpdir'
+    require 'tempfile'
+
+    before do
+      pattern_dir = File.join(LogStash::Environment::LOGSTASH_HOME, "patterns")
+      @file = Tempfile.new('grok', pattern_dir);
+      @file.write('WORD \b[2-5]\b')
+      @file.rewind
+    end
+
+    let(:config) do
+      'filter { grok { pattern => "%{WORD:word}" } }'
+    end
+
+    sample("message" => 'hello') do
+      insist { subject["tags"] } == ["_grokparsefailure"]
+    end
+
+    after do
+      @file.close; @file.unlink
+    end
+  end
+
+  describe "patterns in custom dir override those in 'patterns/' dir" do
+    require 'tmpdir'
+    require 'tempfile'
+
+    let(:tmpdir) { Dir.mktmpdir }
+
+    before do
+      pattern_dir = File.join(LogStash::Environment::LOGSTASH_HOME, "patterns")
+      @file1 = Tempfile.new('grok', pattern_dir);  @file1.write('WORD \b[2-5]\b'); @file1.rewind
+      @file2 = Tempfile.new('grok', tmpdir);       @file2.write('WORD \b[0-1]\b'); @file2.rewind
+    end
+
+    let(:config) do
+      "filter { grok { patterns_dir => \"#{tmpdir}\" pattern => \"%{WORD:word}\" } }"
+    end
+
+    sample("message" => '0') do
+      insist { subject["tags"] } == nil
+    end
+
+    after do
+      @file1.close; @file1.unlink
+      @file2.close; @file2.unlink
+      FileUtils.remove_entry tmpdir
+    end
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-grok
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -93,8 +93,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - lib/logstash/filters/grok.rb
 - logstash-filter-grok.gemspec