fluent-plugin-watch-objectspace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50ef80ccfe4236df352654ccbf415698e15bcf98927fc6bebba8ddbffd3d76bb
+  data.tar.gz: 25efcc62552470384eebf776edcd6dc89e45d7550319dd2bd141b4f4608e6d7c
+SHA512:
+  metadata.gz: '0935e7413eefa8bc4302b0d151c403fa24131960f3aa9dddc87c2c815dab3321328b007a51d5b829a9019c3b5e2450d4fcb48d8aff23f5cbc29e226bc783a8bc'
+  data.tar.gz: 73f7efa2832cce3b36f024b9c1feb4ac729a20aa63426b583b5012ff784391af7150c26a732471ff14aee03342d01647deb7101b35c95a06f5f016dc37c2001d

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,70 @@
+# fluent-plugin-watch-objectspace
+
+[Fluentd](https://fluentd.org/) input plugin to collect ObjectSpace information.
+Additionally, plugin's process information similar to 
+[fluent-plugin-watch-process](https://github.com/y-ken/fluent-plugin-watch-process).
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-watch-objectspace
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-watch-objectspace"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+
+| parameter                      | type              | description                                                | default             |
+|--------------------------------|-------------------|------------------------------------------------------------|---------------------|
+| watch_class                    | array (optional)  | Class to be watched                                        |                     |
+| watch_interval                 | time (optional)   | Interval to watch object space                             | `60`                |
+| tag                            | string (optional) | Tag for this input plugin                                  | `watch_objectspace` |
+| modules                        | array (optional)  | Modules which must be required                             |                     |
+| watch_delay                    | time (optional)   | Delayed seconds until process start up                     | `60`                |
+| gc_raw_data                    | bool (optional)   | Collect GC::Profiler.raw_data                              |                     |
+| res_incremental_threshold_rate | float (optional)  | Threshold rate which regards increased RES as memory leaks | `1.3`               |
+
+## Usage
+
+
+```
+<source>
+  @type watch_objectspace
+  tag watch_objectspace
+  modules cmetrics
+  watch_class CMetrics::Counter, CMetrics::Gauge, CMetrics::Untyped
+  watch_interval 60
+  watch_delay 10
+  res_incremental_threshold_rate 1.3
+</source>
+```
+
+If memory usage is over 1.3 times, it raise an exception.
+
+## FAQ
+
+# What is the different between fluent-plugin-watch-objectspace and fluent-plugin-watch-process
+
+fluent-plugin-watch-process is useful cron/batch process monitoring, In contrast to it, fluent-plugin-watch-objectspace is
+focused on used plugin's resource (memory) usage especially object and memory.
+
+## Copyright
+
+* Copyright(c) 2021- Kentaro Hayashi
+* 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-watch-objectspace.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-watch-objectspace"
+  spec.version = "0.1.0"
+  spec.authors = ["Kentaro Hayashi"]
+  spec.email   = ["kenhys@gmail.com"]
+
+  spec.summary       = %q{Watch fluentd's resource (memory and object) usage}
+  spec.description   = %q{Watch fluentd's resource (memory and object) via ObjectSpace to detect memory leaks}
+  spec.homepage      = "https://github.com/fluent-plugins-nursery/fluent-plugin-watch-objectspace"
+  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.24"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "test-unit", "~> 3.4.4"
+  spec.add_development_dependency "test-unit-rr", "~> 1.0.5"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/in_watch_objectspace.rb

@@ -0,0 +1,119 @@
+#
+# Copyright 2021- Kentaro Hayashi
+#
+# 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/input"
+
+module Fluent
+  module Plugin
+    class WatchObjectspaceInput < Fluent::Plugin::Input
+      Fluent::Plugin.register_input("watch_objectspace", self)
+
+      helpers :timer
+
+      desc "Class to be watched"
+      config_param :watch_class, :array, default: nil
+      desc "Interval to watch object space"
+      config_param :watch_interval, :time, default: 60
+      desc "Tag for this input plugin"
+      config_param :tag, :string, default: "watch_objectspace"
+      desc "Modules which must be required"
+      config_param :modules, :array, default: nil
+      desc "Delayed seconds until process start up"
+      config_param :watch_delay, :time, default: 60
+      desc "Collect GC::Profiler.raw_data"
+      config_param :gc_raw_data, :bool, default: false
+      desc "Threshold rate which regards increased RES as memory leaks"
+      config_param :res_incremental_threshold_rate, :float, default: 1.3
+     
+      def configure(conf)
+        super(conf)
+        if @modules
+          @modules.each do |mod|
+            require mod
+          end
+        end
+        @warmup_time = Time.now + @watch_delay
+        @source = {}
+        GC::Profiler.enable
+      end
+
+      def start
+        super
+        timer_execute(:execute_watch_objectspace, @watch_interval, &method(:refresh_watchers))
+      end
+
+      def parse_top_result(content)
+        record = {}
+        fields = content.split("\n")[-2].split
+        values = content.split("\n").last.split
+        fields.each_with_index do |field, index|
+          case field
+          when "USER", "S", "TIME+", "COMMAND"
+            record[field.downcase] = values[index]
+          when "PID", "PR", "NI", "VIRT", "RES", "SHR"
+            record[field.downcase] = values[index].to_i
+          else
+            record[field.downcase] = values[index].to_f
+          end
+        end
+        record
+      end
+
+      def refresh_watchers
+        return if Time.now < @warmup_time
+        
+        pid = Process.pid
+        record = {
+          "pid" => pid,
+          "count" => {},
+          "memory_leaks" => false
+        }
+
+        begin
+          content = IO.popen("top -p #{pid} -b -n 1") do |io|
+            io.read
+          end
+          record.merge!(parse_top_result(content))
+
+          if @gc_raw_data
+            record["raw_data"] = GC::Profiler.raw_data
+          end
+          @watch_class.each do |klass|
+            record["count"]["#{klass.downcase}"] = ObjectSpace.each_object(Object.const_get(klass)) { |x| x }
+          end
+
+          if @source.empty?
+            @source = record
+          end
+
+          if @source["res"] * @res_incremental_threshold_rate < record["res"]
+            record["memory_leaks"] = true
+            message = sprintf("Memory leak is detected, threshold rate <%f>: %f > %f * %f",
+                              @res_incremental_threshold_rate, record["res"],
+                              @source["res"], @res_incremental_threshold_rate)
+            raise message
+          end
+          es = OneEventStream.new(Fluent::EventTime.now, record)
+          router.emit_stream(@tag, es)
+        rescue => e
+          $log.error(e.message)
+        end
+      end
+
+      def shutdown
+      end
+    end
+  end
+end

data/test/helper.rb

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

data/test/plugin/test_in_watch_objectspace.rb

@@ -0,0 +1,61 @@
+require "helper"
+require "fluent/plugin/in_watch_objectspace"
+
+class WatchObjectspaceInputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  DEFAULT_CONFIG = config_element("ROOT", "", {})
+
+  private
+
+  def create_driver(conf = DEFAULT_CONFIG)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::WatchObjectspaceInput).configure(conf)
+  end
+
+  sub_test_case "configure" do
+    def test_default_configuration
+      d = create_driver
+      assert_equal([
+                     d.instance.watch_class,
+                     d.instance.watch_interval,
+                     d.instance.watch_delay,
+                     d.instance.tag,
+                     d.instance.modules,
+                     d.instance.gc_raw_data,
+                     d.instance.res_incremental_threshold_rate
+                   ],
+                   [
+                     nil,
+                     60,
+                     60,
+                     "watch_objectspace",
+                     nil,
+                     false,
+                     1.3
+                   ])
+    end
+  end
+
+  sub_test_case "parser" do
+    def test_top_parser
+      config = config_element("ROOT", "", {
+                                "watch_delay" => 0,
+                                "watch_interval" => 5,
+                                "watch_class" => ["String"]})
+      d = create_driver(config)
+      d.run(expect_records: 1, timeout:5)
+      event = d.events.first
+      assert_equal([1,
+                    "watch_objectspace",
+                    Fluent::EventTime,
+                    ["pid", "count", "memory_leaks", "user", "pr", "ni", "virt", "res", "shr", "s", "%cpu", "%mem", "time+", "command"]
+                   ],
+                   [d.events.size,
+                    event[0],
+                    event[1].class,
+                    event[2].keys])
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-watch-objectspace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kentaro Hayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-27 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.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.24
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.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: Watch fluentd's resource (memory and object) via ObjectSpace to detect
+  memory leaks
+email:
+- kenhys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-watch-objectspace.gemspec
+- lib/fluent/plugin/in_watch_objectspace.rb
+- test/helper.rb
+- test/plugin/test_in_watch_objectspace.rb
+homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-watch-objectspace
+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: Watch fluentd's resource (memory and object) usage
+test_files:
+- test/helper.rb
+- test/plugin/test_in_watch_objectspace.rb