fluent-plugin-factor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d09ab6ecb1a70333ffa855c88600fc1a010291
+  data.tar.gz: dd54b28f7eab3d95a47bb78d5889f2c1d501618e
+SHA512:
+  metadata.gz: 1a971e0b8c5811fcaee5bfea3eeca9b3ba39c3e9ca4603201184e253614d7986e300eefa8ee1f7ba970b844cfc7553bdf0864b1ca37434e6f8e444339bec0918
+  data.tar.gz: 48acc468e1a900598ad4efa01b5515cd8ab9e565390ee53760b3de7272a6a5a25cb04ef08a7b1a50d725b55e6f017e847881bb2f97d757cf69ba34a6d90522fc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 eramuk
+
+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,116 @@
+# fluent-plugin-factor
+
+## Requirements
+
+| fluent-plugin-factor | fluentd    |
+|----------------------|------------|
+| >= 1.0.0             | >= v0.14.0 |
+| <  1.0.0             | <  v0.14.0 |
+
+## Installation
+```
+gem install fluent-plugin-factor
+```
+
+## Usage
+Example:
+```
+<source>
+  @type factor
+  tag factor
+  run_at_start
+  run_interval 1h
+</source>
+```
+
+output as follows every hour:
+```
+factor: {
+  "hostname": "test-machine",
+  "operatingsystem": {
+    "name": "CentOS",
+    "version": "6.8",
+    "family": "RedHat"
+  },
+  "kernel": {
+    "name": "Linux",
+    "release": "2.6.32-642.11.1.el6.x86_64"
+  },
+  "processors": {
+    "models": [
+      "Intel(R) Xeon(R) CPU           X5650  @ 2.67GHz",
+      "Intel(R) Xeon(R) CPU           X5650  @ 2.67GHz"
+    ],
+    "count": 2,
+    "physicalcount": 1
+  },
+  "memory": {
+    "size": "995.95"
+  },
+  "volumes": [
+    {
+      "name": "sda",
+      "size": 10
+    }
+  ],
+  "interfaces": [
+    {
+      "name": "eth0",
+      "ipaddress": "10.8.0.201",
+      "netmask": "255.255.252.0",
+      "macaddress": "00:0C:29:C5:26:8A"
+    }
+  ],
+  "is_virtual": true
+}
+```
+
+## Configuration
+
+### tag (required)
+The tag of the event.
+
+### run_interval
+The gathering interval. If enable this option, the gathering function is not execute when starting fluentd. If you want, enable  `run_at_start` option.
+
+### run_at_start
+If set to true, gathering at start fluentd.
+
+### run_at_shutdown
+If set to true, gathering at shutdown fluentd.
+
+### \<factors\>
+If you want to gather only specific factor, you can use `<factors>` section.
+```
+<source>
+  @type factor
+  tag factor
+  <factors>
+    memory true
+    volumes true
+  </factors>
+</source>
+```
+In this case, the output is only memory and volumes.
+```
+factor: {
+  "memory": {
+    "size": "995.95"
+  },
+  "volumes": [
+    {
+      "name": "sda",
+      "size": 10
+    }
+  ]
+}
+```
+The available keys as follows:
+- hostname
+- operatingsystem
+- kernel
+- processors
+- memory
+- volumes
+- interfaces
+- is_virtual

data/Rakefile

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

data/fluent-plugin-factor.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-factor"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Yuki Kuwabara"]
+  gem.email         = ["eramuk@gmail.com"]
+  gem.summary       = "input plugin for gathering factor"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/eramuk/fluent-plugin-factor"
+  gem.licenses      = ["MIT"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "fluentd", "~> 0.12.0"
+  gem.add_runtime_dependency "facter", "~> 2.4", ">= 2.4.6"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/in_factor.rb

@@ -0,0 +1,166 @@
+require "fluent/input"
+require "fluent/time"
+require "fluent/timezone"
+require "fluent/config/error"
+require "facter"
+require "json"
+
+module Fluent
+  class FactorInput < Input
+    Plugin.register_input('factor', self)
+
+    config_param :tag, :string
+    config_param :run_interval, :time, default: nil
+    config_param :run_at_start, :bool, default: nil
+    config_param :run_at_shutdown, :bool, default: nil
+    config_section :factors, multi: false do
+      config_param :hostname, :bool, default: false
+      config_param :operatingsystem, :bool, default: false
+      config_param :kernel, :bool, default: false
+      config_param :processors, :bool, default: false
+      config_param :memory, :bool, default: false
+      config_param :volumes, :bool, default: false
+      config_param :interfaces, :bool, default: false
+      config_param :is_virtual, :bool, default: false
+    end
+
+    def configure(conf)
+      super
+
+      if !@run_interval && @run_at_start
+        raise ConfigError, "'run_at_start' option needs 'run_interval' option"
+      end
+
+      factor_keys = [
+        "hostname",
+        "operatingsystem",
+        "kernel",
+        "processors",
+        "memory",
+        "volumes",
+        "interfaces",
+        "is_virtual",
+      ]
+
+      @factors = @factors.to_h
+
+      if @factors.empty?
+        factor_keys.each do |key|
+          @factors[key] = true
+        end
+      end
+
+      if @factors.select { |k,v| v == true }.empty?
+        raise ConfigError, "one or more factor are required"
+      end
+    end
+
+    def start
+      super
+      if @run_interval
+        @finished = false
+        @thread = Thread.new(&method(:run_periodic))
+      else
+        @thread = Thread.new(&method(:run))
+      end
+    end
+
+    def before_shutdown
+      super
+      gather_factor if @run_at_shutdown
+    end
+
+    def shutdown
+      super
+      @thread.terminate
+      @thread.join
+    end
+
+    def run
+      gather_factor
+    end
+
+    def run_periodic
+      gather_factor if @run_at_start
+      while true
+        sleep @run_interval
+        gather_factor
+      end
+    end
+
+    def gather_factor
+      begin
+        record = {}
+        @factors.each do |factor, enabled|
+          record[factor] = send(factor) if enabled
+        end
+        router.emit(@tag, Engine.now, record)
+      rescue => e
+        router.emit_error_event(@tag, Engine.now, record, e)
+      end
+    end
+
+    def hostname
+      Facter.value(:hostname)
+    end
+
+    def operatingsystem
+      {
+        "name" => Facter.value(:operatingsystem),
+        "version" => Facter.value(:operatingsystemrelease),
+        "family" => Facter.value(:osfamily),
+      }
+    end
+
+    def kernel
+      {
+        "name" => Facter.value(:kernel),
+        "release" => Facter.value(:kernelrelease),
+      }
+    end
+
+    def processors
+      Facter.value(:processors)
+    end
+
+    def memory
+      {
+        "size" => Facter.value(:memorysize_mb )
+      }
+    end
+
+    def volumes
+      volumes = []
+      blockdevice_names = Facter.value(:blockdevices).split(/,/)
+      blockdevice_names.each do |device_name|
+        next if device_name !~ /(hd.*|sd.*|md.*)/
+        volumes.push({
+          "name" => device_name,
+          "size" => Facter.value("blockdevice_#{device_name}_size") / 1024 / 1024 / 1024,
+        })
+      end
+      volumes
+    end
+
+    def interfaces
+      interfaces = []
+      interface_names = Facter.value(:interfaces).split(/,/)
+      if interface_names
+        interface_names.each do |if_name|
+          next if if_name == "lo"
+          interfaces.push({
+            "name" => if_name,
+            "ipaddress" => Facter.value("ipaddress_#{if_name}"),
+            "netmask" => Facter.value("netmask_#{if_name}"),
+            "macaddress" => Facter.value("macaddress_#{if_name}"),
+          })
+        end
+      end
+      interfaces
+    end
+
+    def is_virtual
+      Facter.value(:is_virtual)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/in_factor'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_factor.rb

@@ -0,0 +1,21 @@
+require "helper"
+
+class FactorInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %{
+    tag test
+  }
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::InputTestDriver.new(Fluent::FactorInput).configure(conf)
+  end
+
+  def test_emit
+    d = create_driver
+    d.run
+    p d.emits
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-factor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuki Kuwabara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-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.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: facter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.6
+- !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: test-unit
+  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: input plugin for gathering factor
+email:
+- eramuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-factor.gemspec
+- lib/fluent/plugin/in_factor.rb
+- test/helper.rb
+- test/plugin/test_in_factor.rb
+homepage: https://github.com/eramuk/fluent-plugin-factor
+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.5
+signing_key: 
+specification_version: 4
+summary: input plugin for gathering factor
+test_files:
+- test/helper.rb
+- test/plugin/test_in_factor.rb