Merge pull request internetarchive#11046 from scottbarnes/add-sentry-trace-id-to-errors

Feature: show Sentry error ID to patrons

Author: cdrini

openlibrary/i18n/messages.pot

@@ -1913,6 +1913,13 @@ msgstr ""
 msgid "We're sorry, a problem occurred while responding to your request:"
 msgstr ""
 
+#: internalerror.html
+#, python-format
+msgid ""
+"The reference code %s and Sentry trace ID %s have been created to track "
+"this error and we will investigate as we're able."
+msgstr ""
+
 #: internalerror.html
 #, python-format
 msgid ""

openlibrary/plugins/openlibrary/code.py

@@ -1147,7 +1147,7 @@ def save_error():
 
 
 def internalerror():
-    name = save_error()
+    name_webpy_error = save_error()
 
     import sys
 
@@ -1161,14 +1161,20 @@ def internalerror():
     # TODO: move this to plugins\openlibrary\sentry.py
     from openlibrary.plugins.openlibrary.sentry import sentry
 
+    sentry_event_id: str | None = None
     if sentry.enabled:
-        sentry.capture_exception_webpy()
+        sentry_event_id = sentry.capture_exception_webpy()
 
     if features.is_enabled('debug'):
         raise web.debugerror()
     else:
         msg = render.site(
-            render.internalerror(name, etype=exception_type, evalue=exception_value)
+            render.internalerror(
+                name_webpy_error,
+                sentry_event_id,
+                etype=exception_type,
+                evalue=exception_value,
+            )
         )
         raise web.internalerror(web.safestr(msg))
 

openlibrary/templates/internalerror.html

@@ -1,4 +1,4 @@
-$def with (name, etype=None, evalue=None)
+$def with (name_webpy_error, sentry_event_id=None, etype=None, evalue=None)
 
 $var title: $_("Internal Error")
 
@@ -12,6 +12,9 @@ <h1>$_("A Problem Occurred")</h1>
         $etype
         $evalue
     </code>
-    <p>$:_("The reference code %s has been created to track this error and we will investigate as we're able.", name)</p>
+    $if sentry_event_id:
+        <p>$:_("The reference code %s and Sentry trace ID %s have been created to track this error and we will investigate as we're able.", name_webpy_error, sentry_event_id)</p>
+    $else:
+        <p>$:_("The reference code %s has been created to track this error and we will investigate as we're able.", name_webpy_error)</p>
     <p>$:_('Return to the <a class="go-back-link" href="javascript:;">previous page</a>?')</p>
-</div>
+</div>

openlibrary/utils/sentry.py

@@ -83,10 +83,13 @@ def capture_exception():
         app.internalerror = capture_exception
         app.add_processor(WebPySentryProcessor(app))
 
-    def capture_exception_webpy(self):
-        with sentry_sdk.new_scope() as scope:
+    def capture_exception_webpy(self) -> str | None:
+        with sentry_sdk.push_scope() as scope:
             scope.add_event_processor(add_web_ctx_to_event)
             sentry_sdk.capture_exception()
+            transaction = sentry_sdk.get_current_scope().transaction
+            trace_id = transaction.trace_id if transaction else None
+            return trace_id
 
     def capture_exception(self, ex, extras: dict | None = None):
         with sentry_sdk.new_scope() as scope: