fluent-plugin-mackerel 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTA0MzM4MTQ2MTk3OTM4ZTUxNzA3YTBiYmFjOGNiZmY2NjI1MDc4MQ==
+  data.tar.gz: !binary |-
+    NTE3NDRiNDM3MzQ5YTA4MGEzOTIwMmY1NTE1NGE5NzJhOGExNWJjYw==
+SHA512:
+  metadata.gz: !binary |-
+    YmQxN2IyZGY0OGEzODJmMzYzYTgyNzM1MzI3OGI1ZTBiNmRjMGQ4MTY4OGNm
+    N2U0MzE4MjZmMjM2OTJmNzM3MDBiNTAyZDIwYzdiNzJlYzg2OGQzN2NiNTNk
+    ZTZmYjEwMTI5Njk0ZGU3NGZhNmFkN2NhYzYyNGFiNmYzMzEzMDQ=
+  data.tar.gz: !binary |-
+    ODRhN2I4YzhjMmQxMmFjZWFjNTg4NjMzNmViNDQ0N2QwYTNhNTBkNjhkOWUw
+    MmEwZjRiMTJjN2QwMDU4ZWYwYmM0NWQ4Y2Y3NjE4ZTQ0M2ZiM2Y2MGU4MTFl
+    Yjg1NDc0MThkNzQxYzJiM2RjNjQ2YTZlOTI3ODdlOTY3YTEyY2E=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014- SOMEDA Takashi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,69 @@
+# fluent-plugin-mackerel
+
+## Overview
+
+[Fluentd](http://fluentd.org) plugin to send metrics to [mackerel](http://mackerel.io/).
+
+## Installation
+
+Install with gem or fluent-gem command as:
+
+```
+# for fluentd
+$ gem install fluent-plugin-typetalk
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-typetalk
+```
+
+## Configuration
+
+### Usage
+
+This plugin uses [APIv0](http://help-ja.mackerel.io/entry/spec/api/v0) of mackerel.io.
+```
+<match ...>
+  type mackerel
+  api_key 123456
+  hostid xyz
+  metrics_prefix http_status
+  out_keys 2xx_count,3xx_count,4xx_count,5xx_count
+</match>
+```
+
+Then the sent metric data will look like this:
+```
+{
+  "hostId": "xyz",
+  "name": "http_status.2xx_count",
+  "time": 1399997498,
+  "value": 100.0
+}
+```
+As shown above, metric name will be a concatenation of metrics_prefix and out_keys values.
+
+## TODO
+
+Pull requests are very welcome!!
+
+## For developers
+
+You have to run the command below when starting development.
+```
+$ bundle install --path vendor/bundle
+```
+
+To run tests, do the following.
+```
+$ VERBOSE=1 bundle exec rake test
+```
+
+When releasing, call rake release as follows.
+```
+$ bundle exec rake release
+```
+
+## Copyright
+
+* Copyright (c) 2014- Takashi Someda ([@tksmd](http://twitter.com/tksmd/))
+* Apache License, Version 2.0

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
+end
+
+task :default => :test

data/fluent-plugin-mackerel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-mackerel"
+  spec.version       = "0.0.1"
+  spec.authors       = ["tksmd"]
+  spec.email         = ["someda@isenshi.com"]
+  spec.description   = %q{fluent plugin to send metrics to mackerel.io}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/tksmd/fluent-plugin-mackerel"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rr", ">= 1.0.0"
+  spec.add_runtime_dependency "fluentd"
+
+  spec.required_ruby_version = '>= 1.9.3'
+end

data/lib/fluent/plugin/out_mackerel.rb

@@ -0,0 +1,109 @@
+module Fluent
+  class MackerelOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('mackerel', self)
+
+    config_param :api_key, :string
+    config_param :hostid, :string, :default => nil
+    config_param :hostid_path, :string, :default => nil
+    config_param :metrics_prefix, :string
+    config_param :out_keys, :string
+
+    config_param :flush_interval, :time, :default => 1
+
+    attr_reader :mackerel
+
+    # Define `log` method for v0.10.42 or earlier
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      super
+
+      @mackerel = Mackerel.new(conf['api_key'])
+      @out_keys = @out_keys.split(',')
+
+      if @hostid.nil? and @hostid_path.nil?
+        raise Fluent::ConfigError, "Either 'hostid' or 'hostid_path' must be specifed."
+      end
+
+      unless @hostid_path.nil?
+        @hostid = File.open(@hostid_path).read
+      end
+
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      metrics = []
+      chunk.msgpack_each do |(tag,time,record)|
+        out_keys.map do |key|
+          metrics << {
+            'hostId' => @hostid,
+            'value' => record[key].to_f,
+            'time' => time,
+            'name' => "%s.%s" % [@metrics_prefix, key]
+          }
+        end
+      end
+
+      begin
+        @mackerel.post_metrics(metrics)
+      rescue => e
+        log.error("out_mackerel:", :error_class => e.class, :error => e.message)
+      end
+    end
+
+  end
+
+  class Mackerel
+
+    USER_AGENT = "fluent-plugin-mackerel Ruby/#{RUBY_VERSION}"
+
+    def initialize(api_key)
+      require 'net/http'
+      require 'json'
+
+      @api_key = api_key
+      @http = Net::HTTP.new('mackerel.io', 443)
+      @http.use_ssl = true
+    end
+
+    def post_metrics(metrics)
+      req = Net::HTTP::Post.new('/api/v0/tsdb', initheader = {
+        'X-Api-Key' => @api_key,
+        'Content-Type' =>'application/json',
+        'User-Agent' => USER_AGENT
+      })
+      req.body = metrics.to_json
+      res = @http.request(req)
+
+      if res.is_a?(Net::HTTPUnauthorized)
+        raise MackerelError, "invalid api key used. check api_key in your configuration."
+      end
+
+      unless res and res.is_a?(Net::HTTPSuccess)
+        raise MackerelError, "failed to post, code: #{res.code}"
+      end
+    end
+
+  end
+
+  class MackerelError < RuntimeError; end
+
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+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'
+require 'rr'
+
+$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/out_mackerel'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mackerel.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+class MackerelOutputTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type mackerel
+    api_key 123456
+    hostid xyz
+    metrics_prefix service
+    out_keys val1,val2,val3
+  ]
+
+  CONFIG_NOHOST = %[
+    type mackerel
+    api_key 123456
+    metrics_prefix service
+    out_keys val1,val2,val3
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MackerelOutput, tag).configure(conf)
+  end
+
+  def test_configure
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(CONFIG_NOHOST)
+    }
+
+    d = create_driver()
+    assert_equal d.instance.instance_variable_get(:@api_key), '123456'
+    assert_equal d.instance.instance_variable_get(:@hostid), 'xyz'
+    assert_equal d.instance.instance_variable_get(:@metrics_prefix), 'service'
+    assert_equal d.instance.instance_variable_get(:@out_keys), ['val1','val2','val3']
+  end
+
+  def test_write
+    d = create_driver()
+    stub(d.instance.mackerel).post_metrics([
+      {"hostId"=>"xyz", "value"=>1.0, "time"=>1399997498, "name"=>"service.val1"},
+      {"hostId"=>"xyz", "value"=>2.0, "time"=>1399997498, "name"=>"service.val2"},
+      {"hostId"=>"xyz", "value"=>3.0, "time"=>1399997498, "name"=>"service.val3"},
+      {"hostId"=>"xyz", "value"=>5.0, "time"=>1399997498, "name"=>"service.val1"},
+      {"hostId"=>"xyz", "value"=>6.0, "time"=>1399997498, "name"=>"service.val2"},
+      {"hostId"=>"xyz", "value"=>7.0, "time"=>1399997498, "name"=>"service.val3"},
+    ])
+
+    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.run()
+  end
+
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mackerel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tksmd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluent plugin to send metrics to mackerel.io
+email:
+- someda@isenshi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-mackerel.gemspec
+- lib/fluent/plugin/out_mackerel.rb
+- test/helper.rb
+- test/plugin/test_out_mackerel.rb
+homepage: https://github.com/tksmd/fluent-plugin-mackerel
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: fluent plugin to send metrics to mackerel.io
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mackerel.rb