logstash-output-slack 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd002e773f901f0e19f59cc7470426916b1df532
-  data.tar.gz: f2bb362492defe4a2e5fb67699baa1887cf239e9
+  metadata.gz: db23f70996dcdbc3878464c3c944aa6cd8fc08ae
+  data.tar.gz: d724aa6471b1dbbd4ce760ce3af7436ceeda6030
 SHA512:
-  metadata.gz: b2d83115a75c2c2439ac4f0d6f6a4f42cea987e3ee6b4a01355a6d462709feacd044f14778006d725967e51174d94b219403b0fd8b043e1408c2c0f09e661ee1
-  data.tar.gz: 0c17f282446caa837da74630205052315778a54192b00c2fd24f640c552d71778cd56599f207c39729f2c4ad9b8390737da174626aef35f8131f7e9b3b07b95a
+  metadata.gz: 3bf5d70cacabf2a886b520398d96b98565258e0b71afa631e36135c9173e128eba8866486f793f7c0d2fbb9b51e4b3c40d5895f14a4c3fade1e921990705a9ac
+  data.tar.gz: 3d258583fbd011a8c3637cee468c01304f4f4ce19187656dfb55f59ff5d5e485a78e7d905c1860c4679c5e11d7ef3729abca91d631b927cd139f4edda50b234a

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
+  - jruby 1.7.21
   - jruby-head
 
 jdk:
+  - openjdk6
   - openjdk7
   - oraclejdk7
   - oraclejdk8
@@ -12,3 +14,11 @@ script: bundle exec rspec spec
 
 notifications:
   email: false
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-head
+  exclude:
+    - rvm: jruby-head
+      jdk: openjdk6

data/README.md

@@ -1,5 +1,7 @@
 [![Build Status](https://travis-ci.org/cyli/logstash-output-slack.svg?branch=master)](https://travis-ci.org/cyli/logstash-output-slack)
 
+Reviews of the code/contributions are very welcome (particularly with testing!), since I don't really know Ruby.
+
 ## Logstash Slack Output Plugin
 
 Uses Slack [incoming webhooks API](https://api.slack.com/incoming-webhooks) to send log events to Slack.
@@ -30,23 +32,32 @@ output {
 
 Not supported yet: attachments
 
+### Changelog:
+- v 0.1.1:
+    - Added variable expansion to usernames and channel names ([#6](https://github.com/cyli/logstash-output-slack/pull/6))
+    - Fixed bug when reporting malformed requests ([#3](https://github.com/cyli/logstash-output-slack/pull/3))
+    - Test fixes since newer versions of logstash-core expects the values in
+        the `add_field` hash to not be integers.
+- v 0.1.0:
+    - initial version containing basic slack functionality
+
 ### Installation on Logstash >= 1.5
 
-In the logstash directory, run:  `bin/plugin install logstash-output-slack`
+In the logstash directory, run:  `bin/plugin install logstash-output-slack`, which will download and install the public gem.
 
 #### To build your own gem and install:
 
 1. `git clone <thisrepo>`
 1. `bundle install`
 1. `gem build logstash-output-slack.gemspec`
+1. `cd <path to logstash>`
+1. `logstash>1.5.0`: `bin/plugin install <path-to-your-built-gem>`
 
-You should just be able to do `bin/plugin install <path-to-your-built-gem>`, but due to [this bug](https://github.com/elastic/logstash/issues/2674) installing from a local gem doesn't work right now.
-
-You need to:
+    On `logstash==1.5.0`, due to [this bug](https://github.com/elastic/logstash/issues/2674), installing from a local gem doesn't work right now. You will need to:
 
-1. Make sure that the `logstash-core` gem you've installed matches the exact beta 1.5 logstash version you are running.
-1. modify the logstash Gemfile to include the line `gem "logstash-output-slack", :path => <path_to_the_directory_your_gem_is_in>`
-1. `bin/plugin install --no-verify`
+    1. Make sure that the `logstash-core` gem you've installed matches the exact beta 1.5 logstash version you are running.
+    1. modify the logstash Gemfile to include the line `gem "logstash-output-slack", :path => <path_to_the_directory_your_gem_is_in>`
+    1. `bin/plugin install --no-verify`
 
 #### Verify that the plugin installed correctly
 `bin/plugin list | grep logstash-output-slack`

data/lib/logstash/outputs/slack.rb

@@ -42,11 +42,11 @@ class LogStash::Outputs::Slack < LogStash::Outputs::Base
     payload_json['text'] = event.sprintf(@format)
 
     if not @channel.nil?
-      payload_json['channel'] = @channel
+      payload_json['channel'] = event.sprintf(@channel)
     end
 
     if not @username.nil?
-      payload_json['username'] = @username
+      payload_json['username'] = event.sprintf(@username)
     end
 
     if not @icon_emoji.nil?
@@ -66,7 +66,7 @@ class LogStash::Outputs::Slack < LogStash::Outputs::Base
         :'User-Agent' => "logstash-output-slack",
         :content_type => @content_type) { |response, request, result, &block|
           if response.code != 200
-            @logger.warn("Got a #{response.code} result: " + result)
+            @logger.warn("Got a #{response.code} response: #{response}")
           end
         }
     rescue Exception => e

data/logstash-output-slack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-slack'
-  s.version         = '0.1.0'
+  s.version         = '0.1.1'
   s.licenses        = ['MIT','Apache License (2.0)']
   s.summary         = "Write events to Slack"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/outputs/slack_spec.rb

@@ -18,11 +18,13 @@ describe LogStash::Outputs::Slack do
   CONFIG
   end
 
-  let(:long_config) do <<-CONFIG
+  let(:long_formatted_config) do <<-CONFIG
       input {
         generator {
           message => "This message should show in slack"
-          add_field => {"extra" => 3}
+          add_field => {"x" => "3"
+                        "channelname" => "mychannel"
+                        "username" => "slackbot"}
           count => 1
         }
       }
@@ -30,7 +32,28 @@ describe LogStash::Outputs::Slack do
       output {
         slack {
           url => "http://requestb.in/r9lkbzr9"
-          format => "%{message} %{extra}"
+          format => "%{message} %{x}"
+          channel => "%{channelname}"
+          username => "%{username}"
+          icon_emoji => ":chart_with_upwards_trend:"
+          icon_url => "http://lorempixel.com/48/48"
+        }
+      }
+  CONFIG
+  end
+
+  let(:long_unformatted_config) do <<-CONFIG
+      input {
+        generator {
+          message => "This message should not show in slack"
+          count => 1
+        }
+      }
+
+      output {
+        slack {
+          url => "http://requestb.in/r9lkbzr9"
+          format => "Unformatted message"
           channel => "mychannel"
           username => "slackbot"
           icon_emoji => ":chart_with_upwards_trend:"
@@ -71,7 +94,7 @@ describe LogStash::Outputs::Slack do
         to have_been_made.once
     end
 
-    it "uses all provided values" do
+    it "uses and formats all provided values" do
       stub_request(:post, "requestb.in").
         to_return(:body => "", :status => 200,
                   :headers => { 'Content-Length' => 0 })
@@ -84,7 +107,7 @@ describe LogStash::Outputs::Slack do
         :icon_url => "http://lorempixel.com/48/48"
       }
 
-      LogStash::Pipeline.new(long_config).run
+      LogStash::Pipeline.new(long_formatted_config).run
 
       expect(a_request(:post, "http://requestb.in/r9lkbzr9").
         with(:body => "payload=#{CGI.escape(JSON.dump(expected_json))}",
@@ -96,5 +119,29 @@ describe LogStash::Outputs::Slack do
         to have_been_made.once
     end
 
+    it "uses and formats all provided values" do
+      stub_request(:post, "requestb.in").
+        to_return(:body => "", :status => 200,
+                  :headers => { 'Content-Length' => 0 })
+
+      expected_json = {
+        :text => "Unformatted message",
+        :channel => "mychannel",
+        :username => "slackbot",
+        :icon_emoji => ":chart_with_upwards_trend:",
+        :icon_url => "http://lorempixel.com/48/48"
+      }
+
+      LogStash::Pipeline.new(long_unformatted_config).run
+
+      expect(a_request(:post, "http://requestb.in/r9lkbzr9").
+        with(:body => "payload=#{CGI.escape(JSON.dump(expected_json))}",
+             :headers => {
+                'Content-Type' => 'application/x-www-form-urlencoded',
+                'Accept'=> 'application/json',
+                'User-Agent' => 'logstash-output-slack'
+                })).
+        to have_been_made.once
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-slack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ying Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - jar 'org.elasticsearch:elasticsearch', '1.4.0'
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Write events to Slack