ExSentry is an Elixir interface to the Sentry error reporting platform.

Installation

1. Add ExSentry to your list of dependencies in mix.exs:

   def deps do
     [{:exsentry, "~> 0.7.1"}]
   end

2. Ensure ExSentry is started and packaged with your application, in mix.exs:

   def application do
     [applications: [:exsentry]]
   end

3. Configure the default ExSentry client by specifying your Sentry DSN in config.exs:

   config :exsentry,
     otp_app: :my_app,
     dsn: "your-dsn-here"

   To turn ExSentry off for a particular MIX_ENV, set the Sentry DSN to the empty string "" in the appropriate config file.

Typical usage

Use ExSentry.LoggerBackend to send all :error-level log messages to Sentry:

defmodule MyApp do
  use Application

  def start(_type, _args) do
    Logger.add_backend(ExSentry.LoggerBackend)
    # ...
  end

  # ...
end

Use ExSentry.Plug to capture all exceptions in a Plug pipeline:

# Phoenix example
defmodule MyApp.Router do
  use MyApp.Web, :router
  use ExSentry.Plug

  pipeline :browser do
    # ...


# pure Plug example
defmodule MyApp.Router do
  use Plug.Router
  use ExSentry.Plug

  get "/" do
    # ...

Use ExSentry by itself to send exception or message data to Sentry:

ExSentry.capture_message("Hello world!")

ExSentry.capture_exception(an_exception)

ExSentry.capture_exceptions fn ->
  something_that_might_raise()
end

Standalone usage

ExSentry can be used as a manually-configured standalone client.

Create a client process like this:

client = ExSentry.new("your-dsn-here")

And capture messages or exceptions like this:

client |> ExSentry.capture_message("Hello world!")

client |> ExSentry.capture_exception(an_exception)

client |> ExSentry.capture_exceptions fn ->
  something_that_might_raise()
end

Authorship and License

ExSentry is copyright 2015-2016 Appcues, Inc.

ExSentry is released under the MIT License.