logstash-2-output-rollbar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b45676b5a27b208fa6d01f2aa8cbd3527fc0c9f0
+  data.tar.gz: f1d3afcb82dfeccec29e3c1f6bc0d5d0b9182536
+SHA512:
+  metadata.gz: 38191a668bec7f8ce0fb7f9719291f306d21ea8a0e38e3840a1fad6929e35ed422403e261fef224ddf5dad761697b081d15b684ba06e6a2c26bcd459d5d88a86
+  data.tar.gz: 8e07e5cca818eb7fe38aa46378e9c4773ef39171ff1fb092eff5dd79bf3263e044cfd8857fcf95974be01c8f5de8b8506275560ea64c491f5b03f50b685aee33

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+vendor

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.25

data/CONTRIBUTORS

@@ -0,0 +1,15 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Colin Surprenant (colinsurprenant)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Kurt Hurtado (kurtado)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    logstash-2-output-rollbar (0.1.0)
+      logstash-core-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cabin (0.8.1)
+    clamp (0.6.5)
+    coderay (1.1.1)
+    concurrent-ruby (0.9.2-java)
+    diff-lcs (1.2.5)
+    ffi (1.9.12)
+    filesize (0.0.4)
+    fivemat (1.3.2)
+    gem_publisher (1.5.0)
+    gems (0.8.3)
+    i18n (0.6.9)
+    insist (1.0.0)
+    jrjackson (0.3.9-java)
+    jruby-openssl (0.9.13-java)
+    kramdown (1.11.1)
+    logstash-core (2.3.4.snapshot1-java)
+      cabin (~> 0.8.0)
+      clamp (~> 0.6.5)
+      concurrent-ruby (= 0.9.2)
+      filesize (= 0.0.4)
+      gems (~> 0.8.3)
+      i18n (= 0.6.9)
+      jrjackson (~> 0.3.7)
+      jruby-openssl (= 0.9.13)
+      logstash-core-event (= 2.3.4.snapshot1)
+      minitar (~> 0.5.4)
+      pry (~> 0.10.1)
+      rubyzip (~> 1.1.7)
+      stud (~> 0.0.19)
+      thread_safe (~> 0.3.5)
+      treetop (< 1.5.0)
+    logstash-core-event (2.3.4.snapshot1-java)
+    logstash-core-plugin-api (1.19.0-java)
+      logstash-core (>= 2.0.0, <= 2.3.4.snapshot1)
+    logstash-devutils (0.0.19-java)
+      fivemat
+      gem_publisher
+      insist (= 1.0.0)
+      kramdown
+      minitar
+      rake
+      rspec (~> 3.1.0)
+      rspec-wait
+      stud (>= 0.0.20)
+    method_source (0.8.2)
+    minitar (0.5.4)
+    polyglot (0.3.5)
+    pry (0.10.3-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rake (11.2.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rspec-wait (0.0.8)
+      rspec (>= 2.11, < 3.5)
+    rubyzip (1.1.7)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+    stud (0.0.22)
+    thread_safe (0.3.5-java)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  logstash-2-output-rollbar!
+  logstash-devutils
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash) that sends events to the [Rollbar](https://www.rollbar.com) error monitoring service.
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

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

data/lib/logstash/outputs/rollbar.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "json"
+
+# The Rollbar output will send events to the Rollbar event monitoring service.
+# The only required field is a Rollbar project access token with post_server_item
+# permissions. If you're already using Rollbar to report errors directly from your
+# applications, you can use the same token.
+class LogStash::Outputs::Rollbar < LogStash::Outputs::Base
+  config_name "rollbar"
+
+  # Each of these config values can be specified in the plugin configuration section, in which
+  # case they'll apply to all events, or you can override them on an event by event basis.
+  #
+  # Your default Rollbar access token. You can override this for a specific event by adding
+  # a "[rollbar][access_token]" field to that event
+  config :access_token, :validate => :password, :required => true
+
+  # The default Rollbar environment. You can override this for a specific event by adding
+  # a "[rollbar][environment]" field to that event
+  config :environment, :validate => :string, :default => 'production'
+
+  # The default level for Rollbar events (info, warning, error) You can override this for a specific
+  # event by adding a "[rollbar][level]" field to that event
+  config :level, :validate => ['debug', 'info', 'warning', 'error', 'critical'] , :default => 'info'
+
+  # The default format for the Rollbar "message" or item title. In most cases you'll want to override
+  # this and build up a message with specific fields from the event. You can override this for a specific
+  # event by adding a "[rollbar][format]" field to that event.
+  config :format, :validate => :string, :default => "%{message}"
+
+  # Rollbar API URL endpoint. You shouldn't need to change this.
+  config :endpoint, :validate => :string, :default => 'https://api.rollbar.com/api/1/item/'
+
+  def hash_recursive
+    Hash.new do |hash, key|
+      hash[key] = hash_recursive
+    end
+  end
+
+  public
+  def register
+    require 'net/https'
+    require 'uri'
+    @rb_uri = URI.parse(@endpoint)
+    @client = Net::HTTP.new(@rb_uri.host, @rb_uri.port)
+    if @rb_uri.scheme == "https"
+      @client.use_ssl = true
+      @client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    rb_item = hash_recursive
+
+    # We'll want to remove fields from data without removing them from the original event
+    data = JSON.parse(event.to_json)
+
+    #
+    # If logstash has created 'rollbar' fields, we'll use those to populate the item...
+    #
+    if data['rollbar']
+
+      merge_keys = %w{access_token client context environment fingerprint format framework
+                      language level person platform request server title uuid }
+      merge_keys.each do |key|
+        data['rollbar'][key] && rb_item['data'][key] = data['rollbar'][key]
+      end
+      data.delete('rollbar')
+    end
+
+    # ...then put whatever's left in 'custom'...
+    rb_item['data']['custom'] = data
+
+    # ...and finally override the fields that have a specific meaning
+    rb_item['data']['timestamp'] = event.timestamp.to_i
+    rb_item['data']['level'] = @level unless rb_item['data'].has_key?('level')
+    rb_item['data']['environment'] = @environment unless rb_item['data'].has_key?('environment')
+
+    rb_item['data']['notifier']['name'] = 'logstash'
+    rb_item['data']['notifier']['version'] = Gem.loaded_specs["logstash-2-output-rollbar"].version
+
+    # Construct the message body using either:
+    #
+    # - The default format string defined above "%{message}"
+    # - The format string specified in the rollbar plugin config section
+    # - The format string specified in the [rollbar][format] event field
+    #
+    format = rb_item['data'].has_key?('format') ? rb_item['data']['format'] : @format
+    rb_item['data']['body']['message']['body'] = event.sprintf(format)
+
+    # Treat the [rollbar][access_token] field as a special case, since we don't need to
+    # include it more than once in the Rollbar item
+    #
+    if rb_item['data'].has_key?('access_token')
+      rb_item['access_token'] = rb_item['data']['access_token']
+      rb_item['data'].delete('access_token')
+    else
+      rb_item['access_token'] = @access_token.value
+    end
+
+
+    @logger.debug("Rollbar Item", :rb_item => rb_item)
+
+    begin
+      request = Net::HTTP::Post.new(@rb_uri.path)
+      request.body = JSON.dump(rb_item)
+      @logger.debug("Rollbar Request", :request => request.body)
+      response = @client.request(request)
+      @logger.debug("Rollbar Response", :response => response.body)
+
+    rescue Exception => e
+      @logger.warn("Rollbar Exception", :rb_error => e.backtrace)
+    end
+  end # def receive
+end # class LogStash::Outputs::Rollbar

data/logstash-2-output-rollbar.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = "logstash-2-output-rollbar"
+  s.version         = "0.1.0"
+  s.licenses        = ["Apache License (2.0)"]
+  s.summary         = "The Rollbar Logstash output sends events to the Rollbar error monitoring service."
+  s.description     = "This gem is a logstash plugin. Install using: $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Rollbar", "Filip Tepper"]
+  s.email           = "support@rollbar.com"
+  s.homepage        = "https://github.com/filiptepper/logstash-2-output-rollbar"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob("vendor/*")
+
+  # 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-plugin-api", "~> 1.0"
+  s.add_development_dependency "logstash-devutils"
+end
+

data/spec/outputs/rollbar_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: logstash-2-output-rollbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rollbar
+- Filip Tepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This gem is a logstash plugin. Install using: $LS_HOME/bin/plugin install
+  gemname. This gem is not a stand-alone program'
+email: support@rollbar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CONTRIBUTORS
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/outputs/rollbar.rb
+- logstash-2-output-rollbar.gemspec
+- spec/outputs/rollbar_spec.rb
+homepage: https://github.com/filiptepper/logstash-2-output-rollbar
+licenses:
+- 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: The Rollbar Logstash output sends events to the Rollbar error monitoring service.
+test_files:
+- spec/outputs/rollbar_spec.rb