Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getsentry/sentry-elixir

The official Elixir SDK for Sentry (sentry.io)
https://github.com/getsentry/sentry-elixir

hacktoberfest tag-production team-web-backend

Last synced: 3 days ago
JSON representation

The official Elixir SDK for Sentry (sentry.io)

Host: GitHub
URL: https://github.com/getsentry/sentry-elixir
Owner: getsentry
License: mit
Created: 2014-08-13T22:38:05.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2024-10-28T13:28:24.000Z (6 days ago)
Last Synced: 2024-10-29T20:35:24.056Z (5 days ago)
Topics: hacktoberfest, tag-production, team-web-backend
Language: Elixir
Homepage: https://sentry.io
Size: 1.59 MB
Stars: 626
Watchers: 17
Forks: 185
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

freaking_awesome_elixir - Elixir - The Official Elixir client for [Sentry](https://sentry.io/). (Errors and Exception Handling)
fucking-awesome-elixir - sentry-elixir - The Official Elixir client for [Sentry](https://sentry.io/). (Errors and Exception Handling)
awesome-beam-monitoring - Sentry - official Elixir SDK for Sentry.io (Errors logging)
awesome-elixir - sentry-elixir - The Official Elixir client for [Sentry](https://sentry.io/). (Errors and Exception Handling)

README

        


  

    

  



_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_

![Build Status](https://github.com/getsentry/sentry-elixir/actions/workflows/main.yml/badge.svg)

[![Hex Package](https://img.shields.io/hexpm/v/sentry.svg)](https://hex.pm/packages/sentry)

[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/sentry)

This is the official Sentry SDK for [Sentry].

*💁: This README documents unreleased features (from the `master` branch). For documentation on the current release, see [the official documentation][docs].*

## Getting Started

### Install

To use Sentry in your project, add it as a dependency in your `mix.exs` file. Sentry does not install a JSON library nor HTTP client by itself. Sentry will default to trying to use [Jason] for JSON serialization and [Hackney] for HTTP requests, but can be configured to use other ones. To use the default ones, do:

```elixir

defp deps do

  [

    # ...

    {:sentry, "~> 10.0"},

    {:jason, "~> 1.4"},

    {:hackney, "~> 1.19"}

  ]

end

```

### Configuration

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

```elixir

# config/config.exs

config :sentry,

  dsn: "https://[email protected]/1",

  environment_name: Mix.env(),

  enable_source_code_context: true,

  root_source_code_paths: [File.cwd!()]

```

### Usage

This library comes with a [`:logger` handler][logger-handlers] to capture error messages coming from process crashes. To enable this, add the handler when your application starts:

```diff

  def start(_type, _args) do

+   :logger.add_handler(:sentry_handler, Sentry.LoggerHandler, %{})

    # ...

  end

```

The handler can also be configured to capture `Logger` metadata. See the documentation [here](https://hexdocs.pm/sentry/Sentry.LoggerBackend.html).

Sometimes you want to capture specific exceptions manually. To do so, use [`Sentry.capture_exception/2`](https://hexdocs.pm/sentry/Sentry.html#capture_exception/2).

```elixir

try do

  ThisWillError.really()

rescue

  my_exception ->

    Sentry.capture_exception(my_exception, stacktrace: __STACKTRACE__)

end

```

Sometimes you want to capture **messages** that are not exceptions. To do that, use [`Sentry.capture_message/2`](https://hexdocs.pm/sentry/Sentry.html#capture_exception/2):

```elixir

Sentry.capture_message("custom_event_name", extra: %{extra: information})

```

To learn more about how to use this SDK, refer to [the documentation][docs].

#### Testing Your Configuration

To ensure you've set up your configuration correctly we recommend running the

included Mix task. It can be tested on different Mix environments and will tell you if it is not currently configured to send events in that environment:

```bash

MIX_ENV=dev mix sentry.send_test_event

```

### Testing with Sentry

In some cases, you may want to _test_ that certain actions in your application cause a report to be sent to Sentry. Sentry itself does this by using [Bypass]. It is important to note that when modifying the environment configuration the test case should not be run asynchronously, since you are modifying **global configuration**. Not returning the environment configuration to its original state could also affect other tests depending on how the Sentry configuration interacts with them. A good way to make sure to revert the environment is to use the [`on_exit/2`][exunit-on-exit] callback that ships with ExUnit.

For example:

```elixir

test "add/2 does not raise but sends an event to Sentry when given bad input" do

  bypass = Bypass.open()

  Bypass.expect(bypass, fn conn ->

    assert {:ok, _body, conn} = Plug.Conn.read_body(conn)

    Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)

  end)

  Sentry.put_config(:dsn, "http://public:secret@localhost:#{bypass.port}/1")

  Sentry.put_config(:send_result, :sync)

  on_exit(fn ->

    Sentry.put_config(:dsn, nil)

    Sentry.put_config(:send_result, :none)

  end)

  MyModule.add(1, "a")

end

```

When testing, you will also want to set the `:send_result` type to `:sync`, so that sending Sentry events blocks until the event is sent.

## Integrations

  * [Phoenix and Plug][setup-phoenix-and-plug]

## Contributing to the SDK

Please make sure to read the [CONTRIBUTING.md](CONTRIBUTING.md) before making a pull request.

Thanks to everyone who has contributed to this project so far.



  



## Getting Help/Support

If you need help setting up or configuring the Elixir SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!

## Resources

  * [![Documentation](https://img.shields.io/badge/documentation-hexdocs.svg)][docs]

  * [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)

  * [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)

  * [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)

  * [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)

## License

Licensed under the MIT license, see [`LICENSE`](./LICENSE).

[Sentry]: http://sentry.io/

[Jason]: https://github.com/michalmuskala/jason

[Hackney]: https://github.com/benoitc/hackney

[Bypass]: https://github.com/PSPDFKit-labs/bypass

[docs]: https://hexdocs.pm/sentry/readme.html

[logger-handlers]: https://www.erlang.org/doc/apps/kernel/logger_chapter#handlers

[setup-phoenix-and-plug]: https://hexdocs.pm/sentry/setup-with-plug-and-phoenix.html

[exunit-on-exit]: https://hexdocs.pm/ex_unit/ExUnit.Callbacks.html#on_exit/2