TowerHoneybadger

Elixir error tracking and reporting to Honeybadger.

Tower reporter for Honeybadger.

Installation

Package can be installed by adding tower_honeybadger to your list of dependencies in mix.exs:

def deps do
  [
    {:tower_honeybadger, "~> 0.3.0"}
  ]
end

Setup

Option A: Automated setup

$ mix tower_honeybadger.install

Option B: Manual setup

Tell Tower to inform TowerHoneybadger reporter about errors.

# config/config.exs

config(
  :tower,
  :reporters,
  [
    # along any other possible reporters
    TowerHoneybadger
  ]
)

And configure :tower_honeybadger, with at least the API key.

# config/runtime.exs

if config_env() == :prod do
  config :tower_honeybadger,
    api_key: System.get_env("HONEYBADGER_API_KEY"),
    environment_name: System.get_env("DEPLOYMENT_ENV", to_string(config_env()))
end

Reporting

That's it. There's no extra source code needed to get reports in Honeybadger UI.

Tower will automatically report any errors (exceptions, throws or abnormal exits) occurring in your application. That includes errors in any plug call (including Phoenix), Oban jobs, async task or any other Elixir process.

Some HTTP request data will automatically be included in the report if a Plug.Conn if available when Tower handles the error, e.g. when an exception occurs in a web request.

Manual reporting

You can manually report errors just by informing Tower about any manually caught exceptions, throws or abnormal exits.

try do
  # possibly crashing code
rescue
  exception ->
    Tower.report_exception(exception, __STACKTRACE__)
end

More details on https://hexdocs.pm/tower/Tower.html#module-manual-reporting.

License

Copyright 2024 Mimiquate

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.