Backtraces often include many lines that are not relevant for the context under review. This makes it hard to find the signal amongst the backtrace noise, and adds debugging time. With a BacktraceCleaner, filters and silencers are used to remove the noisy lines, so that only the most relevant lines remain.

Filters are used to modify lines of data, while silencers are used to remove lines entirely. The typical filter use case is to remove lengthy path information from the start of each line, and view file paths relevant to the app directory instead of the file system root. The typical silencer use case is to exclude the output of a noisy library from the backtrace, so that you can focus on the rest.

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

To reconfigure an existing BacktraceCleaner (like the default one in Rails) and show as much data as possible, you can always call BacktraceCleaner#remove_silencers!, which will restore the backtrace to a pristine state. If you need to reconfigure an existing BacktraceCleaner so that it does not filter or modify the paths of any lines of the backtrace, you can call BacktraceCleaner#remove_filters! These two methods will give you a completely untouched backtrace.

Inspired by the Quiet Backtrace gem by Thoughtbot.

Methods
A
C
N
R
Class Public methods
new()
    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 25
25:     def initialize
26:       @filters, @silencers = [], []
27:     end
Instance Public methods
add_filter(&block)

Adds a filter from the block provided. Each line in the backtrace will be mapped against this filter.

Example:

  # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
  backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 49
49:     def add_filter(&block)
50:       @filters << block
51:     end
add_silencer(&block)

Adds a silencer from the block provided. If the silencer returns true for a given line, it will be excluded from the clean backtrace.

Example:

  # Will reject all lines that include the word "mongrel", like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
  backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 60
60:     def add_silencer(&block)
61:       @silencers << block
62:     end
clean(backtrace, kind = :silent)

Returns the backtrace after all filters and silencers have been run against it. Filters run first, then silencers.

    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 30
30:     def clean(backtrace, kind = :silent)
31:       filtered = filter(backtrace)
32: 
33:       case kind
34:       when :silent
35:         silence(filtered)
36:       when :noise
37:         noise(filtered)
38:       else
39:         filtered
40:       end
41:     end
remove_filters!()
    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 70
70:     def remove_filters!
71:       @filters = []
72:     end
remove_silencers!()

Will remove all silencers, but leave in the filters. This is useful if your context of debugging suddenly expands as you suspect a bug in one of the libraries you use.

    # File activesupport/lib/active_support/backtrace_cleaner.rb, line 66
66:     def remove_silencers!
67:       @silencers = []
68:     end