logstash-output-slack 0.1.3-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd3c670f33b5ba013a83424124e67d81d900f25e
+  data.tar.gz: a3f3f12a1e8f3eb72fadb2453e2dbbaa65125ae2
+SHA512:
+  metadata.gz: 024147cb302af44aca271029fabdb370b8ea5da971480d18343c9bd9920765bc2733309f431557669cb5e917a8ecc0c182cd5aaafa065ec9e48895fa619d195b
+  data.tar.gz: 5f25d2476832654a7e115a9bd64bd7d58473223699d81dfda9a712c85d98f432471f120759afae6958c0df3c34a23825d8194b94b15df9896eed309b13aef9e7

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+Gemfile.lock
+.ruby-version
+.bundle
+vendor
+lib/com
+lib/logstash-output-slack_jars.rb
+lib/org

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+cache: bundler
+rvm:
+  - jruby 1.7.21
+  - jruby-head
+
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+
+script: bundle exec rspec spec
+
+notifications:
+  email: false
+
+matrix:
+  fast_finish: true
+  exclude:
+    - rvm: jruby-head
+      jdk: openjdk6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+[![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.
+
+Usage:
+
+```
+input {
+    ...
+}
+
+filters {
+    ...
+}
+
+output {
+    ...
+    slack {
+        url => <YOUR SLACK WEBHOOK URL HERE>
+        channel => [channel-name - optional]
+        username => [slack username - optional]
+        icon_emoji => [emoji, something like ":simple_smile:" - optional]
+        icon_url => [icon url, would be overriden by icon_emoji - optional]
+        format => [default is "%{message}", but used to format the text - optional]
+        attachments => [an array of attachment maps as specified by the slack API - optional; if there is an "attachments" field in the event map and it is valid, it will override what is configured here, even if it's empty]
+    }
+}
+```
+
+### Changelog:
+- [v0.1.2](https://github.com/cyli/logstash-output-slack/releases/tag/v0.1.2):
+    - Added support for attachments
+- [v0.1.1](https://github.com/cyli/logstash-output-slack/releases/tag/v0.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.
+- [v0.1.0](https://github.com/cyli/logstash-output-slack/releases/tag/v0.1.0):
+    - initial version containing basic slack functionality
+
+### Installation on Logstash >= 1.5
+
+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>`
+
+    On `logstash==1.5.0`, due to [this bug](https://github.com/elastic/logstash/issues/2674), installing from a local gem doesn't work. 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`
+
+#### Verify that the plugin installed correctly
+`bin/plugin list | grep logstash-output-slack`
+
+#### Test that it works:
+```
+bin/logstash -e '
+input { stdin {} }
+output { slack { <your slack config here> }}'
+```
+
+And type some text in.  The same text should appear in the channel it's configured to go in.
+
+### Installation on Logstash < 1.5
+
+Gem-installing this plugin would only work on Logstash 1.5.  For Logstash < 1.5, you could just rename `lib` in this repo to `logstash`, and then run Logstash with `--pluginpath <path_to_this_repo>.
+
+See the [flags](http://logstash.net/docs/1.4.2/flags) documentation for Logstash 1.4.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/outputs/slack.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+class LogStash::Outputs::Slack < LogStash::Outputs::Base
+  config_name "slack"
+  milestone 1
+
+  # The incoming webhook URI needed to post a message
+  config :url, :validate => :string, :required => true
+
+  # The text to post in slack
+  config :format, :validate => :string, :default => "%{message}"
+
+  # The channel to post to
+  config :channel, :validate => :string
+
+  # The username to use for posting
+  config :username, :validate => :string
+
+  # Emoji icon to use
+  config :icon_emoji, :validate => :string
+
+  # Icon URL to use
+  config :icon_url, :validate => :string
+
+  # Attachments array as described https://api.slack.com/docs/attachments
+  config :attachments, :validate => :array
+
+  public
+  def register
+    require 'rest-client'
+    require 'cgi'
+    require 'json'
+
+    @content_type = "application/x-www-form-urlencoded"
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    payload_json = Hash.new
+    payload_json['text'] = event.sprintf(@format)
+
+    if not @channel.nil?
+      payload_json['channel'] = event.sprintf(@channel)
+    end
+
+    if not @username.nil?
+      payload_json['username'] = event.sprintf(@username)
+    end
+
+    if not @icon_emoji.nil?
+      payload_json['icon_emoji'] = @icon_emoji
+    end
+
+    if not @icon_url.nil?
+      payload_json['icon_url'] = @icon_url
+    end
+
+    if @attachments and @attachments.any?
+      payload_json['attachments'] = @attachments
+    end
+    if event.include?('attachments') and event['attachments'].is_a?(Array)
+      if event['attachments'].any?
+        # need to convert possibly from Java objects to Ruby Array, because
+        # JSON dumps does not work well with Java ArrayLists, etc.
+        rubified = JSON.parse(event.to_json())
+        payload_json['attachments'] = rubified['attachments']
+      else
+        payload_json.delete('attachments')
+      end
+    end
+
+    begin
+      RestClient.post(
+        @url,
+        "payload=#{CGI.escape(JSON.dump(payload_json))}",
+        :accept => "application/json",
+        :'User-Agent' => "logstash-output-slack",
+        :content_type => @content_type) { |response, request, result, &block|
+          if response.code != 200
+            @logger.warn("Got a #{response.code} response: #{response}")
+          end
+        }
+    rescue Exception => e
+      @logger.warn("Unhandled exception", :exception => e,
+                   :stacktrace => e.backtrace)
+    end
+  end # def receive
+end # class LogStash::Outputs::Slack

data/logstash-output-slack.gemspec

@@ -0,0 +1,40 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-slack'
+  s.version         = '0.1.3'
+  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"
+  s.authors         = ["Ying Li"]
+  s.email           = 'cyli@ying.com'
+  s.homepage        = "https://github.com/cyli/logstash-output-slack"
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+
+  # logstash-core > 2.0.0.snapshot3 requires jrjackson ~> 0.3.5, which requires
+  # JDK7.
+  core_upper_bound = "~> 2.0.0.snapshot3"
+  if RUBY_PLATFORM == 'java'
+    s.platform        = RUBY_PLATFORM
+    if java.lang.System.get_property('java.version') < "1.7"   # JDK6
+      core_upper_bound = "<= 2.0.0.snapshot3"
+    end
+  end
+
+  s.add_runtime_dependency "logstash-core", core_upper_bound, ">= 1.4.0"
+  s.add_runtime_dependency "logstash-codec-plain", "~> 2.0.0", ">= 1.0.0"
+  s.add_runtime_dependency "rest-client", '~> 1.8', ">= 1.8.0"
+  s.add_development_dependency "logstash-devutils", "~> 0.0.16"
+  s.add_development_dependency "logstash-filter-json", "~> 2.0.1", ">= 1.0.1"
+  s.add_development_dependency "logstash-input-generator", "~> 2.0.1", ">= 1.0.0"
+  s.add_development_dependency "webmock", "~> 1.22", ">= 1.21.0"
+end

data/spec/outputs/slack_spec.rb

@@ -0,0 +1,296 @@
+require_relative "../spec_helper"
+
+describe LogStash::Outputs::Slack do
+
+  # Actually do most of the boiler plate by stubbing out the request, running
+  # the logstash pipeline, and asserting that a request was made with the
+  # expected JSON.
+  def test_one_event(logstash_config, expected_json)
+    stub_request(:post, "requestb.in").
+      to_return(:body => "", :status => 200,
+                :headers => { 'Content-Length' => 0 })
+
+    LogStash::Pipeline.new(logstash_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
+
+  before do
+    WebMock.disable_net_connect!
+  end
+
+  after do
+    WebMock.reset!
+    WebMock.allow_net_connect!
+  end
+
+  context "passes the right payload to slack and" do
+    it "uses all default values" do
+      expected_json = {
+        :text => "This message should show in slack"
+      }
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "uses and formats all provided values" do
+      expected_json = {
+        :text => "This message should show in slack 3",
+        :channel => "mychannel",
+        :username => "slackbot",
+        :icon_emoji => ":chart_with_upwards_trend:",
+        :icon_url => "http://lorempixel.com/48/48"
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              add_field => {"x" => "3"
+                            "channelname" => "mychannel"
+                            "username" => "slackbot"}
+              count => 1
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              format => "%{message} %{x}"
+              channel => "%{channelname}"
+              username => "%{username}"
+              icon_emoji => ":chart_with_upwards_trend:"
+              icon_url => "http://lorempixel.com/48/48"
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "uses and formats all provided values" do
+      expected_json = {
+        :text => "Unformatted message",
+        :channel => "mychannel",
+        :username => "slackbot",
+        :icon_emoji => ":chart_with_upwards_trend:",
+        :icon_url => "http://lorempixel.com/48/48"
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should 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:"
+              icon_url => "http://lorempixel.com/48/48"
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "uses the default attachments if none are in the event" do
+      expected_json = {
+        :text => "This message should show in slack",
+        :attachments => [{:image_url => "http://example.com/image.png"}]
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => [
+                {image_url => "http://example.com/image.png"}
+              ]
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "supports multiple default attachments" do
+      expected_json = {
+        :text => "This message should show in slack",
+        :attachments => [{:image_url => "http://example.com/image1.png"},
+                         {:image_url => "http://example.com/image2.png"}]
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => [
+                {image_url => "http://example.com/image1.png"},
+                {image_url => "http://example.com/image2.png"}
+              ]
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "ignores empty default attachments" do
+      expected_json = {
+        :text => "This message should show in slack"
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => []
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "uses event attachments over default attachments" do
+      expected_json = {
+        :text => "This message should show in slack",
+        :attachments => [{:thumb_url => "http://other.com/thumb.png"}]
+      }
+
+      # add_field only takes string values, so we'll have to mutate to JSON
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+              add_field => {
+                attachments => '[{"thumb_url": "http://other.com/thumb.png"}]'
+              }
+            }
+          }
+          filter {
+            json {
+              source => "attachments"
+              target => "attachments"
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => [
+                {image_url => "http://example.com/image1.png"},
+                {image_url => "http://example.com/image2.png"}
+              ]
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "erases default attachments if event attachments empty" do
+      expected_json = {
+        :text => "This message should show in slack"
+      }
+
+      # add_field only takes string values, so we'll have to mutate to JSON
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+              add_field => {attachments => '[]'}
+            }
+          }
+          filter {
+            json {
+              source => "attachments"
+              target => "attachments"
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => [
+                {image_url => "http://example.com/image1.png"},
+                {image_url => "http://example.com/image2.png"}
+              ]
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+
+    it "ignores event attachment if not array" do
+      expected_json = {
+        :text => "This message should show in slack",
+        :attachments => [{:image_url => "http://example.com/image.png"}]
+      }
+
+      logstash_config = <<-CONFIG
+          input {
+            generator {
+              message => "This message should show in slack"
+              count => 1
+              add_field => {attachments => "baddata"}
+            }
+          }
+          output {
+            slack {
+              url => "http://requestb.in/r9lkbzr9"
+              attachments => [
+                {image_url => "http://example.com/image.png"}
+              ]
+            }
+          }
+      CONFIG
+
+      test_one_event(logstash_config, expected_json)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/slack"
+require 'webmock/rspec'

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: java
+authors:
+- Ying Li
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot3
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot3
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  name: rest-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  name: logstash-filter-json
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  name: logstash-input-generator
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  name: webmock
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+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
+email: cyli@ying.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/logstash/outputs/slack.rb
+- logstash-output-slack.gemspec
+- spec/outputs/slack_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cyli/logstash-output-slack
+licenses:
+- MIT
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Write events to Slack
+test_files:
+- spec/outputs/slack_spec.rb
+- spec/spec_helper.rb