Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thermondo/log-reporter
https://github.com/thermondo/log-reporter
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/thermondo/log-reporter
- Owner: thermondo
- License: mit
- Created: 2022-12-05T13:32:00.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T05:21:18.000Z (9 months ago)
- Last Synced: 2024-04-16T01:57:46.998Z (9 months ago)
- Language: Rust
- Size: 333 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# heroku sentry reporter
## motivation
In our Heroku apps we saw that developers tend to overlook some Heroku errors.
Since we're using [sentry](sentry.io/) for error reporting, we had the idea of
writing a small service that creates sentry issues for each error.
We now open the codebase up, with the goal to evolve this service into something
that is useful for more companies.
## design
Heroku supports
[HTTPS log drains](https://devcenter.heroku.com/articles/log-drains). On each of
your Heroku application you can configure a new log drain pointing to this
log-reporter service. This leads to us getting all log messages.
The service then parses the logs for specific errors and generates a
sentry report out of it.
So the sentry error grouping works we try to replace some patterns in the path
which we think represent identifiers.
## errors
Currently we parse & report:
- [H12 - request timeout](https://devcenter.heroku.com/articles/error-codes#h12-request-timeout)
- [R10 - boot timeout](https://devcenter.heroku.com/articles/error-codes#r10-boot-timeout)
## deployment
Deployment works via `heroku.yml` and the linked `Dockerfile`.
We're currently running the service on _one_ small dyno, and it's handling
around 3k RPM without any issues.
## configuration
Configuration can be set using environment variables, more details in the
`config` module.
### the service itself
- `PORT` (mandatory): normally set by Heroku, the port the webserver runs on
- `SENTRY_DSN` (optional): the sentry DSN where the service should send _its own_
errors to. The sentry client library additional reads some other environment
variables like `SENTRY_ENVIRONMENT`.
- `SENTRY_DEBUG` (optional): activates sentry debug logging
### mappings for services
You need to add this service as a log-drain to each sender-service:
```bash
$ heroku drains:add https://xxx-log-reporter.herokuapp.com/
...
$ heroku drains
[this will print the _drain token_ you need]
```
Then you can add any mapping as a new environment variable `SENTRY_MAPPING_XXX`
where `XXX` can be replaced with any service name.
The value for this mapping contains of **3** pieces, separated by `|`:
- the logplex token from above
- the destination sentry environment name
- the destination sentry dsn
Example value:
```text
d.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx|production|https://[email protected]/9999999
```
## current limitations
This service is running in production at thermondo, but has some pending
improvements, and also contains some internal thermondo specifics around the
replacement patterns in paths.
You can use the service at your own risk, if these specifics are fine with you.