From f318ab8a2b1c452d5910d4ade49980816fe5cb66 Mon Sep 17 00:00:00 2001 From: Jonas L Date: Wed, 15 Mar 2023 14:13:37 +0100 Subject: [PATCH] docs: add instructions for the sentry setup (#2441) --- docs/admin-manual/monitoring.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/admin-manual/monitoring.md diff --git a/docs/admin-manual/monitoring.md b/docs/admin-manual/monitoring.md new file mode 100644 index 000000000..d8b2dc0c4 --- /dev/null +++ b/docs/admin-manual/monitoring.md @@ -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.