Feat: Sentry error monitoring

[angela-tran]

Closes #252
Closes #312

How to test / review

Create a new Python settings file in your local config/ directory, e.g. config/sentry.py, with the following contents:

# get the DSN from https://sentry.calitp.org/settings/sentry/projects/eligibility-server/keys/
SENTRY_DSN = "https://..."  

# make up a name for testing
AGENCY_NAME = "Your Transit Agency"

In your local .env file, make sure to point to your custom settings file:

ELIGIBILITY_SERVER_SETTINGS=../config/sentry.py

Get this branch and rebuild and reopen in the devcontainer.

F5 to run the app

Go to http://localhost:PORT/error to trigger a Sentry error

Log in to Sentry to confirm your details were recorded in the error.

TODOs

• Figure out / decide on a way to single-source the version number and read it when setting release for Sentry determined that we don't need this. Benefits uses VERSION as a fallback, but in practice, we're always getting the git hash.

Before merging

• Set SENTRY_DSN as a setting for current deployments of eligibility-server (it will be within the file that is specified by ELIGIBILITY_SERVER_SETTINGS)
  • dev
  • test
  • prod
• Set AGENCY_NAME as a setting for current deployments of eligibility-server (it will be within the file that is specified by ELIGIBILITY_SERVER_SETTINGS). This should match the corresponding agency.long_name from Benefits
  • dev
  • test
  • prod

[thekaveman]

Rebased to clean up merge conflicts

[thekaveman]

Confirmed the custom AGENCY_NAME shows up in Sentry as a tag agency_name:

[thekaveman]

I should update the docs with this, putting back into draft -- sorry!

[machikoyasuda]

I'm able to get Sentry errors locally to appear. But having some trouble with the local env file settings not being ready properly.

[angela-tran]

From @thekaveman on 2023-10-26:

between Sentry having issues today and not being able to verify the agency name, we need to hold this and keep working on it.

Also see #355 (comment)

[thekaveman]

@angela-tran @machikoyasuda @allejo I think Sentry is back working again, so we can proceed with testing this again!

Also, my notes were wrong about how to configure locally for testing. I've updated that -- you need to use a custom settings.py file rather than putting all this in your .env.

[machikoyasuda]

I still keep getting this: SENTRY_DSN not set, so won't send events despite following the new instructions.

[allejo]

I second Machiko's findings. I have to set SENTRY_DSN in my local .env file and source that file before I get this reporting correctly to Sentry. Following the instructions above got me the same results as #253 (comment); mind you, doing an install of python-dotfiles did not help.

Also, changing (maybe "fixing") the path to the settings file did not change anything. I'm not sure where the ../ from the original PR comment is coming from.

ELIGIBILITY_SERVER_SETTINGS=./config/sentry.py

[thekaveman]

Also, changing (maybe "fixing") the path to the settings file did not change anything. I'm not sure where the ../ from the original PR comment is coming from.

Yeah we should probably have a comment in there about this. It's because this environment variable has to be relative to the code that loads the settings file, and not to where the environment file is.

The code that loads the settings is in a sibling to the location of the settings file (eligibility_server/ vs. config/), so we have to back out to get to config/.

[machikoyasuda]

This works for me now locally

Always re-build your Devcontainer without cache after changing the .env file.

[machikoyasuda]

🙏

Thank you for the clarifying comment