Sentry's Elixir SDK enables automatic reporting of errors, exceptions and messages. You can also use it to monitor your cron jobs.

On this page, we get you up and running with Sentry's SDK.

You don't have an account and Sentry project established? Head over to sentry.io, then return to this page.

Sentry captures data by using an SDK within your application’s runtime.

Edit your mix.exs file to add it as a dependency and add the :sentry package to your application:

defp deps do
    # ...
    {:sentry, "~> 10.6.1"},
    {:jason, "~> 1.1"},

    # If you want to use Sentry's default HTTP client:
    {:hackney, "~> 1.8"}

Configuration should happen as early as possible in your application's lifecycle.

Sentry has a range of configuration options, but most applications will have a configuration that looks like the following:

config :sentry,
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  environment_name: Mix.env(),
  enable_source_code_context: true,
  root_source_code_paths: [File.cwd!()]

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

try do
  raise "This is a test!"
  exception ->
    Sentry.capture_exception(exception, stacktrace: __STACKTRACE__)

Learn more about manually capturing an error or message in our Usage documentation.

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").