{"id":13508505,"url":"https://github.com/ForzaElixir/rollbax","last_synced_at":"2025-03-30T11:32:04.422Z","repository":{"id":35891729,"uuid":"40178027","full_name":"ForzaElixir/rollbax","owner":"ForzaElixir","description":"Exception tracking and logging from Elixir to Rollbar","archived":false,"fork":false,"pushed_at":"2024-08-01T16:05:29.000Z","size":161,"stargazers_count":242,"open_issues_count":8,"forks_count":52,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-24T02:12:00.471Z","etag":null,"topics":["elixir","rollbar"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/rollbax","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ForzaElixir.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-04T10:21:26.000Z","updated_at":"2025-03-21T18:58:05.000Z","dependencies_parsed_at":"2022-08-08T12:15:49.203Z","dependency_job_id":null,"html_url":"https://github.com/ForzaElixir/rollbax","commit_stats":null,"previous_names":["elixir-addicts/rollbax"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForzaElixir%2Frollbax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForzaElixir%2Frollbax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForzaElixir%2Frollbax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForzaElixir%2Frollbax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ForzaElixir","download_url":"https://codeload.github.com/ForzaElixir/rollbax/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246314011,"owners_count":20757450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","rollbar"],"created_at":"2024-08-01T02:00:54.051Z","updated_at":"2025-03-30T11:31:59.415Z","avatar_url":"https://github.com/ForzaElixir.png","language":"Elixir","funding_links":[],"categories":["Logging","Errors logging"],"sub_categories":[],"readme":"# Rollbax\n\n[![Build Status](https://travis-ci.org/ForzaElixir/rollbax.svg?branch=master \"Build Status\")](https://travis-ci.org/ForzaElixir/rollbax)\n[![Hex Version](https://img.shields.io/hexpm/v/rollbax.svg \"Hex Version\")](https://hex.pm/packages/rollbax)\n\nElixir client for [Rollbar](https://rollbar.com).\n\n## Installation\n\nAdd Rollbax as a dependency to your `mix.exs` file:\n\n```elixir\ndefp deps() do\n  [{:rollbax, \"\u003e= 0.0.0\"}]\nend\n```\n\nThen run `mix deps.get` in your shell to fetch the dependencies. Add `:rollbax` to your list of `:applications` if you're not using `:extra_applications`.\n\n## Usage\n\nRollbax requires some configuration in order to work. For example, in `config/config.exs`:\n\n```elixir\nconfig :rollbax,\n  access_token: \"ffb8056a621f309eeb1ed87fa0c7\",\n  environment: \"production\"\n```\n\nThen, exceptions (errors, exits, and throws) can be reported to Rollbar using `Rollbax.report/3`:\n\n```elixir\ntry do\n  DoesNotExist.for_sure()\nrescue\n  exception -\u003e\n    Rollbax.report(:error, exception, System.stacktrace())\nend\n```\n\nFor detailed information on configuration and usage, take a look at the [online documentation](http://hexdocs.pm/rollbax).\n\n### Crash reports\n\nRollbax provides a way to automatically report crashes from OTP processes (GenServers, Tasks, and so on). It can be enabled with:\n\n```elixir\nconfig :rollbax, enable_crash_reports: true\n```\n\nFor more information, check out the documentation for [`Rollbax.Logger`](http://hexdocs.pm/rollbax/Rollbax.Logger.html).\nIf you had previously configured `Rollbax.Logger` to be a Logger backend (for example `config :logger, backends: [Rollbax.Logger]`), you will need to remove since `Rollbax.Logger` is not a Logger backend anymore and you will get crashes if you use it as such.\n\n### Plug and Phoenix\n\nFor examples on how to take advantage of Rollbax in Plug-based applications (including Phoenix applications), have a look at the [\"Using Rollbax in Plug-based applications\" page in the documentation](http://hexdocs.pm/rollbax/using-rollbax-in-plug-based-applications.html).\n\n### Non-production reporting\n\nFor non-production environments error reporting can be either disabled completely (by setting `:enabled` to `false`) or replaced with logging of exceptions (by setting `:enabled` to `:log`).\n\n```elixir\nconfig :rollbax, enabled: :log\n```\n\n### Using a proxy to reach the Rollbar server\n\nFor environments which require a proxy to connect to hosts outside of the network, the `:proxy` config entry can be added with a proxy URL as it's defined in the [hackney documentation](https://github.com/benoitc/hackney#proxy-a-connection).\n\n```elixir\nconfig :rollbax, proxy: \"https://my-secure-proxy:5001\"\n```\n\n## Contributing\n\nTo run tests, run `$ mix test --no-start`. The `--no-start` bit is important so that tests don't fail (because of the `:rollbax` application being started without an `:access_token` specifically).\n\nWhen making changes to the code, adhere to this [Elixir style guide](https://github.com/lexmag/elixir-style-guide).\n\nFinally, thanks for contributing! :)\n\n## License\n\nThis software is licensed under [the ISC license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FForzaElixir%2Frollbax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FForzaElixir%2Frollbax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FForzaElixir%2Frollbax/lists"}