fluent-plugin-parser-cri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d1a06b1e48e5261c6978062fd21e4684bfbc6ff3ce5aa2bdefdc7263f5493de
+  data.tar.gz: 6940a875e8f60692fca9c0dd230d1d7617f80edc2ee4e40df066cd72fc8423f4
+SHA512:
+  metadata.gz: d9851d38880d11bb73ccbc44d4877f86ccb8de469beb067e503fe3fd1c1cc8558a04b4c3d5655295acbd400f18b324949ef924a7a94ab0703aa404cee36dcc78
+  data.tar.gz: 716328cc1e3851b4c9e8b6933187b3464a03583f829e5948182f5671dbcdaab175cda35ccecc80d9ec4657ede04382722be6184e5ddab7e79239c1d71f6b55b1

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   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.

data/README.md

@@ -0,0 +1,113 @@
+# fluent-plugin-parser-cri
+
+[Fluentd](https://fluentd.org/) parser plugin to parse CRI logs.
+
+CRI logs consist of `time`, `stream`, `logtag` and `message` parts like below:
+
+```
+2020-10-10T00:10:00.333333333Z stdout F Hello Fluentd
+
+time: 2020-10-10T00:10:00.333333333Z
+stream: stdout
+logtag: F
+message: Hello Fluentd
+```
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-parser-cri --no-document
+```
+
+## Configuration
+
+* **merge_cri_fields** (bool) (optional): Put `stream`/`logtag` fields or not when `<parse>` section is specified. Default is `true`
+
+### \<parse\> section (optional)
+
+Same as [parser plugin configuration](https://docs.fluentd.org/configuration/parse-section).
+
+```aconf
+<parse>
+  @type cri
+  <parse>
+    @type json
+  </parse>
+</parse>
+```
+
+This nested `<parse>` is used for parsing `message` part.
+
+## Log and configuration example
+
+### Basic case
+
+```aconf
+<parse>
+  @type cri
+</parse>
+```
+
+With this configuration, following CRI log
+
+```
+2020-10-10T00:10:00.333333333Z stdout F Hello Fluentd
+```
+
+is parsed to
+
+```
+time: 2020-10-10T00:10:00.333333333Z
+record: {"stream":"stdout","logtag":"F","message":"Hello Fluentd","time':'2020-10-10T00:10:00.333333333Z"}
+```
+
+### Parse message part with parsers
+
+By specifying `<parse>` section, you can parse `message` part with parser plugins.
+
+```aconf
+<parse>
+  @type cri
+  <parse>
+    @type json
+    time_key time
+    time_format %Y-%m-%dT%H:%M:%S.%L%z
+    # keep_time_key true # if you want to keep "time" field, enable this parameter
+  </parse>
+</parse>
+```
+
+With this configuration, following CRI log
+
+```
+2020-10-10T00:10:00.333333333Z stdout F {"foo":"bar","num":100,"time":"2020-11-11T00:11:00.111111111Z"}
+```
+
+is parsed to
+
+```
+time: 2020-11-11T00:11:00.111111111Z
+record: {"foo":"bar","num":100,"stream":"stdout","logtag":"F"}
+```
+
+If you don't need `stream`/`logtag` fields, set `merge_cri_fields false` like below:
+
+```
+<parse>
+  @type cri
+  merge_cri_fields false
+  <parse>
+    @type json
+    time_key time
+    time_format %Y-%m-%dT%H:%M:%S.%L%z
+  </parse>
+</parse>
+```
+
+## Copyright
+
+* Copyright(c) 2020- Fluentd project
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-parser-cri.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-parser-cri"
+  spec.version = "0.1.0"
+  spec.authors = ["Masahiro Nakagawa"]
+  spec.email   = ["repeatedly@gmail.com"]
+
+  spec.summary       = %q{CRI log format parser for Fluentd}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fluent/fluent-plugin-parser-cri"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "test-unit", "~> 3.3"
+  spec.add_runtime_dependency "fluentd", ">= 1"
+end

data/lib/fluent/plugin/parser_cri.rb

@@ -0,0 +1,73 @@
+#
+# Fluentd
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    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.
+#
+
+require 'fluent/plugin/parser'
+
+module Fluent
+  module Plugin
+    class CriParser < Parser
+      Plugin.register_parser("cri", self)
+
+      desc 'Merge stream/logtag fields into parsed result'
+      config_param :merge_cri_fields, :bool, default: true
+
+      config_set_default :time_key, 'time'.freeze
+      config_set_default :time_format, '%Y-%m-%dT%H:%M:%S.%L%z'.freeze
+      config_set_default :keep_time_key, true
+
+      def configure(conf)
+        super
+
+        @sub_parser = nil
+        if parser_config = conf.elements('parse').first
+          type = parser_config['@type']
+          @sub_parser = Fluent::Plugin.new_parser(type, parent: self.owner)
+          @sub_parser.configure(parser_config)
+        end
+      end
+
+      def parse(text)
+        elems = text.split(" ".freeze, 4)
+        return yield nil if elems.size != 4
+
+        if @sub_parser
+          time = record = nil
+          @sub_parser.parse(elems[3]) { |t, r|
+            time = t
+            record = r
+          }
+          if @merge_cri_fields && record
+            record['stream'] = elems[1]
+            record['logtag'] = elems[2]
+          end
+        else
+          record = {
+            "stream" => elems[1],
+            "logtag" => elems[2],
+            "message" => elems[3]
+          }
+          t = elems[0]
+          time = @time_parser.parse(t)
+          if @keep_time_key
+            record[@time_key] = t
+          end
+        end
+
+        yield time, record
+      end
+    end
+  end
+end

data/test/plugin/test_parser_cri.rb

@@ -0,0 +1,78 @@
+require "test-unit"
+require "fluent/test"
+require "fluent/test/helpers"
+require "fluent/test/driver/parser"
+require "fluent/plugin/parser_cri.rb"
+
+class CriParserTest < Test::Unit::TestCase
+  include Fluent::Test::Helpers
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf)
+    c = Fluent::Config.parse(conf, "(test)", "(test_dir)", true)
+    Fluent::Test::Driver::Parser.new(Fluent::Plugin::CriParser).configure(c)
+  end
+
+  def test_parse
+    d = create_driver('')
+    log = '2020-10-10T00:10:00.333333333Z stdout F Hello Fluentd'
+    d.instance.parse(log) do |time, record|
+      t = event_time('2020-10-10T00:10:00.333333333Z', format: '%Y-%m-%dT%H:%M:%S.%L%z')
+      r = {'stream' => 'stdout', 'logtag' => 'F', 'message' => 'Hello Fluentd', 'time' => '2020-10-10T00:10:00.333333333Z'}
+      assert_equal t, time
+      assert_equal r, record
+    end
+  end
+
+  def test_parse_without_keep_time_key
+    conf = %[keep_time_key false]
+    d = create_driver(conf)
+    log = '2020-10-10T00:10:00.333333333Z stdout F Hello Fluentd'
+    d.instance.parse(log) do |time, record|
+      t = event_time('2020-10-10T00:10:00.333333333Z', format: '%Y-%m-%dT%H:%M:%S.%L%z')
+      r = {'stream' => 'stdout', 'logtag' => 'F', 'message' => 'Hello Fluentd'}
+      assert_equal t, time
+      assert_equal r, record
+    end
+  end
+
+  def test_parse_with_json
+    conf = %[
+      <parse>
+        @type json
+        time_key time
+        time_format %Y-%m-%dT%H:%M:%S.%L%z
+      </parse>
+    ]
+    d = create_driver(conf)
+    log = '2020-10-10T00:10:00.333333333Z stdout F {"foo":"bar","num":100,"time":"2020-11-11T00:11:00.111111111Z"}'
+    d.instance.parse(log) do |time, record|
+      t = event_time('2020-11-11T00:11:00.111111111Z', format: '%Y-%m-%dT%H:%M:%S.%L%z')
+      r = {"foo" => "bar", "num" => 100, 'stream' => 'stdout', 'logtag' => 'F'}
+      assert_equal t, time
+      assert_equal r, record
+    end
+  end
+
+  def test_parse_with_json_without_merge_cri_fields
+    conf = %[
+      merge_cri_fields false
+      <parse>
+        @type json
+        time_key time
+        time_format %Y-%m-%dT%H:%M:%S.%L%z
+      </parse>
+    ]
+    d = create_driver(conf)
+    log = '2020-10-10T00:10:00.333333333Z stdout F {"foo":"bar","num":100,"time":"2020-11-11T00:11:00.111111111Z"}'
+    d.instance.parse(log) do |time, record|
+      t = event_time('2020-11-11T00:11:00.111111111Z', format: '%Y-%m-%dT%H:%M:%S.%L%z')
+      r = {"foo" => "bar", "num" => 100}
+      assert_equal t, time
+      assert_equal r, record
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-parser-cri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masahiro Nakagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description: CRI log format parser for Fluentd
+email:
+- repeatedly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-parser-cri.gemspec
+- lib/fluent/plugin/parser_cri.rb
+- test/plugin/test_parser_cri.rb
+homepage: https://github.com/fluent/fluent-plugin-parser-cri
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: CRI log format parser for Fluentd
+test_files:
+- test/plugin/test_parser_cri.rb