fluent-plugin-label-router 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7fb09af37b3435f4e2fb3b4cad0c83b864af8a5736ee363cb254eaf1495233
-  data.tar.gz: f0634bcff726634e62b6fd99989fc74a29e811c21309c6edcec93cbd0a8ef175
+  metadata.gz: bd979b17d11338356a4aba41b453da815b59abac9169b4df7ec6aba97f60adf0
+  data.tar.gz: ed8c5dd1a8129582eaafb2ac8e93afc9b0be487b9b89a4dc44d8b90bc0bf0402
 SHA512:
-  metadata.gz: 63f428db21d8538f1d3d3e4eefbdf369e1efe9d73d0e480d1f24d301529b8f7d9530b8fa12bf2fc66b39c13f10627bab2b6d20f88071fd23f9a10076a84db073
-  data.tar.gz: 7e803c4b8ab849dae41f08940b6537e321a622d523970c7eb81849c2fa0f64ecb96c0a9437b85d19fe5a44ae6ace59696186bd7f966b12bfd162db1ff6e410ec
+  metadata.gz: 4031c23b18c50f72953be1d20264c19bd62feea1de49c55bdb479e180f72814bfc064756156b1b4a5d10e2ebe1e1e72339f103e423874d82a01c089da44e1cff
+  data.tar.gz: 0fa73c96e20e9ffb0da8442f2deafb27853434b78c665437a47f42646df2b3c5ba92c406792012d3cdfb41216916198728c45a46d0fca87b3f236ebbda18a74a

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.1)
+    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

@@ -13,7 +13,7 @@ $ gem install fluent-plugin-label-router
 ### Specific install
 
 ```
-$ gem install specific_install && gem specific_install -l https://github.com/banzaicloud/fluent-plugin-label-router.git
+$ gem install specific_install && gem specific_install -l https://github.com/banzaicloud/fluent-plugin-label-router.git
 ```
 
 ### Bundler
@@ -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
 
@@ -114,7 +115,7 @@ Configuration to re-tag and re-label all logs from `default` namespace with labe
 ```
 
 ### 2. Exclude specific `labels` and `namespaces`
-Configuration to re-tag and re-label all logs that **not** from `default` namespace **and not** have labels `ap=nginx` and `env=dev`
+Configuration to re-tag and re-label all logs that **not** from `default` namespace **and not** have labels `app=nginx` and `env=dev`
 ```
 <match example.tag**>
   @type label_router

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

data/lib/fluent/plugin/out_label_router.rb

@@ -33,6 +33,8 @@ module Fluent
       config_param :sticky_tags, :bool, default: true
       desc "Default label to drain unmatched patterns"
       config_param :default_route, :string, :default => ""
+      desc "Metrics labels for the default_route"
+      config_param :default_metrics_labels, :hash, :default => {}
       desc "Default tag to drain unmatched patterns"
       config_param :default_tag, :string, :default => ""
       desc "Enable metrics for the router"
@@ -51,6 +53,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."
@@ -72,15 +76,14 @@ module Fluent
               if registry.exist?(:fluentd_router_records_total)
                 @counter = registry.get(:fluentd_router_records_total)
               else
-                @counter = registry.counter(:fluentd_router_records_total, docstring: "Total number of events router for the flow", labels: [:flow, :id])
+                @counter = registry.counter(:fluentd_router_records_total, docstring: "Total number of events routed for the flow", labels: [:flow, :id])
               end
           end
         end
 
         def get_labels
-          default = { 'flow': @label }
-          labels = default.merge(@metrics_labels)
-          labels
+          labels = { 'flow': @label, 'id': "default" }
+          !@metrics_labels.nil? ? labels.merge(@metrics_labels) : labels
         end
 
         # Evaluate selectors
@@ -116,6 +119,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
@@ -160,6 +167,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
@@ -211,11 +219,12 @@ module Fluent
         end
 
         if @default_route != '' or @default_tag != ''
-          default_rule = { 'matches' => nil, 'tag' => @default_tag, '@label' => @default_route}
+          default_rule = { 'matches' => nil, 'tag' => @default_tag, '@label' => @default_route, 'metrics_labels' => @default_metrics_labels }
           @default_router = Route.new(default_rule, event_emitter_router(@default_route), @registry)
         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")
@@ -224,4 +233,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.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,7 +80,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Routing records based on Kubernetes labels.