fluent-plugin-label-router 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c9fe1a41256dc29a1a7ff87833cfb6f7f4ca6e4ab330b185aa85f66e0e35b3
-  data.tar.gz: 2440249e93baffc3de72dd31fe70ef6d83ce5f4832b9af615a338bb855489cb4
+  metadata.gz: 8db0a645ba254d2ab4e728cae01d96f8e0b4d10d299b69321740d0a183475aa3
+  data.tar.gz: ce2821e9db352d06d402acc1a1962711a4256e40f754fc5fb01b7a444fa69e96
 SHA512:
-  metadata.gz: 0fc6928ca8716774f8291eb013b737f31d2e6d02b34dee5d473ae644c7898aa8145aca73b3691c9ed4520165d3ee19f63da7dee72d48dc1b416c4fd54e45e79f
-  data.tar.gz: cc9afbd8db7ac5c1f10001c6bc91403eb9961b529773f210f3c9b2ac7bf877c792a10e18f6b04cec5b1526762238b3f081f51cce08b4d4a867ebba63f28030d7
+  metadata.gz: 453fdada4c6b1d6d06102203cde03030fdb97e9ae3d4a3cbddd78eb5fa45c61b650c537e2e7333f7d775527512adf92247c795d24dffe945209887d7e7539562
+  data.tar.gz: bad2d5a50a3b6a78bde32b3820690cfce2c2c97a56649ac6a319a7610d81a9634223ac078013145b6c04a39868712a0820fdd667d6820ef87ee273a825d65a86

data/README.md

@@ -192,7 +192,7 @@ Use `default_label` and/or `default_tag` to route non matching records.
 ```
 <match example.tag**>
   @type label_router
-  default_label @default_sink
+  default_route @default_sink
   <route>
      ...
   </route>

data/fluent-plugin-label-router.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-label-router"
-  spec.version = "0.2.1"
+  spec.version = "0.2.6"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 
@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_dependency "prometheus-client", ">= 2.1.0"
   spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
 end

data/lib/fluent/plugin/out_label_router.rb

@@ -11,10 +11,11 @@
 # 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.
+# limitations under the License
 
 require "fluent/plugin/output"
-require 'digest/md5'
+require 'prometheus/client'
+
 
 module Fluent
   module Plugin
@@ -34,12 +35,16 @@ module Fluent
       config_param :default_route, :string, :default => ""
       desc "Default tag to drain unmatched patterns"
       config_param :default_tag, :string, :default => ""
+      desc "Enable metrics for the router"
+      config_param :metrics, :bool, :default => false
 
       config_section :route, param_name: :routes, multi: true do
         desc "New @LABEL if selectors matched"
         config_param :@label, :string, :default => nil
         desc "New tag if selectors matched"
         config_param :tag, :string, :default => ""
+        desc "Extra labels for metrics"
+        config_param :metrics_labels, :hash, :default => {}
 
         config_section :match, param_name: :matches, multi: true do
           desc "Label definition to match record. Example: app:nginx. You can specify more values as comma separated list: key1:value1,key2:value2"
@@ -53,16 +58,25 @@ module Fluent
           desc "Negate the selection making it an exclude"
           config_param :negate, :bool, :default => false
         end
-
       end
 
-
-
       class Route
-        def initialize(matches, tag, router)
+        def initialize(rule, router, registry)
           @router = router
-          @matches = matches
-          @tag = tag
+          @matches = rule['matches']
+          @tag = rule['tag'].to_s
+          @label = rule['@label']
+          @metrics_labels = (rule['metrics_labels'].map { |k, v| [k.to_sym, v] }.to_h if rule['metrics_labels'])
+          @counter = nil
+          unless registry.nil?
+              @counter = registry.counter(:fluentd_router_records_total, "Total number of events router for the flow")
+          end
+        end
+
+        def get_labels
+          default = { 'flow': @label }
+          labels = default.merge(@metrics_labels)
+          labels
         end
 
         # Evaluate selectors
@@ -91,7 +105,7 @@ module Fluent
             return false
           end
           # Break on host mismatch
-          unless match.container_names.empty? || match.container_names.include?(metadata[:container_name])
+          unless match.container_names.empty? || match.container_names.include?(metadata[:container])
             return false
           end
           # Break if list of namespaces is not empty and does not include actual namespace
@@ -116,6 +130,8 @@ module Fluent
           else
             @router.emit_stream(@tag, es)
           end
+          # increment the counter for a given label set
+          @counter&.increment(by: es.size, labels: get_labels)
         end
 
         def match_labels(input, match)
@@ -125,13 +141,15 @@ module Fluent
 
       def process(tag, es)
         if @sticky_tags
-          if @route_map.has_key?(tag)
-            # We already matched with this tag send events to the routers
-            @route_map[tag].each do |r|
-              r.emit_es(tag, es.dup)
+          @mutex.synchronize {
+            if @route_map.has_key?(tag)
+              # We already matched with this tag send events to the routers
+              @route_map[tag].each do |r|
+                r.emit_es(tag, es.dup)
+              end
+              return
             end
-            return
-          end
+          }
         end
         event_stream = Hash.new {|h, k| h[k] = Fluent::MultiEventStream.new }
         es.each do |time, record|
@@ -144,7 +162,9 @@ module Fluent
             if r.match?(input_metadata)
               orphan_record = false
               if @sticky_tags
-                @route_map[tag].push(r)
+                @mutex.synchronize {
+                  @route_map[tag].add(r)
+                }
               end
               if @batch
                 event_stream[r].add(time, record)
@@ -155,7 +175,9 @@ module Fluent
           end
           if !@default_router.nil? && orphan_record
             if @sticky_tags
-              @route_map[tag].push(@default_router)
+              @mutex.synchronize {
+                @route_map[tag].add(@default_router)
+              }
             end
             if @batch
               event_stream[@default_router].add(time, record)
@@ -163,27 +185,29 @@ module Fluent
               @default_router.emit(tag, time, record.dup)
             end
           end
-          if @batch
-            event_stream.each do |r, es|
-              r.emit_es(tag, es.dup)
-            end
+        end
+        if @batch
+          event_stream.each do |r, es|
+            r.emit_es(tag, es.dup)
           end
         end
       end
 
       def configure(conf)
         super
-        @route_map = Hash.new { |h, k| h[k] = Array.new }
+        @registry = (::Prometheus::Client.registry if @metrics)
+        @route_map = Hash.new { |h, k| h[k] = Set.new }
+        @mutex = Mutex.new
         @routers = []
         @default_router = nil
         @routes.each do |rule|
           route_router = event_emitter_router(rule['@label'])
-          puts rule
-          @routers << Route.new(rule.matches, rule.tag.to_s, route_router)
+          @routers << Route.new(rule, route_router, @registry)
         end
 
         if @default_route != '' or @default_tag != ''
-          @default_router = Route.new(nil, @default_tag, event_emitter_router(@default_route))
+          default_rule = { 'matches' => nil, 'tag' => @default_tag, '@label' => @default_route}
+          @default_router = Route.new(default_rule, event_emitter_router(@default_route), @registry)
         end
 
         @access_to_labels = record_accessor_create("$.kubernetes.labels")

data/test/plugin/test_out_label_router.rb

@@ -76,7 +76,7 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       d = Fluent::Test::Driver::BaseOwner.new(Fluent::Plugin::LabelRouterOutput)
       d.configure(routing_conf)
 
-      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0].matches, d.instance.routes[0].tag,nil)
+      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0], nil,nil)
       # Selector matched: GO
       assert_equal(true, r1.match?(labels: { 'app' => 'app1' }, namespace: ''))
       # Exclude match: NO GO
@@ -84,7 +84,7 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       # Nothing matched: NO GO
       assert_equal(false, r1.match?(labels: { 'app3' => 'app2' }, namespace: ''))
 
-      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1].matches, d.instance.routes[1].tag,nil)
+      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1], nil,nil)
       # Match selector and namespace: GO
       assert_equal(true, r2.match?(labels: { 'app' => 'app1' }, namespace: 'test'))
       # Exclude via namespace
@@ -92,18 +92,18 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       # Nothing matched: NO GO
       assert_equal(false, r2.match?(labels: { 'app3' => 'app' }, namespace: 'system'))
 
-      r3 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[2].matches, d.instance.routes[2].tag,nil)
+      r3 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[2], nil,nil)
       assert_equal(true, r3.match?(labels: { 'app' => 'nginx' }, namespace: 'dev'))
       assert_equal(true, r3.match?(labels: { 'app' => 'nginx' }, namespace: 'sandbox'))
       assert_equal(false, r3.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox'))
 
-      r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[3].matches, d.instance.routes[3].tag,nil)
+      r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[3], nil,nil)
       # Matching container name
-      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container_name: 'mycontainer'))
+      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container: 'mycontainer'))
       # Missing container name is equal to wrong container
       assert_equal(false, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'sandbox'))
       # Wrong container name
-      assert_equal(false, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container_name: 'mycontainer2'))
+      assert_equal(false, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container: 'mycontainer2'))
       # Wrong label but good namespace and container_name
       assert_equal(false, r4.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox',  container_name: 'mycontainer2'))
     end
@@ -134,6 +134,26 @@ class LabelRouterOutputTest < Test::Unit::TestCase
     end
   end
 
+
+  sub_test_case 'test_multiple_events_batched' do
+    test 'normal' do
+      conf = %[
+<route>
+  <match>
+  </match>
+</route>
+]
+      event_time = event_time("2019-07-17 11:11:11 UTC")
+      d = create_driver(conf)
+      d.run(expect_emits: 1, expect_records: 2) do
+        d.feed("test", [
+          [event_time, {"kubernetes" => {} } ],
+          [event_time, {"kubernetes" => {} } ],
+        ])
+      end
+    end
+  end
+
   sub_test_case 'test_default_router' do
     test 'normal' do
       CONFIG2 = %[
@@ -148,11 +168,11 @@ default_tag "new_tag"
 ]
       event_time = event_time("2019-07-17 11:11:11 UTC")
       d = create_driver(CONFIG2)
-      d.run(default_tag: 'test') do
-        d.feed(event_time, {"kubernetes" => {"labels" => {"app" => "app1"} } } )
-      end
-      d.run(default_tag: 'test2') do
-        d.feed(event_time, {"kubernetes" => {"labels" => {"app" => "app2"} } } )
+      d.run() do
+        d.feed("test", [
+          [event_time, {"kubernetes" => {"labels" => {"app" => "app1"} } } ],
+          [event_time, {"kubernetes" => {"labels" => {"app" => "app2"} } } ],
+        ])
       end
       events = d.events
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-label-router
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement