fluent-plugin-label-router 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07025a5148e5985c287b5d07e4a8f05c642d650734db78c995be11c2ee478a5e
-  data.tar.gz: 8e787eacb12b8e12a1e2895f919128d1c755e4c553c9e5b218a7970e89f3564b
+  metadata.gz: d2c9fe1a41256dc29a1a7ff87833cfb6f7f4ca6e4ab330b185aa85f66e0e35b3
+  data.tar.gz: 2440249e93baffc3de72dd31fe70ef6d83ce5f4832b9af615a338bb855489cb4
 SHA512:
-  metadata.gz: 8e116c6ace26a31641f467eed943f5a643c1f4c6737ea602106c43af69f40cac89fe54533b08e596d3c32f9630c5a2d1a9532f37314bdf24081c6b4aeb70a120
-  data.tar.gz: e8d0c1c3653c047a65fc0642602a7e5e4aef3e3a341653fca64bd7e15323233c31583451591f9b744becd3f54122b55abd0d936ae48d60a63a5fc4dc640695ca
+  metadata.gz: 0fc6928ca8716774f8291eb013b737f31d2e6d02b34dee5d473ae644c7898aa8145aca73b3691c9ed4520165d3ee19f63da7dee72d48dc1b416c4fd54e45e79f
+  data.tar.gz: cc9afbd8db7ac5c1f10001c6bc91403eb9961b529773f210f3c9b2ac7bf877c792a10e18f6b04cec5b1526762238b3f081f51cce08b4d4a867ebba63f28030d7

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
 

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.1"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 

data/lib/fluent/plugin/out_label_router.rb

@@ -41,11 +41,15 @@ module Fluent
         desc "New tag if selectors matched"
         config_param :tag, :string, :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
@@ -55,9 +59,9 @@ module Fluent
 
 
       class Route
-        def initialize(selectors, tag, router)
+        def initialize(matches, tag, router)
           @router = router
-          @selectors = selectors
+          @matches = matches
           @tag = tag
         end
 
@@ -68,12 +72,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 +85,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_name])
+            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)
@@ -104,8 +117,9 @@ module Fluent
             @router.emit_stream(@tag, es)
           end
         end
+
         def match_labels(input, match)
-          return (match.to_a - input.to_a).empty?
+          (match.to_a - input.to_a).empty?
         end
       end
 
@@ -121,11 +135,13 @@ module Fluent
         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)
@@ -163,7 +179,7 @@ module Fluent
         @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.matches, rule.tag.to_s, route_router)
         end
 
         if @default_route != '' or @default_tag != ''
@@ -172,6 +188,8 @@ module Fluent
 
         @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].matches, d.instance.routes[0].tag,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].matches, d.instance.routes[1].tag,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].matches, d.instance.routes[2].tag,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].matches, d.instance.routes[3].tag,nil)
+      # Matching container name
+      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container_name: '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'))
+      # Wrong label but good namespace and container_name
+      assert_equal(false, r4.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox',  container_name: 'mycontainer2'))
     end
   end
 
@@ -146,7 +164,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 +174,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.1
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler