From 90da48a41fdb7bf83fa36f51e0bee4aac5209c5d Mon Sep 17 00:00:00 2001 From: Tom Morrell Date: Wed, 11 Dec 2024 15:39:06 -0800 Subject: [PATCH 1/2] sentry: new install process --- docs/customize/Logging.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/customize/Logging.md b/docs/customize/Logging.md index 54f25344..f8f0b91c 100644 --- a/docs/customize/Logging.md +++ b/docs/customize/Logging.md @@ -69,10 +69,10 @@ You can configure Celery, SQLAlchemy, and Redis to send logs to Sentry. This beh To enable Sentry integration, follow these steps: -- Install the Sentry SDK: In your `Pipefile`, under the packages section, add the invenio-logging package with the sentry_sdk extra: +- Install the Sentry SDK: In your `Pipefile`, under the packages section, add the invenio-logging package with the sentry extra: ```python -invenio-logging = {extras = ["sentry_sdk"], version = "~=2.0"} +invenio-logging = {extras = ["sentry"]} ``` - Configure Logging Backends: In your `invenio.cfg` file, add the desired logging backends and configure the Sentry initialization options: @@ -97,6 +97,12 @@ INVENIO_SENTRY_DSN = "https://@sentry.io/" Replace with your actual Sentry project ID. +You can adjust any of the logging variables for Sentry like + +```python +LOGGING_SENTRY_LEVEL = "DEBUG" +``` + ## Customizing the Sentry Extension If needed, Additional options can be passed to the Sentry instance using the `LOGGING_SENTRY_INIT_KWARGS` configuration variable. From 0c3a374ef57377230d4367056eae7b4e92fc2368 Mon Sep 17 00:00:00 2001 From: Tom Morrell Date: Wed, 11 Dec 2024 15:43:44 -0800 Subject: [PATCH 2/2] sentry: upgrade instructions --- docs/releases/v13/upgrade-v13.0.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/releases/v13/upgrade-v13.0.md b/docs/releases/v13/upgrade-v13.0.md index 1cf81b27..e8a35abc 100644 --- a/docs/releases/v13/upgrade-v13.0.md +++ b/docs/releases/v13/upgrade-v13.0.md @@ -88,6 +88,13 @@ Update the file `/Pipfile`. +++invenio-app-rdm = {extras = [...], version = "~=13.0.0"} ``` +If you're using Sentry, update invenio-logging in `/Pipfile` to + +```diff +---invenio-logging = {extras = ["sentry_sdk"], version = "~=2.0"} ++++invenio-logging = {extras = ["sentry"]} +``` + ##### Step 3 Update the `Pipfile.lock` file: