Add Sentry to the ingestion server

[krysal]

Fixes

Fixes #1105 by @krysal

Description

Includes the Falcon integration of Sentry for the ingestion server. I'm not 100% sure this will catch all the errors of the ingestion process 🤔 but it's a start.

Testing Instructions

1. Add a test view to the Falcon app. I used the following one:

--- a/ingestion_server/ingestion_server/api.py
+++ b/ingestion_server/ingestion_server/api.py
@@ -314,6 +314,12 @@ class StateResource:
         clear_state()
 
 
+class SentryTest:
+    @staticmethod
+    def on_get(_, res):
+        """Test Sentry integration by raising an exception."""
+        raise Exception("This is a test of Sentry integration.")
+
 def create_api(log=True):
     """Create an instance of the Falcon API server."""
 
@@ -338,6 +344,7 @@ def create_api(log=True):
     _api.add_route("/task/{task_id}", TaskStatus(task_tracker))
     _api.add_route("/worker_finished", WorkerFinishedResource(task_tracker))
     _api.add_route("/state", StateResource())
+    _api.add_route("/sentry_test", SentryTest())
 
     return _api

2. Grab the SENTRY_DSN for the project if you have access to it: https://openverse.sentry.io/settings/projects/ingestion_server/keys/
3. Copy the URL to a .env file under the ingestion_server/ folder
4. Rebuild and start the service

just dc build ingestion_server && just dc up ingestion_server

5. Make a request to the testing view

curl --request GET \
  --url http://localhost:50281/sentry_test

6. See the issue appear in the Sentry dashboard

Checklist

• My pull request has a descriptive title (not a vague title like
  Update index.md).
• My pull request targets the default branch of the repository (main) or
  a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• [N/A] I added or updated tests for the changes I made (if applicable).
• [N/A] I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible
  errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[github-actions]

Full-stack documentation: https://docs.openverse.org/_preview/1106

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

[AetherUnbound]

Tested locally, this works great!

[obulat]

Would be interesting to know the results of the performance monitoring in Sentry!

Should we also add a TODO note to lower the traces_sample_rate as suggested in the docs?
https://docs.sentry.io/platforms/python/performance/#verify

[krysal]

The ingestion process is internal so the number of events shouldn't be a problem here unlike in the public-faced services, I think!