fluent-plugin-kubernetes-parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26dfcbff35f2d6d2c28c0df7581362dfc2fa9d3583f3d34c1884da76f46e6532
+  data.tar.gz: ebeb0100174fd8f9f8ac741b975802d2004d0164ed314eadf99b010bcbf10737
+SHA512:
+  metadata.gz: 19f2ef4af12db51aed93e6f7ce3a245ed5febe974e42268d05ad9b2459ce3903acbe2eeaf9b24ecca9e3bff82fff7ecb698823e649762901f0a637b4ad0293cf
+  data.tar.gz: 517c25c3063d8d66eacb8175d8a4ae8273689741a4d0435021300d8815de33d38ddf245acee61f81eb2a585cbbd23ffaeb8bae015e17b5977f569236309a2380

data/.github/workflows/gem-push.yml

@@ -0,0 +1,46 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+  release:
+    types: ['published']
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

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/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-kubernetes-parser (0.1.0)
+      fluentd (>= 0.14.10, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.10)
+    cool.io (1.7.1)
+    fluentd (1.14.6)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.9.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.2.5, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.4, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (>= 1.4.2, < 1.8.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.8.0)
+    msgpack (1.5.2)
+    power_assert (2.0.1)
+    rake (13.0.6)
+    serverengine (2.3.0)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.5)
+    test-unit (3.3.9)
+      power_assert
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2022.1)
+      tzinfo (>= 1.0.0)
+    webrick (1.7.0)
+    yajl-ruby (1.4.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2.20)
+  fluent-plugin-kubernetes-parser!
+  rake (~> 13.0.3)
+  test-unit (~> 3.3.5)
+
+BUNDLED WITH
+   2.2.20

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,63 @@
+# fluent-plugin-kubernetes-parser
+
+[Fluentd](https://fluentd.org/) parser plugin to parse some Kubernetes and containerd specific log file formats.
+
+## Installation
+
+### Fluent
+
+```
+$ fluent-gem install fluent-plugin-kubernetes-parser
+```
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-kubernetes-parser
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-kubernetes-parser"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+- See also: [TimeParameters Plugin Overview](https://docs.fluentd.org/v/1.0/timeparameters#overview)
+
+- See also: [Parser Plugin Overview](https://docs.fluentd.org/v/1.0/parser#overview)
+
+## Fluent::Plugin::KubernetesParser
+
+### delimiter (string) (optional)
+
+Default value: ` `.
+
+### default_tz (string) (optional)
+
+Default value: `+00:00`.
+
+### force_year (string) (optional)
+
+### keep_time_key (bool) (optional)
+
+### time_format (string) (optional)
+
+### time_key (string) (optional)
+
+Default value: `time`.
+
+## Copyright
+
+- Copyright(c) 2022- Sebastian Podjasek
+- 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-kubernetes-parser.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = 'fluent-plugin-kubernetes-parser'
+  spec.version = '0.1.0'
+  spec.authors = ['Sebastian Podjasek']
+  spec.email   = ['sebastian@podjasek.pl']
+
+  spec.summary       = 'Fluentd plugin to parse some Kubernetes specific log formats'
+  spec.description   = 'This plugin should be able to parse Kubernetes `klog` format with contexts, or other KV based formats'
+  spec.homepage      = 'https://github.com/inway/fluent-plugin-kubernetes-parser'
+  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.2.20'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'test-unit', '~> 3.3.5'
+  spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
+end

data/lib/fluent/plugin/parser_kubernetes.rb

@@ -0,0 +1,155 @@
+#
+# Copyright 2022- Sebastian Podjasek
+#
+# 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/log'
+require 'fluent/plugin/parser'
+
+module Fluent
+  module Plugin
+    class KubernetesParser < Fluent::Plugin::Parser
+      Fluent::Plugin.register_parser('kubernetes', self)
+
+      config_param :delimiter, :string, default: ' '
+      config_param :default_tz, :string, default: '+00:00'
+      config_param :force_year, :string, default: nil
+      config_param :keep_time_key, :bool, default: false
+      config_param :time_format, :string, default: nil
+      config_param :time_key, :string, default: 'time'
+
+      def configure(conf)
+        super
+
+        raise ConfigError, "delimiter must be a single character. #{@delimiter} is not." if @delimiter.length != 1
+
+        # Kubernetes logging format
+        # https://kubernetes.io/docs/concepts/cluster-administration/system-logs/
+        # https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md
+        #
+        # <klog header> "<message>" <key1>="<value1>" <key2>="<value2>" ...
+        # Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
+        #
+        # where the fields are defined as follows:
+        #   L                A single character, representing the log level (eg 'I' for INFO)
+        #   mm               The month (zero padded; ie May is '05')
+        #   dd               The day (zero padded)
+        #   hh:mm:ss.uuuuuu  Time in hours, minutes and fractional seconds
+        #   threadid         The space-padded thread ID as returned by GetTID()
+        #   file             The file name
+        #   line             The line number
+        #   msg              The user-supplied message
+        @klog_regexp = /
+          ^
+          (?<log_level>[A-Z])(?<month>\d{2})(?<day>\d{2})\s+
+          (?<time>\d{2}:\d{2}:\d{2}(|\.\d+))\s+
+          (?<threadid>\d+)\s+
+          (?<file>[^ ]*):(?<line>\d+)\]\s
+          (
+            "(?<msg>([^"\\]*(?:\\.[^"\\]*)*))"(|\s+(?<kv>.*))
+            |
+            (?<greedy_msg>.*)
+          )
+          $
+        /x
+
+        # KV format used by containerd
+        @kv_regexp = /
+          (?<key>[^\s=]+)
+          (
+            \s
+            |
+            =
+            (?<value>
+              "(?<quoted>([^"\\]*(?:\\.[^"\\]*)*))"
+              |
+              \[(?<array>([^\]\\]*(?:\\.[^\]\\]*)*))\]
+              |
+              [^\s]*
+            )
+          )
+        /x
+      end
+
+      def parse(text)
+        if text.nil? || text.empty?
+          yield nil, nil
+          return
+        end
+
+        time = nil
+        record = {}
+
+        matches_klog = @klog_regexp.match(text)
+
+        unless matches_klog.nil?
+          captures = matches_klog.named_captures
+
+          captures['msg'] = captures['greedy_msg'] unless captures['greedy_msg'].nil?
+          captures.delete('greedy_msg')
+
+          unless captures['time'].nil?
+            record['time'] =
+              format('%s-%s-%sT%s%s', @force_year.nil? ? Time.now.year : @force_year, captures['month'], captures['day'],
+                     captures['time'], @default_tz)
+            captures.delete('month')
+            captures.delete('day')
+            captures.delete('time')
+          end
+
+          text = captures['kv']
+          captures.delete('kv')
+
+          captures.each do |key, value|
+            if key == 'log_level'
+              # As seen here:
+              # https://github.com/kubernetes/klog/blob/9ad246211af1ed84621ee94a26fcce0038b69cd1/klog.go#L112
+              record['level'] = case value
+                                when 'I'
+                                  'info'
+                                when 'W'
+                                  'warn'
+                                when 'E'
+                                  'error'
+                                when 'F'
+                                  'fatal'
+                                else
+                                  value
+                                end
+            elsif %w[threadid line].include?(key)
+              record[key] = value.to_i
+            else
+              record[key] = value
+            end
+          end
+        end
+
+        unless text.nil?
+          text.scan(@kv_regexp).each do |key, value, quoted, array|
+            record[key] = if !quoted.nil?
+                            quoted.gsub(/\\(.)/, '\1')
+                          elsif !array.nil?
+                            array.split(',').map(&:strip)
+                          else
+                            value
+                          end
+          end
+        end
+
+        time = parse_time(record)
+
+        yield time, record
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/parser"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_parser_kubernetes.rb

@@ -0,0 +1,117 @@
+require 'helper'
+require 'fluent/plugin/parser_kubernetes'
+
+class KubernetesParserTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  CONFIG = %(
+    keep_time_key false
+    time_format %Y-%m-%dT%H:%M:%S.%N%:z
+  )
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Parser.new(Fluent::Plugin::KubernetesParser).configure(conf)
+  end
+
+  sub_test_case 'should parse logs' do
+    test 'kubelet without quoting' do
+      d = create_driver("#{CONFIG}\nforce_year 2022\ndefault_tz +02:00")
+      text = 'I0524 16:21:12.823864    1025 log.go:195] http: superfluous response.WriteHeader call from k8s.io/kubernetes/vendor/github.com/emicklei/go-restful.(*Response).WriteHeader (response.go:220)'
+
+      d.instance.parse(text) do |time, record|
+        assert_equal_event_time(event_time('2022-05-24T16:21:12.823864+02'), time)
+        assert_equal({
+                       'level' => 'info',
+                       'file' => 'log.go',
+                       'line' => 195,
+                       'msg' => 'http: superfluous response.WriteHeader call from k8s.io/kubernetes/vendor/github.com/emicklei/go-restful.(*Response).WriteHeader (response.go:220)',
+                       'threadid' => 1025
+                     }, record)
+      end
+    end
+    test 'kubelet without quoting, warn' do
+      d = create_driver("#{CONFIG}\nforce_year 2022\ndefault_tz +02:00")
+      text = 'W0627 12:09:57.042726  462622 empty_dir.go:519] Warning: Failed to clear quota on /var/lib/kubelet/pods/5d43adc3-c033-4475-b15c-34610db9c706/volumes/kubernetes.io~configmap/fluentd-config: clearQuota called, but quotas disabled'
+
+      d.instance.parse(text) do |time, record|
+        assert_equal_event_time(event_time('2022-06-27T12:09:57.042726+02'), time)
+        assert_equal({
+                       'level' => 'warn',
+                       'file' => 'empty_dir.go',
+                       'line' => 519,
+                       'msg' => 'Warning: Failed to clear quota on /var/lib/kubelet/pods/5d43adc3-c033-4475-b15c-34610db9c706/volumes/kubernetes.io~configmap/fluentd-config: clearQuota called, but quotas disabled',
+                       'threadid' => 462_622
+                     }, record)
+      end
+    end
+
+    test 'kubelet quoted msg' do
+      d = create_driver("#{CONFIG}\nforce_year 2022\ndefault_tz +02:00")
+      text = 'I0524 17:05:44.446677    1025 topology_manager.go:200] "Topology Admit Handler"'
+
+      d.instance.parse(text) do |time, record|
+        assert_equal_event_time(event_time('2022-05-24T17:05:44.446677+02'), time)
+        assert_equal({
+                       'level' => 'info',
+                       'file' => 'topology_manager.go',
+                       'line' => 200,
+                       'msg' => 'Topology Admit Handler',
+                       'threadid' => 1025
+                     }, record)
+      end
+    end
+
+    test 'kubelet with some context' do
+      d = create_driver("#{CONFIG}\nforce_year 2022\ndefault_tz +02:00")
+      text = 'I0524 17:11:56.952306    1025 kubelet_volumes.go:160] "Cleaned up orphaned pod volumes dir" podUID=c50c3c96-b448-46a8-aff0-ef61795696f7 path="/var/lib/kubelet/pods/c50c3c96-b448-46a8-aff0-ef61795696f7/volumes"'
+
+      d.instance.parse(text) do |time, record|
+        assert_equal_event_time(event_time('2022-05-24T17:11:56.952306+02'), time)
+        assert_equal({
+                       'level' => 'info',
+                       'file' => 'kubelet_volumes.go',
+                       'line' => 160,
+                       'msg' => 'Cleaned up orphaned pod volumes dir',
+                       'threadid' => 1025,
+                       'path' => '/var/lib/kubelet/pods/c50c3c96-b448-46a8-aff0-ef61795696f7/volumes',
+                       'podUID' => 'c50c3c96-b448-46a8-aff0-ef61795696f7'
+                     }, record)
+      end
+    end
+
+    test 'kubelet with some array in context' do
+      d = create_driver("#{CONFIG}\nforce_year 2022\ndefault_tz +02:00")
+      text = 'I0527 09:00:05.110852    1025 eviction_manager.go:167] "Failed to admit pod to node" pod="monitoring/prometheus-k8s-0" nodeCondition=[DiskPressure]'
+
+      d.instance.parse(text) do |time, record|
+        assert_equal_event_time(event_time('2022-05-27T09:00:05.110852+02'), time)
+        assert_equal({
+                       'level' => 'info',
+                       'file' => 'eviction_manager.go',
+                       'line' => 167,
+                       'msg' => 'Failed to admit pod to node',
+                       'nodeCondition' => ['DiskPressure'],
+                       'pod' => 'monitoring/prometheus-k8s-0',
+                       'threadid' => 1025
+                     }, record)
+      end
+    end
+
+    test 'containerd kv logs' do
+      d = create_driver(CONFIG)
+      text = 'time="2022-05-24T14:08:25.144534370+02:00" level=info msg="loading plugin \"io.containerd.grpc.v1.healthcheck\"..." type=io.containerd.grpc.v1'
+
+      d.instance.parse(text) do |time, record|
+        puts "time: #{time}, record: #{record}"
+        assert_equal_event_time(event_time('2022-05-24T14:08:25.144534370+02:00'), time)
+        assert_equal({
+                       'level' => 'info',
+                       'msg' => 'loading plugin "io.containerd.grpc.v1.healthcheck"...',
+                       'type' => 'io.containerd.grpc.v1'
+                     }, record)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kubernetes-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Podjasek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.20
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This plugin should be able to parse Kubernetes `klog` format with contexts,
+  or other KV based formats
+email:
+- sebastian@podjasek.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kubernetes-parser.gemspec
+- lib/fluent/plugin/parser_kubernetes.rb
+- test/helper.rb
+- test/plugin/test_parser_kubernetes.rb
+homepage: https://github.com/inway/fluent-plugin-kubernetes-parser
+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.1.6
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to parse some Kubernetes specific log formats
+test_files:
+- test/helper.rb
+- test/plugin/test_parser_kubernetes.rb