fluent-plugin-slack 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c03f2406138aa33b38a5db1fe9df6a75b2e660e7
-  data.tar.gz: ddb0b1cf2dc19024bca2838eeecc22a99116711c
+  metadata.gz: 3e77ab7baa0827ff765699dcc93878a07fb4b672
+  data.tar.gz: 69e2477beb5f8e394493b773f14ba92430927750
 SHA512:
-  metadata.gz: c4dffa0ecdad7eda6d710cba98078cc1cb0fdb4c4967ed64a200bfcb57d5897a44929d9ec714f837ab443dca01a99a90ddb09ad5cef76dd5a6da85037dd6c674
-  data.tar.gz: 6901248f0fe1b72cca79d26877f3d75e4147b66e9f52132770a537d12a8e579cba9ef45efc8f544caa4cc1f6d3f96fcdbc7f9adaf401cdd1c103d5c4a43e9fd0
+  metadata.gz: 2bd4b7b25d6a3c63bca594121120cf29a5679bbcb77e295d9f245ced3a80061458ed1d6028c67cbf0f159ae6cdf13ee190764f84b9ae7d7219507fc275d409f3
+  data.tar.gz: dd44cbe50f10718b5c5dcdc0fba0e0b9d570db7c82b636e200142be75ea8736ad3d8bbc2f885e785654328894be76c4571ac6635f7c2d9c2ed421d6cbe6d6019

data/.travis.yml

@@ -1,8 +1,9 @@
+sudo: false
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.*
   - 2.2.*
+  - 2.3.0
 gemfile:
   - Gemfile
 before_install:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.3 (2016/05/11)
+
+Enhancements:
+
+* Add `verbose_fallback` option to show fallback (popup) verbosely (thanks @eisuke)
+
 ## 0.6.2 (2015/12/17)
 
 Fixes:

data/README.md

@@ -10,7 +10,7 @@ $ fluent-gem install fluent-plugin-slack
 
 ```apache
 <match slack>
-  type slack
+  @type slack
   webhook_url https://hooks.slack.com/services/XXX/XXX/XXX
   channel general
   username sowasowa
@@ -29,7 +29,7 @@ fluent_logger.post('slack', {
 
 ```apache
 <match slack>
-  type slack
+  @type slack
   slackbot_url https://xxxx.slack.com/services/hooks/slackbot?token=XXXXXXXXX
   channel general
   flush_interval 60s
@@ -46,7 +46,7 @@ fluent_logger.post('slack', {
 
 ```apache
 <match slack>
-  type slack
+  @type slack
   token xoxb-XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXX
   channel general
   username sowasowa
@@ -83,6 +83,7 @@ fluent_logger.post('slack', {
 |message_keys|keys used to format messages|message|
 |auto_channels_create|Create channels if not exist. Not available for Incoming Webhook mode (since Incoming Webhook is specific to a channel). A web api `token` for Normal User is required (Bot User can not create channels. See https://api.slack.com/bot-users)|false|
 |https_proxy|https proxy url such as `https://proxy.foo.bar:443`|nil|
+|verbose_fallback|Originally, only `title` is used for the fallback which is the message shown on popup if `title` is given. If this option is set to be `true`, messages are also included to the fallback attribute|false|
 
 `fluent-plugin-slack` uses `SetTimeKeyMixin` and `SetTagKeyMixin`, so you can also use:
 

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -0,0 +1 @@
+out_slack.rb

data/lib/fluent/plugin/out_slack.rb

@@ -5,38 +5,113 @@ module Fluent
     Fluent::Plugin.register_output('buffered_slack', self) # old version compatiblity
     Fluent::Plugin.register_output('slack', self)
 
+    # For fluentd v0.12.16 or earlier
+    class << self
+      unless method_defined?(:desc)
+        def desc(description)
+        end
+      end
+    end
+
     include SetTimeKeyMixin
     include SetTagKeyMixin
 
     config_set_default :include_time_key, true
     config_set_default :include_tag_key, true
-   
-    config_param :webhook_url,          :string, default: nil # incoming webhook
-    config_param :slackbot_url,         :string, default: nil # slackbot
-    config_param :token,                :string, default: nil # api token
+
+    desc <<-DESC
+Incoming Webhook URI (Required for Incoming Webhook mode).
+See: https://api.slack.com/incoming-webhooks
+DESC
+    config_param :webhook_url,          :string, default: nil
+    desc <<-DESC
+Slackbot URI (Required for Slackbot mode).
+See https://api.slack.com/slackbot.
+NOTE: most of optional parameters such as `username`, `color`, `icon_emoji`,
+`icon_url`, and `title` are not available for this mode, but Desktop Notification
+via Highlight Words works with only this mode.
+DESC
+    config_param :slackbot_url,         :string, default: nil
+    desc <<-DESC
+Token for Web API (Required for Web API mode). See: https://api.slack.com/web.
+DESC
+    config_param :token,                :string, default: nil
+    desc "Name of bot."
     config_param :username,             :string, default: nil
+    desc <<-DESC
+Color to use such as `good` or `bad`.
+See Color section of https://api.slack.com/docs/attachments.
+NOTE: This parameter must not be specified to receive Desktop Notification
+via Mentions in cases of Incoming Webhook and Slack Web API.
+DESC
     config_param :color,                :string, default: nil
+    desc <<-DESC
+Emoji to use as the icon.
+Either of `icon_emoji` or `icon_url` can be specified.
+DESC
     config_param :icon_emoji,           :string, default: nil
+    desc <<-DESC
+Url to an image to use as the icon.
+Either of `icon_emoji` or `icon_url` can be specified.
+DESC
     config_param :icon_url,             :string, default: nil
+    desc "Enable formatting. See: https://api.slack.com/docs/formatting."
     config_param :mrkdwn,               :bool,   default: true
+    desc <<-DESC
+Find and link channel names and usernames.
+NOTE: This parameter must be `true` to receive Desktop Notification
+via Mentions in cases of Incoming Webhook and Slack Web API.
+DESC
     config_param :link_names,           :bool,   default: true
+    desc <<-DESC
+Change how messages are treated. `none` or `full` can be specified.
+See Parsing mode section of https://api.slack.com/docs/formatting.
+DESC
     config_param :parse,                :string, default: nil
+    desc <<-DESC
+Create channels if not exist. Not available for Incoming Webhook mode
+(since Incoming Webhook is specific to a channel).
+A web api token for Normal User is required.
+(Bot User can not create channels. See https://api.slack.com/bot-users)
+DESC
     config_param :auto_channels_create, :bool,   default: false
+    desc "https proxy url such as https://proxy.foo.bar:443"
     config_param :https_proxy,          :string, default: nil
 
+    desc "channel to send messages (without first '#')."
     config_param :channel,              :string
+    desc <<-DESC
+Keys used to format channel.
+%s will be replaced with value specified by channel_keys if this option is used.
+DESC
     config_param :channel_keys,         default: nil do |val|
       val.split(',')
     end
+    desc <<-DESC
+Title format.
+%s will be replaced with value specified by title_keys.
+Title is created from the first appeared record on each tag.
+NOTE: This parameter must **not** be specified to receive Desktop Notification
+via Mentions in cases of Incoming Webhook and Slack Web API.
+DESC
     config_param :title,                :string, default: nil
+    desc "Keys used to format the title."
     config_param :title_keys,           default: nil do |val|
       val.split(',')
     end
+    desc <<-DESC
+Message format.
+%s will be replaced with value specified by message_keys.
+DESC
     config_param :message,              :string, default: nil
+    desc "Keys used to format messages."
     config_param :message_keys,         default: nil do |val|
       val.split(',')
     end
 
+    desc "Include messages to the fallback attributes"
+    config_param :verbose_fallback,     :bool,   default: false
+
     # for test
     attr_reader :slack, :time_format, :localtime, :timef, :mrkdwn_in, :post_message_opts
 
@@ -189,10 +264,16 @@ module Fluent
         ch_fields[channel][per].value << "#{build_message(record)}\n"
       end
       ch_fields.map do |channel, fields|
+        fallback_text = if @verbose_fallback
+                          fields.values.map { |f| "#{f.title} #{f.value}" }.join(' ')
+                        else
+                          fields.values.map(&:title).join(' ')
+                        end
+
         {
           channel: channel,
           attachments: [{
-            :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
+            :fallback => fallback_text, # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
           }.merge(common_attachment)],
         }.merge(common_payload)

data/test/plugin/test_out_slack.rb

@@ -342,6 +342,30 @@ class SlackOutputTest < Test::Unit::TestCase
     end
   end
 
+  def test_title_payload_with_verbose_fallback_option
+    title = "mytitle"
+    d = create_driver(CONFIG + %[title #{title}\nverbose_fallback true])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    # attachments field should be changed to show the title
+    mock(d.instance.slack).post_message(default_payload.merge({
+      attachments: [default_attachment.merge({
+        fallback: "#{title} sowawa1\nsowawa2\n",
+        fields:   [
+          {
+            title: title,
+            value: "sowawa1\nsowawa2\n",
+          }
+        ],
+      })]
+    }), {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
   def test_color_payload
     color = 'good'
     d = create_driver(CONFIG + %[color #{color}])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: fluent Slack plugin

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -1,265 +0,0 @@
-require_relative 'slack_client'
-
-module Fluent
-  class SlackOutput < Fluent::BufferedOutput
-    Fluent::Plugin.register_output('buffered_slack', self) # old version compatiblity
-    Fluent::Plugin.register_output('slack', self)
-
-    include SetTimeKeyMixin
-    include SetTagKeyMixin
-
-    config_set_default :include_time_key, true
-    config_set_default :include_tag_key, true
-   
-    config_param :webhook_url,          :string, default: nil # incoming webhook
-    config_param :slackbot_url,         :string, default: nil # slackbot
-    config_param :token,                :string, default: nil # api token
-    config_param :username,             :string, default: nil
-    config_param :color,                :string, default: nil
-    config_param :icon_emoji,           :string, default: nil
-    config_param :icon_url,             :string, default: nil
-    config_param :mrkdwn,               :bool,   default: true
-    config_param :link_names,           :bool,   default: true
-    config_param :parse,                :string, default: nil
-    config_param :auto_channels_create, :bool,   default: false
-    config_param :https_proxy,          :string, default: nil
-
-    config_param :channel,              :string
-    config_param :channel_keys,         default: nil do |val|
-      val.split(',')
-    end
-    config_param :title,                :string, default: nil
-    config_param :title_keys,           default: nil do |val|
-      val.split(',')
-    end
-    config_param :message,              :string, default: nil
-    config_param :message_keys,         default: nil do |val|
-      val.split(',')
-    end
-
-    # for test
-    attr_reader :slack, :time_format, :localtime, :timef, :mrkdwn_in, :post_message_opts
-
-    def initialize
-      super
-      require 'uri'
-    end
-
-    def configure(conf)
-      conf['time_format'] ||= '%H:%M:%S' # old version compatiblity
-      conf['localtime'] ||= true unless conf['utc']
- 
-      super
-
-      @channel = URI.unescape(@channel) # old version compatibility
-      @channel = '#' + @channel unless @channel.start_with?('#')
-
-      if @webhook_url
-        if @webhook_url.empty?
-          raise Fluent::ConfigError.new("`webhook_url` is an empty string")
-        end
-        @slack = Fluent::SlackClient::IncomingWebhook.new(@webhook_url)
-      elsif @slackbot_url
-        if @slackbot_url.empty?
-          raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
-        end
-        if @username or @color or @icon_emoji or @icon_url
-          log.warn "out_slack: `username`, `color`, `icon_emoji`, `icon_url` parameters are not available for Slackbot Remote Control"
-        end
-        @slack = Fluent::SlackClient::Slackbot.new(@slackbot_url)
-      elsif @token
-        if @token.empty?
-          raise Fluent::ConfigError.new("`token` is an empty string")
-        end
-        @slack = Fluent::SlackClient::WebApi.new
-      else
-        raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
-      end
-      @slack.log = log
-      @slack.debug_dev = log.out if log.level <= Fluent::Log::LEVEL_TRACE
-
-      if @https_proxy
-        @slack.https_proxy = @https_proxy
-      end
-
-      @message      ||= '%s'
-      @message_keys ||= %w[message]
-      begin
-        @message % (['1'] * @message_keys.length)
-      rescue ArgumentError
-        raise Fluent::ConfigError, "string specifier '%s' for `message`  and `message_keys` specification mismatch"
-      end
-      if @title and @title_keys
-        begin
-          @title % (['1'] * @title_keys.length)
-        rescue ArgumentError
-          raise Fluent::ConfigError, "string specifier '%s' for `title` and `title_keys` specification mismatch"
-        end
-      end
-      if @channel_keys
-        begin
-          @channel % (['1'] * @channel_keys.length)
-        rescue ArgumentError
-          raise Fluent::ConfigError, "string specifier '%s' for `channel` and `channel_keys` specification mismatch"
-        end
-      end
-
-      if @icon_emoji and @icon_url
-        raise Fluent::ConfigError, "either of `icon_emoji` or `icon_url` can be specified"
-      end
-
-      if @mrkdwn
-        # Enable markdown for attachments. See https://api.slack.com/docs/formatting
-        @mrkdwn_in = %w[text fields]
-      end
-
-      if @parse and !%w[none full].include?(@parse)
-        raise Fluent::ConfigError, "`parse` must be either of `none` or `full`"
-      end
-
-      @post_message_opts = {}
-      if @auto_channels_create
-        raise Fluent::ConfigError, "`token` parameter is required to use `auto_channels_create`" unless @token
-        @post_message_opts = {auto_channels_create: true}
-      end
-    end
-
-    def format(tag, time, record)
-      [tag, time, record].to_msgpack
-    end
-
-    def write(chunk)
-      begin
-        payloads = build_payloads(chunk)
-        payloads.each {|payload| @slack.post_message(payload, @post_message_opts) }
-      rescue Timeout::Error => e
-        log.warn "out_slack:", :error => e.to_s, :error_class => e.class.to_s
-        raise e # let Fluentd retry
-      rescue => e
-        log.error "out_slack:", :error => e.to_s, :error_class => e.class.to_s
-        log.warn_backtrace e.backtrace
-        # discard. @todo: add more retriable errors
-      end
-    end
-
-    private
-
-    def build_payloads(chunk)
-      if @title
-        build_title_payloads(chunk)
-      elsif @color
-        build_color_payloads(chunk)
-      else
-        build_plain_payloads(chunk)
-      end
-    end
-
-    def common_payload
-      return @common_payload if @common_payload
-      @common_payload = {}
-      @common_payload[:username]   = @username   if @username
-      @common_payload[:icon_emoji] = @icon_emoji if @icon_emoji
-      @common_payload[:icon_url]   = @icon_url   if @icon_url
-      @common_payload[:mrkdwn]     = @mrkdwn     if @mrkdwn
-      @common_payload[:link_names] = @link_names if @link_names
-      @common_payload[:parse]      = @parse      if @parse
-      @common_payload[:token]      = @token      if @token
-      @common_payload
-    end
-
-    def common_attachment
-      return @common_attachment if @common_attachment
-      @common_attachment = {}
-      @common_attachment[:color]     = @color     if @color
-      @common_attachment[:mrkdwn_in] = @mrkdwn_in if @mrkdwn_in
-      @common_attachment
-    end
-
-    Field = Struct.new("Field", :title, :value)
-    # ruby 1.9.x does not provide #to_h
-    Field.send(:define_method, :to_h) { {title: title, value: value} }
-
-    def build_title_payloads(chunk)
-      ch_fields = {}
-      chunk.msgpack_each do |tag, time, record|
-        channel = build_channel(record)
-        per     = tag # title per tag
-        ch_fields[channel]      ||= {}
-        ch_fields[channel][per] ||= Field.new(build_title(record), '')
-        ch_fields[channel][per].value << "#{build_message(record)}\n"
-      end
-      ch_fields.map do |channel, fields|
-        {
-          channel: channel,
-          attachments: [{
-            :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
-            :fields   => fields.values.map(&:to_h)
-          }.merge(common_attachment)],
-        }.merge(common_payload)
-      end
-    end
-
-    def build_color_payloads(chunk)
-      messages = {}
-      chunk.msgpack_each do |tag, time, record|
-        channel = build_channel(record)
-        messages[channel] ||= ''
-        messages[channel] << "#{build_message(record)}\n"
-      end
-      messages.map do |channel, text|
-        {
-          channel: channel,
-          attachments: [{
-            :fallback => text,
-            :text     => text,
-          }.merge(common_attachment)],
-        }.merge(common_payload)
-      end
-    end
-
-    def build_plain_payloads(chunk)
-      messages = {}
-      chunk.msgpack_each do |tag, time, record|
-        channel = build_channel(record)
-        messages[channel] ||= ''
-        messages[channel] << "#{build_message(record)}\n"
-      end
-      messages.map do |channel, text|
-        {
-          channel: channel,
-          text:    text,
-        }.merge(common_payload)
-      end
-    end
-
-    def build_message(record)
-      values = fetch_keys(record, @message_keys)
-      @message % values
-    end
-
-    def build_title(record)
-      return @title unless @title_keys
-
-      values = fetch_keys(record, @title_keys)
-      @title % values
-    end
-
-    def build_channel(record)
-      return @channel unless @channel_keys
-
-      values = fetch_keys(record, @channel_keys)
-      @channel % values
-    end
-
-    def fetch_keys(record, keys)
-      Array(keys).map do |key|
-        begin
-          record.fetch(key).to_s
-        rescue KeyError
-          log.warn "out_slack: the specified key '#{key}' not found in record. [#{record}]"
-          ''
-        end
-      end
-    end
-  end
-end