Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add use_logger config example #577

Merged
merged 3 commits into from
Jan 16, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,20 @@ Elixir Plug, Logger and client for the :zap: [Honeybadger error notifier](https:
### 1. Install the package

Add the Honeybadger package to `deps/0` in your
application's `mix.exs` file and run `mix do deps.get, deps.compile`
application's `mix.exs`:

```elixir
defp deps do
[{:honeybadger, "~> 0.16"}]
[{:honeybadger, "~> 0.22"}]
end
```

Then run:

```sh
mix do deps.get, deps.compile
```

### 2. Set your API key and environment name

By default the environment variable `HONEYBADGER_API_KEY` will be used to find
Expand Down Expand Up @@ -99,10 +105,25 @@ defmodule MyPlugApp do
end
```

### 4. Report a test error

To report a test error to Honeybadger, fire up `iex -S mix`, then run:

```elixir
Honeybadger.notify("Hello Elixir!")
```

#### Logger

Just set the `use_logger` option to `true` in your application's `config.exs`
and you're good to go! Any
and you're good to go:

```elixir
config :honeybadger,
use_logger: true
```

Any
[SASL](http://www.erlang.org/doc/apps/sasl/error_logging.html) compliant
processes that crash will send an error report to the `Honeybadger.Logger`.
After the error reaches the logger we take care of notifying Honeybadger for
Expand Down
Loading