---
title: Elixir integration guide
description: Install and configure Honeybadger error tracking and application monitoring for Elixir applications outside of Phoenix and Plug frameworks.
url: https://docs.honeybadger.io/lib/elixir/integrations/other/
---

**Typical installation time:** 5 minutes

Hi there! You’ve found Honeybadger’s guide to **Elixir error tracking and performance monitoring**. If you use *Phoenix* or *Plug*, go check out the [Phoenix Integration Guide](https://docs.honeybadger.io/lib/elixir/integrations/phoenix/). If not, then read on.

This guide will teach you how to install the `honeybadger` Hex package in your Elixir project and use it to manually report errors to Honeybadger. You can also enable some [automatic logging and performance insights](https://docs.honeybadger.io/lib/elixir/insights/automatic-instrumentation/) (via telemetry) by setting the `insights_enabled` option to `true` in your configuration.

On this page:

## Installing the package

Add the Honeybadger package to `deps/0` in your application’s `mix.exs`:

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

Then run:

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

Finally, update your app’s `config.exs` file to include the Honeybadger configuration:

```elixir
config :honeybadger,
  app: :my_app,
  api_key: "PROJECT_API_KEY",
  environment_name: config_env(),
  insights_enabled: true # Enable logging and performance insights
```

Tip

Set `app` to your OTP application name (the `app` value in your `mix.exs`). Honeybadger uses this to highlight your app’s code in backtraces, making it easier to distinguish your code from library and framework code.

Tip

You can also configure your API key using the `HONEYBADGER_API_KEY` environment variable:

```sh
export HONEYBADGER_API_KEY="PROJECT_API_KEY"
```

If you use this method, you can omit the `api_key` option from your configuration.

See the [Configuration reference](https://docs.honeybadger.io/lib/elixir/reference/configuration/) for additional info.

## Testing your installation

Note

Honeybadger does not report errors in `dev` and `test` environments by default. To enable reporting in development environments, temporarily add `exclude_envs: []` to your Honeybadger config.

To test your installation, fire up `iex -S mix`, then run:

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

If Honeybadger is configured correctly, you should see a new error report in your Honeybadger project dashboard.

You can also send a test error with the included Mix task. It sends the error even in excluded environments, so you do not need to change `exclude_envs`:

```sh
mix honeybadger.test
```

## Configuring Elixir’s logger

When configured, Honeybadger will report errors for any [SASL](http://www.erlang.org/doc/apps/sasl/error_logging.html)-compliant processes when they crash. Just set the `use_logger` option to `true` in your application’s `config.exs` and you’re good to go:

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

## Manually reporting errors

You can use the `Honeybadger.notify/2` function to manually report rescued exceptions:

```elixir
try do
  # Buggy code goes here
rescue
  exception ->
    Honeybadger.notify(exception, stacktrace: __STACKTRACE__)
end
```

You can also pass a string message to the `notify` function (the second argument is optional):

```elixir
Honeybadger.notify("Sign in failed", metadata: %{
  user_id: current_user.id
})
```

See [Reporting Errors](https://docs.honeybadger.io/lib/elixir/errors/reporting-errors/) for more information.

## Reporting custom events

Use the `Honeybadger.event/1` and `Honeybadger.event/2` functions to send events to [Honeybadger Insights](https://docs.honeybadger.io/guides/insights/) for logging and performance monitoring:

```elixir
Honeybadger.event(%{
  event_type: "user_created",
  user: user.id
})


# Honeybadger.event/2 is a shorthand that automatically adds the event_type
# property to the event:
Honeybadger.event("project_deleted", %{
  project: project.name
})
```

See [Sending custom events](https://docs.honeybadger.io/lib/elixir/insights/sending-custom-events/) for more details.

## Sending logs from your infrastructure

Honeybadger isn’t just for errors and application data! You can use our [syslog](https://docs.honeybadger.io/guides/insights/integrations/systemd/), [Vector](https://docs.honeybadger.io/guides/insights/integrations/log-files/), or [PaaS integrations](https://docs.honeybadger.io/guides/insights/#adding-data-from-other-sources) to send additional data from your infrastructure to [Honeybadger Insights](https://docs.honeybadger.io/guides/insights/), where you can query, visualize, and analyze all of your production data in one place.

## Version requirements

See [Supported Versions](https://docs.honeybadger.io/lib/elixir/reference/supported-versions/).

---

## Try Honeybadger for FREE

Intelligent logging, error tracking, and Just Enough APM™ in one dev-friendly platform. Find and fix problems before users notice.

[Start free trial](https://app.honeybadger.io/users/sign_up)

[See plans and pricing](https://www.honeybadger.io/plans/)