fluent-plugin-uri-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a55f51dbb0e385c958549ded9a66fcf809bffbb2
+  data.tar.gz: fe62b1f8010f1d293c2ea4cd1bfec3456ff2c28d
+SHA512:
+  metadata.gz: bb7ca9cf114b0dd4ef080ae891f81b17d8ce91a2d450b17295b136324dcce259933a947a184e0da0ae9ead2dcfbb6c5d56df44ed69c8712ec6708da7dff9c80d
+  data.tar.gz: 4e1eba24dead66bf039d056e3241dba725c682006c5c6aa8979f1f3688c06717662cba509c7657cdde0dff7d638fadd6587baf23b50f104cc6942248f67e1726

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2016 Daichi Hirata
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,43 @@
+# fluent-plugin-uri-parser
+
+[![wercker status](https://app.wercker.com/status/a735d29143f3a1a727fc65653bc81e2a/s "wercker status")](https://app.wercker.com/project/bykey/a735d29143f3a1a727fc65653bc81e2a)
+
+This is a Fluentd plugin to parse uri and query string in log messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-uri-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-uri-parser
+
+## Usage
+
+fluent-plugin-uri-parser includes 2 plugins.
+
+* uri_parser filter plugin
+* query_string_parser filter plugin
+
+## TODO
+
+* Write configuration sample in README.md
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/daichirata/fluent-plugin-uri-parser.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-uri-parser.gemspec

@@ -0,0 +1,25 @@
+# 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-uri-parser"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Daichi HIRATA"]
+  spec.email         = ["bunny.hop.md@gmail.com"]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = "This is a Fluentd plugin to parse uri and query string in log messages."
+  spec.description   = "This is a Fluentd plugin to parse uri and query string in log messages."
+  spec.homepage      = "https://github.com/daichirata/fluent-plugin-uri-parser"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd", "~> 0.12.0"
+
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fluent/plugin/filter_query_string_parser.rb

@@ -0,0 +1,44 @@
+class Fluent::QueryStringParserFilter < Fluent::Filter
+  Fluent::Plugin.register_filter("query_string_parser", self)
+
+  config_param :key_name, :string
+  config_param :hash_value_field, :string, default: nil
+  config_param :inject_key_prefix, :string, default: nil
+  config_param :suppress_parse_error_log, :bool, default: false
+  config_param :ignore_key_not_exist, :bool, default: false
+
+  def initialize
+    super
+    require "uri"
+  end
+
+  def filter_stream(tag, es)
+    new_es = Fluent::MultiEventStream.new
+
+    es.each do |time, record|
+      raw_value = record[@key_name]
+      if raw_value.nil?
+        new_es.add(time, record) unless @ignore_key_not_exist
+        next
+      end
+
+      begin
+        values = Hash[URI.decode_www_form(raw_value)]
+
+        unless values.empty?
+          if @inject_key_prefix
+            values = Hash[values.map{|k,v| [ @inject_key_prefix + k, v ]}]
+          end
+          r = @hash_value_field ? { @hash_value_field => values } : values
+          record = record.merge(r)
+        end
+
+        new_es.add(time, record)
+      rescue => e
+        log.warn "parse failed #{e.message}" unless @suppress_parse_error_log
+      end
+    end
+
+    new_es
+  end
+end

data/lib/fluent/plugin/filter_uri_parser.rb

@@ -0,0 +1,76 @@
+class Fluent::URIParserFilter < Fluent::Filter
+  Fluent::Plugin.register_filter("uri_parser", self)
+
+  DEFAULT_PORT_MAP = {
+    "http" => 80,
+    "https" => 443
+  }
+
+  config_param :key_name, :string
+  config_param :hash_value_field, :string, default: nil
+  config_param :inject_key_prefix, :string, default: nil
+  config_param :suppress_parse_error_log, :bool, default: false
+  config_param :ignore_key_not_exist, :bool, default: false
+  config_param :ignore_nil, :bool, default: false
+
+  config_param :out_key_scheme, :string, default: nil
+  config_param :out_key_host, :string, default: nil
+  config_param :out_key_port, :string, default: nil
+  config_param :out_key_path, :string, default: nil
+  config_param :out_key_query, :string, default: nil
+  config_param :out_key_fragment, :string, default: nil
+
+  def initialize
+    super
+    require "uri"
+  end
+
+  def filter_stream(tag, es)
+    new_es = Fluent::MultiEventStream.new
+
+    es.each do |time, record|
+      raw_value = record[@key_name]
+      if raw_value.nil?
+        new_es.add(time, record) unless @ignore_key_not_exist
+        next
+      end
+
+      begin
+        scheme, host, port, path, query, fragment = parse_uri(raw_value)
+
+        values = {}
+        values[@out_key_scheme] = scheme if @out_key_scheme
+        values[@out_key_host] = host if @out_key_host
+        values[@out_key_port] = port if @out_key_port
+        values[@out_key_path] = path if @out_key_path
+        values[@out_key_query] = query if @out_key_query
+        values[@out_key_fragment] = fragment if @out_key_fragment
+        values.reject! {|_, v| v.nil? } if @ignore_nil
+
+        unless values.empty?
+          if @inject_key_prefix
+            values = Hash[values.map{|k,v| [ @inject_key_prefix + k, v ]}]
+          end
+          r = @hash_value_field ? { @hash_value_field => values } : values
+          record = record.merge(r)
+        end
+
+        new_es.add(time, record)
+      rescue => e
+        log.warn "parse failed #{e.message}" unless @suppress_parse_error_log
+      end
+    end
+
+    new_es
+  end
+
+  private
+
+  def parse_uri(uri)
+    # URI.parse is useful, but it's very slow.
+    scheme, _, host, port, _, path, _, query, fragment = URI.split(uri)
+    port = port.nil? ? DEFAULT_PORT_MAP[scheme] : port.to_i
+
+    [scheme, host, port, path, query, fragment]
+  end
+end

data/wercker.yml

@@ -0,0 +1,25 @@
+box: ruby:2.3.0
+# Build definition
+build:
+  steps:
+    - script:
+      name: update bundler
+      code: gem update bundler
+
+    # A step that executes `bundle install` command
+    - bundle-install:
+      jobs: 4
+
+    # A custom script step, name value is used in the UI
+    # and the code value contains the command that get executed
+    - script:
+      name: echo ruby information
+      code: |
+        echo "ruby version $(ruby --version) running"
+        echo "from location $(which ruby)"
+        echo -p "gem list: $(gem list)"
+
+    # Add more steps here:
+    - script:
+      name: test
+      code: bundle exec rake test

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-uri-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daichi HIRATA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This is a Fluentd plugin to parse uri and query string in log messages.
+email:
+- bunny.hop.md@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-uri-parser.gemspec
+- lib/fluent/plugin/filter_query_string_parser.rb
+- lib/fluent/plugin/filter_uri_parser.rb
+- wercker.yml
+homepage: https://github.com/daichirata/fluent-plugin-uri-parser
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This is a Fluentd plugin to parse uri and query string in log messages.
+test_files: []