fluent-plugin-tag-normaliser 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cff904fdcbdf429db11692bd5a5fde095768807e
-  data.tar.gz: 1857ecae0b7ce8ac1e41cc5e2521d79cdd0f5e01
+SHA256:
+  metadata.gz: 3de141eacd728b5c64ef048c4ba6541db115da0348752e699f4a907185db93aa
+  data.tar.gz: 90fc732beaf853c70176dcf2d27325f7b6e5ee5fe3989219a5404c00ea15165f
 SHA512:
-  metadata.gz: 398266030c0f08ec08367345fb592c412ea3a28622a1b9331db872ad7b010f3afeebb7b2187f4d5c52401838e21f69d068b5fcb12f9436b7e16021d72b8c79cd
-  data.tar.gz: 36a96f7b7ee5ec750f1822ddb88f0368fe374ec98cf53fe24a43fd7e9113c112e5fe05a79e94e591e8633235d71151e3713eb4c07655570d063db04ffd5efb41
+  metadata.gz: fc500f140016b9ce333228829c155b8b9e9f35bbb2c8d6ecaf83dd9abf30873488e275a2889023c00a83ff157b25e148df127c28d026455ef04595a9904945e5
+  data.tar.gz: ab4a9663c53a053e347ac204068b460ac3dec4815367dbbc2f9aa3aa7a9a31d69b4d8044ef5fccb67451346de78c57ab75b4d7a7a06e0fb566926d5b50931be1

data/README.md

@@ -39,7 +39,8 @@ You only need to specify the `format` option.
 |-----------|-------------|---------|
 | key_prefix | Prefix used to access record attributes | kubernetes |
 | format | Format to rewrite tag to. You can access record with `${record_name}` expression. Nested attributes available via `.` separator: `${labels.app}` | "" |
-| unknown | Fallback value for missing record attribute | "unknown |
+| unknown | Fallback value for missing record attribute | "unknown" |
+| sticky_tags | Sticky tags will match only one record from an event stream. The same tag will be treated the same way | true |
 
 ### Available fluent-bit provided kubernetes attributes
 

data/fluent-plugin-tag-normaliser.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-tag-normaliser"
-  spec.version = "0.1.1"
+  spec.version = "0.1.3"
   spec.authors = ["Banzai Cloud"]
   spec.email   = ["info@banzaicloud.com"]
 

data/lib/fluent/plugin/out_tag_normaliser.rb

@@ -37,6 +37,10 @@ module Fluent
         @tag_map = Hash.new { |k, v| k[v] = "" }
       end
 
+      def multi_workers_ready?
+        true
+      end
+
       def process(tag, es)
         if @sticky_tags
           if @tag_map.has_key?(tag)
@@ -68,20 +72,67 @@ module Fluent
 
       def get_key_accessors
         key_accessors = {}
-        keywords = @format.scan(/\$\{([\w\.\/\-]+)}/)
+        keywords = @format.scan(/\$\{([\w\.\/\-\\]+)}/)
         keywords.each do |key|
           placeholder = "${#{key[0]}}"
-          if @key_prefix != ""
-            path = @key_prefix + "." + key[0]
+          if contains_escaped_period?(key[0])
+            path = create_path_with_bracket_notation(key[0])
           else
-            path = key[0]
+            path = create_path(key[0])
           end
-          path = "$." + path
           key_accessors[placeholder] = record_accessor_create(path)
         end
         return key_accessors
       end
 
+      private
+
+      def contains_escaped_period?(key)
+        key.include?('\.')
+      end
+
+      def create_path(key)
+        if @key_prefix != ""
+          path = @key_prefix + "." + key
+        else
+          path = key
+        end
+        path = "$." + path
+      end
+
+      # Produces the output in bracket notation, e.g. $['kubernetes']['labels']['app.tier']"
+      def create_path_with_bracket_notation(key)
+        path = split_by_unescaped_dots(key)
+                .map { |elem| "['#{elem}']" }
+                .join("")
+        if @key_prefix != ""
+          path = "['#{@key_prefix}']" + path
+        end
+        path = "$" + path
+      end
+
+      # Splits the input string by the . character if it is not escaped by \
+      def split_by_unescaped_dots(text)
+        result = []
+        current_part = ""
+        escaped = false
+
+        text.each_char do |char|
+          if char == "\\" && !escaped
+            escaped = true
+          elsif char == "." && !escaped
+            result << current_part
+            current_part = ""
+          else
+            current_part += char
+            escaped = false
+          end
+        end
+
+        result << current_part
+        result
+      end
+
     end
   end
 end

data/test/plugin/test_out_tag_normaliser.rb

@@ -21,10 +21,37 @@ class TagNormaliserOutputTest < Test::Unit::TestCase
     d = create_driver(config)
     d.run(default_tag: 'test') do
       d.feed("tag1", event_time, record.dup)
+    end
+    events = d.events
+    puts events
+
+    assert_equal("cluster.default.understood-butterfly-nginx-logging-demo-7dcdcfdcd7-h7p9n.nginx", events[0][0])
+  end
+
+  test "escape_test" do
+    config = %[
+      format cluster.${namespace_name}.${labels.app}.${labels.app\\.tier}.${labels.app\\.kubernetes\\.io/managed-by}
+    ]
+    record = {
+        "log" => "Example",
+        "kubernetes" => {
+            "pod_name" => "understood-butterfly-nginx-logging-demo-7dcdcfdcd7-h7p9n",
+            "namespace_name" => "default",
+            "labels" => {
+              "app" => "nginx",
+              "app.tier" => "frontend",
+              "app.kubernetes.io/managed-by" => "helm"
+            }
+        }
+    }
+    d = create_driver(config)
+    d.run(default_tag: 'test') do
       d.feed("tag1", event_time, record.dup)
     end
     events = d.events
     puts events
+
+    assert_equal("cluster.default.nginx.frontend.helm", events[0][0])
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-tag-normaliser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Banzai Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,8 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Tag-normaliser is a `fluentd` plugin to help re-tag logs with Kubernetes