5.20.0 (2024-11-08)
5.19.2 (2024-11-05)
- don't run middleware in Sinatra when not configured (#629) (d84c2b1)
- pin rspec-its gem to 1.3.1 (#631) (5f78b8a)
5.19.1 (2024-11-02)
5.19.0 (2024-10-29)
5.18.0 (2024-10-25)
5.17.0 (2024-10-22)
5.16.0 (2024-09-19)
5.15.6 (2024-08-15)
5.15.5 (2024-07-30)
5.15.4 (2024-07-29)
5.15.3 (2024-07-25)
5.15.2 (2024-07-25)
5.15.1 (2024-07-23)
- safe navigate adapter_name for payload connection (#593) (368fb16)
- sidekiq leader check only for version > 6.5 (#594) (3bc005b)
5.15.0 (2024-07-18)
5.14.2 (2024-07-17)
5.14.1 (2024-07-15)
5.14.0 (2024-07-11)
- add --host and --ui_host flags to install command (#584) (5f171ba)
- add ability to link to a custom domain after creating a notice (#583) (5b32b23)
5.13.3 (2024-07-06)
5.13.2 (2024-07-03)
5.13.1 (2024-07-01)
- do not check for rails console (#574) (ba74af8)
- ignore content-less SQL statements (#572) (e7ecd36)
- sanitize SQL when reporting SQL queries (#571) (40d4a79)
5.13.0 (2024-06-18)
5.12.0 (2024-06-17)
5.11.2 (2024-06-12)
5.11.1 (2024-06-07)
5.11.0 (2024-06-04)
5.10.2 (2024-05-24)
5.10.1 (2024-05-23)
5.10.0 (2024-05-10)
5.9.0 (2024-05-09)
5.8.1 (2024-05-07)
5.8.0 (2024-03-23)
- add active_job.attempt_threshold configuration option (#535)
- handle non-string hash keys when sanitizing (#533)
5.7.0 (2024-03-12)
5.6.0 (2024-03-05)
5.5.1 (2024-02-26)
5.5.0 (2024-02-12)
5.4.1 (2023-12-22)
5.4.0 (2023-12-04)
5.3.0 (2023-10-27)
- Support for Karafka (#480)
- Support for nested
to_honeybadger_context(#488) - Explain 413 responses from API (#492)
- Make notify work with proper ruby keyword arguments (#498) (e4a006c)
Honeybadger::Config#respond_to?would always return true (#490)Honeybadger::Agent#notifytakes keyword arguments instead of an options hash now (#498)
- Accept three arguments for the Sidekiq error handler (#495)
- Log level of init message changed to DEBUG (#497)
- Add .tool-versions to set ruby version for development (#501)
- Remove ANSI escape codes from detailed error message in Ruby 3.2 (#473)
- First-class support for Hanami (#470)
- Auto-add Sinatra optional middleware (#471). This is fine, as they don't do anything without the magic strings (and they can be disabled via config, anyway).
- Support for
Exception#detailed_messageon Ruby 3.2 (#459) - Added
notice.parsed_backtracemethod, meant to make custom fingerprints easier (#454) - Support for Sidekiq 7 (#458)
- On Rails 7, The Honeybadger gem now prioritises the more detailed integrations' native error handlers instead of
Rails.error, to avoid loss of context (#460)
- Stopped the Rails middleware from crashing due to changes on Rails 7.1 (#464)
Honeybadger.check_inwould raise an exception when used with the test backend (#449)
- Ignore
Sidekiq::JobRetryskip exception. Since support was added for Rails 7 error reporting interface these exceptions are being reported in addition to the exception that caused the job to be retried. Mike Perham says these exceptions can safely be ignored. See rails/rails#43625 (comment)
Honeybadger.notifyis now idempotent; it will skip reporting exception objects that have already been reported before, and simply return the existing notice ID.- Honeybadger is now initialized before Rails' initializers, allowing you to
report errors raised during startup. Config added via
Honeybadger.configureis added later in the Rails initialization process.
- Support Rails 7 error reporting interface (#443)
- Replace deployhook with release webhook (#444) See https://blog.heroku.com/deployhooks-sunset
- Fix a bug where the auto-detected revision is blank instead of nil
- Fix inadvertent creation of invalid sessions (#441)
- Fix Lambda plugin: support Ruby <2.5 (#428)
- Added
hb_wrap_handlerto automatically capture AWS Lambda handler errors
- Change
:exception_messagekey name to just:exceptionfor error breadcrumb metadata.
- Allow special characters in tags. Also support space-delimited tags: "one two three" and "one, two, three" are equivalent
- Add more items to the default config file
- Fix a Ruby 3.1 bug that breaks regexp classes in honeybadger.yml (#418)
- Replaced fixed number for retries in Sidekiq Plugin with Sidekiq::JobRetry constant
- Properly set environment in deployment tracking (#404, @stmllr)
- Added 'ActionDispatch::Http::MimeNegotiation::InvalidType' (Rails 6.1) to default ignore list. (#402, @jrochkind)
- Suppress any error output from the
git rev-parsecommand. (#394)
- Support deployment tracking in code (#397, @danleyden)
- Don't enable Lambda plugin in non-Lambda execution environments
- Remove usage of
ActiveRecord::Base.connection(thanks @jcoyne for testing) - Check for UTF-8 in ActiveRecord breadcrumb exclusion filter
- ActiveRecord SQL Breadcrumb event pulls adapter from supplied connection, allowing for multiple databases.
- Fix Rails deprecation of
ActionDispatch::ParamsParser::ParseError - Deal with invalid UTF-8 byte sequences during SQL obfuscation
- Fix Ruby 2.7 deprecation notice in sql.rb
- Alias
Notice#controller=asNotice#component= - Fix Rails 6.1 deprecation warning with
ActiveRecord::Base.connection_config - Fix agent where breadcrumbs.enabled = true and local_context = true
- Add
honeybadger_skip_rails_loadCapistrano option to skip rails load on deployment notification (#355) -@NielsKSchjoedt
- Fixed issue where Sidekiq.attempt_threshold was triggering 2 attempts ahead of the setting
- Dupe notify opts before mutating (#345)
- Breadcrumbs on by default
- Added Faktory plugin -@scottrobertson
- Fix remaining Ruby 2.7 deprecation warnings
- Replace empty
Proc.newwith explicit block param to suppress warnings in Ruby 2.7
- Re-released to remove vendor cruft
- Include Context in Notices for failed Resque jobs
- Added parameter filtering to breadcrumb metadata (#329)
- Added
lambdaplugin which forces sync mode (to make sure that we are not sending notices in another thread) and adds extra lambda details to the Notice. (honeybadger-ruby-internal#1)
- Logging breadcrumbs will not crash anymore when logging is done using a block form. -@Bajena
- When
breadcrumbsare enabled ensure we call the originalLogger#addwith the original arguments -@JanStevens
- Default
max_queue_sizehas been reduced from 1000 to 100.
- Added
Notice#causes, which allows cause data to be mutated inbefore_notifycallbacks (useful for filtering purposes). - Added
Notice#cause=, which allows the cause to be changed or disabled inbefore_notifycallbacks. - Added extra shutdown logging.
Honeybadger.notify(exception, cause: nil)will now prevent the cause from being reported.- When throttled, queued notices will be discarded during shutdown.
- Handle ActiveSupport::Notifications passing nil started or finished time -@pcreux
- Allow non-strings to be passed to breadcrumbs logger
- Added the ability to store and send Breadcrumbs along with the notice.
Breadcrumbs are disabled by default in this version so they must be enabled
via the config (option
breadcrumbs.enabled) to work.
- Add Rails 6 RC1 Support
- Send a value for action when reporting a component for Sidekiq jobs -@stympy
- Fix a bug where some non-standard backtraces could not be parsed, resulting in an error when sending error reports. Backtraces are now explicitly converted to arrays, and lines are converted to strings.
- Fix a typo in throttle log message. -@mobilutz
- Fix #301 - before_notify hooks are overridden on subsequent
Honeybadger.configurecalls. - Revert "Get the right controller / action name in Rails, when using an exception app for custom error pages."
- Issue a Notification from a Sidekiq job when either the
sidekiq.attempt_thresholdis reached OR if the job defined retry threshold is reached, whichever comes first. -@mstruve - Updated supported Ruby/Rails versions (MRI >= 2.3.0, JRuby >= 9.2, Rails >= 4.2) https://docs.honeybadger.io/ruby/gem-reference/supported-versions.html
- Get the right controller / action name in Rails, when using an exception app for custom error pages. -@fernandes
- Added flag
--skip-rails-loadto cli commands for optionally skipping Rails initialization when running from a Rails root.
- Added missing Backend::Server#check_in specs
- Fix a memory leak in the worker queue (jruby)
- Added
before_notifyhooks to be defined, this allows setting up of multiple hooks which will be invoked with anoticebefore anoticeis sent. Eachbefore_notifyhook MUST be acallable(lambda, Proc etc,) with an arity of 1. - Added the ability to halt notices in callbacks using
notice.halt! - Make essential attributes on Notice writable:
Honeybadger.configure do |config| config.before_notify do |notice| notice.api_key = 'custom api key', notice.error_message = "badgers!", notice.error_class = 'MyError', notice.backtrace = ["/path/to/file.rb:5 in `method'"], notice.fingerprint = 'some unique string', notice.tags = ['foo', 'bar'], notice.context = { user: 33 }, notice.controller = 'MyController', notice.action = 'index', notice.parameters = { q: 'badgers?' }, notice.session = { uid: 42 }, notice.url = "/badgers", end end
- Ignore SIGTERM SignalExceptions.
- Removed Notice#[]
-
The public method
Notice#backtraceis now exposed as the raw Ruby backtrace instead of an instance ofHoneybadger::Backtrace(a private class).Before:
notice.backtrace # => #<Honeybadger::Backtrace>
After:
notice.backtrace # => ["/path/to/file.rb:5 in `method'"]
-
notice[:context]now defaults to an empty Hash instead of nil.Before:
notice[:context] # => nil
After:
notice[:context] # => {}
-
The public method
Notice#fingerprintnow returns the original String which was passed in from the:fingerprintoption or theexception_fingerprintcallback, not a SHA1 hashed value. The value is still hashed before sending through to the API. -
The public method
Honeybadger.exception_filterhas been deprecated in favor ofbefore_notify:Honeybadger.configure do |config| config.before_notify do |notice| notice.halt! end end
-
The public method
Honeybadger.exception_fingerprinthas been deprecated in favor ofbefore_notify:Honeybadger.configure do |config| config.before_notify do |notice| notice.fingerprint = 'new fingerprint' end end
-
The public method
Honeybadger.backtrace_filterhas been deprecated in favor ofbefore_notify:Honeybadger.configure do |config| config.before_notify do |notice| notice.backtrace.reject!{|x| x =~ /gem/} end end
- The
disabledoption is now removed, Use thereport_dataoption instead.
- Fix synchronous throttling in shoryuken
- Use prepend to add Sidekiq Middleware to fix context getting cleared.
- Add
Rack::QueryParser::ParameterTypeErrorandRack::QueryParser::InvalidParameterErrorto default ignore list.
- Use a unique route name in rails to avoid name conflicts.
- Fix
at_exitcallback being skipped in rails apps with a sinatra dependency.
- Objects which explicitly alias
#to_sto#inspect(such asOpenStruct) are now sanitized.'#<OpenStruct attribute="value">'becomes'#<OpenStruct>'. If you pass the value of#inspect(as aString) directly to Honeybadger (or return it from#to_honeybadger), the value will not be sanitized. - We're now using
String(object)instead ofobject.to_sas the last resort during sanitization.
- The exception cause may now be set using an optional
:causeoption when callingHoneybadger.notify. If not present, the exception's cause will be used, or the global$!exception if available. - Any object can now act as context using the
#to_honeybadger_contextmethod. The method should have no arguments and return aHashof context data. Context from exceptions which define this method will automatically be included in error reports. - Final object representations in Honeybadger (normally the value of
#to_sfor unknown types) can be changed by defining the#to_honeybadgermethod. If the method is defined, the return value of that method will be sent to Honeybadger instead of the#to_svalue (for context values, local variables, etc.). '[RAISED]'is returned whenobject.to_honeybadgerorString(object)fails.- Added
Honeybadger.check_inmethod which allows performing check ins from ruby.
- We no longer use "/dev/null" as the default log device as it doesn't exist on Windows.
- Logs when reporting errors in development mode now mention that the error wasn't actually reported. :)
- Support new Sidekiq job params key.
- Move at_exit callback to an appropriate place for sinatra apps, so that it does not prematurely stop honeybadger workers.
BasicObject, which previously could not be serialized, is now serialized as"#<BasicObject>".
- Fixed a bug in the Resque plugin which prevented error reports from being sent. The issue was that the Resque's callbacks were executed in an unexpected order which caused the queue to be flushed before error notification instead of after.
honeybadger deploycli command now reads default environment from honeybadger.yml/environment variable.- Fixed a conflict with the web-console gem.
- Exceptions encountered while loading/evaluating honeybadger.yml are now raised instead of logged.
- Friendlier backtraces for exceptions originating in honeybadger.yml.
- Notify errors in Shoryuken batches -@phstc
- Rails environment is now loaded when running
honeybadgercli from a Rails root. This fixes an issue where programmatic configuration from Rails was not loaded. - Fixed logger isn't being overridden properly when configuring with Honeybadger.configure -@anujbiyani
- Fixed a bug caused by an interaction with the semantic_logger gem.
- Fixed a bug which caused a NoMethodError (undefined method `start_with?') when Rack env contained non-string keys.
- You may now require 'honeybadger/ruby' instead of 'honeybadger' to get the agent without the integrations (no railtie, plugins or monkey patching).
- You can now create multiple instances of the Honeybadger agent with different configurations (many classes in the library can be composed).
Honeybadger.configureworks again -- use it to configure the library from Ruby! (we still default to honeybadger.yml in our installer)- Our test suite is now leaner and meaner (which means we can add new features faster). Reduced typical build times from up to 2 minutes to 20 seconds.
- We've rebuilt the CLI from scratch. The new CLI features super verbose error
messages with (hopefully) helpful suggestions, some new commands, and better
framework detection in the
installandtestcommands. - Use
honeybadger exec your_commandfrom the command line to report the error when the command fails due to a non-zero exit status or standard error output. (Use it to report failures in cron!) Seehoneybadger help exec. - Use
honeybadger notifyfrom the command line to report custom errors to Honeybadger. Seehoneybadger help notify. - ~/honeybadger.yml is now a default config path for the CLI and standalone-ruby installations.
Honeybadger.notifynow converts arguments which are notExceptionorHashtypes to strings and assigns them as the error message. Example:Honeybadger.notify("Something went wrong").- The currently deployed git revision is now detected automatically and sent with error reports.
Honeybadger.starthas been deprecated and has no effect.- We've changed some of the underlying code of the library. If you depend on internal APIs (such as thread local variable names or any functions not marked public in the code comments) then you may need to update your code. If you are developing 3rd-party integrations with our gem let us know so that we can work with you to build the public APIs you need.
- All Rack middleware no longer require an argument (which used to be a
Honeybadger::Configinstance) when using them. They now default to the global agent and accept an optional argument which expects an alternateHoneybadger::Agentinstance. - The plugins.skip config option has been renamed to skipped_plugins.
- The sidekiq.use_component config option is now
trueby default. To get the old behavior, set it tofalse. When enabled, the Sidekiq plugin will automatically set the component to the class of the job, which helps with grouping. - The
request.filter_keysoption now includes partial matches: with the filter value "password", keys such as "password" and "otherpassword" will be filtered. - CGI variables are now whitelisted when sending the Rack environment to Honeybadger to prevent sensitive data leakage.
Honeybadger.notifynow raises an exception in development mode when called without the required arguments. It logs outside of development and continues to send a generic error report.
- Ruby 1.9.3 and 2.0.x are no longer supported.
Honeybadger.notify_or_ignorehas been removed. UseHoneybadger.notify(e)andHoneybadger.notify(e, force: true)(to skip ignore filters).- The CLI command
honeybadger confighas been removed. - All deprecated Rails controller methods (from version 1.x) have been removed.
- The deprecated
Honeybadger::Rack::MetricsReportermiddleware has been removed.
- Arrays are no longer compacted during sanitization (
nilvalues will be sent as they originally appeared). - Resque plugin now reports
Resque::DirtyExitexceptions.
- Pass whole exception to
notify_or_ignore(includes causes). -@CGamesPlay
- Fix a Sinatra bug where
RACK_ENVdefault was not used as default env. - Fixed an error when accessing notice request data from
exception_fingerprintcallback.
- Support Sinatra 2.0.
- Source snippets are now sent for every line of the backtrace.
- Sunset performance metrics. See http://blog.honeybadger.io/sunsetting-performance-metrics/
- Backtraces are now limited to a maximum of 1000 lines.
- shoryuken plugin. -@ivanvc
- Handle
Errno::ENETUNREACHerror when contacting server. -@tank-bohr - Remove
ActionDispatch::Http::Headersfrom trace payload (fixesIOErrorwhen JSON encoding traces in Rails 5). - Fix "
invoke("git:set_current_revision")already invoked" warning in Capistrano 3.6.
- Automatically report unhandled exceptions at exit.
- Add
Honeybadger.get_contextmethod. -@homanchou
- Filter Authorization header (HTTP_AUTHORIZATION) by default.
- Always convert to string when sanitizing strings.
- Fix potential performance issue due to and
ensureblock. See #186.
- Squashed a bug where the wrong source extract was sent for some instances of
ActionView::Template::Error.
- Allow plugin names in config to be symbols or strings (#177).
- Fix bug in resque-retry logic. -@davidguthu
- Fix bug in resque-retry logic. -@davidguthu
- Configuration option max_queue_size for maximum worker queue size.
- Add
resque.resque_retry.send_exceptions_when_retryingconfig option. -@davidguthu
- Never send traces or metrics when disabled by plan or config.
- Sucker Punch support
- Fixed a bug which caused a Passenger-related error message when booting a heroku console.
- Be stricter when sanitizing recursive objects (allow only
Hash,Array,Set). This fixes a bug where some gems (such as the dropbox gem) monkeypatch#to_hashonArray.
- Handle invalid utf8 in ActiveRecord SQL queries.
- Rails 5 support.
- Support overriding TTY behavior in rake reporter.
- Capistrano 3
undefined methodverbosity'` bugfix. - Fixed "uninitialized constant Set" error when Set is not previously required.
- Added a config option to automatically set the component to the class name of the Sidekiq job where an error originated. Causes errors to be grouped by worker in addition to class name/location.
- Always refresh capistrano revision during deploy notification.
- Support capistrano-chruby. -Kyle Rippey
- Send the wrapped class name for Sidekiq traces when using a wrapper such as ActiveJob.
- Performance tuning for Sidekiq plugin.
- Apply parameter filters to local variables.
- Support windows paths when loading plugins. -@aharpervc
- Don't send empty local_variables in payload when disabled.
- Better logging of reason when API requests are denied.
- Truncate long queries in traces rather than tossing them.
- Missing vendor libs.
- Update heroku cli deprecations. -@adamkuipers
- Don't insert middleware if they're disabled. -Bradley Priest
- Don't send RAW_POST_DATA.
- Filter HTTP_COOKIE in request cgi_data. -Sam McTaggart
- Support for extracting the correct component & action for Rails Active Jobs (previously all Active Jobs where reported as 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'). -Panos Korros
- Fix breakage relating to Exceptions containing a :cause attribute which is not itself an Exception. -Gabe da Silveira
- Add events to instrumented traces (i.e. in background jobs).
- Restart workers once per hour when shutdown due to 40x.
- Send request data with traces.
- Support Resque natively.
- Configure sidekiq.attempt_threshold to suppress notifications until retry threshold is reached.
- Add exceptions.unwrap to config.
- Trim all sanitized strings to 2k.
- Ditch per-controller metrics and add render_partial event to traces. -Benjamin Curtis
- Exit with 1 from deploy command when request fails but ignore the failures in the capistrano task.
- Update default ignored exceptions to include the latest Rails rescue responses. (see issue #107)
- Exceptions with the same type but caused within different delayed jobs are not grouped together. They have their component and action set so that the application class name and excecuted action is displayed in the UI. -Panos Korros
- All events logged within a delayed_job even those logged by Honeybadger.notify inherit the context of the delayed job and include the job_id, attempts, last_error and queue. -Panos Korros
- Allow API key to be overridden from
Honeybadger.notify. - Fix a tracing issue with net/http requests.
- Disable local variables when BetterErrors is detected.
- Prevent Sinatra from using the same middleware more than once and add sinatra.enabled setting (default true) to disable auto-initialization of Sinatra.
- Catch Errno::ENFILE when reading system stats. -Dmitry Polushkin
- Use explicit types for config options when casting from ENV.
- Fix bug when processing source extract for action_view templates.
- Don't access secrets before Rails initialization.
- Fix a bug which introduced a hard-dependency on Rack.
- Add support for honeybadger_user with Capistrano 2. -Nathan Fixler
- Fix a bug in ping where JSON was double-quoted.
- Fixed a bug introduced in v2.0.8 which applied params filters to backtrace.
- Fail gracefully when honeybadger.yml is empty or invalid.
- Include full backtrace when logging worker exceptions.
- Always send a test notice on install.
- Send the id of the current process with error reports.
- Handle bad encodings in exception payloads.
- Don't sub partial project root in backtrace lines.
- Merge exceptions.ignore config values with default ignored exception class names and add exceptions.ignore_only option to override.
- Support for capistrano-rbenv gem in Capistrano task. -Chris Gunther
- Support for capistrano-rvm gem in Capistrano task. -Kyle Rippey
- Don't require honeybadger.yml to be writable when reading.
- Detect ActionDispatch::TestProcess being included globally, fix issue locally, warn the user.
- Fix a nil logger bug when a config error occurs.
- Don't instrument metrics and traces in Rails when features are not available on account.
- Don't send error reports when disabled via configuration.