|
|
We use Glitchtip to collect errors from instances running by the Collective, members of the collective or any admin who decides to donate their data. Glitchtip provides a Sentry compatible API, which makes it possible to use the Sentry SDK to send those data.
|
|
[Glitchtip](https://glitchtip.com) is an open source application monitoring and error tracking platform. Funkwhale uses Glitchtip to track and collate errors from Funkwhale pods. Pod admins can opt in to share this information with the collective or use their own server.
|
|
|
|
|
|
|
|
Glitchtip is compatible with [Sentry](https://sentry.io). Funkwhale implements the [Sentry SDK](https://docs.sentry.io) to send information from Funkwhale pods to Glitchtip.
|
|
|
|
|
|
|
|
## Configuration
|
|
## Configuration
|
|
|
|
|
|
|
|
There are currently two parameters to configure the SDK:
|
|
You can configure the Sentry SDK using the following parameters in the `.env` file:
|
|
|
|
|
|
|
|
* `FUNKWHALE_SENTRY_DSN`: the Glitchtip endpoint to which Funkwhale sends error information. Add your Glitchtip URL here, or use the Funkwhale Collective's instance.
|
|
|
|
* `FUNKWHALE_SENTRY_DSN=https://5840197379c64f65aad3c5c09274994d@am.funkwhale.audio/1`
|
|
|
|
* `FUNKWHALE_SENTRY_SR`: configures the sample rate for error tracking. This value defaults to `0.25`, meaning the SDK tracks **1/4** errors. To report all errors, change this to `1`.
|
|
|
|
|
|
|
|
* `FUNKWHALE_SENTRY_DSN` configures the endpoint to send the data to. If you want to use our instance to collect errors, use `FUNKWHALE_SENTRY_DSN=https://5840197379c64f65aad3c5c09274994d@am.funkwhale.audio/1`. You are free to use your own instance of course.
|
|
## Glitchtip properties
|
|
|
* `FUNKWHALE_SENTRY_SR` configures the share of reported errors. The default is `0.25`. If you run a small instance, feel free to raise it up to 1. If you experience performance issues, you can lower the value.
|
|
|
|
|
|
|
|
|
|
## Usage of options
|
|
Funkwhale sets the following properties in the Sentry SDK:
|
|
|
|
|
|
|
|
* `dsn` is set by `FUNKWHALE_SENTRY_DSN`
|
|
* [`dsn`](https://docs.sentry.io/platforms/unity/configuration/options/#debug): the data source name. Configured by `FUNKWHALE_SENTRY_DSN` in the `.env` file
|
|
|
* `debug` is set by `DEBUG`
|
|
* [`debug`](https://docs.sentry.io/platforms/unity/configuration/options/#debug): whether the SDK runs in debug mode. Configured by `DEBUG` in the `.env` file
|
|
|
* `release` is set by the current Funkwhale Version
|
|
* [`release`](https://docs.sentry.io/platforms/unity/configuration/options/#release): the current Funkwhale Version
|
|
|
* `environment` is `api` for the backend and `prod` or `develop` for the frontend
|
|
* [`environment`](https://docs.sentry.io/platforms/unity/configuration/options/#environment): Set to "api" for the backend and "prod" or "develop" for the frontend
|
|
|
|
|
|
|
|
## Custom tags
|
|
## Custom tags
|
|
|
|
|
|
|
|
* `instance` is the base URL of the Funkwhale instance reporting the error |
|
Funkwhale adds the following custom tags to Glitchtip payloads:
|
|
\ No newline at end of file |
|
|
|
|
|
- `instance`: the base URL of the reporting Funkwhale pod |
|
|
|
\ No newline at end of file |
