fluent-plugin-num-comparison 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72074742508a0fa851aea8e1d0b00d7d2e480f308bf92ea11712fe8b784c0cda
+  data.tar.gz: f5a80daddb2ee54bd8cb7b67ab72d1f5828ba334747a13a2339ed03aaec3eefa
+SHA512:
+  metadata.gz: b9fec99c11d6134e8c9a039596c133695fbf496131d47e2bf3f26b448517df889dcfe1732a27cd6975d9bcac888cb7d13a22d3436df8bab1c2302621f22eb0d6
+  data.tar.gz: ee3f0162b8139ee69c3df234702d3f1f78d6c48f0662748cffe61ca39c106de591ab02176f740a5e3c095e0de2c4170e17f507a4b28fe61c9bcc28b9ecac72f3

data/.github/workflows/test.yaml

@@ -0,0 +1,20 @@
+name: RakeTest
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7.2
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - name: test
+        run: |
+          gem install bundler rake
+          bundle install
+          bundle exec rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 homirun
+
+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,81 @@
+# fluent-plugin-num-comparison
+[![RakeTest](https://github.com/homirun/fluent-plugin-num-comparison/actions/workflows/test.yaml/badge.svg)](https://github.com/homirun/fluent-plugin-num-comparison/actions/workflows/test.yaml)
+
+fluent-plugin-num-comparison is a fluent-plugin that compares the value of a specified key with a threshold value and extracts only the larger or smaller ones.
+
+
+## Installation
+
+### RubyGems
+```
+$ gem install fluent-plugin-num-comparison
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-num-comparison"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+### InputExample
+```json
+{"access_count": 29},
+{"access_count": 30},
+{"access_count": 31},
+```
+
+### ConfigExample
+```
+<source>
+  @type tail
+  path input.txt
+  pos_file input.pos
+  format json
+  tag test
+</source>
+
+<filter test>
+  @type num_comparison
+  record_key access_count
+  threshold 30
+  inequality larger
+</filter>
+
+<match test>
+  @type stdout
+</match>
+
+```
+
+### OutputExample
+```json
+{"access_count": 30},
+{"access_count": 31},
+```
+
+## Params
+- record_key: string  
+  The key of the event record to be compared.
+  
+- threshold: integer  
+  The threshold value to compare with the event record.
+- inequality: string (`larger` || `smaller`)  
+  Decide whether to output a comparison object that is larger or smaller than the threshold.
+  The default value is `larger`.  
+
+
+## Copyright
+
+* Copyright(c) 2021- homirun
+* License
+  * MIT

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-num-comparison.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-num-comparison"
+  spec.version = "0.1.0"
+  spec.authors = ["homirun"]
+  spec.email   = ["me@homi.run"]
+
+  spec.summary       = %q{This plugin that compares thresholds and extracts only the larger or smaller ones.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/homirun/fluent-plugin-num-comparison"
+  spec.license       = "MIT"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/filter_num_comparison.rb

@@ -0,0 +1,52 @@
+#
+# Copyright 2021- homirun
+#
+# 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.
+
+require "fluent/plugin/filter"
+
+module Fluent
+  module Plugin
+    class NumComparisonFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("num_comparison", self)
+
+      config_param :record_key, :string
+      config_param :threshold, :integer
+      # larger or smaller
+      config_param :inequality, :string, default: "larger"
+
+      def configure(conf)
+        super
+        @record_key = @record_key.to_s
+        @threshold = @threshold.to_i
+        @inequality_flag = @inequality == "smaller" ? 0 : 1
+      end
+
+      def filter_stream(tag, es)
+        new_es = Fluent::MultiEventStream.new
+        es.each do |time, record|
+          if @inequality_flag == 0
+            if record[@record_key].to_i < @threshold
+              new_es.add(time, record)
+            end
+          else
+            if record[@record_key].to_i > @threshold
+              new_es.add(time, record)
+            end
+          end
+        end
+        new_es
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/filter"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_filter_num_comparison.rb

@@ -0,0 +1,94 @@
+require "helper"
+require "fluent/plugin/filter_num_comparison.rb"
+
+class NumComparisonFilterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  sub_test_case 'filter' do
+    test 'If inequality-property is <larger> and the value is larger than the threshold, do not delete record.' do
+      config = %[
+          inequality larger
+          record_key count
+          threshold 10
+        ]
+      d = create_driver(config)
+      data = d.run(default_tag: 'test') do
+        d.feed(event_time,
+               {
+                 "count" => "11"
+               })
+      end
+      assert_equal 1, data.count
+    end
+
+    test 'If inequality-property is <larger> and the value is smaller than the threshold, delete record.' do
+      config = %[
+          inequality larger
+          record_key count
+          threshold 10
+        ]
+      d = create_driver(config)
+      data = d.run(default_tag: 'test') do
+        d.feed(event_time,
+               {
+                 "count" => "9"
+               })
+      end
+      assert_equal 0, data.count
+    end
+
+    test 'If inequality-property is <smaller> and the value is smaller than the threshold, do not delete record.' do
+      config = %[
+          inequality smaller
+          record_key count
+          threshold 10
+        ]
+      d = create_driver(config)
+      data = d.run(default_tag: 'test') do
+        d.feed(event_time,
+               {
+                 "count" => "9"
+               })
+      end
+      assert_equal 1, data.count
+    end
+
+    test 'If inequality-property is <smaller> and the value is larger than the threshold, delete record.' do
+      config = %[
+          inequality smaller
+          record_key count
+          threshold 10
+        ]
+      d = create_driver(config)
+      data = d.run(default_tag: 'test') do
+        d.feed(event_time,
+               {
+                 "count" => "11"
+               })
+      end
+      assert_equal 0, data.count
+    end
+
+    test 'if the value is equal to the threshold, delete record.' do
+      config = %[
+          inequality smaller
+          record_key count
+          threshold 10
+        ]
+      d = create_driver(config)
+      data = d.run(default_tag: 'test') do
+        d.feed(event_time,
+               {
+                 "count" => "10"
+               })
+      end
+      assert_equal 0, data.count
+    end
+  end
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::NumComparisonFilter).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-num-comparison
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- homirun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This plugin that compares thresholds and extracts only the larger or
+  smaller ones.
+email:
+- me@homi.run
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yaml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-num-comparison.gemspec
+- lib/fluent/plugin/filter_num_comparison.rb
+- test/helper.rb
+- test/plugin/test_filter_num_comparison.rb
+homepage: https://github.com/homirun/fluent-plugin-num-comparison
+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.1.4
+signing_key: 
+specification_version: 4
+summary: This plugin that compares thresholds and extracts only the larger or smaller
+  ones.
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_num_comparison.rb