fluent-plugin-boundio 0.0.2 → 0.1.1

data/README.md

@@ -16,9 +16,18 @@ gem install fluent-plugin-boundio
 /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-boundio
 `````
 
-## Output Configuration
+## Configuration
 
-### Output Sample
+### Message Format
+`````
+fluent_logger.post('notify.call', {
+  :message  => 'Hello World!',   # Required
+  :number   => '090-1234-5678',  # Optional
+  :voice    => 'male'            # Optional
+})
+`````
+
+### Sample
 `````
 <source>
   type http
@@ -27,22 +36,32 @@ gem install fluent-plugin-boundio
 
 <match notify.call>
   type boundio
-  user_serial_id  YOUR_BOUNDIO_USER_SERIAL_ID
-  api_key         YOUR_BOUNDIO_API_KEY
-  user_key        YOUR_BOUNDIO_USER_KEY
-  default_number  09012345678
+  user_serial_id  BOUNDIO_USER_SERIAL_ID  # Required
+  api_key         BOUNDIO_API_KEY         # Required
+  user_key        BOUNDIO_USER_KEY        # Required
+  default_number  090-1234-5678           # Optional
+  default_voice   female                  # Optional [female/male] (default: female)
   # http://boundio.jp/docs/%E3%83%87%E3%83%99%E3%83%AD%E3%83%83%E3%83%91%E3%83%BC%E3%83%84%E3%83%BC%E3%83%AB
   developer_tool  yes
 </match>
 `````
 
-### Debug
+### Quick Test
 `````
-$ curl http://localhost:8888/notify.call -F 'json={"number":"09012345678","message":"Help! System ABC has down."}'
+# test call to 09012345678 and say "Help! System ABC has down." with male voice.
+$ curl http://localhost:8888/notify.call -F 'json={"number":"09012345678","voice":"male","message":"Help! System ABC has down."}'
+
+# check boundio activity log
 $ tail -f /var/log/td-agent/td-agent.log
 `````
 
+## Reference
+
+### Use Case1: make a call when it goes to over 5 times 500_errors in a minutes.
+http://github.com/y-ken/fluent-plugin-boundio/blob/master/example.conf
+
 ## Backend Service
+You can register to get 20 times trial call credit.
 http://boundio.jp/
 
 ## TODO
@@ -53,3 +72,4 @@ Copyright © 2012- Kentaro Yoshida (@yoshi_ken)
 
 ## License
 Apache License, Version 2.0
+

data/example.conf

@@ -0,0 +1,115 @@
+## It is a example to make a call when it goes to over 5 times 500_errors in a minutes.
+##
+## * Apache LogFormat (httpd.conf)
+## LogFormat "%V %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %D" combined
+##
+## * Target Website
+## www.example.com
+##
+## * required plugin
+## fluent-plugin-rewrite-tag-filter
+## fluent-plugin-datacounter
+## fluent-plugin-notifier
+## fluent-plugin-parser
+## fluent-plugin-boundio
+
+## following an access_log
+<source>
+  type tail
+  path /var/log/httpd/access_log
+  format /^(?<domain>[^ ]*) (?<host>[^ ]*) [^ ]* (?<user>[^ ]*) \[(?<time>[^\]]*)\] "(?<method>\S+)(?: +(?<path>[^ ]*) +\S*)?" (?<status>[^ ]*) (?<size>[^ ]*)(?: "(?<referer>[^\"]*)" "(?<agent>[^\"]*)" (?<response_time>[^ ]*))?$/
+  time_format %d/%b/%Y:%H:%M:%S %z
+  tag log.apache.access
+  pos_file /var/log/td-agent/apache_access.pos
+</source>
+
+## extract the target domain and rewrite tag name to site.ExampleWebSite
+<match log.apache.access>
+  type rewrite_tag_filter
+  rewriterule1 domain ^www.example.com$ site.ExampleWebSite
+</match>
+
+## count values of "status" by each pattern
+# Record Sample:
+# site.ExampleWebSite: {"domain":"www.example.com","host":"127.0.0.1","user":"-","method":"GET","path":"/home","status":"200","size":"12121","referer":"-","agent":"Wget","response_time":"0"}
+<match site.ExampleWebSite>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type      datacounter
+    unit      minute
+    count_key status
+    tag       count.responsecode.ExampleWebSite
+    aggregate all
+    pattern1  200 ^200$
+    pattern2  2xx ^2\d\d$
+    pattern3  301 ^301$
+    pattern4  302 ^302$
+    pattern5  3xx ^3\d\d$
+    pattern6  403 ^403$
+    pattern7  404 ^404$
+    pattern8  410 ^410$
+    pattern9  4xx ^4\d\d$
+    pattern10 500 ^5\d\d$
+    outcast_unmatched false
+  </store>
+</match>
+
+## output a record when the "status_500" value exceed threshold.
+# Record Sample:
+# count.responsecode.ExampleWebSite: {"unmatched_count":0,"unmatched_rate":0.0,"unmatched_percentage":0.0,"200_count":0,"200_rate":0.0,"200_percentage":0.0,"2xx_count":0,"2xx_rate":0.0,"2xx_percentage":0.0,"301_count":0,"301_rate":0.0,"301_percentage":0.0,"302_count":0,"302_rate":0.0,"302_percentage":0.0,"3xx_count":0,"3xx_rate":0.0,"3xx_percentage":0.0,"403_count":0,"403_rate":0.0,"403_percentage":0.0,"404_count":0,"404_rate":0.0,"404_percentage":0.0,"410_count":0,"410_rate":0.0,"410_percentage":0.0,"4xx_count":0,"4xx_rate":0.0,"4xx_percentage":0.0,"500_count":20,"500_rate":0.33,"500_percentage":100.0}
+<match count.responsecode.ExampleWebSite>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type notifier
+    input_tag_remove_prefix count.responsecode
+    <def>
+      pattern            status_500
+      check              numeric_upward
+      warn_threshold     5
+      crit_threshold     20
+      tag                alert.http_500_error
+      target_key_pattern ^500_count$
+    </def>
+  </store>
+</match>
+
+## build an alert message
+# Record Sample:
+# alert.http_500_error: {"pattern":"status_500","target_tag":"ExampleWebSite","target_key":"500_count","check_type":"numeric_upward","level":"crit","threshold":20.0,"value":20.0,"message_time":"2012-10-18 20:08:52 +0900"}
+<match alert.http_500_error>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type             deparser
+    tag              notify.call
+    # format         WebSite has down level %s. The service of %s %s is exceed %s times. This threshold is %s now. Thank you.
+    format           サイトが落ちました。レベルは%s。%sの%sが%s回を超えました。しきい値は%sです。対応お願いします。
+    format_key_names level,target_tag,target_key,value,threshold
+    key_name         message
+    reserve_data     no
+  </store>
+</match>
+
+# make a call to 09012345678
+<match notify.call>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type boundio
+    user_serial_id  YOUR_BOUNDIO_USER_SERIAL_ID
+    api_key         YOUR_BOUNDIO_API_KEY
+    user_key        YOUR_BOUNDIO_USER_KEY
+    default_number  09012345678
+    developer_tool  yes
+  </store>
+</match>

data/fluent-plugin-boundio.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-boundio"
-  s.version     = "0.0.2"
+  s.version     = "0.1.1"
   s.authors     = ["Kentaro Yoshida"]
   s.email       = ["y.ken.studio@gmail.com"]
   s.homepage    = "https://github.com/y-ken/fluent-plugin-boundio"

data/lib/fluent/plugin/out_boundio.rb

@@ -2,46 +2,52 @@
 class Fluent::BoundioOutput < Fluent::Output
   Fluent::Plugin.register_output('boundio', self)
 
+  VOICE_MAP = {'female' => 0, 'male' => 1}
+
   config_param :user_serial_id, :string
   config_param :user_key, :string, :default => nil # Optional at this time
   config_param :api_key, :string
-  config_param :default_number, :string
+  config_param :default_number, :string, :default => nil
+  config_param :default_voice, :string, :default => 'male'
   config_param :developer_tool, :string, :default => 'no'
 
   def initialize
     super
-
     require 'uri'
     require 'net/https'
   end
 
   def configure(conf)
     super
+    unless VOICE_MAP.include?(@default_voice)
+      raise Fluent::ConfigError, "boundio: invalid value for default_voice(male/female): #{@default_voice}"
+    end
     @developer_tool = Fluent::Config.bool_value(@developer_tool) || false
-    @voice_type = 1
+    $log.info "boundio: using developer tool api" if @developer_tool
   end
 
   def emit(tag, es, chain)
     es.each do |time,record|
       number = record['number'].nil? ? @default_number : record['number']
-      call(number, record['message'])
+      voice = VOICE_MAP.include?(record['voice']) ? record['voice'] : @default_voice
+      call(number, record['message'], voice)
     end
 
     chain.next
   end
 
-  def call(number, message)
+  def call(number, message, voice = 'male')
     begin
       https = Net::HTTP.new('boundio.jp', 443)
       https.use_ssl = true
-      cast = "file_d(#{message}, #{@voice_type})"
-      query = 'key=' + @api_key + '&tel_to=' + number + '&cast=' + cast
+      cast = "file_d(#{message}, #{VOICE_MAP[voice]})"
+      query = 'key=' + @api_key + '&tel_to=' + number.gsub('-','') + '&cast=' + cast
       path = @developer_tool ? '/api/vd2/' : '/api/v2/'
       response = https.post(path + @user_serial_id + '/call', URI.escape(query))
-      $log.info "boundio makeing a call: #{path} #{message} "
-      $log.info "boundio call result: #{response.body}"
+      $log.info "boundio: makeing a call to #{number} and say '#{message}'"
+      $log.info "boundio: call result: #{response.body}"
     rescue => e
-      $log.error("Boundio Error: #{e.message}")
+      $log.error "boundio: Error: #{e.message}"
     end
   end
 end

data/test/plugin/test_out_boundio.rb

@@ -6,9 +6,9 @@ class BoundioOutputTest < Test::Unit::TestCase
   end
 
   CONFIG = %[
-    user_serial_id  YOUR_BOUNDIO_USER_SERIAL_ID
-    api_key         YOUR_BOUNDIO_API_KEY
-    user_key        YOUR_BOUNDIO_USER_KEY
+    user_serial_id  BOUNDIO_USER_SERIAL_ID
+    api_key         BOUNDIO_API_KEY
+    user_key        BOUNDIO_USER_KEY
     default_number  09012345678
   ]
 
@@ -21,15 +21,15 @@ class BoundioOutputTest < Test::Unit::TestCase
       d = create_driver('')
     }
     d = create_driver %[
-      user_serial_id  YOUR_BOUNDIO_USER_SERIAL_ID
-      api_key         YOUR_BOUNDIO_API_KEY
-      user_key        YOUR_BOUNDIO_USER_KEY
+      user_serial_id  BOUNDIO_USER_SERIAL_ID
+      api_key         BOUNDIO_API_KEY
+      user_key        BOUNDIO_USER_KEY
       default_number  09012345678
     ]
     d.instance.inspect
-    assert_equal 'YOUR_BOUNDIO_USER_SERIAL_ID', d.instance.user_serial_id
-    assert_equal 'YOUR_BOUNDIO_API_KEY', d.instance.api_key
-    assert_equal 'YOUR_BOUNDIO_USER_KEY', d.instance.user_key
+    assert_equal 'BOUNDIO_USER_SERIAL_ID', d.instance.user_serial_id
+    assert_equal 'BOUNDIO_API_KEY', d.instance.api_key
+    assert_equal 'BOUNDIO_USER_KEY', d.instance.user_key
     assert_equal '09012345678', d.instance.default_number
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-boundio
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
-  requirement: &11291020 !ruby/object:Gem::Requirement
+  requirement: &21687940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11291020
+  version_requirements: *21687940
 - !ruby/object:Gem::Dependency
   name: fluentd
-  requirement: &11290580 !ruby/object:Gem::Requirement
+  requirement: &21687500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11290580
+  version_requirements: *21687500
 description: 
 email:
 - y.ken.studio@gmail.com
@@ -45,6 +45,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example.conf
 - fluent-plugin-boundio.gemspec
 - lib/fluent/plugin/out_boundio.rb
 - test/helper.rb