fluent-plugin-label-router 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0188ed80bdd96932a8d4942585a4cba52843b2e32c0492718aa1706b73ae29e4'
-  data.tar.gz: 8d9fd20daf7e0a2d171185e752bbd4310fb52575747cc73442492839d51056a3
+  metadata.gz: 84f4bafc4ac5d89f9c326c55c54e12f70b4315afe546aa6463492cc6ba69aa8e
+  data.tar.gz: 6c507a4af8eccfd37a5f70ea40e64f077ceefb4d34519ea3db1d284d90700a92
 SHA512:
-  metadata.gz: 687f7dfb1523caf6ac12c7d5574b7fbab1a7f2a70f4b350a53a1d81aa1c69b24d365546c95d490af4f992b2174b0ad3c6a8793f56e07656f9988f96bf093ad5b
-  data.tar.gz: 38ce993e367fc24bc974da84a96579ba4ce311cf3891f0afe268bea9ee24b05ddb164e7d7fc1214172128a8fa6d9a9ac42d8ddfe974b8a487e86e7b38817d713
+  metadata.gz: 4db8ea9e6b6e0af1c491f9635c47dcf8e5eb8f4ac91cff15c46600717714e2e9784b2eb32a287ba83fdd96439c588e70a9b7e256c8b330998127976fd039d4ee
+  data.tar.gz: 8f112e80a1b562008ecbe69e02fe6292c93deed2afd53e9a54a6eb2f2fad56bfbdbb3994ab7fc4b1a2dbe942c25982a3858eed2c4f7f5aaf7813d2b4be8152bd

data/Gemfile

@@ -1,3 +1,3 @@
 source "https://rubygems.org"
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,25 +1,27 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-label-router (0.3.0)
-      fluentd (>= 0.14.10, < 2)
+    fluent-plugin-label-router (0.3.2)
+      concurrent-ruby
+      fluentd (>= 1.17.1, < 1.18)
       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)
+    concurrent-ruby (1.3.4)
+    cool.io (1.9.0)
     csv (3.3.0)
     drb (2.2.1)
-    fluentd (1.17.0)
+    fluentd (1.17.1)
       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)
+      logger (~> 1.6)
       msgpack (>= 1.3.1, < 2.0.0)
       serverengine (>= 2.3.2, < 3.0.0)
       sigdump (~> 0.2.5)
@@ -29,21 +31,25 @@ GEM
       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)
+    logger (1.6.1)
+    msgpack (1.7.5)
+    power_assert (2.0.4)
+    prometheus-client (4.2.3)
+      base64
     rake (12.3.3)
-    serverengine (2.3.2)
+    serverengine (2.4.0)
+      base64 (~> 0.1)
+      logger (~> 1.4)
       sigdump (~> 0.2.2)
     sigdump (0.2.5)
     strptime (0.2.5)
-    test-unit (3.6.2)
+    test-unit (3.6.4)
       power_assert
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    tzinfo-data (1.2024.1)
+    tzinfo-data (1.2024.2)
       tzinfo (>= 1.0.0)
-    webrick (1.8.2)
+    webrick (1.9.0)
     yajl-ruby (1.4.3)
 
 PLATFORMS

data/README.md

@@ -35,7 +35,7 @@ $ bundle
 The configuration builds from `<route>` sections. Each `route` section
 can have several `<match>` statement. These statements computed in order and
 positive (or in case of *negate true* negative) results break the evaluation.
-We can say that the sections are coupled in a **lazy evaluation OR**. 
+We can say that the sections are coupled in a **lazy evaluation OR**.
 
 ```
 <match example.tag**>
@@ -78,6 +78,7 @@ Configuration reference
 |------------------|-------------------------------------------------------------------------------------------------------|----------|----------|
 | labels           | Label definition to match record. Example: `app:nginx`                                                | Hash     | nil      |
 | namespaces       | Comma separated list of namespaces. Ignored if left empty.                                            | []string | nil      |
+| namespaces_regex | Comma separated list of regex for namespaces match. 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      |
@@ -145,7 +146,7 @@ Output
 @label = "@NGINX"; tag = "new_tag"; {"log" => "", "kubernetes" => { "namespace_name" => "default", "labels" =>  {"app" => "nginx" } } }
 nil
 ```
-### 2. Both `labels` and `namespace` are optional
+### 3. Both `labels` and `namespace` are optional
 Only `labels`
 ```
 <match example.tag**>
@@ -183,10 +184,10 @@ Rewrite all
 </match>
 ```
 
-### 3. One of `@label` ot `tag` configuration should be specified
+### 4. One of `@label` or `tag` configuration should be specified
 If you don't rewrite either of them fluent will **likely to crash** because it will reprocess the same messages again.
 
-### 4. Default route/tag
+### 5. Default route/tag
 
 Use `default_label` and/or `default_tag` to route non matching records.
 
@@ -200,6 +201,22 @@ Use `default_label` and/or `default_tag` to route non matching records.
 </match>
 ```
 
+### 6. Use of namespaces_regex
+
+Configuration to re-tag and re-label all logs from namespaces_regex which match regex .*-system$
+
+```
+<match example.tag**>
+  @type label_router
+  <route>
+    @label SYSTEM_NAMESPACE
+    tag new_tag
+    <match>
+      namespaces_regex .*-system$
+    </match>
+  </route>
+</match>
+```
 
 ## Copyright
 

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.3.2"
+  spec.version = "0.5.0"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   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"]
+  spec.add_runtime_dependency "fluentd", [">= 1.17.1", "< 1.18"]
 end

data/lib/fluent/plugin/out_label_router.rb

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License
 
-require "fluent/plugin/output"
+require "fluent/plugin/bare_output"
 require 'prometheus/client'
 require 'concurrent'
 
@@ -54,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 regex for namespace definition to filter the record. Ignored if left empty."
+          config_param :namespaces_regex, :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."
@@ -117,6 +119,10 @@ module Fluent
           unless match.namespaces.empty? || match.namespaces.include?(metadata[:namespace])
             return false
           end
+          # Break if list of namespaces is not empty and does not contain any entry that match actual namespace
+          unless match.namespaces_regex.empty? || match.namespaces_regex.any? { |pattern| Regexp.new(pattern).match?(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
@@ -222,7 +228,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_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")

data/test/plugin/test_out_label_router.rb

@@ -59,6 +59,12 @@ class LabelRouterOutputTest < Test::Unit::TestCase
   </match>
   tag new_app_tag
 </route>
+<route>
+  <match>
+    labels app:app3
+    namespaces_regex .*-system$,^kube-.*
+  </match>
+</route>
 <route>
   <match>
     labels app:nginx
@@ -98,23 +104,42 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       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'))
+      # Match selector and namespace: GO
+      assert_equal(true, r3.match?(labels: { 'app' => 'app3' }, namespace: 'logging-system'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: 'logging-system1'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: 'system'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: '1system'))
+      # Match selector and namespace: GO
+      assert_equal(true, r3.match?(labels: { 'app' => 'app3' }, namespace: 'kube-ns'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: '1kube-ns'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: 'kube'))
+      # Nothing matched: NO GO
+      assert_equal(false, r3.match?(labels: { 'app' => 'app3' }, namespace: 'kube1'))
+
 
       r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[3], nil,nil)
+      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev'))
+      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'sandbox'))
+      assert_equal(false, r4.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox'))
+
+      r5 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[4], nil,nil)
       # Matching container name
-      assert_equal(true, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container: 'mycontainer'))
+      assert_equal(true, r5.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'))
+      assert_equal(false, r5.match?(labels: { 'app' => 'nginx' }, namespace: 'sandbox'))
       # Wrong container name
-      assert_equal(false, r4.match?(labels: { 'app' => 'nginx' }, namespace: 'dev', container: 'mycontainer2'))
+      assert_equal(false, r5.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'))
+      assert_equal(false, r5.match?(labels: { 'app' => 'nginx2' }, namespace: 'sandbox',  container_name: 'mycontainer2'))
 
-      r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[4], nil,nil)
+      r6 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[5], nil,nil)
       # Matching namespaces_labels
-      assert_equal(true, r4.match?(namespaces_labels: { 'name' => 'default' }))
+      assert_equal(true, r6.match?(namespaces_labels: { 'name' => 'default' }))
     end
   end
 
@@ -156,15 +181,15 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       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"} } } )
+        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"} } } )
+        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]
+      assert_equal ["matching", event_time, {"kubernetes_namespace" => {"labels" => {"matching" => "yes"} } }], events[0]
     end
   end
 
@@ -224,6 +249,7 @@ default_tag "new_tag"
   <match>
     labels
     namespaces
+    namespaces_regex
   </match>
 </route>
 ]
@@ -254,6 +280,7 @@ default_tag "new_tag"
     <match>
       labels
       namespaces
+      namespaces_regex
     </match>
   </route>
   ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-label-router
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,20 +72,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.10
+        version: 1.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.10
+        version: 1.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.18'
 description: Label-Router helps routing log messages based on their labels and namespace
   tag in a Kubernetes environment.
 email: