класс ActiveSupport::BacktraceCleaner

Родитель:: Object

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

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

bc = ActiveSupport::BacktraceCleaner.new
bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
bc.add_silencer { |line| line =~ /puma|rubygems/ } # skip any lines from puma 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) Показать исходный код

# File activesupport/lib/active_support/backtrace_cleaner.rb, line 55
def add_filter(&block)
  @filters << block
end

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

# Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }

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

# File activesupport/lib/active_support/backtrace_cleaner.rb, line 64
def add_silencer(&block)
  @silencers << block
end

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

# Will reject all lines that include the word "puma", like "/gems/puma/server.rb" or "/app/my_puma_server/rb"
backtrace_cleaner.add_silencer { |line| line =~ /puma/ }

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

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