Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/telebugs/telebugs-ruby
Telebugs error reporter for Ruby
https://github.com/telebugs/telebugs-ruby
backtrace crash-reporting crash-reporting-tool crash-reports error-handling error-monitoring error-reporting error-tracking ruby stacktrace
Last synced: 7 days ago
JSON representation
Telebugs error reporter for Ruby
- Host: GitHub
- URL: https://github.com/telebugs/telebugs-ruby
- Owner: telebugs
- License: mit
- Created: 2024-04-11T09:48:11.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T06:44:22.000Z (4 months ago)
- Last Synced: 2024-10-01T12:38:23.840Z (about 2 months ago)
- Topics: backtrace, crash-reporting, crash-reporting-tool, crash-reports, error-handling, error-monitoring, error-reporting, error-tracking, ruby, stacktrace
- Language: Ruby
- Homepage: https://telebugs.com/docs/integrations/ruby
- Size: 82 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Telebugs for Ruby
[](https://badge.fury.io/rb/telebugs)
Simple error monitoring for developers. Monitor production errors in real-time
and get them reported to Telegram with Telebugs.
- [Official Documentation](https://telebugs.com/docs/integrations/ruby)
- [FAQ](https://telebugs.com/faq)
- [Telebugs News](https://t.me/TelebugsNews)
- [Telebugs Community](https://t.me/TelebugsCommunity)
## Introduction
Any Ruby application or script can be integrated with
[Telebugs](https://telebugs.com) using the
[`telebugs`](https://rubygems.org/gems/telebugs) gem. The gem is designed to be
simple and easy to use. It provides a simple API to send errors to Telebugs,
which will then be reported to your Telegram project. This guide will help you
get started with Telebugs for Ruby.
For full details, please refer to the [Telebugs documentation](https://telebugs.com/docs/integrations/ruby).
## Installation
Install the gem and add to the application's Gemfile by executing:
```sh
bundle add telebugs
```
If bundler is not being used to manage dependencies, install the gem by executing:
```sh
gem install telebugs
```
## Usage
This is the minimal example that you can use to test Telebugs for Ruby with your
project:
```rb
require "telebugs"
Telebugs.configure do |c|
c.api_key = "YOUR_API_KEY"
end
begin
1 / 0
rescue ZeroDivisionError => e
Telebugs.report(e)
end
sleep 2
puts "An error was sent to Telebugs asynchronously.",
"It will appear in your dashboard shortly.",
"A notification was also sent to your Telegram chat."
```
Replace `YOUR_API_KEY` with your actual API key. You can ask
[@TelebugsBot](http://t.me/TelebugsBot) for your API key or find it in
your project's dashboard.
## Telebugs for Ruby integrations
Telebugs for Ruby is a standalone gem that can be used with any Ruby application
or script. It can be integrated with any Ruby framework or library.
We provide official integrations for the following Ruby platforms:
- [Ruby on Rails](https://github.com/telebugs/telebugs-rails)
## Ruby support policy
Telebugs for Ruby supports the following Ruby versions:
- Ruby 3.0+
If you need support older rubies or other Ruby implementations, please contact
us at [[email protected]](mailto:[email protected]).
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake test` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To
release a new version, update the version number in `version.rb`, and then run
`bundle exec rake release`, which will create a git tag for the version, push
git commits and the created tag, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/telebugs/telebugs-ruby.