honeybadger 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2222a4433ac78457a32df416c829a8e0723a7a4e
-  data.tar.gz: 2b86c78e7f197cb536bc113b0f529fbe1c8922f4
+  metadata.gz: d602a9205496510494a04ef272fd244394280071
+  data.tar.gz: a2a9ef904df4c7aae69a2a5ecd7aedcf520ebd81
 SHA512:
-  metadata.gz: 5df00423284aa557dcf82df4d6e951e63fe0c4cd1c1cd019332c03f5b60cccaab0169e39692e40369ba4e5a5d01c145f4abd740ecce2f6b609c83a55c94cee90
-  data.tar.gz: 052aab1703d0ab8895754725423791079bf675ca274442b8b5ba475bc8b28b5a7febe13906c1eed7bd946a427b8646dd36675e36b5a0f2d6335918e6eabf5921
+  metadata.gz: 4f437187a727ce3cc61542e0df3a64dbd7e0af43fcee10e8346a9476f0a78f1a50225a0a3e3861090f5de16e33362c2f7bcc4e3c5ee13da0bab780abab5cffb9
+  data.tar.gz: 84a063b994896e85b8a10024b60cb79674e6d904ffcdb3412445afdf4d549d85a6885ad294f6cc3c8f36f93f6ba927b6ab9e3ff76222d422dfe9c0c62d067771

data/CHANGELOG.md

@@ -5,6 +5,17 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [2.6.1] - 2016-08-24
+### Added
+- shoryuken plugin. -@ivanvc
+
+### Fixed
+- Handle `Errno::ENETUNREACH` error when contacting server. -@tank-bohr
+- Remove `ActionDispatch::Http::Headers` from trace payload (fixes `IOError`
+  when JSON encoding traces in Rails 5).
+- Fix "`invoke("git:set_current_revision")` already invoked" warning in
+  Capistrano 3.6.
+
 ## [2.6.0] - 2016-04-22
 ### Added
 - Automatically report unhandled exceptions at exit.

data/README.md

@@ -1,7 +1,5 @@
 # Honeybadger for Ruby
 
-[![Code Climate](https://codeclimate.com/github/honeybadger-io/honeybadger-ruby/badges/gpa.svg)](https://codeclimate.com/github/honeybadger-io/honeybadger-ruby)
-[![Test Coverage](https://codeclimate.com/github/honeybadger-io/honeybadger-ruby/badges/coverage.svg)](https://codeclimate.com/github/honeybadger-io/honeybadger-ruby)
 [![Build Status](https://secure.travis-ci.org/honeybadger-io/honeybadger-ruby.png?branch=master)](http://travis-ci.org/honeybadger-io/honeybadger-ruby)
 [![Gem Version](https://badge.fury.io/rb/honeybadger.png)](http://badge.fury.io/rb/honeybadger)
 
@@ -21,7 +19,7 @@ When an uncaught exception occurs, Honeybadger will POST the relevant data to th
 
 | Framework     | Version       | Native?    |
 | ------------- | ------------- |------------|
-| Rails         | >= 3.0        | yes        |
+| Rails         | >= 3.2        | yes        |
 | Sinatra       | >= 1.2.1      | yes        |
 | Rack          | >= 1.0        | middleware |
 
@@ -262,7 +260,7 @@ You can use any of the options below in your config file, or in the environment.
 |`feedback.enabled`               | Boolean | Enable the UserFeedback middleware. Feedback displays a comment form to your-end user when they encounter an error. When the user creates a comment, it is added to the error in Honeybadger, and a notification is sent.  [Learn More](http://docs.honeybadger.io/article/166-how-to-implement-a-custom-feedback-form)<br/>_Default: `true`_|
 |&nbsp;                           |         ||
 |__EXCEPTION REPORTING__          |         ||
-|`exceptions.ignore`              | Array   | A list of exception class names to ignore (appends to defaults).<br/>_Default: `['ActiveRecord::RecordNotFound', 'ActionController::RoutingError', 'ActionController::InvalidAuthenticityToken', 'CGI::Session::CookieStore::TamperedWithCookie', 'ActionController::UnknownAction', 'AbstractController::ActionNotFound', 'Mongoid::Errors::DocumentNotFound Sinatra::NotFound']`_|
+|`exceptions.ignore`              | Array   | A list of exception class names to ignore (appends to defaults).<br/>_Default: `['ActionController::RoutingError', 'AbstractController::ActionNotFound', 'ActionController::MethodNotAllowed', 'ActionController::UnknownHttpMethod', 'ActionController::NotImplemented', 'ActionController::UnknownFormat', 'ActionController::InvalidAuthenticityToken', 'ActionController::InvalidCrossOriginRequest', 'ActionDispatch::ParamsParser::ParseError', 'ActionController::BadRequest', 'ActionController::ParameterMissing', 'ActiveRecord::RecordNotFound', 'ActionController::UnknownAction', 'CGI::Session::CookieStore::TamperedWithCookie', 'Mongoid::Errors::DocumentNotFound', 'Sinatra::NotFound']`_|
 |`exceptions.ignore_only`         | Array   | A list of exception class names to ignore (overrides defaults).<br/>_Default: `[]`_|
 |`exceptions.` `ignored_user_agents` | Array   | A list of user agents to ignore.<br/>_Default: `[]`_|
 |`exceptions.rescue_rake`         | Boolean | Enable rescuing exceptions in rake tasks.<br/>_Default: `true` when run in background; `false` when run in terminal._|
@@ -295,13 +293,14 @@ You can use any of the options below in your config file, or in the environment.
 
 Sometimes, default exception data just isn't enough. If you have extra data that will help you in debugging, send it as part of an error's context. [View full method documentation](http://www.rubydoc.info/gems/honeybadger/Honeybadger%3Acontext)
 
+Global context is stored in a thread local variable and automatically reported with any exception which occurrs within the current thread's execution.
+
 #### Use this method if:
 
 * You want to record the current user's id at the time of an exception
 * You need to send raw POST data for use in debugging
 * You have any other metadata you'd like to send with an exception
 
-
 #### Examples:
 
 ```ruby
@@ -315,6 +314,7 @@ end
 # Clearing global context:
 Honeybadger.context.clear!
 ```
+
 ---
 
 
@@ -501,9 +501,10 @@ If you're adding a new feature, please [submit an issue](https://github.com/hone
 
 1. Fork it.
 2. Create a topic branch `git checkout -b my_branch`
-3. Commit your changes `git commit -am "Boom"`
-3. Push to your branch `git push origin my_branch`
-4. Send a [pull request](https://github.com/honeybadger-io/honeybadger-ruby/pulls)
+3. Make your changes and add an entry to the [CHANGELOG](CHANGELOG.md).
+4. Commit your changes `git commit -am "Boom"`
+5. Push to your branch `git push origin my_branch`
+6. Send a [pull request](https://github.com/honeybadger-io/honeybadger-ruby/pulls)
 
 ### Running the tests
 
@@ -511,8 +512,9 @@ We're using the [Appraisal](https://github.com/thoughtbot/appraisal) gem to run
 our [RSpec](https://www.relishapp.com/rspec/) test suite against multiple
 versions of [Rails](http://rubyonrails.org/).
 
-* The unit test suite can be run with `rake` (aliased to `rake spec:unit`).
+* The unit test suite can be run with `rake spec:units`.
 * The integration test suite can be run with `rake spec:features`.
+* The combined suite can be run with `rake`.
 
 ### License
 

data/TROUBLESHOOTING.md

@@ -0,0 +1,131 @@
+# Troubleshooting
+
+Common issues/workarounds are documented here. If you don't find a solution to
+your problem here or in our [support
+documentation](http://docs.honeybadger.io/), email support@honeybadger.io and
+one or all of our helpful founders will assist you!
+
+## Upgrade the gem
+
+Before digging deeper into this guide, **make sure you are on the latest minor
+release of the honeybadger gem** (i.e. 2.x.x). There's a chance you've found a bug
+which has already been fixed!
+
+## How to enable verbose logging
+
+Troubleshooting any of these issues will be much easier if you can see what's
+going on with Honeybadger when your app starts. To enable verbose debug logging,
+run your app with the `HONEYBADGER_DEBUG=true` environment variable or add the
+following to your *honeybadger.yml* file:
+
+```yml
+debug: true
+```
+
+By default Honeybadger will log to the default Rails logger or STDOUT outside of
+Rails. When debugging it can be helpful to have a dedicated log file for
+Honeybadger. To enable one, set the
+`HONEYBADGER_LOGGING_PATH=log/honeybadger.log` environment variable or add the
+following to your *honeybadger.yml* file:
+
+```yml
+logging:
+  path: 'log/honeybadger.log'
+```
+
+## Common Issues
+
+### My errors aren't being reported
+
+Error reporting may be disabled for several reasons:
+
+#### Honeybadger is not configured
+
+Honeybadger requires at minimum the `api_key` option to be set. If Honeybadger
+is unable to start due to invalid configuration, you should see something like
+the following in your logs:
+
+```
+** [Honeybadger] Unable to start Honeybadger -- api_key is missing or invalid. level=2 pid=18195
+```
+
+#### Honeybadger is in a development environment
+
+Errors are ignored by default in the "test", "development", and "cucumber"
+environments. To explicitly enable Honeybadger in a development environment, set
+the `HONEYBADGER_REPORT_DATA=true` environment variable or add the following
+configuration to *honeybadger.yml* file (change "development" to the name of the
+environment you want to enable):
+
+```yml
+development:
+  report_data: true
+```
+
+#### Is the error ignored by default?
+
+Honeybadger ignores [this list of
+exceptions](https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/config/defaults.rb#L7)
+by default.
+
+#### Is the error rescued without re-raising?
+
+Honeybadger will automatically report exceptions in many frameworks including
+Rails, Sinatra, Sidekiq, Rake, etc. For exceptions to reported automatically
+they must be raised; check for any `rescue` statements in your app where
+exceptions may be potentially silenced. In Rails, this includes any use of
+`rescue_from` which does not re-raise the exception.
+
+Errors which are handled in a `rescue` block without re-raising must be reported
+to Honeybadger manually:
+
+```ruby
+begin
+  fail 'This error will be handled internally.'
+rescue => e
+  Honeybadger.notify(e)
+end
+```
+
+#### Honeybadger is not started
+
+We currently initialize Rails and Sinatra apps automatically. If you use either
+of those frameworks and are not receiving error reports, then you probably have
+a different issue and should skip this section. For all other frameworks (or
+plain ol' Ruby), `Honeybadger.start()` must be called manually.
+
+To verify that Honeybadger is not started, [enable debug
+logging](#how-to-enable-verbose-logging) and then start your app; if Honeybadger
+was initialized, you should see something in the log output.
+
+```
+** [Honeybadger] Starting Honeybadger version 2.1.0 level=1 pid=18077
+```
+
+If you don't get any logs prefixed with "** [Honeybadger]", then you can start
+Honeybadger manually like this:
+
+```ruby
+honeybadger_config = Honeybadger::Config.new
+Honeybadger.start(honeybadger_config)
+```
+
+## Sidekiq/Resque/ActiveJob/etc.
+
+- See [Common Issues](#common-issues)
+
+### If the error is ignored by default
+
+Honeybadger ignores [this list of
+exceptions](https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/config/defaults.rb#L7)
+by default. It may be surprising that `ActiveRecord::RecordNotFound` is on that
+list; that's because in a Rails controller that error class is treated as a 404
+not-found and handled internally (and thus we shouldn't report it).  Support for
+Sidekiq and friends was added later and inherited the default. We would like to
+provide alternate defaults for job processors in the future, but for now you can
+provide your own list of ignored class names if you want to change this
+behavior:
+
+```
+HONEYBADGER_EXCEPTIONS_IGNORE_ONLY=Error,ClassNames,Here bundle exec sidekiq
+```

data/lib/honeybadger/agent.rb

@@ -34,7 +34,7 @@ module Honeybadger
 
     private
 
-    def self.load_plugins(config)
+    def self.load_plugins!(config)
       Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
         require plugin
       end
@@ -71,7 +71,7 @@ module Honeybadger
       end
 
       config.logger.info("Starting Honeybadger version #{VERSION}")
-      load_plugins(config)
+      load_plugins!(config)
       @instance = new(config)
 
       true

data/lib/honeybadger/backend/server.rb

@@ -20,11 +20,12 @@ module Honeybadger
       HTTP_ERRORS = [Timeout::Error,
                      Errno::EINVAL,
                      Errno::ECONNRESET,
+                     Errno::ECONNREFUSED,
+                     Errno::ENETUNREACH,
                      EOFError,
                      Net::HTTPBadResponse,
                      Net::HTTPHeaderSyntaxError,
                      Net::ProtocolError,
-                     Errno::ECONNREFUSED,
                      OpenSSL::SSL::SSLError,
                      SocketError].freeze
 

data/lib/honeybadger/config.rb

@@ -162,6 +162,8 @@ module Honeybadger
     def ca_bundle_path
       if self[:'connection.system_ssl_cert_chain'] && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
         OpenSSL::X509::DEFAULT_CERT_FILE
+      elsif self[:'connection.ssl_ca_bundle_path']
+        self[:'connection.ssl_ca_bundle_path']
       else
         local_cert_path
       end

data/lib/honeybadger/config/defaults.rb

@@ -136,6 +136,11 @@ module Honeybadger
         default: false,
         type: Boolean
       },
+      :'connection.ssl_ca_bundle_path' => {
+        description: 'Use this ca bundle when establishing secure connections.',
+        default: nil,
+        type: String
+      },
       :'connection.http_open_timeout' => {
         description: 'The HTTP open timeout when connecting to the server.',
         default: 2,

data/lib/honeybadger/notice.rb

@@ -461,6 +461,9 @@ module Honeybadger
     # doesn't exist in that object, it calls #session *again* on `nil`, which
     # also inherited it from Object, resulting in a SystemStackError.
     #
+    # See https://stackoverflow.com/questions/18202261/include-actiondispatchtestprocess-prevents-guard-from-reloading-properly
+    # for more info.
+    #
     # This method restores the correct #session method on @request and warns
     # the user of the issue.
     #

data/lib/honeybadger/plugins/shoryuken.rb

@@ -0,0 +1,46 @@
+require 'honeybadger/plugin'
+require 'honeybadger'
+
+module Honeybadger
+  module Plugins
+    module Shoryuken
+      class Middleware
+        def call(worker, queue, sqs_msg, body)
+          if sqs_msg.is_a?(Array)
+            yield
+            return
+          end
+
+          klass = worker.class.name
+          Honeybadger.flush do
+            Honeybadger::Trace.instrument("#{klass}#perform", { :source => 'shoryuken'.freeze, :queue => sqs_msg.queue_name.freeze, :message_id => sqs_msg.data.message_id.freeze, :class => klass }) do
+              begin
+                yield
+              rescue => e
+                receive_count = sqs_msg.attributes['ApproximateReceiveCount'.freeze]
+                if receive_count && ::Honeybadger::Agent.config[:'shoryuken.attempt_threshold'].to_i <= receive_count.to_i
+                  Honeybadger.notify(e, parameters: body)
+                end
+                raise e
+              end
+            end
+          end
+        ensure
+          Honeybadger.context.clear!
+        end
+      end
+
+      Plugin.register do
+        requirement { defined?(::Shoryuken) }
+
+        execution do
+          ::Shoryuken.configure_server do |config|
+            config.server_middleware do |chain|
+              chain.add Middleware
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/trace.rb

@@ -205,7 +205,7 @@ module Honeybadger
 
     class ActionController < Base
       def payload
-        event.payload.reject {|k, v| k == :params }
+        event.payload.reject {|k, v| k == :params || k == :headers }
       end
 
       def to_s

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # Public: The current String Honeybadger version.
-  VERSION = '2.6.0'.freeze
+  VERSION = '2.6.1'.freeze
 end

data/vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap

@@ -4,10 +4,9 @@ namespace :honeybadger do
   end
 
   desc 'Notify Honeybadger of the deployment.'
-  task :deploy => :env do
+  task :deploy => [:env, :'deploy:set_current_revision'] do
     next if sshkit_outdated?
     if server = fetch(:honeybadger_server)
-      invoke "#{scm}:set_current_revision"
       revision = fetch(:current_revision)
 
       on server do |host|
@@ -70,6 +69,13 @@ namespace :honeybadger do
   end
 end
 
+namespace :deploy do
+  task :set_current_revision do
+    # noop -- we just want to make sure this task exists prior to Capistrano
+    # 3.2, since we depend on it.
+  end
+end
+
 namespace :load do
   task :defaults do
     set :bundle_bins, fetch(:bundle_bins, []).push('honeybadger')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -21,6 +21,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- TROUBLESHOOTING.md
 - bin/honeybadger
 - lib/honeybadger.rb
 - lib/honeybadger/agent.rb
@@ -61,6 +62,7 @@ files:
 - lib/honeybadger/plugins/passenger.rb
 - lib/honeybadger/plugins/rails.rb
 - lib/honeybadger/plugins/resque.rb
+- lib/honeybadger/plugins/shoryuken.rb
 - lib/honeybadger/plugins/sidekiq.rb
 - lib/honeybadger/plugins/sucker_punch.rb
 - lib/honeybadger/plugins/thor.rb
@@ -140,7 +142,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: Error reports you can be happy about.