Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add updated sentry instructions #733

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add updated sentry instructions #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90da48a
sentry: new install process
tmorrell Dec 11, 2024
0c3a374
sentry: upgrade instructions
tmorrell Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/customize/Logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for little extra formatting + typo:

Suggested change
- Install the Sentry SDK: In your `Pipefile`, under the packages section, add the invenio-logging package with the sentry extra:
- Install the Sentry SDK: In your `Pipfile`, 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:
Expand All @@ -97,6 +97,12 @@ INVENIO_SENTRY_DSN = "https://<SENTRY_PROJECT_ID>@sentry.io/<SENTRY_PROJECT_ID>"

Replace <SENTRY_PROJECT_ID> 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.
Expand Down
7 changes: 7 additions & 0 deletions docs/releases/v13/upgrade-v13.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@ Update the file `<my-site>/Pipfile`.
+++invenio-app-rdm = {extras = [...], version = "~=13.0.0"}
```

If you're using Sentry, update invenio-logging in `<my-site>/Pipfile` to

```diff
---invenio-logging = {extras = ["sentry_sdk"], version = "~=2.0"}
+++invenio-logging = {extras = ["sentry"]}
```

##### Step 3
Update the `Pipfile.lock` file:

Expand Down