crystal-rollbar

Version, currently master branch1 version
  • master branchlatestOct 4, 2023

github.com/msa7/crystal-rollbar

Crystal client for Rollbar https://rollbar.com

7 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crystal-rollbar:
    github: msa7/crystal-rollbar
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.32.1
License
MIT
Author
Sergey Makridenkov <s@msa.im>

Dependencies

This version declares no dependencies.

README

# crystal-rollbar

An unofficial Crystal-language client and integration layer for the [Rollbar](https://rollbar.com) error reporting API.

Based on [Rollbar-gem](https://github.com/rollbar/rollbar-gem) and [raven.cr](https://github.com/Sija/raven.cr)

Features:

- [x] report to Rollbar
- [ ] report about parent exception
- [ ] Kemal integration. Sumbit URL, HTTP variable based on Kemal environment
- [ ] Write example of async error reporting (fiber, sidekiq)

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml
   dependencies:
     crystal-rollbar:
       github: msa7/crystal-rollbar
   ```

2. Run `shards install`

## Usage

```crystal
require "crystal-rollbar"

Rollbar.access_token = "rollbar_access_token"
Rollbar.environment = "staging"
Rollbar.framework = "Kemal"
Rollbar.code_version = "0.1"

Rollbar.debug("Debug #{Time.utc}", user_id = "777")

begin
  raise "Error #{Time.utc}"
rescue e
  Rollbar.error(e, user_id = "555")
end
```

With Kemal

```crystal
require "crystal-rollbar/kemal"

Kemal.config.add_handler(Rollbar::Kemal::ExceptionHandler.new)
Kemal.run
```

With Sidekiq

```crystal
require "crystal-rollbar/sidekiq"
cli = Sidekiq::CLI.new

server = cli.configure do |config|
  config.error_handlers << Rollbar::Sidekiq::ExceptionHandler.new
end

cli.run(server)
```


## Contributing

1. Fork it (<https://github.com/your-github-user/crystal-rollbar/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Sergey Makridenkov](https://github.com/your-github-user) - creator and maintainer