README.md

Airbrake Crystal

Introduction

Airbrake Crystal is a Crystal notifier for Airbrake. 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.

deps do
  github "kyrylo/airbrake"
end

Examples

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.

Airbrake.configure do |config|
  # ...
end

To tweak values inline use the following API:

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.

airbrake.configure do |config|
  config.project_id = 105138
  config.project_key = 'fd04e13d806a90f96614ad8e529b2822'
end

endpoint

You may set a custom endpoint

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.

Airbrake.notify(Exception.new("App crashed!"))