Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bugsnag-elixir/plugsnag
A Bugsnag notifier for Elixir's plug
https://github.com/bugsnag-elixir/plugsnag
Last synced: 2 months ago
JSON representation
A Bugsnag notifier for Elixir's plug
- Host: GitHub
- URL: https://github.com/bugsnag-elixir/plugsnag
- Owner: bugsnag-elixir
- License: mit
- Created: 2014-07-18T15:41:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-11-02T01:27:26.000Z (about 2 years ago)
- Last Synced: 2024-10-19T01:47:06.569Z (3 months ago)
- Language: Elixir
- Size: 78.1 KB
- Stars: 66
- Watchers: 5
- Forks: 41
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Bugsnag notifier for Elixir's plug. (Framework Components)
- fucking-awesome-elixir - plugsnag - Bugsnag notifier for Elixir's plug. (Framework Components)
- awesome-elixir - plugsnag - Bugsnag notifier for Elixir's plug. (Framework Components)
README
# Plugsnag
[](https://hex.pm/packages/plugsnag)
[](https://hexdocs.pm/plugsnag/)
[](https://hex.pm/packages/plugsnag)
[](https://github.com/bugsnag-elixir/plugsnag/blob/master/LICENSE.md)
[](https://github.com/bugsnag-elixir/plugsnag/commits/master)
Report errors in your Plug stack or whatever to [Bugsnag](https://bugsnag.com),
because that's a super great place to send your errors.
## Installation/Usage
Just throw it in your deps in your `mix.exs`:
```elixir
defp deps do
[
{:plugsnag, "~> 1.7.0"}
]
end
```
Then you'll need to configure it with your API key as
per [the bugsnag-elixir docs](https://github.com/jarednorman/bugsnag-elixir).
To use the plug, `use` it in your router. For example in an Phoenix app:
```elixir
defmodule YourApp.Router do
use Phoenix.Router
use Plugsnag
# ...
end
```
If you want to define your own `handle_errors` functions using [Plug.ErrorHandler](https://hexdocs.pm/plug/Plug.ErrorHandler.html), then you can call `Plugsnag.handle_errors/{2,3}` directly.
```elixir
defmodule YourApp.Router do
use Phoenix.Router
use Plug.ErrorHandler
# ...
defp handle_errors(conn, assigns) do
Plugsnag.handle_errors(conn, assigns)
# do your own handling
end
end
```
### Filtering Parameters and Headers
By default, the `BasicErrorReportBuilder` will filter out password parameters from error reports sent to Bugsnag. You can customize this list inside your configuration:
```elixir
config :plugsnag, filter: [params: ~w(password password_confirmation super_sekrit), headers: []]
```
By default, query strings are not filtered and may still leak sensitive information stored there
(which shouldn't be, anyway). To filter the query string in the generated report, set the
`:filter_query_string` config option to true:
```elixir
config :plugsnag, filter_query_string: true
```
## Customizing error reporting
You can also customize how an error is sent to bugsnag-elixir by passing your
own custom ErrorReportBuilder with the `:error_report_builder` option.
```elixir
defmodule YourApp.Router do
use Phoenix.Router
use Plugsnag, error_report_builder: YourApp.ErrorReportBuilder
# ...
end
```
```elixir
defmodule YourApp.ErrorReportBuilder do
@behaviour Plugsnag.ErrorReportBuilder
def build_error_report(error_report, conn) do
error_report
|> Plugsnag.BasicErrorReportBuilder.build_error_report(conn)
|> put_user_info(conn)
end
defp put_user_info(error_report, conn) do
current_user = conn.assigns[:current_user]
user_info = %{
id: current_user.id
}
%{error_report | user: user_info}
end
end
```
## Copyright and License
Copyright (c) 2015 Jared Norman, Andrew Harvey, Guilherme de Maio
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.