darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-08-19 14:08:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

Catch and log any exception thrown in the checkin event method.

Browse Source 
We don't want an exception while recording metrics to affect a user action. A KeyError exception was thrown today, that meant that a user say a 500, the action being performed was to download a document from the document-download-frontend app. By catching the error we prevent the user from seeing a 500 when a recording the connection metric fails.

Also catch the exception in the checkout event.
This commit is contained in:
Rebecca Law
2020-08-28 11:23:51 +01:00
parent cf20588603
commit da4efbbb82
1 changed files with 44 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
app/__init__.py
View File

@@ -352,49 +352,55 @@ def setup_sqlalchemy_events(app):
@event.listens_for(db.engine, 'checkout') @event.listens_for(db.engine, 'checkout')
def checkout(dbapi_connection, connection_record, connection_proxy): def checkout(dbapi_connection, connection_record, connection_proxy):
# connection given to a web worker try:
TOTAL_CHECKED_OUT_DB_CONNECTIONS.inc() # connection given to a web worker
TOTAL_CHECKED_OUT_DB_CONNECTIONS.inc()
# this will overwrite any previous checkout_at timestamp # this will overwrite any previous checkout_at timestamp
connection_record.info['checkout_at'] = time.monotonic() connection_record.info['checkout_at'] = time.monotonic()
# checkin runs after the request is already torn down, therefore we add the request_data onto the # checkin runs after the request is already torn down, therefore we add the request_data onto the
# connection_record as otherwise it won't have that information when checkin actually runs. # connection_record as otherwise it won't have that information when checkin actually runs.
# Note: this is not a problem for checkouts as the checkout always happens within a web request or task # Note: this is not a problem for checkouts as the checkout always happens within a web request or task
# web requests # web requests
if has_request_context(): if has_request_context():
connection_record.info['request_data'] = { connection_record.info['request_data'] = {
'method': request.method, 'method': request.method,
'host': request.host, 'host': request.host,
'url_rule': request.url_rule.rule if request.url_rule else 'No endpoint' 'url_rule': request.url_rule.rule if request.url_rule else 'No endpoint'
} }
# celery apps # celery apps
elif current_task: elif current_task:
connection_record.info['request_data'] = { connection_record.info['request_data'] = {
'method': 'celery', 'method': 'celery',
'host': current_app.config['NOTIFY_APP_NAME'], # worker name 'host': current_app.config['NOTIFY_APP_NAME'], # worker name
'url_rule': current_task.name, # task name 'url_rule': current_task.name, # task name
} }
# anything else. migrations possibly. # anything else. migrations possibly.
else: else:
current_app.logger.warning('Checked out sqlalchemy connection from outside of request/task') current_app.logger.warning('Checked out sqlalchemy connection from outside of request/task')
connection_record.info['request_data'] = { connection_record.info['request_data'] = {
'method': 'unknown', 'method': 'unknown',
'host': 'unknown', 'host': 'unknown',
'url_rule': 'unknown', 'url_rule': 'unknown',
} }
except Exception:
current_app.logger.exception("Exception caught for checkout event.")
@event.listens_for(db.engine, 'checkin') @event.listens_for(db.engine, 'checkin')
def checkin(dbapi_connection, connection_record): def checkin(dbapi_connection, connection_record):
# connection returned by a web worker try:
TOTAL_CHECKED_OUT_DB_CONNECTIONS.dec() # connection returned by a web worker
TOTAL_CHECKED_OUT_DB_CONNECTIONS.dec()
# duration that connection was held by a single web request # duration that connection was held by a single web request
duration = time.monotonic() - connection_record.info['checkout_at'] duration = time.monotonic() - connection_record.info['checkout_at']
DB_CONNECTION_OPEN_DURATION_SECONDS.labels( DB_CONNECTION_OPEN_DURATION_SECONDS.labels(
connection_record.info['request_data']['method'], connection_record.info['request_data']['method'],
connection_record.info['request_data']['host'], connection_record.info['request_data']['host'],
connection_record.info['request_data']['url_rule'] connection_record.info['request_data']['url_rule']
).observe(duration) ).observe(duration)
except Exception:
current_app.logger.exception("Exception caught for checkin event.")