fluent-plugin-mail 0.0.1 → 0.0.2

data/README.md

@@ -7,16 +7,88 @@ 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
 
+Or use td-agent : (on Ubuntu12.04)
+
+    $ sudo /usr/lib/fluent/ruby/bin/fluent-gem install fluent-plugin-mail
+
+
+##  Mail Configuration with out_keys (no auth)
+
+    <match **>
+      type mail
+      host SMTPSERVER
+      port 25
+      from SOURCE
+      to DEST1,DEST2,DEST3
+      subject SUBJECT: %s
+      subject_out_keys target_tag
+      out_keys target_tag,pattern,value
+    </match>
+
+Email is sent like
+
+    From: SOURCE
+    To: DEST1,DEST2,DEST3
+    Subject: SUBJECT: #{target_tag}
+    Mime-Version: 1.0
+    Content-Type: text/plain; charset=utf-8
+
+    target_tag: #{target_tag}
+    pattern: #{pattern}
+    value: #{value}
 
-## SingleNode's Usage
+## Mail Configuration with Message Format (no auth)
+
+You may use `message` parameter to define mail format as you like. Use `\n` to put a return code.
+
+    <match **>
+      type mail
+      host SMTPSERVER
+      port 25
+      from SOURCE
+      to DEST1,DEST2,DEST3
+      subject SUBJECT: %s
+      subject_out_keys target_tag
+      message %s %s\n%s
+      message_out_keys target_tag,pattern,value
+    </match>
+
+Email is sent like
+
+    From: SOURCE
+    To: DEST1,DEST2,DEST3
+    Subject: SUBJECT: #{target_tag}
+    Mime-Version: 1.0
+    Content-Type: text/plain; charset=utf-8
+
+    #{target_tag} #{pattern}
+    #{value}
+
+## Mail Configuration for Gmail(use TLS)
+
+    <match **>
+      type mail
+      host smtp.gmail.com
+      port 587
+      domain gmail.com
+      from SOURCE
+      to DEST1,DEST2,DEST3
+      subject SUBJECT
+      user USERNAME( ex. hoge@gmail.com)
+      password PASSWORD
+      enable_starttls_auto true
+      out_keys target_tag,pattern,value
+    </match>
+
+
+
+## Usage Sample
+
+### SingleNode's syslog check
 
 use fluent_plugin_notifier(https://github.com/tagomoris/fluent-plugin-notifier)
 
@@ -53,12 +125,12 @@ configure td-agent.conf for single node
       domain DOMAIN
       from SOURCE_MAIL_ADDRESS
       to DESTINATION_MAIL_ADDRESS
-      subject SUBJET
+      subject SUBJECT
       outkeys target_tag, pattern, value, message_time
     </match>
 
 
-## MultiNode's Configuration for syslog
+### MulatiNode's syslog check
 
 use config_expander(https://github.com/tagomoris/fluent-plugin-config-expander)
 
@@ -115,27 +187,11 @@ log server("/etc/td-agent/td-agent.conf")
       domain DOMAIN
       from SOURCE_MAIL_ADDRESS
       to DESTINATION_MAIL_ADDRESS
-      subject SUBJET
+      subject SUBJECT
       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
 

data/fluent-plugin-mail.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |gem|
   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.version       = '0.0.2'
   gem.add_development_dependency "fluentd"
+  gem.add_development_dependency "rake"
   gem.add_runtime_dependency "fluentd"
-  gem.add_runtime_dependency "rake"
 end
 

data/lib/fluent/plugin/out_mail.rb

@@ -1,7 +1,9 @@
 class Fluent::MailOutput < Fluent::Output
   Fluent::Plugin.register_output('mail', self)
 
-  config_param :out_keys, :string
+  config_param :out_keys, :string, :default => ""
+  config_param :message, :string, :default => nil
+  config_param :message_out_keys, :string, :default => ""
   config_param :time_key, :string, :default => nil
   config_param :time_format, :string, :default => nil
   config_param :tag_key, :string, :default => 'tag'
@@ -13,6 +15,7 @@ class Fluent::MailOutput < Fluent::Output
   config_param :from, :string, :default => 'localhost@localdomain'
   config_param :to, :string, :default => ''
   config_param :subject, :string, :default => 'Fluent::MailOutput plugin'
+  config_param :subject_out_keys, :string, :default => ""
   config_param :enable_starttls_auto, :bool, :default => false
 
   def initialize
@@ -24,7 +27,25 @@ class Fluent::MailOutput < Fluent::Output
   def configure(conf)
     super
 
-    @out_keys = conf['out_keys'].split(',')
+    @out_keys = @out_keys.split(',')
+    @message_out_keys = @message_out_keys.split(',')
+    @subject_out_keys = @subject_out_keys.split(',')
+
+    if @out_keys.empty? and @message.nil?
+      raise Fluent::ConfigError, "Either 'message' or 'out_keys' must be specifed."
+    end
+
+    begin
+      @message % (['1'] * @message_out_keys.length) if @message
+    rescue ArgumentError
+      raise Fluent::ConfigError, "string specifier '%s' of message and message_out_keys specification mismatch"
+    end
+
+    begin
+      @subject % (['1'] * @subject_out_keys.length)
+    rescue ArgumentError
+      raise Fluent::ConfigError, "string specifier '%s' of subject and subject_out_keys specification mismatch"
+    end
 
     if @time_key
       if @time_format
@@ -48,30 +69,23 @@ class Fluent::MailOutput < Fluent::Output
 
   def emit(tag, es, chain)
     messages = []
+    subjects = []
 
     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
+      if @message
+        messages << create_formatted_message(tag, time, record)
+      else
+        messages << create_key_value_message(tag, time, record)
       end
-
-      messages.push (values.join("\n"))
+      subjects << create_formatted_subject(tag, time, record)
     }
 
-    messages.each do |msg|
+    messages.each_with_index do |msg, i|
+      subject = subjects[i]
       begin
-        res = sendmail(msg)
+        res = sendmail(subject, msg)
       rescue
-        $log.warn "out_mail: failed to send notice to #{@host}:#{@port}, message: #{msg}"
+        $log.warn "out_mail: failed to send notice to #{@host}:#{@port}, subject: #{subject}, message: #{msg}"
       end
     end
 
@@ -82,7 +96,58 @@ class Fluent::MailOutput < Fluent::Output
     "#{Time.at(time).strftime('%Y/%m/%d %H:%M:%S')}\t#{tag}\t#{record.to_json}\n"
   end
 
-  def sendmail(msg)
+  def create_key_value_message(tag, time, record)
+    values = []
+
+    @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
+
+    values.join("\n")
+  end
+
+  def create_formatted_message(tag, time, record)
+    values = []
+
+    values = @message_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
+
+    (@message % values).gsub(/\\n/, "\n")
+  end
+
+  def create_formatted_subject(tag, time, record)
+    values = []
+
+    values = @subject_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
+
+    @subject % values
+  end
+
+  def sendmail(subject, msg)
     smtp = Net::SMTP.new(@host, @port)
 
     if @user and @password
@@ -93,7 +158,7 @@ class Fluent::MailOutput < Fluent::Output
       smtp.start
     end
 
-    subject = @subject.force_encoding('binary')
+    subject = subject.force_encoding('binary')
     body = msg.force_encoding('binary')
 
     smtp.send_mail(<<EOS, @from, @to.split(/,/))

data/test/plugin/test_out_mail.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mail
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
-  requirement: &12125340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12125340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: fluentd
-  requirement: &12124060 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *12124060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &12122980 !ruby/object:Gem::Requirement
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *12122980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: output plugin for Mail
 email:
 - yuichi.u@gmail.com
@@ -80,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: fluent-plugin-mail
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: output plugin for Mail