fluent-plugin-filter-kv-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ed4b252f8b033a1adf97ff84262c182e16c2e280d0e8a647fca1c93b28851d1
+  data.tar.gz: 9b4801ce9b57c7b2a8705c8f85b963616d2e004f6653ed861700fa3e2e4b4cfe
+SHA512:
+  metadata.gz: f81e9efa55ee3c61d780633e8108e0b3d6f11f83cfc13c1e20a45d4002fa5431e77eaa22df2e381b44b410aa61e1ba93e2284f1bfc017a5e2870a1d460c4d60d
+  data.tar.gz: b949db4abb5d6a62c7abaed2eeb825b100a1a49d27f5f8c0dfdb821ccc9b0da170833ee63a72cefe82331c09f5de396dfc69fe3798b7a31c8bb961c9035b5ac8

data/.github/workflows/ci-release-gem.yml

@@ -0,0 +1,39 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    if: github.actor == github.event.repository.owner.login
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+
+    - name: Slack notification Success
+      if: success()
+      env:
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+      uses: cemkiy/action-slacker@master
+      with:
+        channel: '#github-ci-actions'
+        icon_url: 'https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png'
+        username: 'GitHub'

data/.github/workflows/ci-test-cases.yml

@@ -0,0 +1,33 @@
+name: CI-TEST-CASES
+
+on:
+
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test_cases:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: [2.5, 2.6]
+
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install Dependencies
+      run: |
+        gem install bundler -v 1.17.3
+        bundle install --jobs=4 --retry=3 --path vendor/bundle
+    - name: Run tests
+      run: |
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/*

data/.rbenv-version

@@ -0,0 +1 @@
+2.6.5

data/.ruby-gemset

@@ -0,0 +1 @@
+kvparse

data/CHANGELOG.md

@@ -0,0 +1 @@
+# 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.v0.12

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'fluentd', '~> 0.12.0'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naotoshi Seo
+
+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,48 @@
+# fluent-plugin-filter-kv-parser
+
+A Fluentd filter plugin to parse key value items
+
+## Requirements
+
+Fluentd >= v0.12
+
+## Install
+
+Use RubyGems:
+
+```
+gem install fluent-plugin-filter-kv-parser
+```
+
+## Configuration Examples
+
+```
+<filter **>
+  type key_value_parser
+  key log
+  remove_prefix /^prefix/
+  keys_delimiter /\s+/
+  kv_delimiter_chart '='
+</filter>
+
+<match **>
+  type stdout
+</match>
+```
+
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2015 Naotoshi Seo. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = true
+end
+task :default => :test
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-filter-kv-parser.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-filter-kv-parser"
+  s.version     = "0.0.1"
+  s.authors     = ["Al-waleed Shihadeh"]
+  s.email       = ["wshihadeh.dev@gmail.com"]
+  s.homepage    = "https://github.com/wshihadeh/fluent-plugin-filter-kv-parser.git"
+  s.summary     = "A Fluentd filter plugin to parse key value items"
+  s.description = s.summary
+  s.licenses    = ["MIT"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd", ">= 0.12"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/filter_key_value_parser.rb

@@ -0,0 +1,42 @@
+require 'fluent/filter'
+require 'fluent/parser'
+
+module Fluent
+  class KeyValueParser < Filter
+    Fluent::Plugin.register_filter('key_value_parser', self)
+
+    config_param :key, :string, default: 'log'
+    config_param :remove_key, :bool, default: false
+    config_param :remove_prefix, :string, default: ''
+    config_param :keys_delimiter, :string, default: '/\s+/'
+    config_param :kv_delimiter_chart, :string, default: '='
+
+
+    def configure(conf)
+      super
+      if @keys_delimiter[0] == '/' and @keys_delimiter[-1] == '/'
+        @keys_delimiter = Regexp.new(@keys_delimiter[1..-2])
+      end
+
+      if @remove_prefix[0] == '/' and @remove_prefix[-1] == '/'
+        @remove_prefix = Regexp.new(@remove_prefix[1..-2])
+      end
+    end
+
+    def filter(tag, time, record)
+      log_line = extract_log_line record[@key]
+      log_line.split(@keys_delimiter).each do |kv|
+        key, value = kv.split(@kv_delimiter_chart, 2)
+        record[key] = value
+      end
+
+      record.tap { |r| r.delete(@key) if @remove_key }
+    end
+
+    private
+
+    def extract_log_line(line)
+      line.gsub(@remove_prefix,'').strip
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end

data/test/test_filter_key_value_parser.rb

@@ -0,0 +1,86 @@
+require_relative 'helper'
+require 'fluent/plugin/filter_key_value_parser'
+
+class KeyValueFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(KeyValueParser).configure(conf, true)
+  end
+
+  def filter(d, msgs)
+    d.run {
+      msgs.each {|msg|
+        d.filter(msg, @time)
+      }
+    }
+    d.filtered_as_array
+  end
+
+  test 'test_key_value_parser' do
+    d = create_driver(%[
+        key log
+      ])
+    msg = {
+      'time'      => '2013-02-12 22:01:15 UTC',
+      'log'      => 'key=10 akey=20 zkey=30 dkey=40',
+    }
+    filtered = filter(d, [msg]).first[2]
+    assert_equal 6, filtered.count
+    assert_equal true,  filtered.key?("time")
+    assert_equal true,  filtered.key?("log")
+    assert_equal true,  filtered.key?("key")
+    assert_equal true,  filtered.key?("akey")
+    assert_equal true,  filtered.key?("zkey")
+    assert_equal true,  filtered.key?("dkey")
+  end
+
+  test 'test_remove_key' do
+    d = create_driver(%[
+        key log
+        remove_key true
+      ])
+    msg = {
+      'time'      => '2013-02-12 22:01:15 UTC',
+      'log'      => 'key=10 akey=20 zkey=30 dkey=40',
+    }
+    filtered = filter(d, [msg]).first[2]
+    assert_equal 5, filtered.count
+    assert_equal false,  filtered.key?("log")
+  end
+
+  test 'test_remove_prefix_str' do
+    d = create_driver(%[
+        key log
+        remove_key true
+        remove_prefix 'Start Request'
+      ])
+    msg = {
+      'time'      => '2013-02-12 22:01:15 UTC',
+      'log'      => 'Start Request key=10 akey=20 zkey=30 dkey=40',
+    }
+    filtered = filter(d, [msg]).first[2]
+    assert_equal 5, filtered.count
+    assert_equal false,  filtered.key?("log")
+  end
+
+  test 'test_remove_prefix_regex' do
+    d = create_driver(%[
+        key log
+        remove_key true
+        remove_prefix /^[^ ]+\s[^ ]+/
+      ])
+    msg = {
+      'time'      => '2013-02-12 22:01:15 UTC',
+      'log'      => 'Start Request key=10 akey=20 zkey=30 dkey=40',
+    }
+    filtered = filter(d, [msg]).first[2]
+    assert_equal 5, filtered.count
+    assert_equal false,  filtered.key?("log")
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter-kv-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Al-waleed Shihadeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-05 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: pry
+  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: pry-nav
+  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'
+description: A Fluentd filter plugin to parse key value items
+email:
+- wshihadeh.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci-release-gem.yml"
+- ".github/workflows/ci-test-cases.yml"
+- ".gitignore"
+- ".rbenv-version"
+- ".ruby-gemset"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.v0.12
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-filter-kv-parser.gemspec
+- lib/fluent/plugin/filter_key_value_parser.rb
+- test/helper.rb
+- test/test_filter_key_value_parser.rb
+homepage: https://github.com/wshihadeh/fluent-plugin-filter-kv-parser.git
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Fluentd filter plugin to parse key value items
+test_files: []