fluent-plugin-sns 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f1aa27719f45448dc6f81ee814d8d7363475ef6
-  data.tar.gz: 986e60b82fe3bf32fe2f3f98c7a092fad4ff5819
+  metadata.gz: 9de55cad0620884c09c3af8585702b223f34539f
+  data.tar.gz: 0bc74974c8e6c782f34975693da51fa8a37c4094
 SHA512:
-  metadata.gz: c719f12ca0187b81550abe7503e2221018b19d7317a8d0adfcbac43d83a7835500ae4a55836dd439db2485761f759374612fd0e19d7a9ff0e1f24cb0fad4ed42
-  data.tar.gz: d530dd4bce2607bbff2818c4df63161c6f4051189f10a6e024269ae36e235678bf0e480880cf0b65962fb8ff042f2dd21f037e3e38602087ffe1554f8280cb49
+  metadata.gz: 07f5b4c7d49354013e02b6617109995827cf1166c56bb16fd203304f5203b468d5dbe4054acbbbfbe5a9606243e2aca1788534c70aa3afe2dfea09c01de2e259
+  data.tar.gz: 25b9d3329b21e224fdeb55527726d1f3e4912fccd8b07a35b22590ec03c58450e0299b83ec53d12ef6e9f83ab454221626290bfac24593f1e13dcbc0296389c7

data/README.rdoc

@@ -21,10 +21,10 @@ Send fluent-event as message to amazon SNS.
 
       sns_topic_name {sns_topic_name}
 
-      # following attibutes are required if you don't use IAM Role
+      # following attibutes are required if you don't use IAM Role and you don't set environment variables
 
-      aws_key_id {your_aws_key_id}
-      aws_sec_key {your_aws_secret_key}
+      aws_key_id {your_aws_key_id}       # Default: ENV['AWS_ACCESS_KEY_ID']
+      aws_sec_key {your_aws_secret_key}  # Default: ENV['AWS_SECRET_ACCESS_KEY']
 
       # following attibutes are optional
 
@@ -39,22 +39,44 @@ Send fluent-event as message to amazon SNS.
       # EU-West (Ireland)              : sns.eu-west-1.amazonaws.com
       # South America (São Paulo)      : sns.sa-east-1.amazonaws.com
 
+      sns_subject_template {template_erb_file_path}
       sns_subject_key {sns_subject_key}
       sns_subject {sns_subject} #constant subject
 
+      sns_body_template {sns_body_template}
+      sns_body_key {sns_body_key}
+
       proxy http(s)://{url}:{port}
 
     </match>
 
-== TODO
-=== More configuration
-- E-Mail formatter
-- buffer-output
+== Example
+
+=== fluentd.conf
+
+    <match sns.**>
+
+      type sns
+
+      sns_topic_name example
+      
+      sns_endpoint sns.ap-northeast-1.amazonaws.com
+
+      sns_subject_key from
+      sns_body_template /path/to/template/body_template.erb
+
+    </match>
+
+=== template
+
+/path/to/template/body_template.erb
+    hello <%= record['to'] %>!
+
+=== sample input
 
-== Test
-- Other Notification Protcol (HTTP/HTTPS,SQS,SMS)
+    $ echo '{"from":'Alice',"to":"Bob" }' | fluent-cat sns.example
 
-== Tool
+Then, the message is published. (subject -> 'Alice', body -> 'hello Bob!')
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.1.0

data/lib/fluent/plugin/out_sns.rb

@@ -1,64 +1,90 @@
 module Fluent
-    
-    require 'aws-sdk'
-
-    class SNSOutput < Output
-        
-        Fluent::Plugin.register_output('sns', self)
-        
-        include SetTagKeyMixin
-        config_set_default :include_tag_key, false
-        
-        include SetTimeKeyMixin
-        config_set_default :include_time_key, true
-        
-        config_param :aws_key_id, :string, :default => nil
-        config_param :aws_sec_key, :string, :default => nil
-        
-        config_param :sns_topic_name, :string
-        config_param :sns_subject_key, :string, :default => nil
-        config_param :sns_subject, :string, :default => nil
-        config_param :sns_endpoint, :string, :default => 'sns.ap-northeast-1.amazonaws.com'
-        config_param :proxy, :string, :default => ENV['HTTP_PROXY']
-        
-        def configure(conf)
-            super
-        end
-        
-        def start
-            super
-            options = {}
-            options[:sns_endpoint] = @sns_endpoint
-            options[:proxy_uri] = @proxy
-            if @aws_key_id && @aws_sec_key
-              options[:access_key_id] = @aws_key_id
-              options[:secret_access_key] = @aws_sec_key
-            end
-            AWS.config(options)
-            
-            @sns = AWS::SNS.new
-            @topic = get_topic
-        end
-        
-        def shutdown
-            super
-        end
-        
-        def emit(tag, es, chain)
-            chain.next
-            es.each {|time,record|
-                record["time"] = Time.at(time).localtime
-                subject = record[@sns_subject_key] || @sns_subject  || 'Fluent-Notification'
-                @topic.publish(record.to_json, :subject => subject )
-            }
-        end
-        
-        def get_topic()
-            @sns.topics.each do |topic|
-                if @sns_topic_name == topic.name
-                    return topic
-                end
-            end
-        end
+
+  require 'aws-sdk'
+
+  class SNSOutput < Output
+
+    Fluent::Plugin.register_output('sns', self)
+
+    include SetTagKeyMixin
+    config_set_default :include_tag_key, false
+
+    include SetTimeKeyMixin
+    config_set_default :include_time_key, true
+
+    config_param :aws_key_id, :string, :default => ENV['AWS_ACCESS_KEY_ID']
+    config_param :aws_sec_key, :string, :default => ENV['AWS_SECRET_ACCESS_KEY']
+
+    config_param :sns_topic_name, :string
+    config_param :sns_subject_template, :default => nil
+    config_param :sns_subject_key, :string, :default => nil
+    config_param :sns_subject, :string, :default => nil
+    config_param :sns_body_template, :default => nil
+    config_param :sns_body_key, :string, :default => nil
+    config_param :sns_body, :string, :default => nil
+    config_param :sns_endpoint, :string, :default => 'sns.ap-northeast-1.amazonaws.com'
+    config_param :proxy, :string, :default => ENV['HTTP_PROXY']
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+      options = {}
+      options[:sns_endpoint] = @sns_endpoint
+      options[:proxy_uri] = @proxy
+      if @aws_key_id && @aws_sec_key
+        options[:access_key_id] = @aws_key_id
+        options[:secret_access_key] = @aws_sec_key
+      end
+      AWS.config(options)
+
+      @sns = AWS::SNS.new
+      @topic = @sns.topics.find{|topic| @sns_topic_name == topic.name}
+
+      @subject_template = nil
+      unless @sns_body_template.nil?
+        template_file = open(@sns_subject_template)
+        @subject_template = ERB.new(template_file.read)
+        template_file.close
+      end
+
+      @body_template = nil
+      unless @sns_body_template.nil?
+        template_file = open(@sns_body_template)
+        @body_template = ERB.new(template_file.read)
+        template_file.close
+      end
+    end
+
+    def shutdown
+      super
+    end
+
+    def emit(tag, es, chain)
+      chain.next
+      es.each {|time,record|
+        record['time'] = Time.at(time).localtime
+        body = get_body(record).force_encoding('UTF-8')
+        subject = get_subject(record).force_encoding('UTF-8').gsub(/(\r\n|\r|\n)/, '')
+        puts "subject:#{subject}, body:#{body}"
+        @topic.publish( body, :subject => subject )
+      }
+    end
+
+    def get_subject(record)
+      unless @subject_template.nil?
+        return @subject_template.result(binding)
+      end
+      subject = record[@sns_subject_key].to_s || @sns_subject  || 'Fluentd-Notification'
+    end
+
+    def get_body(record)
+      unless @body_template.nil?
+        return @body_template.result(binding)
+      end
+      record[@sns_body_key] || @sns_body || record.to_json
     end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sns
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Yuri Odagiri