honeybadger 2.5.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 960bb68ee11d0d8dce4c6eb5d9311993653f33db
-  data.tar.gz: a2c016f3cadd8d29dba7c5d1771e113ae568c2aa
+  metadata.gz: 2222a4433ac78457a32df416c829a8e0723a7a4e
+  data.tar.gz: 2b86c78e7f197cb536bc113b0f529fbe1c8922f4
 SHA512:
-  metadata.gz: 2cb05d59a7a735ef68afa3527c555a4206db6fea6aaf97023b6d5e314466229bbf0931542f86d8ac5ee554bd0b0a990246aff1713c849e54dcf023032d28956d
-  data.tar.gz: b10c5fa1d237940f8cef27852c97f43ca0e02222495f5d062d3f9d2352000c635906685c758f284877bdc7c55d9cbcb9e04270a5c63cb3c0ca8e1368d2bc2ffd
+  metadata.gz: 5df00423284aa557dcf82df4d6e951e63fe0c4cd1c1cd019332c03f5b60cccaab0169e39692e40369ba4e5a5d01c145f4abd740ecce2f6b609c83a55c94cee90
+  data.tar.gz: 052aab1703d0ab8895754725423791079bf675ca274442b8b5ba475bc8b28b5a7febe13906c1eed7bd946a427b8646dd36675e36b5a0f2d6335918e6eabf5921

data/CHANGELOG.md

@@ -5,6 +5,18 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [2.6.0] - 2016-04-22
+### Added
+- Automatically report unhandled exceptions at exit.
+- Add `Honeybadger.get_context` method. -@homanchou
+
+### Changed
+- Filter Authorization header (HTTP\_AUTHORIZATION) by default.
+
+### Fixed
+- Always convert to string when sanitizing strings.
+- Fix potential performance issue due to and `ensure` block. See #186.
+
 ## [2.5.3] - 2016-03-10
 ### Fixed
 - Squashed a bug where the wrong source extract was sent for some instances of

data/README.md

@@ -146,6 +146,10 @@ run app
 
 There are a few ways to configure the Honeybadger gem. You can use a YAML config file. You can use environment variables. Or you can use a combination of the two. 
 
+We put together a short video highligting a few of the most common configuration options:
+
+[![Advanced Honeybadger Gem Usage](https://embed-ssl.wistia.com/deliveries/5fccf29d2b27d0f7ec62b5b39e2f5d9cd1f6f5b7.jpg?image_play_button=true&image_play_button_color=7b796ae0&image_crop_resized=150x84)](https://honeybadger.wistia.com/medias/vv9qq9x39d)
+
 
 ### YAML Configuration File
 
@@ -167,7 +171,7 @@ Some configuration options are written in YAML as nested hashes. For example, he
 logging:
   path: "/path/to/honeybadger.log" 
 request:
-  filter-keys:
+  filter_keys:
     - "credit_card"
 ```
 
@@ -221,6 +225,7 @@ You can use any of the options below in your config file, or in the environment.
 |`hostname`                       | String  | The hostname of the current box.<br/>_Default: `Socket.gethostname`_|
 |`backend`                        | String  | An alternate backend to use for reporting data.<br/>_Default: `nil`_|
 |`debug`                          | Boolean | Forces metrics and traces to be reported every 10 seconds rather than 60, and enables verbose debug logging.<br/>_Default: `false`_|
+|`send_data_at_exit`              | Boolean | Finish sending enqueued exceptions and metrics data before allowing program to exit.<br/>_Default: `true`_|
 |`disabled`                       | Boolean | Prevents Honeybadger from starting entirely.<br/>_Default: `false`_|
 | `config_path`                   | String  | The path of the honeybadger config file. Can only be set via the `$HONEYBADGER_CONFIG_PATH` environment variable |
 |`development_environments`       | Array   | Environments which will not report data by default (use report_data to enable/disable explicitly).<br/>_Default: `["development", "test", "cucumber"]`_|
@@ -257,11 +262,11 @@ 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.enabled`             | Boolean | Enable automatic reporting of exceptions.<br/>_Default: `true`_|
 |`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_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._|
+|`exceptions.notify_at_exit`      | Boolean | Report unhandled exception when Ruby crashes (at\_exit).<br/>_Default: `true`._|
 |`exceptions.source_radius`       | Integer | The number of lines before and after the source when reporting snippets.<br/>_Default: `2`_|
 |`exceptions.local_variables`     | Boolean | Enable sending local variables. Requires the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller).<br/>_Default: `false`_|
 |`exceptions.unwrap`              | Boolean | Reports #original_exception or #cause one level up from rescued exception when available.<br/>_Default: `false`_|

data/lib/honeybadger.rb

@@ -171,6 +171,20 @@ module Honeybadger
     self
   end
 
+
+  # Public: Get global context for the current request.
+  #
+  #
+  # Examples:
+  #
+  #   Honeybadger.context({my_data: 'my value'})
+  #   Honeybadger.get_context #now returns {my_data: 'my value'}
+  #
+  # Returns hash or nil.
+  def get_context
+    Thread.current[:__honeybadger_context]
+  end
+
   # Internal: Clears the global context
   def clear!
     Thread.current[:__honeybadger_context] = nil

data/lib/honeybadger/agent.rb

@@ -154,6 +154,7 @@ module Honeybadger
           exit_status = $!.status if $!.is_a?(SystemExit)
         end
 
+        notify_at_exit($!)
         stop if config[:'send_data_at_exit']
         self.class.at_exit.call if self.class.at_exit
 
@@ -299,12 +300,12 @@ module Honeybadger
     def work
       flush_metrics if metrics.flush?
       flush_traces if traces.flush?
+      sleep(delay)
     rescue StandardError => e
       error {
         msg = "error in agent thread class=%s message=%s\n\t%s"
         sprintf(msg, e.class, e.message.dump, Array(e.backtrace).join("\n\t"))
       }
-    ensure
       sleep(delay)
     end
 
@@ -342,5 +343,13 @@ module Honeybadger
         init_traces
       end
     end
+
+    def notify_at_exit(ex)
+      return unless ex
+      return unless config[:'exceptions.notify_at_exit']
+      return if ex.is_a?(SystemExit)
+
+      notice(exception: ex, component: 'at_exit')
+    end
   end
 end

data/lib/honeybadger/backend/server.rb

@@ -25,6 +25,7 @@ module Honeybadger
                      Net::HTTPHeaderSyntaxError,
                      Net::ProtocolError,
                      Errno::ECONNREFUSED,
+                     OpenSSL::SSL::SSLError,
                      SocketError].freeze
 
       def initialize(config)

data/lib/honeybadger/config/defaults.rb

@@ -168,7 +168,7 @@ module Honeybadger
       },
       :'request.filter_keys' => {
         description: 'A list of keys to filter when sending request data.',
-        default: ['password'.freeze, 'password_confirmation'.freeze].freeze,
+        default: ['password'.freeze, 'password_confirmation'.freeze, 'HTTP_AUTHORIZATION'.freeze].freeze,
         type: Array
       },
       :'request.disable_session' => {
@@ -227,10 +227,15 @@ module Honeybadger
         type: Array
       },
       :'exceptions.rescue_rake' => {
-        description: 'Enable rescuing exceptions in rake tasks.',
+        description: 'Enable reporting exceptions in rake tasks.',
         default: !STDOUT.tty?,
         type: Boolean
       },
+      :'exceptions.notify_at_exit' => {
+        description: 'Report unhandled exception when Ruby crashes (at_exit).',
+        default: true,
+        type: Boolean
+      },
       :'exceptions.source_radius' => {
         description: 'The number of lines before and after the source when reporting snippets.',
         default: 2,

data/lib/honeybadger/util/sanitizer.rb

@@ -107,7 +107,7 @@ module Honeybadger
         end
 
         def sanitize_string(data)
-          data = valid_encoding(data)
+          data = valid_encoding(data.to_s)
           return data unless data.respond_to?(:size) && data.size > MAX_STRING_SIZE
           data[0...MAX_STRING_SIZE] + TRUNCATION_REPLACEMENT
         end

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.6.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email: