fluent-plugin-grok_pure-parser 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa26798ef35727f5de838a43e27aace6f28d0ba7
+  data.tar.gz: bedad52e8c1465f3eecd1f0f33af9fccd6e0132d
+SHA512:
+  metadata.gz: 87f8b7eadc768bf4fb0027848771fa243a7490319f97c65079fd116e1977bf77ddd8e7689e8a420674f550ee83d9f889be1896fae8f15b9094a778379508606a
+  data.tar.gz: b6cd515ba810bab014954cf87c2fe4c50d0dfc98f96687bd1172e6851c21abf9276876e6b8b093541122e86362e4e00387d45c7aa235f3c40d88c43e695c7b08

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-grok_pure-parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alex Hornung
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Fluent::Plugin::grok_pure::Parser
+
+This fluentd parser plugin adds a parse format `grok_pure` which allows using any Grok pattern. It uses the [jls-grok](https://rubygems.org/gems/jls-grok) ruby gem, so it supports all Grok features, including type coercion.
+
+## Installation
+
+Install the plugin by running:
+
+    fluent-gem install fluent-plugin-grok_pure-parser
+
+## Usage
+
+```
+<source>
+  type tail
+  path /path/to/log
+  tag foo.log
+
+  format grok_pure
+  grok_pattern %{HAPROXYHTTP}
+  grok_pattern_path /etc/grok_patterns
+</source>
+```
+
+Setting `format` to `grok_pure` enables the Grok parser. The two main configuration options are `grok_pattern_path`, which must be the path to a directory that contains grok patterns, and `grok_pattern`, which is the pattern used to match and format the record. All named grok patterns will end up as keys in the resulting record.
+
+The following standard format options are also supported:
+
+ - `time_key`: Sets the name of the grok capture group that contains the log timestamp
+ - `time_format`: Sets the format of the log timestamp, for parsing
+ - type coercion via the `TypeConverter` mixin (no official documentation available yet)
+
+Grok patterns can generally be of the form of `%{PATTERN_NAME}`, `%{PATTERN_NAME:CAPTURE_NAME}` or `%{PATTERN_NAME:CAPTURE_NAME:type_coercion}`. See the [Logstash Grok documentation](http://logstash.net/docs/latest/filters/grok) for more details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/fluent-plugin-grok_pure-parser.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-grok_pure-parser"
+  spec.version       = File.read("VERSION").strip
+  spec.authors       = ["Alex Hornung"]
+  spec.email         = ["alex@alexhornung.com"]
+  spec.description   = %q{fluentd parser plugin to be able to use Grok patterns}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/bwalex/fluent-plugin-grok_pure-parser"
+  spec.license       = "MIT"
+  spec.has_rdoc      = false
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jls-grok", "~> 0.11.0"
+  spec.add_dependency "fluentd", "~> 0.10.17"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.4.2"
+end

data/lib/fluent/plugin/parser_grok_pure.rb

@@ -0,0 +1,80 @@
+require 'grok-pure'
+
+module Fluent
+  class TextParser
+    class GrokPure < Parser
+      include TypeConverter
+
+      Plugin.register_parser('grok_pure', self)
+
+      config_param :time_format, :string, :default => nil
+      config_param :time_key, :string, :default => 'time'
+      config_param :grok_pattern, :string
+      config_param :grok_pattern_path, :string, :default => nil
+
+      unless method_defined?(:log)
+        define_method(:log) { $log }
+      end
+
+      class PatternError < ParserError; end
+
+      def initialize
+        super
+        @time_parser = TimeParser.new(@time_format)
+        @mutex = Mutex.new
+        @grok = Grok.new
+        @grok.logger = LogProxy.new(log)
+      end
+
+      def configure(conf)
+        super
+
+        if @grok_pattern_path
+          Dir["#{@grok_pattern_path}/*"].sort.each do |f|
+            @grok.add_patterns_from_file(f)
+          end
+        end
+
+        begin
+          @grok.compile(@grok_pattern, true)
+        rescue Grok::PatternError => e
+          raise PatternError, e.message
+        end
+      end
+
+      def parse(text)
+        time = nil
+        record = {}
+
+        matched = @grok.match_and_capture(text) do |k,v|
+          if k == @time_key
+            time = @mutex.synchronize { @time_parser.parse(v) }
+          else
+            record[k] = @type_converters.nil? ? v : convert_type(k,v)
+          end
+        end
+
+        if matched
+          time ||= Engine.now if @estimate_current_event
+          yield time, record
+        else
+          yield nil, nil
+        end
+      end
+
+      class LogProxy
+        def initialize(logger)
+          @logger = logger
+        end
+
+        def method_missing(sym, *args, &block)
+          @logger.send(sym, *args, &block)
+        end
+
+        %w(debug info warn error fatal).each do |name|
+          define_method("#{name}?".to_sym) { true }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-grok_pure-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Alex Hornung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jls-grok
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: fluentd parser plugin to be able to use Grok patterns
+email:
+- alex@alexhornung.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-grok_pure-parser.gemspec
+- lib/fluent/plugin/parser_grok_pure.rb
+homepage: https://github.com/bwalex/fluent-plugin-grok_pure-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: fluentd parser plugin to be able to use Grok patterns
+test_files: []