https://github.com/backtrace-labs/backtrace-ruby
https://github.com/backtrace-labs/backtrace-ruby
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/backtrace-labs/backtrace-ruby
- Owner: backtrace-labs
- License: mit
- Created: 2018-06-21T14:58:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-19T22:24:08.000Z (almost 6 years ago)
- Last Synced: 2024-03-26T11:08:43.912Z (almost 2 years ago)
- Language: Ruby
- Size: 16.6 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backtrace error submission gem
# Installation
Add `gem 'backtraceio'` to your Gemfile. Alternatively, install it yourself:
```
gem install backtraceio
```
# Usage
```ruby
require 'backtraceio'
```
## Global crash handler
Pass your custom token and upload url from your Backtrace
account.
```ruby
BacktraceIO.register_error_handler(TOKEN, URL)
```
## Reporting custom errors
Create a new `Report` object.
```ruby
report = BacktraceIO::Report
```
(Optional) Add custom attributes/annotations/exception objects:
```ruby
report.attributes['cpu.cores'] = 8
report.annotations['Current User'] = { name: 'John', uid: 42 }
# if we're in an exception handler
report.add_exception_data current_exception
```
The format for attributes and annotations can be found in
[Backtrace I/O api docs][1].
Submit the crash. Pass your custom token and upload url from your Backtrace
account.
```ruby
st = BacktraceIO::SubmissionTarget.new TOKEN, URL
st.submit report.to_hash
```
[1]: https://api.backtrace.io/#tag/submit-crash