fluent-plugin-mail 0.0.1

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
+vendor/bundle

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012- Yuichi UEMURA
+
+   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,150 @@
+# Fluent::Plugin::Mail
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-mail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-mail
+
+
+## SingleNode's Usage
+
+use fluent_plugin_notifier(https://github.com/tagomoris/fluent-plugin-notifier)
+
+    $ gem install fluent-plugin-notifier
+
+configure td-agent.conf for single node
+
+    <source>
+      type tail
+      tag syslog
+      path /var/log/syslog
+    </source>
+    <match syslog**>
+      type notifier
+      <def>
+        pattern check_syslog
+        check string_find
+        warn_regexp .*warn.*
+        crit_regexp .*crit.*
+        target_key_pattern message
+      </def>
+      <def>
+        pattern check_syslog
+        check string_find
+        warn_regexp .*Error.*
+        crit_regexp .*Down.*
+        target_key_pattern message
+      </def>
+    </match>
+    <match notification**>
+      type mail
+      host MAILSERVER
+      port MAILSERVER_PORT
+      domain DOMAIN
+      from SOURCE_MAIL_ADDRESS
+      to DESTINATION_MAIL_ADDRESS
+      subject SUBJET
+      outkeys target_tag, pattern, value, message_time
+    </match>
+
+
+## MultiNode's Configuration for syslog
+
+use config_expander(https://github.com/tagomoris/fluent-plugin-config-expander)
+
+    $ gem install fluent-plugin-config-expander
+
+
+
+source node("/etc/td-agent/td-agent.conf")
+
+    <source>
+      type config_expander
+      <config>
+        type tail
+        format syslog
+        path /var/log/syslog
+        tag syslog.${hostname}
+        pos_file /tmp/syslog.pos
+      </config>
+    </source>a
+    <match **>
+      type forward
+      <server>
+        host HOST_ADDRESS
+      </server>
+    </match>
+
+
+log server("/etc/td-agent/td-agent.conf")
+
+    <source>
+      type forward
+    </source>
+    <match syslog**>
+      type copy
+      <store>
+        type file
+        path /var/log-server/syslog
+      </store>
+      <store>
+        type notifier
+        <def>
+          pattern check_syslog
+          check string_find
+          warn_regexp .*warn.*
+          crit_regexp .*crit.*
+          target_key_pattern message
+        </def>
+      </store>
+    </match>
+    <match notification**>
+      type mail
+      host MAILSERVER
+      port MAILSERVER_PORT
+      domain DOMAIN
+      from SOURCE_MAIL_ADDRESS
+      to DESTINATION_MAIL_ADDRESS
+      subject SUBJET
+      outkeys target_tag, pattern, value
+    </match>
+
+
+## Mail Configuration for Gmail(TLS)
+
+    <match **>
+      type mail
+      host smtp.gmail.com
+      port 587
+      domain gmail.com
+      from SOURCE
+      to DEST1,DEST2,DEST3
+      subject SUBJET
+      user USERNAME( ex. hoge@gmail.com)
+      password PASSWORD
+      enable_starttls_auto true
+      out_keys target_tag,pattern,value
+    </match>
+
+
+## TODO
+
+* add config "mail_text_format"
+
+## Copyright
+
+* Copyright
+  * Copyright (c) 2012- Yuichi UEMURA
+  * 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-mail.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yuichi UEMURA"]
+  gem.email         = ["yuichi.u@gmail.com"]
+  gem.description   = %q{output plugin for Mail}
+  gem.summary       = %q{output plugin for Mail}
+  gem.homepage      = "https://github.com/u-ichi/fluent-plugin-mail"
+  gem.rubyforge_project = "fluent-plugin-mail"
+  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.name          = "fluent-plugin-mail"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.0.1'
+  gem.add_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "rake"
+end
+

data/lib/fluent/plugin/out_mail.rb

@@ -0,0 +1,113 @@
+class Fluent::MailOutput < Fluent::Output
+  Fluent::Plugin.register_output('mail', self)
+
+  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'
+  config_param :host, :string
+  config_param :port, :integer, :default => 25
+  config_param :domain, :string, :default => 'localdomain'
+  config_param :user, :string, :default => nil
+  config_param :password, :string, :default => nil
+  config_param :from, :string, :default => 'localhost@localdomain'
+  config_param :to, :string, :default => ''
+  config_param :subject, :string, :default => 'Fluent::MailOutput plugin'
+  config_param :enable_starttls_auto, :bool, :default => false
+
+  def initialize
+    super
+    require 'net/smtp'
+    require 'kconv'
+  end
+
+  def configure(conf)
+    super
+
+    @out_keys = conf['out_keys'].split(',')
+
+    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
+
+  end
+
+  def shutdown
+  end
+
+  def emit(tag, es, chain)
+    messages = []
+
+    es.each {|time,record|
+      values = []
+      last = @out_keys.length - 1
+
+      @out_keys.each do |key|
+        case key
+        when @time_key
+          values << @time_format_proc.call(time)
+        when @tag_key
+          values << tag
+        else
+          values << "#{key}: #{record[key].to_s}"
+        end
+      end
+
+      messages.push (values.join("\n"))
+    }
+
+    messages.each do |msg|
+      begin
+        res = sendmail(msg)
+      rescue
+        $log.warn "out_mail: failed to send notice to #{@host}:#{@port}, message: #{msg}"
+      end
+    end
+
+    chain.next
+  end
+
+  def format(tag, time, record)
+    "#{Time.at(time).strftime('%Y/%m/%d %H:%M:%S')}\t#{tag}\t#{record.to_json}\n"
+  end
+
+  def sendmail(msg)
+    smtp = Net::SMTP.new(@host, @port)
+
+    if @user and @password
+      smtp_auth_option = [@domain, @user, @password, :plain]
+      smtp.enable_starttls if @enable_starttls_auto
+      smtp.start(@domain,@user,@password,:plain)
+    else
+      smtp.start
+    end
+
+    subject = @subject.force_encoding('binary')
+    body = msg.force_encoding('binary')
+
+    smtp.send_mail(<<EOS, @from, @to.split(/,/))
+Date: #{Time::now.strftime("%a, %d %b %Y %X")}
+From: #{@from}
+To: #{@to}
+Subject: #{subject}
+Mime-Version: 1.0
+Content-Type: text/plain; charset=utf-8
+
+#{body}
+EOS
+    smtp.finish
+  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_mail'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mail.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class MailOutputTest < Test::Unit::TestCase
+
+
+  CONFIG = %[
+    message out_mail: %s [%s] %s
+    out_keys tag,time,value
+    time_key time
+    time_format %Y/%m/%d %H:%M:%S
+    tag_key tag
+    subject Fluentd Notification Alerm
+    host localhost
+    port 25
+    from localhost@localdomain
+    to localhost@localdomain
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::MailOutput, tag).configure(conf)
+  end
+
+  def test_configure
+  end
+
+  def test_notice
+    d = create_driver
+    time = Time.now.to_i
+    d.run do
+      d.emit({'value' => "message from fluentd out_mail: testing now"}, time)
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuichi UEMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &12125340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12125340
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &12124060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12124060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12122980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12122980
+description: output plugin for Mail
+email:
+- yuichi.u@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-mail.gemspec
+- lib/fluent/plugin/out_mail.rb
+- test/helper.rb
+- test/plugin/test_out_mail.rb
+homepage: https://github.com/u-ichi/fluent-plugin-mail
+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: fluent-plugin-mail
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: output plugin for Mail
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mail.rb