Raven Ruby v3.1.1 Release Notes

Release Date: 2020-09-25 // 2 months ago
  • Feature

    โž• Add request id to headers if exists (#1033)

    ๐Ÿ‘ Allow blocks on user_context (#1023)

    ๐Ÿ”ง Enable configurable rack environment recorded parameters (#860)

    โœ‚ Remove ActiveJob keys for both Sidekiq and DelayedJob (#898)

    ๐Ÿ›  Fix

    • โœ‚ Remove circular dependency in transport/http.rb (#1035)

Previous changes from v3.1.0

  • ๐Ÿ”‹ Feature

    • ๐Ÿ’Ž Exclude all 4xx Rails errors (#1004)

      See the full list here

    • Add some error context in transport_failure_callback (#1003)

      Before:

      config.transport_failure_callback = lambda { |event|
        AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
      }
      

      After:

      config.transport_failure_callback = lambda { |event, error|
        AdminMailer.email_admins("Oh god, it's on fire because #{error.message}!", event).deliver_later
      }
      
    • ๐Ÿ‘Œ Support cleaning up exception backtrace with customized backtrace_cleaner (#1011)

      The new config backtrace_cleanup_callback takes a lambda/proc object (default is nil) and will be called with exception's backtrace

      Raven.configure do |config|
        config.backtrace_cleanup_callback = lambda do |backtrace|
          Rails.backtrace_cleaner.clean(backtrace)
        end
      end
      

      And with the Rails integration, it'll automatically use a customized Raven::Rails::BacktraceCleaner to clean up exception's backtrace. It's basically Rails 6's backtrace cleaner but without silencers.

      The main reason to add this cleaner is to remove template methods from the trace, e.g.

      app/views/welcome/view_error.html.erb in _app_views_welcome_view_error_html_erb__2807287320172182514_65600 at line 1
      

      will become

      app/views/welcome/view_error.html.erb at line 1
      

      This can help Sentry group issues more accurately. See #957 for more information about this.

      If you don't want this change, you can disable it with:

      Raven.configure do |config|
        config.backtrace_cleanup_callback = nil
      end
      
    • ๐Ÿ’Ž Make dsn value accessable from config (#1012)

      You can now access the dsn value via Raven.configuration.dsn

    ๐Ÿ—„ Deprecation

    • ๐Ÿ—„ Deprecate dasherized filenames (#1006)

      If you're using

      gem 'sentry-raven', require: 'sentry-raven-without-integrations'
      # or 
      require "sentry-raven-without-integrations"
      

      you will start seeing deprecation warnings. Please change them into

      gem 'sentry-raven', require: 'sentry_raven_without_integrations'
      # or 
      require "sentry_raven_without_integrations"
      
    • ๐Ÿ’Ž Unify breadcrumb loggers activation (#1016)

      Currently, we activate our breadcrumb loggers differently:

      require "raven/breadcrumbs/sentry_logger"
      Raven.configuration.rails_activesupport_breadcrumbs = true
      

      It's not a nice user interface, so this PR adds a new configuration option breadcrumbs_logger to improve this:

      Raven.configuration.breadcrumbs_logger = :sentry_logger
      Raven.configuration.breadcrumbs_logger = :active_support_logger
      Raven.configuration.breadcrumbs_logger = [:sentry_logger, :active_support_logger]
      

      Please migrate to the new activation apporach, otherwise you'll see depraction warnings. And old ones will be dropped in version 4.0.

    โ™ป๏ธ Refactor

    • ๐Ÿ’Ž Accept non-string message in Event.from_exception (#1005)
    • โ™ป๏ธ Refactor event initialization (#1010)
    • โ™ป๏ธ Refactor sidekiq integration (#1019)

    ๐Ÿ›  Fix

    • ๐Ÿ’Ž Replace sys_command usages in context.rb (#1017)
    • ๐Ÿ›  Fix merge error from rack-timeout raven_context on old releases (#1007)
    • Return value of rescue_with_handler when intercepting ActiveJob exceptions (#1027)