fluent-plugin-label-router 0.2.10 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eccef2ba45a644db797ef22980134d652db67bf049467e3d404e2211dbedd9c
-  data.tar.gz: ab9a02cde570157b3b01228d06982a8cef69ab39c8b5f28ca7c1518ef91ccf35
+  metadata.gz: '0188ed80bdd96932a8d4942585a4cba52843b2e32c0492718aa1706b73ae29e4'
+  data.tar.gz: 8d9fd20daf7e0a2d171185e752bbd4310fb52575747cc73442492839d51056a3
 SHA512:
-  metadata.gz: 3d61f1b61634e0afabc6e4f9418b8eb6d69eb6a5b20833973500b9094e123877af08971576fe6d11240fa53169bd87ed0ca0d94cfc42ba987f4bb3e74789afc6
-  data.tar.gz: d9ed37e986627feb738a384c89242fc8aadd05d58141f91573b3791f8498b6d6ce00e67ad6dfb38e5e151decb7ed5456392936ed3c0d821f241175e656c67a0e
+  metadata.gz: 687f7dfb1523caf6ac12c7d5574b7fbab1a7f2a70f4b350a53a1d81aa1c69b24d365546c95d490af4f992b2174b0ad3c6a8793f56e07656f9988f96bf093ad5b
+  data.tar.gz: 38ce993e367fc24bc974da84a96579ba4ce311cf3891f0afe268bea9ee24b05ddb164e7d7fc1214172128a8fa6d9a9ac42d8ddfe974b8a487e86e7b38817d713

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-label-router (0.3.0)
+      fluentd (>= 0.14.10, < 2)
+      prometheus-client (>= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    concurrent-ruby (1.3.1)
+    cool.io (1.8.1)
+    csv (3.3.0)
+    drb (2.2.1)
+    fluentd (1.17.0)
+      base64 (~> 0.2)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      csv (~> 3.2)
+      drb (~> 2.2)
+      http_parser.rb (>= 0.5.1, < 0.9.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.3.2, < 3.0.0)
+      sigdump (~> 0.2.5)
+      strptime (>= 0.2.4, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (~> 1.4)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.8.0)
+    msgpack (1.7.2)
+    power_assert (2.0.3)
+    prometheus-client (4.2.2)
+    rake (12.3.3)
+    serverengine (2.3.2)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.5)
+    strptime (0.2.5)
+    test-unit (3.6.2)
+      power_assert
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2024.1)
+      tzinfo (>= 1.0.0)
+    webrick (1.8.2)
+    yajl-ruby (1.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fluent-plugin-label-router!
+  rake (~> 12.0)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -74,13 +74,14 @@ 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      |
-| 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    |
+| 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      |
+| namespace_labels | Label definition of the namespace a record originates. Example: `kubernetes.io/metadata.name=default` | Hash     | 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.10"
+  spec.version = "0.3.2"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 
@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   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_dependency "concurrent-ruby"
   spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
 end

data/lib/fluent/plugin/out_label_router.rb

@@ -15,6 +15,7 @@
 
 require "fluent/plugin/output"
 require 'prometheus/client'
+require 'concurrent'
 
 
 module Fluent
@@ -53,6 +54,8 @@ module Fluent
           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 namespace labels to filter the record based on where it came from. Ignored if left empty."
+          config_param :namespace_labels, :hash, :default => {}
           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."
@@ -93,11 +96,8 @@ module Fluent
         # There is no match at all                 -> return false
         def match?(metadata)
           @matches.each do |match|
-            if filter_select(match, metadata) and !match.negate
-              return true
-            end
-            if filter_select(match, metadata) and match.negate
-              return false
+            if filter_select(match, metadata)
+              return !match.negate
             end
           end
           false
@@ -117,6 +117,10 @@ module Fluent
           unless match.namespaces.empty? || match.namespaces.include?(metadata[:namespace])
             return false
           end
+          # Break if list of namespace_labels is not empty and does not match actual namespace labels
+          if !match.namespace_labels.empty? && !match_labels(metadata[:namespace_labels], match.namespace_labels)
+            return false
+          end
 
           match_labels(metadata[:labels], match.labels)
         end
@@ -147,7 +151,7 @@ module Fluent
 
       def process(tag, es)
         if @sticky_tags
-          @mutex.synchronize {
+          @rwlock.with_read_lock {
             if @route_map.has_key?(tag)
               # We already matched with this tag send events to the routers
               @route_map[tag].each do |r|
@@ -161,6 +165,7 @@ module Fluent
         es.each do |time, record|
           input_metadata = { labels: @access_to_labels.call(record).to_h,
                              namespace: @access_to_namespace.call(record).to_s,
+                             namespace_labels: @access_to_namespace_labels.call(record).to_h,
                              container: @access_to_container_name.call(record).to_s,
                              host: @access_to_host.call(record).to_s}
           orphan_record = true
@@ -168,7 +173,7 @@ module Fluent
             if r.match?(input_metadata)
               orphan_record = false
               if @sticky_tags
-                @mutex.synchronize {
+                @rwlock.with_write_lock {
                   @route_map[tag].add(r)
                 }
               end
@@ -181,7 +186,7 @@ module Fluent
           end
           if !@default_router.nil? && orphan_record
             if @sticky_tags
-              @mutex.synchronize {
+              @rwlock.with_write_lock {
                 @route_map[tag].add(@default_router)
               }
             end
@@ -203,7 +208,7 @@ module Fluent
         super
         @registry = (::Prometheus::Client.registry if @metrics)
         @route_map = Hash.new { |h, k| h[k] = Set.new }
-        @mutex = Mutex.new
+        @rwlock = Concurrent::ReadWriteLock.new
         @routers = []
         @default_router = nil
         @routes.each do |rule|
@@ -217,6 +222,7 @@ module Fluent
         end
 
         @access_to_labels = record_accessor_create("$.kubernetes.labels")
+        @access_to_namespace_labels = record_accessor_create("$.kubernetes.namespace_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")
@@ -225,4 +231,4 @@ module Fluent
       end
     end
   end
-end
+end

data/test/plugin/test_out_label_router.rb

@@ -72,6 +72,11 @@ class LabelRouterOutputTest < Test::Unit::TestCase
     container_names mycontainer
   </match>
 </route>
+<route>
+  <match>
+    namespaces_labels name:default
+  </match>
+</route>
 )
       d = Fluent::Test::Driver::BaseOwner.new(Fluent::Plugin::LabelRouterOutput)
       d.configure(routing_conf)
@@ -106,6 +111,10 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       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'))
+
+      r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[4], nil,nil)
+      # Matching namespaces_labels
+      assert_equal(true, r4.match?(namespaces_labels: { 'name' => 'default' }))
     end
   end
 
@@ -134,6 +143,31 @@ class LabelRouterOutputTest < Test::Unit::TestCase
     end
   end
 
+  sub_test_case 'test_namespaces_labels' do
+    test 'normal' do
+      CONFIG = %[
+<route>
+  <match>
+    namespace_labels matching:yes
+  </match>
+  tag matching
+</route>
+]
+      event_time = event_time("2019-07-17 11:11:11 UTC")
+      d = create_driver(CONFIG)
+      d.run(default_tag: 'test') do
+        d.feed(event_time, {"kubernetes" => {"namespace_labels" => {"matching" => "no"} } } )
+      end
+      d.run(default_tag: 'test2') do
+        d.feed(event_time, {"kubernetes" => {"namespace_labels" => {"matching" => "yes"} } } )
+      end
+      events = d.events
+
+      assert_equal(1, events.size)
+      assert_equal ["matching", event_time, {"kubernetes" => {"namespace_labels" => {"matching" => "yes"} } }], events[0]
+    end
+  end
+
 
   sub_test_case 'test_multiple_events_batched' do
     test 'normal' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-label-router
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.2
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -80,7 +94,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -107,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Routing records based on Kubernetes labels.