From ef486c54ac518521ee40a1f7fe44e90c0f4a248f Mon Sep 17 00:00:00 2001 From: Stillhart Date: Mon, 15 Apr 2024 10:21:06 +0200 Subject: [PATCH] Update README.md with error reporting example --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2f206a2..4b118c9 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,14 @@ Please consult the [official guides](https://guides.rubyonrails.org/error_report There are intentionally few features; you can view and resolve errors. That’s it. The goal is to provide a simple, lightweight, and performant solution for tracking exceptions in your Rails application. If you need more features, you should probably use a 3rd party service like [Honeybadger](https://www.honeybadger.io/), whose MIT-licensed [Ruby agent gem](https://github.com/honeybadger-io/honeybadger-ruby) provided a couple of critical pieces of code for this project. +### Manually reporting an Error + +Errors can be added to Solid Errors via the Rails error reporting API: + +```ruby +Rails.error.report(error) +``` + ### Configuration You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, 6 configuration options are available: