logstash-output-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd002e773f901f0e19f59cc7470426916b1df532
+  data.tar.gz: f2bb362492defe4a2e5fb67699baa1887cf239e9
+SHA512:
+  metadata.gz: b2d83115a75c2c2439ac4f0d6f6a4f42cea987e3ee6b4a01355a6d462709feacd044f14778006d725967e51174d94b219403b0fd8b043e1408c2c0f09e661ee1
+  data.tar.gz: 0c17f282446caa837da74630205052315778a54192b00c2fd24f640c552d71778cd56599f207c39729f2c4ad9b8390737da174626aef35f8131f7e9b3b07b95a

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,14 @@
+language: ruby
+cache: bundler
+rvm:
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+
+script: bundle exec rspec spec
+
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+[![Build Status](https://travis-ci.org/cyli/logstash-output-slack.svg?branch=master)](https://travis-ci.org/cyli/logstash-output-slack)
+
+## 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 - this is optional]
+        username => [slack username - this is 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]
+    }
+}
+```
+
+Not supported yet: attachments
+
+### Installation on Logstash >= 1.5
+
+In the logstash directory, run:  `bin/plugin install logstash-output-slack`
+
+#### To build your own gem and install:
+
+1. `git clone <thisrepo>`
+1. `bundle install`
+1. `gem build logstash-output-slack.gemspec`
+
+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:
+
+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.4
+
+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,77 @@
+# 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
+
+
+  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'] = @channel
+    end
+
+    if not @username.nil?
+      payload_json['username'] = @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
+
+
+    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} result: " + result)
+          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,31 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-slack'
+  s.version         = '0.1.0'
+  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@twistedmatrix.com'
+  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
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 2.0.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "logstash-devutils"
+  s.add_development_dependency "logstash-input-generator"
+  s.add_development_dependency "webmock"
+
+  # Jar dependencies
+  s.requirements << "jar 'org.elasticsearch:elasticsearch', '1.4.0'"
+  s.add_runtime_dependency "jar-dependencies", ">= 0.1.7"
+end

data/spec/outputs/slack_spec.rb

@@ -0,0 +1,100 @@
+require_relative "../spec_helper"
+
+describe LogStash::Outputs::Slack do
+
+  let(:short_config) do <<-CONFIG
+      input {
+        generator {
+          message => "This message should show in slack"
+          count => 1
+        }
+      }
+
+      output {
+        slack {
+          url => "http://requestb.in/r9lkbzr9"
+        }
+      }
+  CONFIG
+  end
+
+  let(:long_config) do <<-CONFIG
+      input {
+        generator {
+          message => "This message should show in slack"
+          add_field => {"extra" => 3}
+          count => 1
+        }
+      }
+
+      output {
+        slack {
+          url => "http://requestb.in/r9lkbzr9"
+          format => "%{message} %{extra}"
+          channel => "mychannel"
+          username => "slackbot"
+          icon_emoji => ":chart_with_upwards_trend:"
+          icon_url => "http://lorempixel.com/48/48"
+        }
+      }
+  CONFIG
+  end
+
+  before do
+    WebMock.disable_net_connect!
+  end
+
+  after do
+    WebMock.reset!
+    WebMock.allow_net_connect!
+  end
+
+  context "passes the right payload to slack" do
+    it "uses all default values" do
+      stub_request(:post, "requestb.in").
+        to_return(:body => "", :status => 200,
+                  :headers => { 'Content-Length' => 0 })
+
+      expected_json = {
+        :text => "This message should show in slack"
+      }
+
+      LogStash::Pipeline.new(short_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
+
+    it "uses all provided values" do
+      stub_request(:post, "requestb.in").
+        to_return(:body => "", :status => 200,
+                  :headers => { 'Content-Length' => 0 })
+
+      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::Pipeline.new(long_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

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,162 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ying Li
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: logstash-input-generator
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: webmock
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: jar-dependencies
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  prerelease: false
+  type: :runtime
+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@twistedmatrix.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:
+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:
+- jar 'org.elasticsearch:elasticsearch', '1.4.0'
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Write events to Slack
+test_files:
+- spec/outputs/slack_spec.rb
+- spec/spec_helper.rb