fluent-plugin-numeric-monitor 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9958f6c8175857684aa47425a26b7a334570e6a
-  data.tar.gz: 64f7c2b792cf2a14b62e4f120ece11e5f0aab977
+  metadata.gz: 1cf1eb4b47ac10ec80e86d04fd2f15e8d643df59
+  data.tar.gz: d1cd69d123dde29badd4c9bd6bcb930e7d19e37c
 SHA512:
-  metadata.gz: c9ea36335547a948cfd4f808224c4c55158ca350a9fc39f1a5c5135a1da19c5ded3f456440d3de21cdec05740e2c17ecb19f6efa39d8a6ac90d6d7cdccbefc4e
-  data.tar.gz: 030b305fc8bb4bcf9c504d683d33a1c5ca511e57c7fe97b86a276d2a5728c005119fe6c33db0f9db37e81c709a562755888bbe21a97310afc4c1c855c08f15dd
+  metadata.gz: d68ae1eb9aac126f0971b1ad341c1a66725774c2dc47b8b2c8475d22a94806b7366ef839aa06bd0c6eaf0f51b3118ec0c91356d05d4a988f5bbb608edae2b126
+  data.tar.gz: 388375635aaad65cbb10c26a68cd18085ca906e3f47841cd2244e52d0dcdddce249842d43ddcc930fd29c40dfc91bb1dd8d4b2078a60843e6f7c8e518076455e

data/fluent-plugin-numeric-monitor.gemspec

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-numeric-monitor"
-  gem.version       = "0.1.8"
+  gem.version       = "0.1.9"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{Fluentd plugin to calculate min/max/avg/Xpercentile values, and emit these data as message}
   gem.summary       = %q{Fluentd plugin to calculate min/max/avg/Xpercentile values}
   gem.homepage      = "https://github.com/tagomoris/fluent-plugin-numeric-monitor"
-  gem.license       = "APLv2"
+  gem.license       = "Apache-2.0"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/fluent/plugin/out_numeric_monitor.rb

@@ -8,7 +8,8 @@ class Fluent::NumericMonitorOutput < Fluent::Output
 
   EMIT_STREAM_RECORDS = 100
 
-  config_param :count_interval, :time, default: 60
+  config_param :count_interval, :time, default: 60,
+               desc: 'The interval time to monitor in seconds.'
   config_param :unit, default: nil do |value|
     case value
     when 'minute' then 60
@@ -18,11 +19,21 @@ class Fluent::NumericMonitorOutput < Fluent::Output
       raise Fluent::ConfigError, "unit must be one of minute/hour/day"
     end
   end
-  config_param :tag, :string, default: 'monitor'
-  config_param :tag_prefix, :string, default: nil
+  config_param :tag, :string, default: 'monitor',
+               desc: 'The output tag.'
+  config_param :tag_prefix, :string, default: nil,
+               desc: <<-DESC
+The prefix string which will be added to the input tag.
+output_per_tag yes must be specified together.
+DESC
 
-  config_param :output_per_tag, :bool, default: false
-  config_param :aggregate, default: 'tag' do |val|
+  config_param :output_per_tag, :bool, default: false,
+               desc: <<-DESC
+Emit for each input tag.
+tag_prefix must be specified together.
+DESC
+  config_param :aggregate, default: 'tag',
+               desc: 'Calculate in each input tag separetely, or all records in a mass.' do |val|
     case val
     when 'tag' then :tag
     when 'all' then :all
@@ -30,10 +41,15 @@ class Fluent::NumericMonitorOutput < Fluent::Output
       raise Fluent::ConfigError, "aggregate MUST be one of 'tag' or 'all'"
     end
   end
-  config_param :input_tag_remove_prefix, :string, default: nil
-  config_param :monitor_key, :string
-  config_param :output_key_prefix, :string, default: nil
-  config_param :percentiles, default: nil do |val|
+  config_param :input_tag_remove_prefix, :string, default: nil,
+               desc: 'The prefix string which will be removed from the input tag.'
+  config_param :monitor_key, :string,
+               desc: 'The key to monitor in the event record.'
+  config_param :output_key_prefix, :string, default: nil,
+               desc: 'The prefix string which will be added to the output key.'
+  config_param :percentiles, default: nil,
+               desc: 'Activate the percentile monitoring. ' \
+                     'Must be specified between 1 and 99 by integer separeted by , (comma).' do |val|
     values = val.split(",").map(&:to_i)
     if values.select{|i| i < 1 or i > 99 }.size > 0
       raise Fluent::ConfigError, "percentiles MUST be specified between 1 and 99 by integer"
@@ -41,7 +57,8 @@ class Fluent::NumericMonitorOutput < Fluent::Output
     values
   end
 
-  config_param :samples_limit, :integer, default: 1000000
+  config_param :samples_limit, :integer, default: 1000000,
+               desc: 'The limit number of sampling.'
   config_param :interval, :float, default: 0.5
 
   attr_accessor :count, :last_checked

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-numeric-monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,7 +74,7 @@ files:
 - test/plugin/test_out_numeric_monitor.rb
 homepage: https://github.com/tagomoris/fluent-plugin-numeric-monitor
 licenses:
-- APLv2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []