fluent-plugin-label-router 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07025a5148e5985c287b5d07e4a8f05c642d650734db78c995be11c2ee478a5e
-  data.tar.gz: 8e787eacb12b8e12a1e2895f919128d1c755e4c553c9e5b218a7970e89f3564b
+  metadata.gz: 7f98b66b8fcb6667342e2c8e30b1c20eaa07f949eab93514cceba98872502d7f
+  data.tar.gz: 7316dcea967a1dc2160b7996fdd8718d307809e86ab7900f5195b7b7f8e57b3e
 SHA512:
-  metadata.gz: 8e116c6ace26a31641f467eed943f5a643c1f4c6737ea602106c43af69f40cac89fe54533b08e596d3c32f9630c5a2d1a9532f37314bdf24081c6b4aeb70a120
-  data.tar.gz: e8d0c1c3653c047a65fc0642602a7e5e4aef3e3a341653fca64bd7e15323233c31583451591f9b744becd3f54122b55abd0d936ae48d60a63a5fc4dc640695ca
+  metadata.gz: c180a282410db01da6f356598cda074390bcfa56e02fa53d8197605228a5b20679f17af766054de9109906829f6bb8efd43d46a968d8f7ad5a05618a0d41c539
+  data.tar.gz: 2b74fcc7c70de9fd1cd06ff9f2d070befebc48544962e2eba828c72a131f79358d2f0f877af332f236da18c409cce52425babf24853af706cacbcafc3d68ddf2

data/README.md

@@ -74,11 +74,13 @@ Configuration reference
 
 
 #### \<match\>
-| Parameter  | Description                                                                   | Type     | Default  |
-|------------|-------------------------------------------------------------------------------|----------|----------|
-| labels     | Label definition to match record. Example: `app:nginx`                        | Hash     | nil      |
-| namespaces | Comma separated list of namespaces. Ignored if left empty.                    | []string | nil      |
-| negate     | Negate the selector meaning to exclude matches                                | bool     | false    |
+| Parameter       | Description                                                                   | Type     | Default  |
+|-----------------|-------------------------------------------------------------------------------|----------|----------|
+| labels          | Label definition to match record. Example: `app:nginx`                        | Hash     | nil      |
+| namespaces      | Comma separated list of namespaces. Ignored if left empty.                    | []string | nil      |
+| hosts           | Comma separated list of hosts. Ignored if left empty.                         | []string | nil      |
+| container_names | Comma separated list of container names. Ignored if left empty.               | []string | nil      |
+| negate          | Negate the selector meaning to exclude matches                                | bool     | false    |
 
 ## Rules of thumb
 
@@ -190,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.0"
+  spec.version = "0.2.5"
   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
@@ -40,25 +41,40 @@ module Fluent
         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: :selectors, multi: true do
+        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"
           config_param :labels, :hash, :default => {}
           desc "List of namespace definition to filter the record. Ignored if left empty."
           config_param :namespaces, :array, :default => [], value_type: :string
+          desc "List of hosts definition to filter the record. Ignored if left empty."
+          config_param :hosts, :array, :default => [], value_type: :string
+          desc "List of container names definition to filter the record. Ignored if left empty."
+          config_param :container_names, :array, :default => [], value_type: :string
           desc "Negate the selection making it an exclude"
           config_param :negate, :bool, :default => false
         end
-
       end
 
-
-
       class Route
-        def initialize(selectors, tag, router)
+        def initialize(rule, router, registry)
           @router = router
-          @selectors = selectors
-          @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
@@ -68,12 +84,12 @@ module Fluent
         # 3. If match == false and negate == false -> continue
         # 4. If match == false and negate == true  -> continue
         # There is no match at all                 -> return false
-        def match?(labels, namespace)
-          @selectors.each do |selector|
-            if (filter_select(selector, labels, namespace) and !selector.negate)
+        def match?(metadata)
+          @matches.each do |match|
+            if filter_select(match, metadata) and !match.negate
               return true
             end
-            if (filter_select(selector, labels, namespace) and selector.negate)
+            if filter_select(match, metadata) and match.negate
               return false
             end
           end
@@ -81,12 +97,21 @@ module Fluent
         end
 
         # Returns true if filter passes (filter match)
-        def filter_select(selector, labels, namespace)
+        def filter_select(match, metadata)
+          # Break on container_name mismatch
+          unless match.hosts.empty? || match.hosts.include?(metadata[:host])
+            return false
+          end
+          # Break on host mismatch
+          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
-          unless selector.namespaces.empty? or selector.namespaces.include?(namespace)
+          unless match.namespaces.empty? || match.namespaces.include?(metadata[:namespace])
             return false
           end
-          match_labels(labels, selector.labels)
+
+          match_labels(metadata[:labels], match.labels)
         end
 
         def emit(tag, time, record)
@@ -103,32 +128,41 @@ 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)
-          return (match.to_a - input.to_a).empty?
+          (match.to_a - input.to_a).empty?
         end
       end
 
       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|
-          input_labels = @access_to_labels.call(record).to_h
-          input_namespace = @access_to_namespace.call(record).to_s
+          input_metadata = { labels: @access_to_labels.call(record).to_h,
+                             namespace: @access_to_namespace.call(record).to_s,
+                             container: @access_to_container_name.call(record).to_s,
+                             host: @access_to_host.call(record).to_s}
           orphan_record = true
           @routers.each do |r|
-            if r.match?(input_labels, input_namespace)
+            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)
@@ -139,7 +173,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)
@@ -147,31 +183,35 @@ 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.selectors, 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")
         @access_to_namespace = record_accessor_create("$.kubernetes.namespace_name")
+        @access_to_host = record_accessor_create("$.kubernetes.host")
+        @access_to_container_name = record_accessor_create("$.kubernetes.container_name")
 
         @batch = @emit_mode == :batch
       end

data/test/plugin/test_out_label_router.rb

@@ -65,29 +65,47 @@ class LabelRouterOutputTest < Test::Unit::TestCase
     namespaces dev,sandbox
   </match>
 </route>
+<route>
+  <match>
+    labels app:nginx
+    namespaces dev,sandbox
+    container_names mycontainer
+  </match>
+</route>
 )
       d = Fluent::Test::Driver::BaseOwner.new(Fluent::Plugin::LabelRouterOutput)
       d.configure(routing_conf)
 
-      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0].selectors, "",nil)
+      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0], nil,nil)
       # Selector matched: GO
-      assert_equal(true, r1.match?({'app' => 'app1'},""))
+      assert_equal(true, r1.match?(labels: { 'app' => 'app1' }, namespace: ''))
       # Exclude match: NO GO
-      assert_equal(false, r1.match?({"app" => "app2"},""))
+      assert_equal(false, r1.match?(labels: { 'app' => 'app2' }, namespace: ''))
       # Nothing matched: NO GO
-      assert_equal(false, r1.match?({"app3" => "app2"},""))
+      assert_equal(false, r1.match?(labels: { 'app3' => 'app2' }, namespace: ''))
 
-      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1].selectors, "",nil)
+      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1], nil,nil)
       # Match selector and namespace: GO
-      assert_equal(true, r2.match?({"app" => "app1"},"test"))
+      assert_equal(true, r2.match?(labels: { 'app' => 'app1' }, namespace: 'test'))
       # Exclude via namespace
-      assert_equal(false, r2.match?({"app" => "app2"},"system"))
+      assert_equal(false, r2.match?(labels: { 'app' => 'app2' }, namespace: 'system'))
       # Nothing matched: NO GO
-      assert_equal(false, r2.match?({"app3" => "app"},"system"))
+      assert_equal(false, r2.match?(labels: { 'app3' => 'app' }, namespace: 'system'))
+
+      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'))
 
-      r3 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[2].selectors, "",nil)
-      assert_equal(true, r3.match?({"app" => "nginx"},"dev"))
-      assert_equal(true, r3.match?({"app" => "nginx"},"sandbox"))
+      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: '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: 'mycontainer2'))
+      # Wrong label but good namespace and container_name
+      assert_equal(false, r4.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox',  container_name: 'mycontainer2'))
     end
   end
 
@@ -116,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 = %[
@@ -130,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
 
@@ -146,7 +184,7 @@ default_tag "new_tag"
 
   sub_test_case 'test_empty_router' do
     test 'normal' do
-      CONFIG2 = %[
+      CONFIG3 = %[
 <route>
   tag new_app_tag
   <match>
@@ -156,7 +194,7 @@ default_tag "new_tag"
 </route>
 ]
       event_time = event_time("2019-07-17 11:11:11 UTC")
-      d = create_driver(CONFIG2)
+      d = create_driver(CONFIG3)
       d.run(default_tag: 'test') do
         d.feed(event_time, {"kubernetes" => {"labels" => {"app" => "app1"} } } )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-label-router
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2021-05-13 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