fluent-plugin-sar 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2f1de19c13358cdfb0040af85545cb253a7f062
+  data.tar.gz: b61888ae08152566a0c0059c61d9396e1cfe0116
+SHA512:
+  metadata.gz: e5c5e049083875ddc3098b3ecf831c32390a263841fade7c435886cbb12fe99a403570fa8f474ecfa1dcec516e5a1f090b5d9638c1b9dec4f025228d40b11278
+  data.tar.gz: 9e49bc41ed286fbb6e56ba7931f4c08ea0306e81cb0493e00c62ee52fa5eee8fd64b50e49ece22eae5abfc9b3d988406dee240997c3fa665536dda2be28e32eb

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hirotaka tajiri
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# Fluent::Plugin::Sar
+
+Fluentd input plugin to get sar result.
+
+This plugin needs "sysstat".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-sar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-sar
+
+## Overview
+
+This plugin collect "sar command result" every (interval) minutes.
+
+## Configuration
+### Parameters:
+
++ sar_option
+
+
+    (required)
+    
+    same sar option, but not all.
+
+    e.g.) sysstat version 9.0.4 on CentOS 6.5
+
+   Support
+
+        b     Report I/O and transfer rate statistics.  
+        B     Report paging statistics. Some of the metrics below are available only with post 2.5 kernels. 
+        m     Report power management statistics.  Note that these statistics depend on sadc option "-S POWER"  to  be  collected. 
+        q     Report queue length and load averages.
+        r     Report memory utilization statistics.  
+        R     Report memory statistics. 
+        S     Report swap space utilization statistics.
+        u     Report  CPU  utilization.
+        v     Report status of inode, file and other kernel tables.
+        w     Report task creation and system switching activity.
+        W     Report swapping statistics.
+
+   Not support
+   
+        A
+        C    
+        d
+        I     
+        j
+        n
+        P
+        p         
+        y
+
+- tag 
+
+
+    (optional | default : "sar_result.tag")
+
+- interval
+
+
+    (optional | defalut : 5)
+    
+    every (interval) minutes.
+
+- hostname_output
+
+
+    (optional | defalut : True)
+    
+    true or false
+
+- hostname
+
+
+    (optionl |  defalut : your server's hostname)
+
+### Example:
+
+    <source>
+        type              sar
+        sar_option        u q
+        tag               sar.tag
+        interval          10
+        hostname_output   true
+        hostname          check_host01
+    </source>
+
+output
+
+    sar.tag: {"hostname":"check_host01","check_time":"18:51:25","runq-sz":"0","plist-sz":"223","ldavg-1":"0.00","ldavg-5":"0.00","ldavg-15":"0.00","CPU":"all","%user":"0.00","%nice":"0.00","%system":"1.03","%iowait":"0.00","%steal":"0.00","%idle":"98.97"}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2014 Hirotaka Tajiri. See [LICENSE](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) {| spec |
+    spec.pattern = FileList['spec/*_spec.rb']
+}
+task :default => :spec

data/fluent-plugin-sar.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+#lib = File.expand_path('../lib', __FILE__)
+#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-sar"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Hirotaka Tajiri"]
+  spec.email         = ["ganryu_koziro@excite.co.jp"]
+  spec.homepage      = "https://github.com/hirotaka-tajiri/fluent-plugin-sar"
+  spec.description   = %q{Fluentd input plugin to get sar result}
+  spec.summary       = %q{Fluentd input plugin to get sar result}
+  spec.license       = "MIT"
+  spec.has_rdoc      = false
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{| f | File.basename(f)}
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fluentd', "~> 0.10"
+  spec.add_development_dependency "rake", ">0"
+  spec.add_development_dependency "rspec", ">0"
+end

data/lib/fluent/plugin/in_sar.rb

@@ -0,0 +1,60 @@
+class SarInput < Fluent::Input
+    Fluent::Plugin.register_input('sar', self)
+
+    config_param :sar_option,       :string,  default: ''
+    config_param :tag,              :string,  default: 'sar_result.tag'
+    config_param :interval,         :integer, default: 5
+    config_param :hostname_output,  :bool,    default: true 
+    config_param :hostname,         :string,  default: Socket.gethostname
+
+    def configure(conf)
+        super
+        @interval_m = @sar_option.split.size.zero? ? @interval * 60 : @interval * 60 - 1
+        begin
+           `sar -V`
+           raise Fluent::ConfigError, "sar_option contains illegal characters.(sar_option: #{@sar_option})" if /[^a-zA-Z ]+/ =~ @sar_option
+        rescue
+           raise Fluent::ConfigError, "sar(sysstat) is not installed."
+        end
+    end
+
+    def start
+        super
+        @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+        @thread.kill
+    end
+
+    private
+
+    def run
+        loop do
+            @result             = Hash.new
+            @result["hostname"] = @hostname if @hostname_output
+            Fluent::Engine.emit(@tag, Fluent::Engine.now, @result.merge(sar_execute(@sar_option.split)))
+            sleep @interval_m
+        end
+    end
+
+    def sar_execute(opt_ary)
+
+        rlt = Hash.new{| k, v | Hash[k] = Hash.new }
+        rec = Hash.new
+        th  = Array.new
+
+        opt_ary.each {| opt |
+            th << Thread.new {
+                i = 0
+                `LANG=C sar -#{opt} 1 1 | grep -vi average | tail -n2`.split("\n").each{| a | rlt[(i += 1)] = a.split }
+                rlt[1][0].sub!(/[0-9]{2}\:[0-9]{2}\:[0-9]{2}/, "check_time")
+                rec.merge!(Hash[*rlt[1].zip(rlt[2]).flatten])
+            }
+        }
+        th.each {| t | t.join }
+
+        rec
+    end
+end
+

data/spec/in_sar_spec.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+describe "SarInput" do
+
+    before { Fluent::Test.setup }
+
+    CONFIG = %[
+        type              sar
+        sar_option        u q r b w B R S v W
+        tag               sar.tag
+        interval          10
+        hostname_output   false
+        hostname          test_node
+    ]
+    CONF_D = %[
+        type sar
+        sar_option        u
+    ]
+    CNF_I1 = %[
+        type sar
+        sar_command_path  /usr/bin/sar
+        sar_option |
+    ]
+    CNF_I2 = %[
+        type sar
+        sar_command_path  /usr/bin/sar
+        sar_option |;
+    ]
+    CNF_I3 = %[
+        type sar
+        sar_command_path  /usr/bin/sar
+        sar_option a ;rm b
+    ]
+
+    def create_driver(conf)
+        Fluent::Test::InputTestDriver.new(SarInput).configure(conf)
+    end
+
+  describe "config test" do
+
+        let(:driver)  { Fluent::Test::InputTestDriver.new(SarInput).configure(CONFIG) }
+        let(:driver1) { Fluent::Test::InputTestDriver.new(SarInput).configure(CONF_D) }
+
+    context "Test config F " do
+        subject { driver.instance }
+        its (:sar_option)       { should eq "u q r b w B R S v W" }
+        its (:tag)              { should eq "sar.tag" }
+        its (:interval)         { should eq 10 }
+        its (:hostname_output)  { should eq false }
+        its (:hostname)         { should eq "test_node"}
+    end
+
+    context "Test config defalut " do
+        subject { driver1.instance }
+        its (:sar_option)       { should eq 'u' }
+        its (:tag)              { should eq 'sar_result.tag' }
+        its (:interval)         { should eq 5 }
+        its (:hostname_output)  { should eq true }
+        its (:hostname)         { should eq Socket.gethostname}
+    end
+
+    context "Test config raise error" do
+        it { expect(lambda{create_driver(CNF_I1)}).to raise_error(Fluent::ConfigError) }
+        it { expect(lambda{create_driver(CNF_I2)}).to raise_error(Fluent::ConfigError) }
+        it { expect(lambda{create_driver(CNF_I3)}).to raise_error(Fluent::ConfigError) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+ require 'rubygems'
+ require 'bundler'
+
+ require 'rspec'
+ require 'fluent/test'
+
+ Dir["./lib/**/*.rb"].each{| f | require f}

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sar
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Hirotaka Tajiri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: rspec
+  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'
+description: Fluentd input plugin to get sar result
+email:
+- ganryu_koziro@excite.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-sar.gemspec
+- lib/fluent/plugin/in_sar.rb
+- spec/in_sar_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hirotaka-tajiri/fluent-plugin-sar
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Fluentd input plugin to get sar result
+test_files:
+- spec/in_sar_spec.rb
+- spec/spec_helper.rb