Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add instructions for the sentry setup (#2441)

This commit is contained in:
Jonas L 2023-03-15 14:13:37 +01:00 committed by GitHub
parent c290aece92
commit f318ab8a2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/admin-manual/monitoring.md Normal file
View File

@ -0,0 +1,26 @@
---
title: Monitoring
sidebar_position: 85
---
This page provide some guidance to monitor LibreTime.
## Sentry
To gather and remotely monitor exceptions that may occur in your installation, you can use the Sentry library shipped in LibreTime to send reports to any Sentry compatible server ([Sentry](https://sentry.io/), [Glitchtip](https://glitchtip.com/)).
To configure Sentry in LibreTime, you need to:
- install the LibreTime Python packages with the `sentry` extra (the container images already ship the sentry extra),
```bash
# Inside the LibreTime source dir
sudo pip install ./analyzer[sentry]
sudo pip install ./api[prod,sentry]
sudo pip install ./playout[sentry]
sudo pip install ./worker[sentry]
```
- set the [`SENTRY_DSN`](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) environment variable on each of the LibreTime services you want to monitor.
See the [Sentry Python SDK configuration options documentation](https://docs.sentry.io/platforms/python/configuration/options/) to further configure your setup.