# File activesupport/lib/active_support/error_reporter.rb, line 185
def disable(subscriber)
  disabled_subscribers = (ActiveSupport::IsolatedExecutionState[self] ||= [])
  disabled_subscribers << subscriber
  begin
    yield
  ensure
    disabled_subscribers.delete(subscriber)
  end
end

Запретить уведомление подписчика об ошибках на время блока. Можно передать самого подписчика или его класс.

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

# File activesupport/lib/active_support/error_reporter.rb, line 78
def handle(*error_classes, severity: :warning, context: {}, fallback: nil, source: DEFAULT_SOURCE)
  error_classes = DEFAULT_RESCUE if error_classes.empty?
  yield
rescue *error_classes => error
  report(error, handled: true, severity: severity, context: context, source: source)
  fallback.call if fallback
end

Выполняет заданный блок, сообщая об и проглатывая любые необработанные ошибки. Если ошибка не возникла, возвращает результат выполнения блока. В противном случае, возвращает результат fallback.call, или nil если fallback не указан.

# Will report a TypeError to all subscribers and return nil.
Rails.error.handle do
  1 + '1'
end

Может быть ограничено для обработки только определённых классов ошибок:

maybe_tags = Rails.error.handle(Redis::BaseError) { redis.get("tags") }

Параметры

• :severity - Это значение передаётся подписчикам, чтобы указать насколько важен отчёт об ошибке. Может быть :error, :warning, или :info. По умолчанию :warning.

• :context - Дополнительная информация, передаваемая подписчикам. Например:

  Rails.error.handle(context: { section: "admin" }) do
    # ...
  end
  

• :fallback - Вызываемый объект, который предоставляет значение возврата handle при возникновении необработанной ошибки. Например:

  user = Rails.error.handle(fallback: -> { User.anonymous }) do
    User.find_by(params)
  end
  

• :source - Это значение передаётся подписчикам, чтобы указать источник ошибки. Подписчики могут использовать это значение для игнорирования определённых ошибок. По умолчанию "application".

# File activesupport/lib/active_support/error_reporter.rb, line 114
def record(*error_classes, severity: :error, context: {}, source: DEFAULT_SOURCE)
  error_classes = DEFAULT_RESCUE if error_classes.empty?
  yield
rescue *error_classes => error
  report(error, handled: false, severity: severity, context: context, source: source)
  raise
end

Выполняет заданный блок, сообщая об и повторно поднимая любые необработанные ошибки. Если ошибка не возникла, возвращает результат выполнения блока.

# Will report a TypeError to all subscribers and re-raise it.
Rails.error.record do
  1 + '1'
end

Может быть ограничено для обработки только определённых классов ошибок:

tags = Rails.error.record(Redis::BaseError) { redis.get("tags") }

Параметры

• :severity - Это значение передаётся подписчикам, чтобы указать насколько важен отчёт об ошибке. Может быть :error, :warning, или :info. По умолчанию :error.

• :context - Дополнительная информация, передаваемая подписчикам. Например:

  Rails.error.record(context: { section: "admin" }) do
    # ...
  end
  

• :source - Это значение передаётся подписчикам, чтобы указать источник ошибки. Подписчики могут использовать это значение для игнорирования определённых ошибок. По умолчанию "application".

# File activesupport/lib/active_support/error_reporter.rb, line 210
def report(error, handled: true, severity: handled ? :warning : :error, context: {}, source: DEFAULT_SOURCE)
  return if error.instance_variable_defined?(:@__rails_error_reported)

  unless SEVERITIES.include?(severity)
    raise ArgumentError, "severity must be one of #{SEVERITIES.map(&:inspect).join(", ")}, got: #{severity.inspect}"
  end

  full_context = ActiveSupport::ExecutionContext.to_h.merge(context)
  disabled_subscribers = ActiveSupport::IsolatedExecutionState[self]
  @subscribers.each do |subscriber|
    unless disabled_subscribers&.any? { |s| s === subscriber }
      subscriber.report(error, handled: handled, severity: severity, context: full_context, source: source)
    end
  rescue => subscriber_error
    if logger
      logger.fatal(
        "Error subscriber raised an error: #{subscriber_error.message} (#{subscriber_error.class})\n" +
        subscriber_error.backtrace.join("\n")
      )
    else
      raise
    end
  end

  unless error.frozen?
    error.instance_variable_set(:@__rails_error_reported, true)
  end

  nil
end

Отправить отчёт об ошибке напрямую подписчикам. Можно использовать этот метод, когда блок-основанные методы handle и record не подходят.

Rails.error.report(error)

# File activesupport/lib/active_support/error_reporter.rb, line 201
def set_context(...)
  ActiveSupport::ExecutionContext.set(...)
end

Обновить контекст выполнения, доступный подписчикам об ошибках. Любой контекст, переданный методам handle, record или report, будет объединён с контекстом, установленным здесь.

Rails.error.set_context(section: "checkout", user_id: @user.id)

# File activesupport/lib/active_support/error_reporter.rb, line 161
def subscribe(subscriber)
  unless subscriber.respond_to?(:report)
    raise ArgumentError, "Error subscribers must respond to #report"
  end
  @subscribers << subscriber
end

Зарегистрировать нового подписчика на уведомления об ошибках. Подписчик должен отвечать на

report(Exception, handled: Boolean, severity: (:error OR :warning OR :info), context: Hash, source: String)

Метод report никогда не должен поднимать ошибку.

# File activesupport/lib/active_support/error_reporter.rb, line 145
def unexpected(error, severity: :warning, context: {}, source: DEFAULT_SOURCE)
  error = RuntimeError.new(error) if error.is_a?(String)
  error.set_backtrace(caller(1)) if error.backtrace.nil?

  if @debug_mode
    raise UnexpectedError, "#{error.class.name}: #{error.message}", error.backtrace, cause: error
  else
    report(error, handled: true, severity: severity, context: context, source: source)
  end
end

Отправить отчёт об ошибке при работе в режиме производства, или поднять её при разработке или тестировании.

При вызове в режиме производства, после отправки отчёта, этот метод вернёт null и выполнение продолжится.

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

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

Ошибка может быть экземпляром исключения или String.

example:

  def edit
    if published?
      Rails.error.unexpected("[BUG] Attempting to edit a published article, that shouldn't be possible")
      return false
    end
    # ...
  end

# File activesupport/lib/active_support/error_reporter.rb, line 176
def unsubscribe(subscriber)
  @subscribers.delete_if { |s| subscriber === s }
end

Отписаться от подписчика на уведомления об ошибках. Принимает либо подписчика, либо класс.

subscriber = MyErrorSubscriber.new
Rails.error.subscribe(subscriber)

Rails.error.unsubscribe(subscriber)
# or
Rails.error.unsubscribe(MyErrorSubscriber)