fluent-plugin-kubernetes-log-level 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 235d42a537afe3543033a875ccafc4878b67b88d
+  data.tar.gz: b94a6bd3c12e240a57ada07fb682a28dfe155f66
+SHA512:
+  metadata.gz: 8ad8f5f3929d225aecafbb54f90407de457c8bc28b70320b43b803a0c2e82854ba9284daf8375c77e1eee0795af52ac84105bd27301e8b319c2e006560911901
+  data.tar.gz: 37c32b784507e0e0a706dc2c3b5fefc9dfcdb14805db0ff2d0e3f7bc06b73a747f4771fecd7398067f73bfe78d1e945440e103cfb65283544a9a5ba05569923d

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/vendor/bundle
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+*.gem

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: nz6MRwf5TslWV/OP2IwklhWAi7VEH8m+4S7Kpd/TAtnn/M0ULPnCn3Ei99hJnpKmia28JEf/SSK6qQCgntQqyZaNs6ohM9ZtNHKL+D2yBb+FWfjql0nQyCTT7mN+6OuFFn3R5dR8mYDCiDaD5WCrGs6caHR3JUMe+3rYprzPJoIOW7txgwI760ynebxJMtebMD9a1fmob1bC/bV1nu7Gil9mjNEi7VrRpN7KmDwFQxXUPGu0L0hixJgSYcE0At+gdcCAsv6AQHMr/CbVRnr6a7nIQBISDjiv6ygzkqYPWpUjv+CACoBotl+M4SlBSCuCW5MsguF8Mti9mx9L2BkzYzkZ10fDNOk5xXxmW5Hg7QaM0EdqMk434AZ+qPa6hNZmAw6s5yqpdR7pKOPSWQJkJWhvvIDGIpcLhbWoordsrpmGiyUqh4ZYZ+bcCVjTmjpgANg5Fsf1KPv/fxAXtoG18R+MyJu9stn73g6kyDiV0llyD6/bi5+xTklnnuLf9IIvdI3121sRoJMaK1EMydyJOyBSG82urcPbduOtOdnfKi30+oSyk16L1vdHKrl7CPFB3ZlNqrke7r4CrbvWEv4GhAbBOUUrL+no1O8ox265NPAWMqzY32pg7IBNayrOZkMNr4AnoT2UDd3c9WCIy5XPK0dlfKw5YC5QTQpNpnlHHlk=
+  gem: fluent-plugin-kubernetes-log-level
+  on:
+    tags: true
+    repo: Soluto/fluent-plugin-kubernetes-log-level

data/Gemfile

@@ -0,0 +1,3 @@
+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,45 @@
+# fluent-plugin-kubernetes-log-level
+
+[Fluentd](https://fluentd.org/) filter plugin to filter messages according to log level
+
+This plugin allows setting a kubernetes label to your pods, and have fluentd filter logs containing a level value lower then the level indicated by the label.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-kubernetes-log-level
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-kubernetes-log-level"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+You can generate configuration template:
+
+```
+$ fluent-plugin-config-format filter kubernetes-log-level
+```
+TODO - generate this doc once the plugin is published
+
+You can copy and paste generated documents here.
+
+## Copyright
+
+* Copyright(c) 2018- yaron-idan
+* 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-log-level.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-kubernetes-log-level"
+  spec.version = "0.1.0"
+  spec.authors = ["yaron-idan"]
+  spec.email   = ["yaronidan@gmail.com"]
+
+  spec.summary       = %q{Fluentd plugin for setting kubernetes log level.}
+  spec.description   = %q{Use kubernetes labels to set log level dynamically.}
+  spec.homepage      = "https://github.com/Soluto/fluent-plugin-kubernetes-log-level"
+  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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/filter_kubernetes_log_level.rb

@@ -0,0 +1,84 @@
+#
+# Copyright 2018- yaron-idan
+#
+# 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/filter"
+
+module Fluent
+  module Plugin
+    class KubernetesLogLevelFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("kubernetes_log_level", self)
+
+      # TODO - solve default values problem
+      config_param :log_level_label, :string
+      config_param :log_level_key, :string
+      config_param :default_logging_level, :string
+
+      def configure(conf)
+          super
+      end
+
+      def level_to_num(level)
+        case level
+        when 'trace'
+          10
+        when 'debug'
+          20
+        when 'info'
+          30
+        when 'warning'
+          40
+        when 'error'
+          50
+        when 'fatal'
+          60
+        else
+          0
+        end
+      end
+
+      def filter(tag, time, record)
+        puts @log_level_label
+        log.trace "Start to process record"
+        is_logging_label_exist = false
+        if record.has_key?("kubernetes")
+          if record["kubernetes"].has_key?("labels")
+            if record["kubernetes"]["labels"].has_key?(@log_level_label)
+              log.trace "kubernetes.labels.logging-level found"
+              numeric_logging_level = level_to_num(record['kubernetes']['labels'][@log_level_label])
+              is_logging_label_exist = true
+            end
+          end
+        end
+        
+        log.trace "Check for logging level existance"
+        if is_logging_label_exist == false
+          if @default_logging_level.nil?
+            record
+          else
+            numeric_logging_level = level_to_num(@default_logging_level)
+          end
+        end
+        
+        log.trace "Process current log level"
+        numeric_level = level_to_num(record[@log_level_key])
+        if numeric_level >= numeric_logging_level
+          record
+        else
+          nil
+        end
+      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/filter"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_filter_kubernetes_log_level.rb

@@ -0,0 +1,72 @@
+require "helper"
+require "fluent/plugin/filter_kubernetes_log_level.rb"
+
+class KubernetesLogLevelFilterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+    @expected_warning = [{
+      'level'      => 'warning',
+      'kubernetes' => {
+        'labels' => {
+          'logging-level' => 'warning'
+        }
+      }
+    }]
+
+    @expected_error = [{
+      'level'  => 'error',
+      'kubernetes' => {
+        'labels' => {
+          'logging-level' => 'warning'
+        }
+      }
+    }]
+
+    @expected_info = []
+
+    @expected_static_warning_default = [{
+      'level' => 'warning'
+    }]
+  end
+
+  CONFIG = %[
+    log_level_label logging-level
+    log_level_key level
+    default_logging_level warning
+  ]
+
+ # private
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::KubernetesLogLevelFilter).configure(conf)
+  end
+
+  def filter(msg, time = event_time("2017-07-12 19:20:21 UTC"))
+    d = create_driver
+    d.run { d.feed('kubernetes', time, msg) }
+    d.filtered_records
+  end
+
+  def test_default_configuration
+    d = create_driver
+    assert_equal 'logging-level', d.instance.config['log_level_label']
+    assert_equal 'level', d.instance.config['log_level_key']
+    assert_equal 'warning', d.instance.config['default_logging_level']
+  end
+
+  def test_log_level_higher_then_threshold
+    assert_equal @expected_error, filter({"level"=>"error", "kubernetes"=>{"labels"=>{"logging-level"=>"warning"}}})
+  end 
+
+  def test_log_level_equal_to_threshold
+    assert_equal @expected_warning, filter({"level"=>"warning", "kubernetes"=>{"labels"=>{"logging-level"=>"warning"}}})
+  end 
+
+  def test_log_level_lower_then_threshold
+    assert_equal @expected_info, filter({"level"=>"info", "kubernetes"=>{"labels"=>{"logging-level"=>"warning"}}})
+  end 
+
+  def test_static_log
+    assert_equal @expected_static_warning_default, filter({"level"=>"warning"})
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kubernetes-log-level
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yaron-idan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: Use kubernetes labels to set log level dynamically.
+email:
+- yaronidan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kubernetes-log-level.gemspec
+- lib/fluent/plugin/filter_kubernetes_log_level.rb
+- test/helper.rb
+- test/plugin/test_filter_kubernetes_log_level.rb
+homepage: https://github.com/Soluto/fluent-plugin-kubernetes-log-level
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin for setting kubernetes log level.
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_kubernetes_log_level.rb