fluent-plugin-typetalk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjIwYTlmMzRhMTFhNTk5NDAxODU1ODVkYjEzOTViYTY1MGJlNTRiNA==
+    MzFhNThjMWE0NjIzNmIyZDNhMDk4ODg1OTM0OGQ3ZTNjOGIwYjUzOQ==
   data.tar.gz: !binary |-
-    NTRhNDIxMWNiMmEwMmViNTlkOGFmNjIyZDA4NTQ2ZDA5NThiNzczOA==
+    YmE2Y2ZkM2ViZmNmNzg0MzRiMGFhYmI5MzU2N2IwODk0MTA4ZDdlOQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDQ4NmQxNTZiNjYyMDdiODRmN2ViZDY0ZTdlN2MwNmFiZmUyZmQxYmVkMTRm
-    NjQ4NTQ4ZmIxY2I5NTAyNWZiZTc5ZDAzYTc2MDE0NjAwZGI3N2Y0MzcxYWYw
-    NWVlM2Y3ZGU1MDk0OGJjZjZjNDE2NzhmNjU4MTk4MGM4YTY0M2E=
+    ODQzZDBmMjc1Zjc4Njg1ZWY5NTczMjE3NDI5ODEzZTE0MzIyZDRlZGJiNzU2
+    NzhlNTljZmYyOWU3MDBjYjI5MmQwMGZiMmNiY2EyNjk3NWEwZGJhYmViNjM2
+    YmJlOGUzYjM1OWU0MzM4NTRjYTQ4NDA5YjVhMTY4ZDQ1ZDFhYWQ=
   data.tar.gz: !binary |-
-    YWIyYjc2YWJhMDM0ZjI0OTA1ZDdkMDAxYTc3MmNiOTI5NmVjZTY0OGU5ZWRk
-    ZTcxZGI2NWE3YTNmOTQ1ZTYwZTc0MDY3OTkwMGViOTE0MTE1MzE1MjMzMDZm
-    ZjU1MjIwMjQ3ODAwMWZkMmY3MjUwMzk3Y2Q5N2JhMTIyNGEzNzA=
+    NjBkMjgyODJjZDgzY2E3NjA1YTI1ODRiMGI4MDlmNTA0NzhhZmUxY2Q0MzIz
+    ZTZkNmQzODE2NWI5YmVmMzQ0YTcyZGFiMWQ2NWRiYzJhYjMzYjljNjQ4MTQ3
+    NzFjMTE4OTVkNDhlOTYxYjFhOWQ1YzNiZjFlOWRkZTdiZTFhZDA=

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/README.md

@@ -1,8 +1,8 @@
-# fluent-plugin-typetalk
+# fluent-plugin-typetalk [![Build Status](https://travis-ci.org/tksmd/fluent-plugin-typetalk.png?branch=master)](https://travis-ci.org/tksmd/fluent-plugin-typetalk)
 
 ## Overview
 
-[Fluentd](http://fluentd.org) plugin to emit notifications to Typetalk.
+[Fluentd](http://fluentd.org) plugin to emit notifications to [Typetalk](http://typetalk.in/).
 
 ## Installation
 
@@ -27,29 +27,30 @@ This plugin uses client credentials for authentication. See [the developer docum
   client_id YOUR_CLIENT_ID
   client_secret YOUR_CLIENT_SECRET
   topic_id YOUR_TOPIC_ID
+  message notice: %s [%s] %s errors found
+  out_keys tag,time,count
+  time_key time
+  time_format %Y/%m/%d %H:%M:%S
+  tag_key tag
 </match>
 ```
 
-The default output format is "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>" and an example output is like this:
-```
-test at 2014-05-13 01:21:30  0900
-{"message":"test1"}
-```
+The notified message will look like this : `notice: count.service [2014/05/13 03:34:02] 200 errors found`. The meanings of out_keys,time_key,time_format and tag_key are equivalent to those of [fluent-plugin-ikachan](https://github.com/tagomoris/fluent-plugin-ikachan).
 
-To change output format, you can set "template" parameter as follows:
+This plugin allows you to use special value namely $hostname in out_keys. By using it, you can include hostname within the notified message.
 ```
 <match ...>
   type typetalk
   client_id YOUR_CLIENT_ID
   client_secret YOUR_CLIENT_SECRET
   topic_id YOUR_TOPIC_ID
-  template "Check! <%= record.to_json %>"
+  message notice: %s [%s] %s errors found on %s
+  out_keys tag,time,count,$hostname
+  time_key time
+  time_format %Y/%m/%d %H:%M:%S
+  tag_key tag
 </match>
 ```
-Then you'll get the output like this:
-```
-Check! {"message":"test1"}
-```
 
 ## TODO
 
@@ -57,12 +58,22 @@ Pull requests are very welcome!!
 
 ## For developers
 
+You have to run the command below when starting development.
+```
+$ bundle install --path vendor/bundle
+```
+
 To run tests, do the following.
 ```
 $ VERBOSE=1 bundle exec rake test
 ```
 
+When releasing, call rake release as follows.
+```
+$ bundle exec rake release
+```
+
 ## Copyright
 
-Copyright :  Copyright (c) 2014- Takashi Someda (@tksmd)
-License   :  Apache License, Version 2.0
+* Copyright (c) 2014- Takashi Someda ([@tksmd](http://twitter.com/tksmd/))
+* Apache License, Version 2.0

data/fluent-plugin-typetalk.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-typetalk"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["tksmd"]
   spec.email         = ["someda@isenshi.com"]
   spec.description   = %q{fluent plugin to send message to typetalk}
@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rr", ">= 1.0.0"
   spec.add_runtime_dependency "fluentd"
+
+  spec.required_ruby_version = '>= 1.9.3'
 end

data/lib/fluent/plugin/out_typetalk.rb

@@ -5,9 +5,14 @@ module Fluent
     config_param :client_id, :string
     config_param :client_secret, :string
     config_param :topic_id, :integer
-    config_param :template, :string, :default => "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>"
     config_param :flush_interval, :time, :default => 1
 
+    config_param :message, :string
+    config_param :out_keys, :string, :default => ""
+    config_param :time_key, :string, :default => 'time'
+    config_param :time_format, :string, :default => nil
+    config_param :tag_key, :string, :default => 'tag'
+
     attr_reader :typetalk
 
     # Define `log` method for v0.10.42 or earlier
@@ -19,11 +24,32 @@ module Fluent
     def initialize
       super
       require 'erb'
+      require 'socket'
     end
 
     def configure(conf)
       super
       @typetalk = Typetalk.new(conf['client_id'], conf['client_secret'])
+      @hostname = Socket.gethostname
+
+      @out_keys = @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_format
+        f = @time_format
+        tf = Fluent::TimeFormatter.new(f, true) # IRC notification is formmatted as localtime only...
+        @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
 
     def start
@@ -49,14 +75,34 @@ module Fluent
     end
 
     def send_message(tag, time, record)
-      message = ERB.new(@template).result(binding)
+      message = evaluate_message(tag, time, record)
       @typetalk.post(@topic_id, message)
     end
 
+    def evaluate_message(tag, time, record)
+
+      values = out_keys.map do |key|
+        case key
+        when @time_key
+          @time_format_proc.call(time)
+        when @tag_key
+          tag
+        when "$hostname"
+          @hostname
+        else
+          record[key].to_s
+        end
+      end
+
+      (message % values).gsub(/\\n/, "\n")
+    end
+
   end
 
   class Typetalk
 
+    USER_AGENT = "fluent-plugin-typetalk Ruby/#{RUBY_VERSION}"
+
     def initialize(client_id, client_secret)
       require 'net/http'
       require 'uri'
@@ -76,12 +122,17 @@ module Fluent
       res = @http.post(
         "/api/v1/topics/#{topic_id}",
         "message=#{message}",
-        { 'Authorization' => "Bearer #{@access_token}" }
+        { 'Authorization' => "Bearer #{@access_token}", 'User-Agent' => USER_AGENT }
       )
 
       # todo: handling 429
       unless res and res.is_a?(Net::HTTPSuccess)
-        raise TypetalkError, "failed to post to typetalk.in, code: #{res && res.code}"
+        msg = ""
+        unless res.body.nil?
+          json = JSON.parse(res.body)
+          msg = json.fetch('errors', [])[0].fetch('message',"")
+        end
+        raise TypetalkError, "failed to post, msg: #{msg}, code: #{res.code}"
       end
 
     end
@@ -106,7 +157,8 @@ module Fluent
 
       res = @http.post(
         "/oauth2/access_token",
-        params
+        params,
+        { 'User-Agent' => USER_AGENT }
       )
 
       if res.is_a?(Net::HTTPUnauthorized)

data/test/plugin/test_out_typetalk.rb

@@ -13,7 +13,8 @@ class TypetalkOutputTest < Test::Unit::TestCase
     client_id 123456
     client_secret secret
     topic_id 1
-    template <%= record.to_json %>
+    message notice : %s
+    out_keys message
   ]
 
   def create_driver(conf = CONFIG, tag = 'test')
@@ -28,15 +29,16 @@ class TypetalkOutputTest < Test::Unit::TestCase
 
   def test_write
     d = create_driver()
-    stub(d.instance.typetalk).post(1, '{"message":"test1"}')
+    stub(d.instance.typetalk).post(1, 'notice : test1')
     d.emit({'message' => 'test1'})
     d.run()
   end
 
   def test_template
     d = create_driver(CONFIG, 'warn')
-    d.instance.template = "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>"
-    stub(d.instance.typetalk).post(1, "warn at 2014-05-13 01:05:38 +0900\n{\"message\":\"test1\"}")
+    d.instance.message = "notice : %s [%s]"
+    d.instance.out_keys = ["message", "time"]
+    stub(d.instance.typetalk).post(1, "notice : test1 [1399910738]")
 
     ENV["TZ"]="Asia/Tokyo"
     t = Time.strptime('2014-05-13 01:05:38', '%Y-%m-%d %T')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-typetalk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - tksmd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='