Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyrylo/airbrake-crystal
A Crystal notifier for Airbrake
https://github.com/kyrylo/airbrake-crystal
Last synced: 2 months ago
JSON representation
A Crystal notifier for Airbrake
- Host: GitHub
- URL: https://github.com/kyrylo/airbrake-crystal
- Owner: kyrylo
- License: mit
- Created: 2015-08-08T17:13:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-27T16:08:53.000Z (about 2 years ago)
- Last Synced: 2024-01-31T09:58:53.673Z (5 months ago)
- Language: Crystal
- Homepage: https://airbrake.io
- Size: 9.77 KB
- Stars: 9
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-crystal - airbrake-crystal - A Crystal notifier for [Airbrake](https://airbrake.io) (Third-party APIs)
README
Airbrake Crystal
----------------
[](https://travis-ci.org/kyrylo/airbrake-crystal)
Introduction
------------
Airbrake Crystal is a Crystal notifier for [Airbrake][airbrake.io]. Airbrake
Crystal is currently in early development. Please, use and report bugs or share
your ideas. The library provides minimalist API that enables the ability to send
any Crystal exception to the Airbrake dashboard.
Installation
------------
Add the library to `Projectfile`.
```crystal
deps do
github "kyrylo/airbrake"
end
```
Examples
--------
```crystal
require "airbrake"
Airbrake.configure do |config|
config.project_id = 105138
config.project_key = "fd04e13d806a90f96614ad8e529b2822"
# Optionally set the endpoint
config.endpoint = "http://something.private.com:8080"
end
begin
1/0
rescue ex : DivisionByZero
Airbrake.notify(ex)
end
puts 'Check your dashboard on https://app.airbrake.io'
```
Configuration
-------------
The main interface is `Airbrake.configure`.
```crystal
Airbrake.configure do |config|
# ...
end
```
To tweak values inline use the following API:
```crystal
Airbrake.config.project_id = 105138
```
### Config options
#### project_id & project_key
You **must** set both `project_id` & `project_key`.
To find your `project_id` and `project_key` navigate to your project's _General
Settings_ and copy the values from the right sidebar.
![][project-idkey]
```ruby
airbrake.configure do |config|
config.project_id = 105138
config.project_key = 'fd04e13d806a90f96614ad8e529b2822'
end
```
#### endpoint
You **may** set a custom `endpoint`
```crystal
Airbrake.configure do |config|
config.project_id = 105138
config.project_key = "fd04e13d806a90f96614ad8e529b2822"
config.endpoint = "http://something.private.com:8080"
end
```
API
---
#### Airbrake#notify
Sends an exception to Airbrake.
```crystal
Airbrake.notify(Exception.new("App crashed!"))
```
[airbrake.io]: http://airbrake.io
[project-idkey]: https://img-fotki.yandex.ru/get/3907/98991937.1f/0_b558a_c9274e4d_orig