fluent-plugin-mackerel 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a02664ca113a287a4b0168e01ffbe73cf0cf1dc
-  data.tar.gz: bf339f5f4dd9c5a5b8f45556dda7ba70fb0b6df8
+  metadata.gz: bb25b1bebca00458ef188707294fe348300e118d
+  data.tar.gz: 13f96b2fb493d0dfa870f602abef8f3bbd8b50bc
 SHA512:
-  metadata.gz: ec37b759c0234771d0d2cc89b48be35202e13d746da9bfed086795a5ce7579b290d9699e1cdb5ef092bec2f5a108b11299e4abdf85685d2a5e167fb9f2972f0f
-  data.tar.gz: 86dfe07a76ceaec0f37075aa2b60fb4cb6eb2d0a4aa358c454d54804a727172dd4c7387c2da53bb6fbe274d663fd6a21b1ba3f8736fdd81d79f6f980a8ac5a4f
+  metadata.gz: bd13a7e12775ab9808e23bb7dfdc2952c60be1be738f9369dd8a03177bf3609c36a45628ac624a1f08b99ce35c7ac6d8247d829e093b7de7468cc0633dc3128a
+  data.tar.gz: 556685cba190b6afbf59566941bbd796959bd3803fbe5d0fd9befc12a8e50cf72ed93c3f802a4732a8611b6b09c1d9d34e412ada9b2f717e14582d159784a3fe

data/.travis.yml

@@ -1,3 +1,6 @@
+sudo: false
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.1
+  - 2.2
+  - 2.3.0

data/README.md

@@ -22,10 +22,10 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mackerel
 
 ### MackerelOutput
 
-This plugin uses mackerel.io's [APIv0](http://help-ja.mackerel.io/entry/spec/api/v0).
+This plugin uses mackerel.io's [APIv0](https://mackerel.io/api-docs/).
 ```
 <match ...>
-  type mackerel
+  @type mackerel
   api_key 123456
   hostid xyz
   metrics_name http_status.${out_key}
@@ -52,7 +52,7 @@ For example, if you have set `out_keys 2xx_count,3xx_count,4xx_count,5xx_count`,
 
 ```
 <match ...>
-  type mackerel
+  @type mackerel
   api_key 123456
   service yourservice
   metrics_name http_status.${out_key}
@@ -63,7 +63,7 @@ For example, if you have set `out_keys 2xx_count,3xx_count,4xx_count,5xx_count`,
 
 ```
 <match mackerel.*>
-  type mackerel
+  @type mackerel
   api_key 123456
   hostid xyz
   metrics_name ${[1]}.${out_key}
@@ -85,7 +85,7 @@ This indicates the value of the `n` th index of the array. By splitting the tag
 You can also send [service metrics](http://help.mackerel.io/entry/spec/api/v0#service-metric-value-post) as shown.
 ```
 <match ...>
-  type mackerel
+  @type mackerel
   api_key 123456
   service yourservice
   metrics_name http_status.${out_key}
@@ -98,7 +98,7 @@ This option is not availabe when sending host metrics.
 
 ```
 <match ...>
-  type mackerel
+  @type mackerel
   api_key 123456
   service yourservice
   remove_prefix
@@ -123,7 +123,7 @@ From version 0.0.4 and on, metrics_prefix has been removed and metrics_name shou
 Let's say you want to add the hostid to the record with a specific key name...
 ```
 <match ...>
-  type mackerel_hostid_tag
+  @type mackerel_hostid_tag
   add_to record
   key_name mackerel_hostid
 </match>
@@ -133,12 +133,14 @@ As shown above, the key_name field is required. For example if the host_id is "x
 To append the hostid to the tag, you can simply configure "add_to" as "tag" like this.
 ```
 <match ...>
-  type mackerel_hostid_tag
+  @type mackerel_hostid_tag
   add_to tag
 </match>
 ```
 If the input is `["test", 1407650400, {"val1"=>1, "val2"=>2, "val3"=>3, "val4"=>4}]`, then the output will be `["test.xyz", 1407650400, {"val1"=>1, "val2"=>2, "val3"=>3, "val4"=>4}]`
 
+Both `add_prefix` and `remove_prefix` options are availale to control rebuilding tags.
+
 ## TODO
 
 Pull requests are very welcome!!
@@ -173,7 +175,7 @@ $ bundle exec rake release
 For debugging purposes, you can change the Mackerel endpoint with an `origin` parameter like this.
 ```
 <match ...>
-  type mackerel
+  @type mackerel
   api_key 123456
   hostid xyz
   metrics_name http_status.${out_key}

data/fluent-plugin-mackerel.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mackerel"
-  spec.version       = "0.1.3"
+  spec.version       = "1.0.0"
   spec.authors       = ["tksmd","hatz48","stanaka","Songmu"]
   spec.email         = ["developers@mackerel.io"]
   spec.description   = %q{fluent plugin to send metrics to mackerel.io}
@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rr", ">= 1.0.0"
   spec.add_development_dependency "test-unit"
-  spec.add_runtime_dependency "fluentd"
+  spec.add_development_dependency "test-unit-rr"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.8", "< 2"]
 
   spec.required_ruby_version = '>= 1.9.3'
 end

data/lib/fluent/plugin/out_mackerel.rb

@@ -1,9 +1,13 @@
 require 'mackerel/client'
 
-module Fluent
-  class MackerelOutput < Fluent::BufferedOutput
+module Fluent::Plugin
+  class MackerelOutput < Output
     Fluent::Plugin.register_output('mackerel', self)
 
+    helpers :compat_parameters
+
+    DEFAULT_FLUSH_INTERVAL = 60
+
     config_param :api_key, :string, :secret => true
     config_param :hostid, :string, :default => nil
     config_param :hostid_path, :string, :default => nil
@@ -18,6 +22,10 @@ module Fluent
     MAX_BUFFER_CHUNK_LIMIT = 100 * 1024
     config_set_default :buffer_chunk_limit, MAX_BUFFER_CHUNK_LIMIT
     config_set_default :buffer_queue_limit, 4096
+    config_section :buffer do
+      config_set_default :@type, 'memory'
+      config_set_default :flush_interval, DEFAULT_FLUSH_INTERVAL
+    end
 
     attr_reader :mackerel
 
@@ -31,6 +39,7 @@ module Fluent
     end
 
     def configure(conf)
+      compat_parameters_convert(conf, :buffer)
       super
 
       @mackerel = Mackerel::Client.new(:mackerel_api_key => conf['api_key'], :mackerel_origin => conf['origin'])
@@ -45,9 +54,8 @@ module Fluent
         raise Fluent::ConfigError, "Either 'out_keys' or 'out_key_pattern' must be specifed."
       end
 
-      if @flush_interval < 60
-        log.info("flush_interval less than 60s is not allowed and overwritten to 60s")
-        @flush_interval = 60
+      if @buffer_config.flush_interval and @buffer_config.flush_interval < 60
+        raise Fluent::ConfigError, "flush_interval less than 60s is not allowed."
       end
 
       unless @hostid_path.nil?
@@ -98,6 +106,10 @@ module Fluent
       super
     end
 
+    def formatted_to_msgpack_binary
+      true
+    end
+
     def format(tag, time, record)
       [tag, time, record].to_msgpack
     end

data/test/helper.rb

@@ -8,7 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'test/unit'
-require 'rr'
+require 'test/unit/rr'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -23,8 +23,10 @@ unless ENV.has_key?('VERBOSE')
   $log = nulllogger
 end
 
+require 'test/unit/rr'
+require 'fluent/test/driver/output'
 require 'fluent/plugin/out_mackerel'
 require 'fluent/plugin/out_mackerel_hostid_tag'
 
 class Test::Unit::TestCase
-end
+end

data/test/plugin/test_out_mackerel.rb

@@ -88,7 +88,7 @@ class MackerelOutputTest < Test::Unit::TestCase
     type mackerel
     api_key 123456
     service xyz
-    out_keys val1,val2,val3
+    out_keys val1,val2
   ]
 
   CONFIG_SERVICE_REMOVE_PREFIX = %[
@@ -96,7 +96,7 @@ class MackerelOutputTest < Test::Unit::TestCase
     api_key 123456
     service xyz
     remove_prefix
-    out_keys val1,val2,val3
+    out_keys val1,val2
   ]
 
   CONFIG_INVALID_REMOVE_PREFIX = %[
@@ -114,8 +114,8 @@ class MackerelOutputTest < Test::Unit::TestCase
     out_keys val1,val2,val3
   ]
 
-  def create_driver(conf = CONFIG, tag='test')
-    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MackerelOutput, tag).configure(conf)
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::MackerelOutput).configure(conf)
   end
 
   def test_configure
@@ -140,8 +140,9 @@ class MackerelOutputTest < Test::Unit::TestCase
       d = create_driver(CONFIG_INVALID_REMOVE_PREFIX)
     }
 
-    d = create_driver(CONFIG_SMALL_FLUSH_INTERVAL)
-    assert_equal d.instance.instance_variable_get(:@flush_interval), 60
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(CONFIG_SMALL_FLUSH_INTERVAL)
+    }
 
     d = create_driver(CONFIG_ORIGIN)
     assert_equal d.instance.instance_variable_get(:@origin), 'example.domain'
@@ -151,18 +152,19 @@ class MackerelOutputTest < Test::Unit::TestCase
     assert_equal d.instance.instance_variable_get(:@hostid), 'xyz'
     assert_equal d.instance.instance_variable_get(:@metrics_name), 'service.${out_key}'
     assert_equal d.instance.instance_variable_get(:@out_keys), ['val1','val2','val3']
-    assert_equal d.instance.instance_variable_get(:@flush_interval), 60
+    buffer = d.instance.instance_variable_get(:@buffer_config)
+    assert_equal buffer.flush_interval, 60
 
     d = create_driver(CONFIG_OUT_KEY_PATTERN)
     assert_match d.instance.instance_variable_get(:@out_key_pattern), "val1"
     assert_no_match d.instance.instance_variable_get(:@out_key_pattern), "foo"
 
     d = create_driver(CONFIG_BUFFER_LIMIT_DEFAULT)
-    assert_equal d.instance.instance_variable_get(:@buffer_chunk_limit), Fluent::MackerelOutput::MAX_BUFFER_CHUNK_LIMIT
+    assert_equal d.instance.instance_variable_get(:@buffer_chunk_limit), Fluent::Plugin::MackerelOutput::MAX_BUFFER_CHUNK_LIMIT
     assert_equal d.instance.instance_variable_get(:@buffer_queue_limit), 4096
 
     d = create_driver(CONFIG_BUFFER_LIMIT_IGNORE)
-    assert_equal d.instance.instance_variable_get(:@buffer_chunk_limit), Fluent::MackerelOutput::MAX_BUFFER_CHUNK_LIMIT
+    assert_equal d.instance.instance_variable_get(:@buffer_chunk_limit), Fluent::Plugin::MackerelOutput::MAX_BUFFER_CHUNK_LIMIT
 
 end
 
@@ -180,11 +182,12 @@ end
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2, 'val3' => 3, 'val4' => 4}, t)
-    d.emit({'val1' => 5, 'val2' => 6, 'val3' => 7, 'val4' => 8}, t)
-    d.emit({'val1' => 9, 'val2' => 10}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test') do
+      d.feed(t, {'val1' => 1, 'val2' => 2, 'val3' => 3, 'val4' => 4})
+      d.feed(t, {'val1' => 5, 'val2' => 6, 'val3' => 7, 'val4' => 8})
+      d.feed(t, {'val1' => 9, 'val2' => 10})
+    end
   end
 
   def test_write_pattern
@@ -195,22 +198,24 @@ end
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2, 'foo' => 3}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test') do
+      d.feed(t, {'val1' => 1, 'val2' => 2, 'foo' => 3})
+    end
   end
 
   def test_write_issue4
-    d = create_driver(CONFIG_FOR_ISSUE_4, tag='test.status')
+    d = create_driver(CONFIG_FOR_ISSUE_4)
     mock(d.instance.mackerel).post_metrics([
       {"hostId"=>"xyz", "value"=>1.0, "time"=>1399997498, "name"=>"custom.a-status-b.val1"},
       {"hostId"=>"xyz", "value"=>2.0, "time"=>1399997498, "name"=>"custom.a-status-b.val2"},
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test.status') do
+      d.feed(t, {'val1' => 1, 'val2' => 2})
+    end
   end
 
   def test_service
@@ -221,9 +226,10 @@ end
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2, 'foo' => 3}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test') do
+      d.feed(t, {'val1' => 1, 'val2' => 2, 'foo' => 3})
+    end
   end
 
   def test_service_remove_prefix
@@ -234,9 +240,10 @@ end
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2, 'foo' => 3}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test') do
+      d.feed(t, {'val1' => 1, 'val2' => 2, 'foo' => 3})
+    end
   end
 
   def test_service_use_zero
@@ -248,9 +255,10 @@ end
     ])
 
     ENV["TZ"]="Asia/Tokyo"
-    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T')
-    d.emit({'val1' => 1, 'val2' => 2, 'foo' => 3}, t)
-    d.run()
+    t = Time.strptime('2014-05-14 01:11:38', '%Y-%m-%d %T').to_i
+    d.run(default_tag: 'test') do
+      d.feed(t, {'val1' => 1, 'val2' => 2, 'foo' => 3})
+    end
   end
 
   def test_name_processor
@@ -281,7 +289,7 @@ end
         metrics_name #{obj[:metrics_name]}
         out_keys val1,val2
       ]
-      d = create_driver(test_config, tag='test.status')
+      d = create_driver(test_config)
       name_processor = d.instance.instance_variable_get(:@name_processor)
       actual = name_processor.map{ |p| p.call(:out_key => 'val1', :tokens => ['test', 'status']) }.join('.')
       assert_equal obj[:expected], actual

data/test/plugin/test_out_mackerel_hostid_tag.rb

@@ -101,7 +101,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 2, emits.length
     assert_equal 'test.xyz', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 4, emits[0][2].length # record
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record
@@ -109,7 +109,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     assert_equal 4, emits[0][2]["val4"] # record
 
     assert_equal 'test.xyz', emits[1][0] # tag
-    assert_equal 1407650400, emits[1][1] # time
+    assert_equal 1407650400, emits[1][1].to_i # time
     assert_equal 4, emits[1][2].length # record
     assert_equal 5, emits[1][2]["val1"] # record
     assert_equal 6, emits[1][2]["val2"] # record
@@ -131,7 +131,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 2, emits.length
     assert_equal 'test', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 5, emits[0][2].length # record length
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record
@@ -140,7 +140,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     assert_equal "xyz", emits[0][2]["mackerel_hostid"] # record
 
     assert_equal 'test', emits[1][0] # tag
-    assert_equal 1407650400, emits[1][1] # time
+    assert_equal 1407650400, emits[1][1].to_i # time
     assert_equal 5, emits[1][2].length # record length
     assert_equal 5, emits[1][2]["val1"] # record
     assert_equal 6, emits[1][2]["val2"] # record
@@ -162,7 +162,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 1, emits.length
     assert_equal 'service', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 5, emits[0][2].length # record length
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record
@@ -185,7 +185,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 1, emits.length
     assert_equal 'mackerel.test', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 5, emits[0][2].length # record length
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record
@@ -208,7 +208,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 1, emits.length
     assert_equal 'mackerel.service', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 5, emits[0][2].length # record length
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record
@@ -231,7 +231,7 @@ class MackerelHostidTagOutputTest < Test::Unit::TestCase
     emits = d.emits
     assert_equal 1, emits.length
     assert_equal 'mackerel.service.xyz', emits[0][0] # tag
-    assert_equal 1407650400, emits[0][1] # time
+    assert_equal 1407650400, emits[0][1].to_i # time
     assert_equal 4, emits[0][2].length # record length
     assert_equal 1, emits[0][2]["val1"] # record
     assert_equal 2, emits[0][2]["val2"] # record

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mackerel
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - tksmd
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mackerel-client
@@ -56,21 +56,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: test-unit-rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,14 +89,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: fluent plugin to send metrics to mackerel.io
 email:
 - developers@mackerel.io