fluent-plugin-match_counter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01b4e141cefd46b67981b6e7a738482b690d18e6396e212addece81731867171
+  data.tar.gz: d9ccf51e029aef3a200d3c3dfafd68614b981ad773def796ab033d7a4d83956f
+SHA512:
+  metadata.gz: 3a71764f5341b669db5d436200eb63281ab4cdb7b6e4f86cfff188a6d88ff7dbb684c2c9264fd3fa7e80536785cdc18da91af99dc614fac223da349ce2961279
+  data.tar.gz: 8fd3a83e13fdc5bb8d39b0ae83a3755d685fd97a7a8622b5a7d8da5568f5b60d2cf5ff434aba3b9601d927c067f5f92b96342a25793d5133e13d92631e0544f4

data/lib/fluent/plugin/match_counter.rb

@@ -0,0 +1,82 @@
+# coding: utf-8
+# frozen_string_literal: true
+require 'fluent/plugin/filter'
+
+module Fluent
+  class MatchCounter < Plugin::Filter
+    Fluent::Plugin.register_filter('match_counter', self)
+
+    config_section :match_counter, required: true, multi: true do
+      # REQUIRED
+      desc 'Pattern to be matched'
+      config_param :matcher, :string
+
+      desc 'Name for counter output, "${tag}" will be replaced with record tag'
+      config_param :name, :string
+
+      # OPTIONAL
+      desc 'Input key, where match event is contained; if unset, then search entire event'
+      config_param :event_key, :string, default: nil
+
+      desc 'Use RegExp to match value'
+      config_param :regexp, :bool, default: true
+
+      desc 'Metric type passed to output'
+      config_param :type, :string, default: nil
+
+      desc 'Fields to be merged'
+      config_param :fields, :hash, default: nil
+    end
+
+    def configure(conf)
+      super
+    end
+
+    def filter(tag, time, record)
+      out = []
+      @match_counter.each do |mc|
+        str = \
+          begin
+            ek = mc[:event_key].to_sym
+            next unless ek.nil? || record.has_key?(ek)
+
+            record[ek]
+          rescue
+            record.to_s
+          end
+
+        if !!((mc[:regexp] && Regexp.new(mc[:matcher]).match(str)) || \
+          str.include?(mc[:matcher]))
+
+          name = mc[:name].clone
+          name.gsub!('${tag}', tag) if name.include?('${tag}')
+
+          met = {
+            name: name,
+            value: 1
+          }
+          met[:type] = mc[:type] unless mc[:type].nil?
+          met.merge!(mc[:fields]) unless mc[:fields].nil?
+
+          out << met
+        end
+      end
+
+      return nil if out.empty?
+      out
+    end
+
+    def filter_stream(tag, es)
+      new_es = Fluent::MultiEventStream.new
+      es.each do |time, record|
+        begin
+          new_es.add(time, filter(tag, time, record))
+        rescue => e
+          router.emit_error_event(tag, time, record, e)
+        end
+      end
+
+      new_es
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'bundler/setup'
+require 'test/unit'
+require 'pry'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'test-unit'
+require 'fluent/test'
+require 'fluent/test/helpers'
+require 'fluent/test/driver/filter'
+require 'fluent/plugin/match_counter'
+
+class Fluent::MatchCounterTestHelper < Test::Unit::TestCase
+  def setup
+    super
+
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+    @tag  = 'test'
+  end
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Filter.new(Fluent::MatchCounter).configure(conf)
+  end
+
+  def filter(messages, conf)
+    d = create_driver(conf)
+
+    d.run(default_tag: 'test', start: true, shutdown: false) do
+      messages.each do |message|
+        d.feed(@time, message)
+      end
+    end
+
+    d.filtered_records
+  end
+
+  def config(s = '')
+    %[
+      <match_counter>
+        matcher "^message.+foo.+$"
+        event_key foo
+        name foo
+        type count
+      </match_counter>
+      <match_counter>
+        matcher bar
+        regexp false
+        event_key bar
+        name bar
+      </match_counter>
+    ] + s
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-match_counter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-20 00:00:00.000000000 Z
+dependencies:
+- !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: 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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: FluentD Plugin for counting matched events via a pattern
+email:
+- jmervine@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fluent/plugin/match_counter.rb
+- test/test_helper.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: FluentD Plugin for counting matched events via a pattern
+test_files:
+- test/test_helper.rb