class BacktraceCleaner

Ruby on Rails 2.3.18

Since v2.3.18

Available in: v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Many backtraces include too much information that’s not relevant for the context. This makes it hard to find the signal in the backtrace and adds debugging time. With a BacktraceCleaner, you can setup filters and silencers for your particular context, so only the relevant lines are included.

If you need to reconfigure an existing BacktraceCleaner, like the one in Rails, to show as much as possible, you can always call BacktraceCleaner#remove_silencers!

Example:

bc = BacktraceCleaner.new
bc.add_filter   { |line| line.gsub(Rails.root, '') } 
bc.add_silencer { |line| line =~ /mongrel|rubygems/ }
bc.clean(exception.backtrace) # will strip the Rails.root prefix and skip any lines from mongrel or rubygems

Inspired by the Quiet Backtrace gem by Thoughtbot.

Inherits from

Object

Methods (defined here)

Private methods

(2) Implementation detail — not part of the public API.

Used by

Subclasses (1)

Methods (inherited)

From Object (37)
From Benchmark (2)

Type at least 2 characters to search.

↑↓ navigate · open · esc close