Packages
sentry
1.0.0
13.3.0
13.2.0
13.1.0
13.0.1
13.0.0
12.0.3
12.0.2
12.0.1
12.0.0
11.0.4
11.0.3
11.0.2
11.0.1
11.0.0
10.10.0
10.9.0
10.8.1
10.8.0
10.7.1
10.7.0
10.6.2
10.6.1
10.6.0
10.5.0
10.4.0
10.3.0
10.2.1
10.2.0
10.2.0-rc.2
10.2.0-rc.1
10.1.0
10.0.3
10.0.2
10.0.1
10.0.0
9.1.0
9.0.0
8.1.0
8.0.6
8.0.5
8.0.4
8.0.3
8.0.2
8.0.1
8.0.0
8.0.0-rc.2
8.0.0-rc.1
8.0.0-rc.0
retired
7.2.5
7.2.4
7.2.3
7.2.2
7.2.1
7.2.0
7.1.0
7.0.6
7.0.5
7.0.4
7.0.3
7.0.2
7.0.1
7.0.0
6.4.2
6.4.1
6.4.0
6.3.0
6.2.1
6.2.0
6.1.0
6.0.5
6.0.4
6.0.3
6.0.2
6.0.1
6.0.0
5.0.1
5.0.0
4.0.3
4.0.2
4.0.1
4.0.0
3.0.0
2.2.0
2.1.0
2.0.2
2.0.1
2.0.0
1.1.2
1.1.1
1.1.0
1.0.0
0.3.2
0.3.1
0.3.0
0.2.0
0.1.3
0.1.2
0.1.1
0.1.0
The Official Elixir client for Sentry
Current section
Files
Jump to
Current section
Files
README.md
# sentry
[](https://travis-ci.org/getsentry/sentry-elixir)
[](https://hex.pm/packages/sentry)
Sentry Client for Elixir which provides a simple API to capture exceptions, automatically handle Plug Exceptions and provides a backend for the Elixir Logger.
## Getting Started
To use Sentry with your projects, edit your mix.exs file to add it as a dependency and add the `:sentry` package to your applications:
```elixir
defp application do
[applications: [:sentry, :logger]]
end
defp deps do
[{:sentry, "~> 1.0"}]
end
```
Setup the application environment in your `config/prod.exs`
```elixir
config :sentry,
dsn: "https://public:secret@app.getsentry.com/1",
tags: %{
env: "production"
}
```
### Capture Exceptions
```elixir
Sentry.capture_exception(my_exception)
```
### Setup with Plug or Phoenix
In your router add the following lines
```elixir
use Plug.ErrorHandler
use Sentry.Plug
```
### Capture all Exceptions
Use this if you'd like to capture all Error messages that the Plug handler might not. Simply set `use_error_logger` to true.
This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).
```elixir
config :sentry,
use_error_logger: true
```
## Configuration
| Key | Required | Default |
| ------------- | -----------------|--------------|
| `dsn` | True | n/a |
| `environment_name` | False | `MIX_ENV` |
| `included_environments` | False | `~w(prod test dev)a` |
| `tags` | False | `%{}` |
| `release` | False | None |
| `server_name` | False | None |
| `use_error_logger` | False | False |