https://github.com/mimiquate/tower_error_tracker
Tower reporter for ErrorTracker
https://github.com/mimiquate/tower_error_tracker
elixir error-handling error-monitoring error-reporting error-tracking tower
Last synced: about 1 year ago
JSON representation
Tower reporter for ErrorTracker
- Host: GitHub
- URL: https://github.com/mimiquate/tower_error_tracker
- Owner: mimiquate
- License: apache-2.0
- Created: 2024-09-23T20:07:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T13:35:56.000Z (about 1 year ago)
- Last Synced: 2025-03-26T09:42:44.600Z (about 1 year ago)
- Topics: elixir, error-handling, error-monitoring, error-reporting, error-tracking, tower
- Language: Elixir
- Homepage: https://hex.pm/packages/tower_error_tracker
- Size: 138 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TowerErrorTracker
[](https://github.com/mimiquate/tower_error_tracker/actions?query=branch%3Amain)
[](https://hex.pm/packages/tower_error_tracker)
[](https://hexdocs.pm/tower_error_tracker)
[Tower](https://github.com/mimiquate/tower) reporter for [ErrorTracker](https://github.com/elixir-error-tracker/error-tracker).
## Installation
Package can be installed by adding `tower_error_tracker` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:tower_error_tracker, "~> 0.3.6"}
]
end
```
> [!NOTE]
> Don't list `:error_tracker` in the dependencies, it is already included as part of `:tower_error_tracker`.
> If you really must list it, list it with [`runtime: false`](https://hexdocs.pm/mix/Mix.Tasks.Deps.html#module-dependency-definition-options), so you don't get [duplicated](https://github.com/mimiquate/tower_error_tracker/issues/38) errors reports.
## Usage
Tell `Tower` to inform `TowerErrorTracker` reporter about errors.
```elixir
# config/config.exs
config(
:tower,
:reporters,
[
# along any other possible reporters
TowerErrorTracker
]
)
```
And configure and set up `:error_tracker` new database tables by following just these two ErrorTracker sections:
- [Configure](https://github.com/elixir-error-tracker/error-tracker/blob/main/guides/Getting%20Started.md#configuring-errortracker)
- [Set up the database](https://github.com/elixir-error-tracker/error-tracker/blob/main/guides/Getting%20Started.md#setting-up-the-database)
That's it.
It will try report any errors (exceptions, throws or abnormal exits) within your application. That includes errors in
any plug call (including Phoenix), Oban job, async task or any other Elixir process.
### Manual reporting
You can manually report errors just by informing `Tower` about any manually caught exceptions, throws or abnormal exits.
```elixir
try do
# possibly crashing code
rescue
exception ->
Tower.report_exception(exception, __STACKTRACE__)
end
```
More details on https://hexdocs.pm/tower/Tower.html#module-manual-reporting.
## License
Copyright 2024 Mimiquate
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.