fluent-plugin-firelens-tag-filter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4701b128678a435fd56087546ededb0c86a85e9a3a05e279282d47c8cfa71e5d
-  data.tar.gz: 7166ca91caa479120fd8f2636209c6b6367fbb0ca355c71d214d88e16f2dfacf
+  metadata.gz: fae1c8e9ddeda7c653e66a9279f5e50b1b2fa0a18022d0481775270e887f3ae3
+  data.tar.gz: 77a304edd71d77f8aef9219cc054f1a6a73b5ff3568900b63631d94352392591
 SHA512:
-  metadata.gz: 8b51a75afec20e79b3d4170ee2f3a2eeb2e1592b843f8c7a02059cb081e8a8f96e8c7e985a3dcdf41e3819aafbe107517ad367e38cf16b660e63a3f853c05a93
-  data.tar.gz: 5517cb0f7c6ce558f040bf43465056c4ea490ef92f132a0835550f0e2c9c603f74ed488b9a9e92066bfc0f76a02fe4bc620cac5a051884d67a49228c6dedb31f
+  metadata.gz: 5a008fbbf4f4a2fdfee94f1cbd794ef2482f73a75a479e63f1170b75b2853253a0bdcbaefec362f3a81330e722d35bdc11faa08295b8f8f103b6c2356934d474
+  data.tar.gz: 668d417d2261f42a876c9175dae69cc7ce15e1ee9e51b9fa060e08e93b2ca8743e6d8676d9e3b395969a2f9702a594b2e5fa2ce422e8f4882f014034d59310e7

data/README.md

@@ -4,7 +4,7 @@
 
 A tag of messages from AWS firelens has format like `[containerName]-firelens-[taskID]`, but a tag of fluentd is a string separated by dots (e.g. myapp.access) usually.
 
-fluent-plugin-firelens-tag-filter rewrites message tags from `[containerName]-firelens-[taskID]` to `[tag_prefix].[containerName].(stdout|stderr).[taskID]`.
+fluent-plugin-firelens-tag-filter rewrites message tags from `[containerName]-firelens-[taskID]` to `[tag_prefix].[containerName].(stdout|stderr).[taskID]` by default.
 
 ## Installation
 
@@ -47,6 +47,25 @@ $ bundle
 </match>
 ```
 
+Customize `tag` format.
+
+```conf
+<match *-firelens-*>
+  @type firelens_tag_filter
+  tag ${container_name}.${source}
+</match>
+
+<match app.stdout>
+  # ...
+</match>
+```
+
+Placeholders allowed in tag as below.
+
+- ${container-name} : Container name in task.
+- ${task_id} : ECS task ID
+- ${source} : source field in record (`stdout` or `stderr`)
+
 ## Copyright
 
 * Copyright(c) 2020- FUJIWARA Shunichiro

data/example.conf

@@ -16,3 +16,9 @@
 <match **>
   @type stdout
 </match>
+
+<label @FLUENT_LOG>
+  <match **>
+    @type null
+  </match>
+</label>

data/fluent-plugin-firelens-tag-filter.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-firelens-tag-filter"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["FUJIWARA Shunichiro"]
   spec.email   = ["fujiwara.shunichiro@gmail.com"]
 

data/lib/fluent/plugin/out_firelens_tag_filter.rb

@@ -24,6 +24,15 @@ module Fluent
       desc 'rewrote tag prefix'
       config_param :tag_prefix, :string, :default => 'firelens'
 
+      desc 'tag format'
+      config_param :tag, :string, :default => '${tag_prefix}.${container_name}.${source}.${task_id}'
+
+      def configure(conf)
+        super
+        @tag_format = @tag.gsub(/%/, '%%').gsub(/\$\{(.*?)\}/, '%{\1}')
+        log.debug("tag_format #{@tag_format}")
+      end
+
       # rewrite message tag
       # from: [containerName]-firelens-[taskID]
       # to:   [tag_prefix].[containerName].(stdout|stderr).[taskID]
@@ -34,10 +43,15 @@ module Fluent
           router.emit_stream(@tag_prefix + "." + tag, es)
           return
         end
+        v = {
+          tag_prefix: @tag_prefix,
+          container_name: matched[1],
+          task_id: matched[2],
+        }
         es.each do |time, record|
-          src = record['source'] || 'unknown'
+          v[:source] = record['source'] || 'unknown'
           router.emit(
-            [@tag_prefix, matched[1], src, matched[2]].join('.'),
+            sprintf(@tag_format, v),
             time,
             record,
           )

data/test/plugin/test_out_firelens_tag_filter.rb

@@ -38,6 +38,22 @@ class FirelensTagFilterOutputTest < Test::Unit::TestCase
     assert_equal events[2], ['ecs.app.unknown.a27287f301b06d77', time, {"foo" => "boo"}]
   end
 
+  test "tag" do
+    d = create_driver "tag xxx.${source}.${task_id}.${container_name}"
+    time = event_time("2020-07-22 11:22:33Z")
+    d.run(default_tag: "app-firelens-a27287f301b06d77") do
+      d.feed(time, {"foo" => "bar", "source" => "stdout"})
+      d.feed(time, {"foo" => "baz", "source" => "stderr"})
+      d.feed(time, {"foo" => "boo"})
+    end
+
+    events = d.events
+    assert_equal 3, events.length
+    assert_equal events[0], ['xxx.stdout.a27287f301b06d77.app', time, {"foo" => "bar", "source" => "stdout"}]
+    assert_equal events[1], ['xxx.stderr.a27287f301b06d77.app', time, {"foo" => "baz", "source" => "stderr"}]
+    assert_equal events[2], ['xxx.unknown.a27287f301b06d77.app', time, {"foo" => "boo"}]
+  end
+
   test "unexpected" do
     d = create_driver ""
     time = event_time("2020-07-22 11:22:33Z")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-firelens-tag-filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - FUJIWARA Shunichiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler