fluent-plugin-top 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68d92f3f4a576246b36676c92c36d930a29512a2
+  data.tar.gz: f171f9eb83e0999918432beb4a25c83b166347cd
+SHA512:
+  metadata.gz: 74c90f3744cce92369344c10a1db9090a7484bd75e7c837f08df2617fb3cd0ebcf33148d9e94d904d97a6662037930ae49f33982489cac9d90c45a308a791fcf
+  data.tar.gz: 9b4019cfde8285e36f195e4d8ed92da80e6603e1214982d5631787790a7b0ffbf58c853d3160e46c6ad376bb6813e28abaeb5598eec6a7b22c5c4b41ef1241e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-top.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2016 Tetsu Izawa (@moccos)
+
+   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,39 @@
+fluent-plugin-top
+===
+
+Fluentd input plugin for top command.
+
+If you focus on system metrics rather than each process,
+you should use [dstat plugin](https://github.com/shun0102/fluent-plugin-dstat).
+
+## Configuration
+    <source>
+      @type top
+      tag local.top       # *required*
+      interval 30         # default: 10.0
+      command_line true   # default: true
+      extra_switch -w 200 # default: ""
+      cpu_percent 50      # default: nil
+    </source>
+
+* **tag**: Output tag. [required]
+* **interval**: Refresh interval in sec.
+* **command_line**: Get command line (/usr/bin/ruby foo.rb -v) instead of simple name (ruby).
+* **extra_switch**: Extra command line switch for top command.
+* **cpu_percent**: Threshold - CPU usage (percent).
+* **mem_percent**: Threshold - Memory usage (percent).
+* **mem**: Threshold - Memory usage in megabytes.
+
+At least one threshold parameter should be specified.
+Otherwise, this plugin does not output anything.
+If you specify multiple threshold parameters, they are "OR"ed.
+
+<!--== Examples-->
+
+<!--TODO: write here-->
+
+## Copyright
+
+Copyright (c) 2016 Tetsu Izawa (@moccos)
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/plugin/test*.rb']
+  t.verbose = true
+end
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fluent-plugin-top.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-top"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tetsu Izawa (@moccos)"]
+  spec.email         = ["tt.izawa@gmail.com"]
+  spec.homepage      = "https://github.com/moccos/fluent-plugin-top"
+
+  spec.summary       = %q{Fluentd top command input plugin}
+  spec.description   = %q{Fluentd top command input plugin}
+  spec.licenses      = ["Apache License, Version 2.0"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd", ">= 0.12.0"
+  spec.add_runtime_dependency "fluent-mixin-rewrite-tag-name"
+end

data/lib/fluent/plugin/in_top.rb

@@ -0,0 +1,108 @@
+require 'thread'
+require 'fluent/input'
+require 'fluent/mixin/rewrite_tag_name'
+require_relative 'in_top_parser'
+
+module Fluent
+  class TopInput < Fluent::Input
+    INTERVAL_MIN = 0.5 # avoid too short interval
+
+    Fluent::Plugin.register_input('top', self)
+    desc "Top command. Don't forget to specify batch switch (-b)."
+    config_param :top, :string, :default => "top -b"
+    desc 'Output tag.'
+    config_param :tag, :string
+
+    ### Command line options
+    desc 'Refresh interval. (top -d)'
+    config_param :interval, :float, :default => 10.0
+    desc 'Get command line. (top -c)'
+    config_param :command_line, :bool, :default => true
+    desc 'Extra command line args for top command.'
+    config_param :extra_switch, :string, :default => ""
+
+    ### Conditions
+    desc "Threshold - CPU usage (percent)."
+    config_param :cpu_percent, :float, :default => nil
+    desc "Threshold - Memory usage (percent)."
+    config_param :mem_percent, :float, :default => nil
+    desc "Threshold - Memory usage in megabytes."
+    config_param :mem, :integer, :default => nil
+
+    ### Future works
+    #config_param :cpu_rank, :integer, :default => nil
+    #config_param :pid, :array, :default => []
+    #config_param :pid_file, :array, :default => []
+    #config_param :pid_file_watch_interval, :int, :default => 30
+
+    desc 'Command line and args. This overrides other settings.'
+    config_param :test_cmd, :string, :default => nil
+
+    # for fluent-mixin-rewrite-tag-name
+    include Fluent::Mixin::RewriteTagName
+    desc 'Command to get hostname. Typically it is "hostname" or "hostname -s".'
+    config_param :hostname_command, :string, :default => "hostname"
+
+    def configure(conf)
+      super
+      interval = @interval > INTERVAL_MIN ? @interval : INTERVAL_MIN
+      @top_command =
+        if @test_cmd then
+          @test_cmd
+        else
+          "#{@top} -d #{interval} #{@command_line ? "-c" : ""} #{@extra_switch}"
+        end
+    end
+
+    def start
+      super
+      @top_thread = Thread.new do
+        run_top()
+      end
+    end
+
+    def shutdown
+      super
+      $log.trace "Shutdown top command thread."
+      @top_thread.kill if @top_thread
+    end
+
+    private
+    def run_top
+      $log.trace "Top command thread is running: " + @top_command
+			IO.popen(@top_command, "r") {|io|
+        parser = Fluent::TopInputParser.new()
+				io.each {|line|
+          result, ps = parser.parse(line)
+          if result && check_ps_info(ps) then
+            ps.args = ps.args.join(' ')
+            emit_message(@tag, ps.to_h)
+          end
+				}
+			}
+      $log.info "Exit top command thread. (reached EOF)"
+    end
+
+    def check_ps_info(ps)
+      # For now, all conditions are "OR"ed
+      case
+      when @cpu_percent && ps.cpu >= @cpu_percent
+        true
+      when @mem_percent && ps.mem >= @mem_percent
+        true
+      when @mem && ps.res >= @mem * 1024 # megabytes
+        true
+      else
+        false
+      end
+    end
+
+    def emit_message(tag, message)
+      time = Engine.now
+      # for fluent-mixin-rewrite-tag-name
+      emit_tag = tag.dup
+      filter_record(emit_tag, time, message)
+      router.emit(emit_tag, time, message)
+    end
+  end
+end

data/lib/fluent/plugin/in_top_parser.rb

@@ -0,0 +1,80 @@
+module Fluent
+  class TopInputParser
+    ### state
+    STATE_HEADER  = 1
+    STATE_PROCESS = 2
+
+    @@PS_INFO = Struct.new(:pid, :user, :res, :cpu, :mem, :cmd, :args)
+
+    def initialize()
+      reset_state
+    end
+
+    def parse(line)
+      case @state
+      when STATE_HEADER then
+        return parse_header line
+      else
+        return parse_process line
+      end
+    end
+
+    private
+    def reset_state()
+      @state = STATE_HEADER
+    end
+
+    def parse_header(line)
+      #  PID USER      PR  NI    VIRT    RES    SHR S %CPU %MEM     TIME+ COMMAND
+      #    1 root      20   0   38004   5992   3916 S  0.0  0.6   0:03.43 systemd
+
+      ss = line.split("\s")
+      @state = STATE_PROCESS if ss[0] == "PID"
+      return false, nil
+    end
+
+    def parse_process(line)
+      ss = line.split("\s")
+      if !is_number?(ss[0]) then
+        reset_state
+        return parse_header(line)
+      end
+      begin
+        pid, user, _pr, _ni, _virt, res, _shr, _s, cpu, mem, _time, cmd = ss
+        args = ss.drop(12)
+        return true, @@PS_INFO.new(pid.to_i, user, res, cpu.to_f, mem.to_f, cmd, args)
+      rescue => e
+        $log.warn "parse error #{e.to_s}: " + line
+        reset_state
+        return false, nil
+      end
+    end
+
+    def is_number?(s)
+      begin
+        Float(s)
+        true
+      rescue
+        false
+      end
+    end
+
+    def parse_unit(s)
+      begin 
+        case s[-1]
+        when "m"
+          s[0, s.length-1].to_f * 1024
+        when "g"
+          s[0, s.length-1].to_f * 1024 * 1024
+        #when "t"  # I've never seen...
+          #s[0, s.length-1].to_f * 1024 * 1024 * 1024
+        else
+          s.to_i
+        end
+      rescue
+        $log.warn "Memory unit parse error: " + s
+        -1
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-top
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tetsu Izawa (@moccos)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-rewrite-tag-name
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd top command input plugin
+email:
+- tt.izawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-top.gemspec
+- lib/fluent/plugin/in_top.rb
+- lib/fluent/plugin/in_top_parser.rb
+homepage: https://github.com/moccos/fluent-plugin-top
+licenses:
+- Apache License, Version 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.6.6
+signing_key: 
+specification_version: 4
+summary: Fluentd top command input plugin
+test_files: []