4 Sentry Integration
Ciarán Ainsworth edited this page 2022-09-10 13:55:24 +00:00

Glitchtip 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. Funkwhale implements the Sentry SDK to send information from Funkwhale pods to Glitchtip.

Configuration

You can configure the Sentry SDK using the following parameters in the .env file:

  • FUNKWHALE_SENTRY_DSN: the 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.

Sentry properties

Funkwhale sets the following properties in the Sentry SDK:

  • dsn: the data source name. Configured by FUNKWHALE_SENTRY_DSN in the .env file
  • debug: whether the SDK runs in debug mode. Configured by DEBUG in the .env file
  • release: the current Funkwhale Version
  • environment: Set to "api" for the backend and "prod" or "develop" for the frontend

Custom tags

Funkwhale adds the following custom tags to error payloads:

  • instance: the base URL of the reporting Funkwhale pod