# Airbrakex ![Package Version](https://img.shields.io/hexpm/v/airbrakex.svg) [![Code Climate](https://codeclimate.com/github/fazibear/airbrakex/badges/gpa.svg)](https://codeclimate.com/github/fazibear/airbrakex) [![Build Status](https://travis-ci.org/fazibear/airbrakex.svg?branch=master)](https://travis-ci.org/fazibear/airbrakex)
Elixir client for the [Airbrake](https://airbrake.io) service!
## Installation
Add Airbrakex as a dependency to your `mix.exs` file:
```elixir
def application do
[applications: [:airbrakex]]
end
defp deps do
[{:airbrakex, "~> 0.1.0"}]
end
```
Then run `mix deps.get` in your shell to fetch the dependencies.
### Configuration
It requires `project_key` and `project` parameters to be set
in your application environment, usually defined in your `config/config.exs`.
`logger_level` and `environment` are optional.
If you want to use errbit instance, set custom url as endpoint.
```elixir
config :airbrakex,
project_key: "abcdef12345",
project_id: 123456,
logger_level: :error,
environment: Mix.env,
endpoint: "http://errbit.yourdomain.com"
```
## Usage
```elixir
try do
IO.inspect("test",[],"")
rescue
exception -> Airbrakex.notify(exception)
end
```
### Logger Backend
There is a Logger backend to send logs to the Airbrake,
which could be configured as follows:
```elixir
config :logger,
backends: [Airbrakex.LoggerBackend]
```
### Plug
You can plug `Airbrakex.Plug` in your web application Plug stack to send all exception to Airbrake
```elixir
defmodule YourApp.Router do
use Phoenix.Router
use Airbrakex.Plug
# ...
end
```
### Ignore
You can ignore certain types of errors by specifying `:ignore` config key:
```elixir
config :airbrakex,
...
# List form
ignore: [Phoenix.Router.NoRouteError]
# OR
# Function
ignore: fn(error) ->
cond do
error.type == Phoenix.Router.NoRouteError -> true
String.contains?(error.message, "Ecto.NoResultsError") -> true
true -> false
end
end
```
## Thankx
- [Airbrake Elixir](https://github.com/romul/airbrake-elixir)
- [AirbrakePlug](https://github.com/romul/airbrake_plug)
- [Rollbax](https://github.com/elixir-addicts/rollbax)