fluent-plugin-label-router 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6b78faaf79aa156a111780a7dde808623edb45059e75412e839a8f899121ff
-  data.tar.gz: 52498b7e26d5d3d9d69edb4c2dc4ae497729c73785ba07b4ffbad474e6ae96ae
+  metadata.gz: 214b0ab1c791ea384c2bc1f1f2e44f8f27ee23b0ba5b35c9d357e535f0ac4bda
+  data.tar.gz: 9dc61783f297966d51469a9716465a4cf37c62d2c1f7059c9175b3686709a694
 SHA512:
-  metadata.gz: d89cca1fad117cea4b1a40fbf31ff54d811562165929ba9c1603e40923f694221e2407262c24b867d11edf6d6d9ef452446fbb51d72da63aede210016d3b5a87
-  data.tar.gz: 91aa7edd22925ecdae9f05cf1fc1f8f0e7e9fb5cf89b15437db50269112aaf1d44738bde764acb60d3840c9b36566fc819e99d9fff366ed180019711bc2847af
+  metadata.gz: b55e88561ee31fe9dbdf6481c293be9337a8aab482031c00717a972a212785f263a382e3e05384b45efed6258c39f30a71099e80556e9f55b001933a735d58b3
+  data.tar.gz: d0e80aeba02b97c9a2bc2d17f991eac2baf8e53fb56d1a7f24dee60d528f97c5da417a4233e1f9d65c3ec5a9f71d749cfaa1da269db947ed262c4becfb65769d

data/README.md

@@ -192,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.3"
+  spec.version = "0.2.8"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = test_files
   spec.require_paths = ["lib"]
 
-  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
@@ -34,12 +35,16 @@ module Fluent
       config_param :default_route, :string, :default => ""
       desc "Default tag to drain unmatched patterns"
       config_param :default_tag, :string, :default => ""
+      desc "Enable metrics for the router"
+      config_param :metrics, :bool, :default => false
 
       config_section :route, param_name: :routes, multi: true do
         desc "New @LABEL if selectors matched"
         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: :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"
@@ -56,10 +61,22 @@ module Fluent
       end
 
       class Route
-        def initialize(matches, tag, router)
+        def initialize(rule, router, registry)
           @router = router
-          @matches = matches
-          @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, docstring: "Total number of events router for the flow", labels: [:flow, :id])
+          end
+        end
+
+        def get_labels
+          default = { 'flow': @label }
+          labels = default.merge(@metrics_labels)
+          labels
         end
 
         # Evaluate selectors
@@ -88,7 +105,7 @@ module Fluent
             return false
           end
           # Break on host mismatch
-          unless match.container_names.empty? || match.container_names.include?(metadata[:container_name])
+          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
@@ -105,6 +122,7 @@ module Fluent
           else
             @router.emit(@tag, time, record)
           end
+          @counter&.increment(by: 1, labels: get_labels)
         end
 
         def emit_es(tag, es)
@@ -113,6 +131,8 @@ 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)
@@ -176,18 +196,19 @@ module Fluent
 
       def configure(conf)
         super
+        @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.matches, 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")

data/test/plugin/test_out_label_router.rb

@@ -76,7 +76,7 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       d = Fluent::Test::Driver::BaseOwner.new(Fluent::Plugin::LabelRouterOutput)
       d.configure(routing_conf)
 
-      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0].matches, d.instance.routes[0].tag,nil)
+      r1 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[0], nil,nil)
       # Selector matched: GO
       assert_equal(true, r1.match?(labels: { 'app' => 'app1' }, namespace: ''))
       # Exclude match: NO GO
@@ -84,7 +84,7 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       # Nothing matched: NO GO
       assert_equal(false, r1.match?(labels: { 'app3' => 'app2' }, namespace: ''))
 
-      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1].matches, d.instance.routes[1].tag,nil)
+      r2 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[1], nil,nil)
       # Match selector and namespace: GO
       assert_equal(true, r2.match?(labels: { 'app' => 'app1' }, namespace: 'test'))
       # Exclude via namespace
@@ -92,18 +92,18 @@ class LabelRouterOutputTest < Test::Unit::TestCase
       # Nothing matched: NO GO
       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)
+      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'))
 
-      r4 = Fluent::Plugin::LabelRouterOutput::Route.new(d.instance.routes[3].matches, d.instance.routes[3].tag,nil)
+      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_name: 'mycontainer'))
+      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_name: 'mycontainer2'))
+      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
@@ -208,4 +208,35 @@ default_tag "new_tag"
       assert_equal ["new_app_tag", event_time, {"kubernetes" => {"labels" => {"app" => "app2"} } }], events[1]
     end
   end
+
+    sub_test_case 'test_metrics' do
+      test 'normal' do
+        CONFIG4 = %[
+  @id xxx
+  metrics true
+  <route>
+    metrics_labels {"id": "test"}
+    tag new_app_tag
+    <match>
+      labels
+      namespaces
+    </match>
+  </route>
+  ]
+        event_time = event_time("2019-07-17 11:11:11 UTC")
+        d = create_driver(CONFIG4)
+        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"} } } )
+        end
+        events = d.events
+
+        assert_equal(2, events.size)
+        assert_equal ["new_app_tag", event_time, {"kubernetes" => {"labels" => {"app" => "app1"} } }], events[0]
+        assert_equal ["new_app_tag", event_time, {"kubernetes" => {"labels" => {"app" => "app2"} } }], events[1]
+      end
+    end
+
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-label-router
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.8
 platform: ruby
 authors:
 - Banzai Cloud
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: 2.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,7 @@ homepage: https://github.com/banzaicloud/fluent-plugin-label-router
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Routing records based on Kubernetes labels.
 test_files: