fluent-plugin-mackerel 0.0.9 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjIwZThjMzJiNmNjNjE1ZGU1MWM3YWQwYzJmZjVkYmMzY2Y5MzdkNw==
+    ZDg3MGNjYjM5M2QwMzQzYmViODQ5YWZlZGI4OTY0ZDc0ZGI3MTVmMg==
   data.tar.gz: !binary |-
-    MjgxN2FjOGIwZWZjMmRjMWNkZDQ0MzJkMzc0N2U3ZGZhZjI3OTAzNw==
+    ZTNlZTYwZmNjODUyYTgxOTFjODEyYWVjOGY2NGY1OTkwMjg1YmQyMQ==
 SHA512:
   metadata.gz: !binary |-
-    ODAzNWZiYjc4MzU4ODM2NDJhZWY5M2M5MGU3MDU5Yzc3NGNiNmYyMzcyYzNj
-    N2FjZmY3NWYwZGIwZTMyYmQ4OTg1NGFmYWU2YzE1NzAxODYzMTJjNDI4MzM4
-    ZDlkNzBkNjc3NGZlYWIyZDVkMzQyZjIwMTk3N2U2NDQyZjlmYzI=
+    YjU4Yjk1NDEzMjIyZWJmYjEzMmExNDc1YjQ5NWJmZDU5NjU0OGViMDZjNzJm
+    NjYyZDJhOGNmOGNiNGU0NjI4MTY1Nzk4Mjk4YjRjNGI4YmZmNjM3MzA2OTc2
+    NjkwMWIwMmJkOWU1MTljYjUzOTFhNjVjZGYyZGE3OWI5NDQ2YTU=
   data.tar.gz: !binary |-
-    NjA1NzE2MmVlY2YyZmFmYzU4NmJhMGJkZTNiYjE3MjU2NDk3ZmJiZDBlOGI4
-    MmQzMDg3ZTBiOGRjNjI1ZDljMzY2YjFjZWFlNDAxNDVlNWVhOTdmMTNjODZj
-    NTU5YWI2YThlZTg2YTExZjVkNDY2ZWY1YTU2YzZhNDc0MGIwMzU=
+    N2EzZTFhNTIxNmI1YjA1ZmQ2MzgyMjExMDExMTEwZmQ1MDE4YzJhN2UyZjlk
+    NTFkYjViZmNiYzI0YWNmYzA2MzJlNjQ4ZGYxZjlhYzJkZTdjYzBjNWU3MmQ5
+    MWRhZjg2NTAzZjQ1ZGU5ZWZhZjA3Njg5NzBjYzY3NmJhMGQzMjY=

data/README.md

@@ -88,6 +88,21 @@ You can also send ["service" metric](http://help-ja.mackerel.io/entry/spec/api/v
   out_keys 2xx_count,3xx_count,4xx_count,5xx_count
 </match>
 ```
+
+When you send service metric, "custom" can be removed with `remove_prefix` as follows.
+This option is not availabe when sending host metric.
+
+```
+<match ...>
+  type mackerel
+  api_key 123456
+  service yourservice
+  remove_prefix
+  metrics_name http_status.${out_key}
+  out_keys 2xx_count,3xx_count,4xx_count,5xx_count
+</match>
+```
+
 `flush_interval` is not allowed to be set less than 60 secs not to send API requests more than once in a minute.
 
 This plugin overwrites the default value of `buffer_queue_limit` and `buffer_chunk_limit` as follows.

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.0.9"
+  spec.version       = "0.1.0"
   spec.authors       = ["tksmd","hatz48"]
   spec.email         = ["someda@isenshi.com"]
   spec.description   = %q{fluent plugin to send metrics to mackerel.io}

data/lib/fluent/plugin/out_mackerel.rb

@@ -8,6 +8,7 @@ module Fluent
     config_param :hostid, :string, :default => nil
     config_param :hostid_path, :string, :default => nil
     config_param :service, :string, :default => nil
+    config_param :remove_prefix, :bool, :default => false
     config_param :metrics_name, :string, :default => nil
     config_param :out_keys, :string, :default => nil
     config_param :out_key_pattern, :string, :default => nil
@@ -60,6 +61,10 @@ module Fluent
         raise Fluent::ConfigError, "Niether 'hostid' and 'service' cannot be specifed."
       end
 
+      if @remove_prefix and @service.nil?
+        raise Fluent::ConfigError, "'remove_prefix' must be used with 'service'."
+      end
+
       unless @hostid.nil?
         if matched = @hostid.match(/^\${tag_parts\[(\d+)\]}$/)
           hostid_idx = matched[1].to_i
@@ -115,7 +120,7 @@ module Fluent
           metric = {
             'value' => record[key].to_f,
             'time' => time,
-            'name' => "%s.%s" % ['custom', name]
+            'name' => @remove_prefix ? name : "%s.%s" % ['custom', name]
           }
           metric['hostId'] = @hostid_processor.call(:tokens => tokens) if @hostid
           metrics << metric

data/test/plugin/test_out_mackerel.rb

@@ -84,6 +84,28 @@ class MackerelOutputTest < Test::Unit::TestCase
     buffer_chunk_limit 1k
   ]
 
+  CONFIG_SERVICE = %[
+    type mackerel
+    api_key 123456
+    service xyz
+    out_keys val1,val2,val3
+  ]
+
+  CONFIG_SERVICE_REMOVE_PREFIX = %[
+    type mackerel
+    api_key 123456
+    service xyz
+    remove_prefix
+    out_keys val1,val2,val3
+  ]
+
+  CONFIG_INVALID_REMOVE_PREFIX = %[
+    type mackerel
+    api_key 123456
+    remove_prefix
+    out_keys val1,val2,val3
+  ]
+
   def create_driver(conf = CONFIG, tag='test')
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::MackerelOutput, tag).configure(conf)
   end
@@ -106,6 +128,10 @@ class MackerelOutputTest < Test::Unit::TestCase
       d = create_driver(CONFIG_NO_OUT_KEYS)
     }
 
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(CONFIG_INVALID_REMOVE_PREFIX)
+    }
+
     d = create_driver(CONFIG_SMALL_FLUSH_INTERVAL)
     assert_equal d.instance.instance_variable_get(:@flush_interval), 60
 
@@ -129,7 +155,8 @@ class MackerelOutputTest < Test::Unit::TestCase
 
     d = create_driver(CONFIG_BUFFER_LIMIT_IGNORE)
     assert_equal d.instance.instance_variable_get(:@buffer_chunk_limit), Fluent::MackerelOutput::MAX_BUFFER_CHUNK_LIMIT
-  end
+
+end
 
   def test_write
     d = create_driver()
@@ -172,6 +199,32 @@ class MackerelOutputTest < Test::Unit::TestCase
       {"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()
+  end
+
+  def test_service
+    d = create_driver(CONFIG_SERVICE)
+    mock(d.instance.mackerel).post_service_metrics('xyz', [
+      {"value"=>1.0, "time"=>1399997498, "name"=>"custom.val1"},
+      {"value"=>2.0, "time"=>1399997498, "name"=>"custom.val2"},
+    ])
+
+    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()
+  end
+
+  def test_service_remove_prefix
+    d = create_driver(CONFIG_SERVICE_REMOVE_PREFIX)
+    mock(d.instance.mackerel).post_service_metrics('xyz', [
+      {"value"=>1.0, "time"=>1399997498, "name"=>"val1"},
+      {"value"=>2.0, "time"=>1399997498, "name"=>"val2"},
+    ])
+
     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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mackerel
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - tksmd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mackerel-client