класс ActiveSupport::BacktraceCleaner

Родитель:: Объект

Стек вызовов часто содержит множество строк, не относящихся к рассматриваемому контексту. Это затрудняет поиск сигнала среди шума стека вызовов и увеличивает время отладки. С помощью BacktraceCleaner, фильтры и заглушки используются для удаления ненужных строк, оставляя только самые важные.

Фильтры используются для изменения строк данных, а заглушки — для полного удаления строк. Типичный случай использования фильтров — удаление длинной информации о путях из начала каждой строки и отображение путей файлов, относящихся к каталогу приложения, вместо корня файловой системы. Типичный случай использования заглушек — исключение вывода шумной библиотеки из стека вызовов, чтобы вы могли сосредоточиться на остальном.

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

Чтобы перенастроить существующий BacktraceCleaner (например, по умолчанию в Rails) и отобразить как можно больше данных, вы всегда можете вызвать BacktraceCleaner#remove_silencers!, что восстановит стек вызовов в исходном состоянии. Если вам нужно перенастроить существующий BacktraceCleaner так, чтобы он не фильтровал и не изменял пути ни одной строки стека вызовов, вы можете вызвать BacktraceCleaner#remove_filters! Эти два метода предоставят вам полностью нетронутый стек вызовов.

Вдохновлено плагином Quiet Backtrace от Thoughtbot.

Публичные методы класса

new() Показать исходный код

# File activesupport/lib/active_support/backtrace_cleaner.rb, line 30
def initialize
  @filters, @silencers = [], []
end

Публичные методы экземпляра

add_filter(&block) Показать исходный код

Добавляет фильтр из предоставленного блока. Каждая строка в стеке вызовов будет сопоставлена с этим фильтром.

# 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 55
def add_filter(&block)
  @filters << block
end

add_silencer(&block) Показать исходный код

Добавляет заглушку из предоставленного блока. Если заглушка возвращает true для данной строки, она будет исключена из очищенного стека вызовов.

# 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 64
def add_silencer(&block)
  @silencers << block
end

clean(backtrace, kind = :silent) Показать исходный код

Возвращает стек вызовов после применения всех фильтров и заглушек. Фильтры применяются первыми, затем заглушки.

# File activesupport/lib/active_support/backtrace_cleaner.rb, line 36
def clean(backtrace, kind = :silent)
  filtered = filter_backtrace(backtrace)

  case kind
  when :silent
    silence(filtered)
  when :noise
    noise(filtered)
  else
    filtered
  end
end

Также алиас: filter

filter(backtrace, kind = :silent)

Алиас для: clean

remove_filters!() Показать исходный код

Удаляет все фильтры, но оставляет заглушки. Полезно, если внезапно вам нужно увидеть полные пути файлов в стеке вызовов, которые вы уже отфильтровали.

# File activesupport/lib/active_support/backtrace_cleaner.rb, line 78
def remove_filters!
  @filters = []
end

remove_silencers!() Показать исходный код

Удалить все заглушки, но оставить фильтры. Это полезно, если контекст отладки внезапно расширился, и вы подозреваете ошибку в одной из используемых библиотек.

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