Packages
honeybadger
0.30.2
0.30.2
0.30.1
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.1
0.24.0
0.23.0
0.22.1
0.22.0
0.21.0
0.20.0
0.19.0
0.18.1
0.18.0
0.17.0
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.0
0.14.1
0.14.0
0.13.1
0.13.0
0.12.1
0.12.0
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.9.0
0.8.0
0.7.0
0.7.0-beta
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.1
0.3.0
0.2.0
0.1.2
0.1.1
0.1.0
Elixir client, Plug and error_logger for integrating with the Honeybadger.io exception tracker"
Current section
Files
Jump to
Current section
Files
honeybadger
README.md
README.md
# Honeybadger for Elixir
[](https://github.com/honeybadger-io/honeybadger-elixir/actions/workflows/elixir.yml)
[](https://hex.pm/packages/honeybadger)
This is the Elixir Plug, Logger, and client for integrating apps with the :zap: [Honeybadger Exception Notifier for Elixir and Phoenix](https://www.honeybadger.io/for/elixir/).
When an uncaught exception occurs, Honeybadger will POST the relevant data to the Honeybadger server specified in your environment. Honeybadger can also send automatic performance events from Phoenix, Ecto, Oban, and more to [Honeybadger Insights](https://docs.honeybadger.io/guides/insights/).
## Documentation and Support
For comprehensive documentation and support, [check out our documentation site](https://docs.honeybadger.io/lib/elixir/).
API documentation is available on [HexDocs](https://hexdocs.pm/honeybadger/).
## Changelog
The [CHANGELOG](CHANGELOG.md) is generated automatically as part of the release process, using [conventional commits](https://www.conventionalcommits.org/).
## Development
Pull requests are welcome. If you're adding a new feature, please [submit an issue](https://github.com/honeybadger-io/honeybadger-elixir/issues/new) as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.
### To contribute your code:
1. Fork it.
2. Create a topic branch `git checkout -b my_branch`
3. Commit your changes `git commit -am "feat: add a thing"`
4. Push to your branch `git push origin my_branch`
5. Send a [pull request](https://github.com/honeybadger-io/honeybadger-elixir/pulls)
PR titles must follow the [conventional commits](https://www.conventionalcommits.org/) format.
### Running the tests
To run the same tests as CI (the main suite plus the `dummy/mixapp` tests):
```sh
mix deps.ci
mix test.ci
```
To run only the main test suite:
```sh
mix deps.get
mix test
```
### Releasing
Releases are automated, using [GitHub Actions](.github/workflows/publish.yml):
- When a PR is merged on master, the [elixir.yml](.github/workflows/elixir.yml) workflow is executed, which runs the tests.
- The [publish.yml](.github/workflows/publish.yml) workflow uses [release-please](https://github.com/googleapis/release-please) to open or update a release PR with the suggested version bump and changelog, based on the commit messages.
Note: Not all commit messages trigger a new release, for example, `chore: ...` will not trigger a release.
- When the release PR is merged, the [publish.yml](.github/workflows/publish.yml) workflow runs again, creates a GitHub release, and publishes the package to Hex.pm.
### License
This library is MIT licensed. See the [LICENSE](https://raw.github.com/honeybadger-io/honeybadger-elixir/master/LICENSE) file in this repository for details.