fluent-plugin-kube-events-timestamp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dfe5a8c690dc78e410526e16bcab7a300eb2ec2e94120514d4a5d506b0cbf6a
+  data.tar.gz: f012d1226ebaa0294bab225d9718d6a0de21a9808e562a5e2582902f69ede398
+SHA512:
+  metadata.gz: c7d97dede27902bd9f8d8fe246a59bc826db32133573325d3ccf38ff99c22d50bb233517448b236a8f101d8ed520bb410db0d7c26d2008be9441346574b839a1
+  data.tar.gz: 60ba72bdb67f23c8e822a50cde4a944bc0a369285953f096c045eaded114bf91c5af6fead3436e760b82fdde17e8fcee7bbeffe7dacdb9492ee9d84ead090809

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 @@
+# 

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.warning = false
+end
+
+task :default => :test

data/fluent-plugin-kube-events-timestamp.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-kube-events-timestamp"
+  spec.version = "0.1.0"
+  spec.authors = ["Banzai Cloud"]
+  spec.email   = ["info@banzaicloud.com"]
+  spec.description   = %q{fluent filter plugin to map multiple timestamps into an additional one}
+  spec.summary       = %q{fluent kubernetes events timestamps filter}
+  spec.homepage      = "https://github.com/banzaicloud/fluentd-filter-kube-events-timestamp"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd", [">= 0.14.0", "< 2"]
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "test-unit", "~> 3.2"
+end

data/lib/fluent/plugin/filter_kube_events_timestamp.rb

@@ -0,0 +1,46 @@
+require 'fluent/plugin/filter'
+
+module Fluent::Plugin
+  class KubEventsTimestampFilter < Filter
+
+    Fluent::Plugin.register_filter('kube_events_timestamp', self)
+
+    config_param :mapped_time_key, :string, default: 'triggerts'
+    config_param :timestamp_fields, :array, default: ['event.eventTime', 'event.lastTimestamp', 'event.firstTimestamp'], value_type: :string
+
+    def configure(conf)
+      super
+      require 'date'
+      @strftime_format = "%Y-%m-%dT%H:%M:%S.%3N%z".freeze
+      raise Fluent::ConfigError, "mapped_time_key can not be empty" if mapped_time_key == ""
+      raise Fluent::ConfigError, "timestamp_fields must have 3 items" if timestamp_fields.length != 3
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def filter(tag, time, record)
+
+      @timestamp_fields.map do |field|
+        record[field]
+      end.compact.each do |timestamp|
+        begin
+          record[@mapped_time_key] = record[timestamp_fields[0]] == "" ? record[timestamp_fields[1]] == "" ? record[timestamp_fields[2]] : record[timestamp_fields[1]] : record[timestamp_fields[0]]
+        end
+      end
+
+        unless record[@mapped_time_key] != ""
+          record[@mapped_time_key] = Time.at(time.is_a?(Fluent::EventTime) ? time.to_int : time).strftime(@strftime_format)
+          $log.debug("Timestamp added: #{record[@mapped_time_key]}")
+        end
+  
+      record
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'fluent/test'
+require 'fluent/test/helpers'
+require 'fluent/test/driver/filter'
+require 'fluent/plugin/filter_kube_events_timestamp'
+
+class Test::Unit::TestCase
+  include Fluent::Test::Helpers
+end

data/test/plugin/test_filter_kube_events_timestamp.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class TestKubEventsTimestampFilter < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf='')
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::KubEventsTimestampFilter).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[mapped_time_key ""])
+    end
+    assert_nothing_raised do
+      create_driver(%[mapped_time_key "anyvalidstring"])
+    end
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[timestamp_fields ["foo","bar"]])
+    end
+    assert_nothing_raised do
+      create_driver(%[timestamp_fields ["foo","bar","baz"]])
+    end
+  end
+
+  def test_config_mapped_time_key()
+    data={'event.eventTime' => '','event.lastTimestamp'  => '', 'event.firstTimestamp' => ''}
+    d = create_driver('mapped_time_key "foobar"')
+    d.run(default_tag: 'test') do
+      d.feed({'test' => 'config_mapped_time_key'}.merge(data))
+    end
+    filtered = d.filtered.map {|e| e.last}.first
+    puts "result => " + filtered.to_s
+    assert_true(filtered['foobar'] != nil)
+  end
+
+  def test_config_timestamp_fields()
+    data={'event.eventTime' => 'also set','event.lastTimestamp'  => '', 'event.firstTimestamp' => '', 'foo' => 'SET', 'bar' => '', 'baz' => ''}
+    d = create_driver('timestamp_fields ["foo","bar","baz"]')
+    d.run(default_tag: 'test') do
+      d.feed({'test' => 'timestamp_fields'}.merge(data))
+    end
+    filtered = d.filtered.map {|e| e.last}.first
+    puts "result => " + filtered.to_s
+    assert_equal(filtered['triggerts'], filtered['foo'])
+  end
+
+  def test_notime()
+    data={'event.eventTime' => '','event.lastTimestamp'  => '', 'event.firstTimestamp' => ''}
+    puts "testcase => " + data.to_s
+    d = create_driver
+    d.run(default_tag: 'test') do
+      d.feed({'test' => 'notime'}.merge(data))
+    end
+    filtered = d.filtered.map {|e| e.last}.first
+    puts "result => " + filtered.to_s
+    assert_true(filtered['triggerts'] != nil)
+  end
+
+  def test_expected_mappings()
+    data=[
+      {'expected' => 'event.eventTime', 'event.eventTime' => '2021-09-21T21:39:16.000+0200','event.lastTimestamp'  => '', 'event.firstTimestamp' => ''},
+      {'expected' => 'event.eventTime', 'event.eventTime' => '2021-09-21T21:39:16.000+0200','event.lastTimestamp'  => 'notempty', 'event.firstTimestamp' => ''},
+      {'expected' => 'event.eventTime', 'event.eventTime' => '2021-09-21T21:39:16.000+0200','event.lastTimestamp'  => 'notempty', 'event.firstTimestamp' => 'alsonotempty'},
+      {'expected' => 'event.eventTime', 'event.eventTime' => '2021-09-21T21:39:16.000+0200','event.lastTimestamp'  => '', 'event.firstTimestamp' => 'nonempty'},
+      {'expected' => 'event.lastTimestamp', 'event.eventTime' => '','event.lastTimestamp'  => 'exists', 'event.firstTimestamp' => ''},
+      {'expected' => 'event.lastTimestamp', 'event.eventTime' => '','event.lastTimestamp'  => 'exists', 'event.firstTimestamp' => 'alsoexists'},
+      {'expected' => 'event.firstTimestamp', 'event.eventTime' => '','event.lastTimestamp'  => '', 'event.firstTimestamp' => 'exists'}
+    ]
+    data.each do |testcase|
+      puts "testcase => " + testcase.to_s
+      d = create_driver
+      d.run(default_tag: 'test') do
+        d.feed({'test' => 'expected_mappings'}.merge(testcase))
+      end
+      filtered = d.filtered.map {|e| e.last}.first
+      puts "result => " + filtered.to_s
+      assert_equal(filtered['triggerts'], filtered[filtered['expected']])
+    end
+  end
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kube-events-timestamp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Banzai Cloud
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: fluent filter plugin to map multiple timestamps into an additional one
+email:
+- info@banzaicloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kube-events-timestamp.gemspec
+- lib/fluent/plugin/filter_kube_events_timestamp.rb
+- test/helper.rb
+- test/plugin/test_filter_kube_events_timestamp.rb
+homepage: https://github.com/banzaicloud/fluentd-filter-kube-events-timestamp
+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.2.22
+signing_key:
+specification_version: 4
+summary: fluent kubernetes events timestamps filter
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_kube_events_timestamp.rb