fluent-plugin-ikachan 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TAGOMORI Satoshi
+
+MIT License
+
+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,50 @@
+# fluent-plugin-ikachan
+
+## Component
+
+### IkachanOutput
+
+Plugin to send message to IRC, over IRC-HTTP bridge 'Ikachan' by yappo.
+
+About Ikachan:
+ * https://metacpan.org/module/ikachan
+ * http://blog.yappo.jp/yappo/archives/000760.html (Japanese)
+
+## Configuration
+
+### IkachanOutput
+
+Before testing of fluent-plugin-ikachan, you should invoke 'ikachan' process::
+
+    ### at first, install perl and cpanm (App::cpanminus)
+    cpanm App::ikachan
+    ikachan -S your.own.irc.server -P port
+
+And then, configure out_ikachan::
+
+    <match alert.**>
+      # ikachan host/port(default 4979)
+      host localhost
+      port 4979
+      # channel to notify (this means #morischan)
+      channel morischan
+      message notice: %s [%s] %s
+      out_keys tag,time,msg
+      time_key time
+      time_format %Y/%m/%d %H:%M:%S
+      tag_key tag
+    </match>
+    
+You will got message like 'notice: alert.servicename [2012/05/10 18:51:59] alert message in attribute "msg"'.
+
+## TODO
+
+* implement 'tag_mapped'
+* implement 'time' and 'tag' in key_names
+
+## Copyright
+
+* Copyright
+  * Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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-ikachan.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-ikachan"
+  gem.version       = "0.1.0"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.summary       = %q{output plugin for IRC-HTTP gateway 'ikachan'}
+  gem.description   = %q{output plugin for IRC-HTTP gateway 'ikachan' (see: https://metacpan.org/module/ikachan and (jpn) http://blog.yappo.jp/yappo/archives/000760.html)}
+  gem.homepage      = "https://github.com/tagomoris/fluent-plugin-ikachan"
+
+  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_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_ikachan.rb

@@ -0,0 +1,92 @@
+class Fluent::IkachanOutput < Fluent::Output
+  Fluent::Plugin.register_output('ikachan', self)
+
+  config_param :host, :string
+  config_param :port, :integer, :default => 4979
+  config_param :channel, :string
+  config_param :message, :string
+  config_param :out_keys, :string
+  config_param :time_key, :string, :default => nil
+  config_param :time_format, :string, :default => nil
+  config_param :tag_key, :string, :default => 'tag'
+
+  def initialize
+    super
+    require 'net/http'
+    require 'uri'
+  end
+
+  def configure(conf)
+    super
+
+    @channel = '#' + @channel
+    @join_uri = URI.parse "http://#{@host}:#{@port}/join"
+    @notice_uri = URI.parse "http://#{@host}:#{@port}/notice"
+
+    @out_keys = conf['out_keys'].split(',')
+
+    begin
+      @message % (['1'] * @out_keys.length)
+    rescue ArgumentError
+      raise Fluent::ConfigError, "string specifier '%s' and out_keys specification mismatch"
+    end
+
+    if @time_key
+      if @time_format
+        f = @time_format
+        tf = Fluent::TimeFormatter.new(f, @localtime)
+        @time_format_proc = tf.method(:format)
+        @time_parse_proc = Proc.new {|str| Time.strptime(str, f).to_i }
+      else
+        @time_format_proc = Proc.new {|time| time.to_s }
+        @time_parse_proc = Proc.new {|str| str.to_i }
+      end
+    end
+  end
+
+  def start
+    res = Net::HTTP.post_form(@join_uri, {'channel' => @channel})
+    if res.code.to_i == 200
+      # ok
+    elsif res.code.to_i == 403 and res.body == "joinned channel: #{@channel}"
+      # ok
+    else
+      raise Fluent::ConfigError, "failed to connect ikachan server #{@host}:#{@port}"
+    end
+  end
+
+  def shutdown
+  end
+
+  def emit(tag, es, chain)
+    messages = []
+
+    es.each {|time,record|
+      values = []
+      last = @out_keys.length - 1
+
+      values = @out_keys.map do |key|
+        case key
+        when @time_key
+          @time_format_proc.call(time)
+        when @tag_key
+          tag
+        else
+          record[key].to_s
+        end
+      end
+      messages.push (@message % values)
+    }
+
+    messages.each do |msg|
+      begin
+        res = Net::HTTP.post_form(@notice_uri, {'channel' => @channel, 'message' => msg})
+      rescue
+        $log.warn "out_ikachan: failed to send notice to #{@host}:#{@port}, #{@channel}, message: #{msg}"
+      end
+    end
+
+    chain.next
+  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/out_ikachan'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_ikachan.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class IkachanOutputTest < Test::Unit::TestCase
+  CONFIG = %[
+    host localhost
+    channel morischan
+    message out_ikachan: %s [%s] %s
+    out_keys tag,time,msg
+    time_key time
+    time_format %Y/%m/%d %H:%M:%S
+    tag_key tag
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::IkachanOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal '#morischan', d.instance.channel
+  end
+
+  def test_notice
+    # To test this code, execute ikachan on your own host
+    d = create_driver
+    time = Time.now.to_i
+    d.run do
+      d.emit({'msg' => "message from fluentd out_ikachan: testing now"}, time)
+      d.emit({'msg' => "message from fluentd out_ikachan: testing second line"}, time)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ikachan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'output plugin for IRC-HTTP gateway ''ikachan'' (see: https://metacpan.org/module/ikachan
+  and (jpn) http://blog.yappo.jp/yappo/archives/000760.html)'
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-ikachan.gemspec
+- lib/fluent/plugin/out_ikachan.rb
+- test/helper.rb
+- test/plugin/test_out_ikachan.rb
+homepage: https://github.com/tagomoris/fluent-plugin-ikachan
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: output plugin for IRC-HTTP gateway 'ikachan'
+test_files:
+- test/helper.rb
+- test/plugin/test_out_ikachan.rb