darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-07-14 02:09:44 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
128752636927b5a17ea47486df237c7d20bb7eec
notifications-admin/application.py

25 lines
714 B
Python
Raw Normal View History

Trial running Sentry in Admin This will capture and send various events to Sentry: - Any unhandled exceptions. - Any logger.error calls. - Some request traces. The latter are severely limited to avoid going over the free tier limits for Sentry, and to avoid excess effort on our end.
2021-12-30 14:05:43 +00:00
import os
import sentry_sdk
remove flask-script flask-script has been deprecated by the internal flask.cli module, but making this carries a few changes with it * you should add FLASK_APP=application.py and FLASK_DEBUG=1 to your environment.sh. * instead of using `python app.py runserver`, now you must run `flask run -p 6012`. The -p command is important - the port must be set before the config is loaded, so that it can live reload nicely. (https://github.com/pallets/flask/issues/2113#issuecomment-268014481) * find available commands by just running `flask`. * run them using flask. eg `flask list_routes` * define new tasks by giving them the decorator `@app.cli.command('task-name')`. Task name isn't needed if it's just the same as the function name. Alternatively, if app isn't available in the current scope, you can invoke the decorator directly, as seen in app/commands.py
2017-11-06 13:07:21 +00:00
from flask import Flask
Trial running Sentry in Admin This will capture and send various events to Sentry: - Any unhandled exceptions. - Any logger.error calls. - Some request traces. The latter are severely limited to avoid going over the free tier limits for Sentry, and to avoid excess effort on our end.
2021-12-30 14:05:43 +00:00
from sentry_sdk.integrations.flask import FlaskIntegration
Add RedisIntegration to Sentry trial This should expose additional performance stats.
2021-12-31 17:43:10 +00:00
from sentry_sdk.integrations.redis import RedisIntegration
Silence errors from Python Client Otherwise we start spamming Sentry with every 404 error log. Even if the erorr is a 5xx, it depends on how we handle it in the calling code as to whether we would want to consider it an error. I didn't spot this in initial testing on Preview because the 404s in Preview are only triggered due to the functional tests, which only run when we're deploying something. Arguably we shouldn't be logging at error level in our Python Client, since we're also raising an exception [1]. But changing that would be a can of worms as it's not an internal-only library. [1]: https://github.com/alphagov/notifications-python-client/blob/74a958de00d39571101996c8483869ba43068006/notifications_python_client/base.py#L118
2021-12-31 12:04:35 +00:00
from sentry_sdk.integrations import logging
Fix flake8 and isort errors Note, isort now has default behaviour of searching recursively so we no longer need the `-rc` flag
2021-03-08 15:36:23 +00:00
remove flask-script flask-script has been deprecated by the internal flask.cli module, but making this carries a few changes with it * you should add FLASK_APP=application.py and FLASK_DEBUG=1 to your environment.sh. * instead of using `python app.py runserver`, now you must run `flask run -p 6012`. The -p command is important - the port must be set before the config is loaded, so that it can live reload nicely. (https://github.com/pallets/flask/issues/2113#issuecomment-268014481) * find available commands by just running `flask`. * run them using flask. eg `flask list_routes` * define new tasks by giving them the decorator `@app.cli.command('task-name')`. Task name isn't needed if it's just the same as the function name. Alternatively, if app isn't available in the current scope, you can invoke the decorator directly, as seen in app/commands.py
2017-11-06 13:07:21 +00:00
from app import create_app
Tweak Sentry config to work in development This makes a couple of changes: - Most importantly, it wraps the setup code in a conditional so that developers don't need to have a DSN set to start the app locally. - Secondly, it removes the redundant call to "set_level". Originally I thought the integration was sending info/warning events, but this isn't the case [1] and even if it was, "set_level" affects the level of custom events [2], not the level they are dispatched at. [1]: https://github.com/getsentry/sentry-python/blob/4c09f3203d6d19789c6fa729a2e46557ad4ea913/sentry_sdk/integrations/logging.py#L56 [2]: https://docs.sentry.io/platforms/python/guides/logging/usage/set-level/
2022-01-04 11:53:26 +00:00
if 'SENTRY_DSN' in os.environ:
sentry_sdk.init(
dsn=os.environ['SENTRY_DSN'],
integrations=[FlaskIntegration(), RedisIntegration()],
environment=os.environ['NOTIFY_ENVIRONMENT'],
attach_stacktrace=True,
traces_sample_rate=0.00005 # avoid exceeding rate limits in Production
)
Silence errors from Python Client Otherwise we start spamming Sentry with every 404 error log. Even if the erorr is a 5xx, it depends on how we handle it in the calling code as to whether we would want to consider it an error. I didn't spot this in initial testing on Preview because the 404s in Preview are only triggered due to the functional tests, which only run when we're deploying something. Arguably we shouldn't be logging at error level in our Python Client, since we're also raising an exception [1]. But changing that would be a can of worms as it's not an internal-only library. [1]: https://github.com/alphagov/notifications-python-client/blob/74a958de00d39571101996c8483869ba43068006/notifications_python_client/base.py#L118
2021-12-31 12:04:35 +00:00
Tweak Sentry config to work in development This makes a couple of changes: - Most importantly, it wraps the setup code in a conditional so that developers don't need to have a DSN set to start the app locally. - Secondly, it removes the redundant call to "set_level". Originally I thought the integration was sending info/warning events, but this isn't the case [1] and even if it was, "set_level" affects the level of custom events [2], not the level they are dispatched at. [1]: https://github.com/getsentry/sentry-python/blob/4c09f3203d6d19789c6fa729a2e46557ad4ea913/sentry_sdk/integrations/logging.py#L56 [2]: https://docs.sentry.io/platforms/python/guides/logging/usage/set-level/
2022-01-04 11:53:26 +00:00
logging.ignore_logger('notifications_python_client.*') # ignore logs about 404s, etc.
Trial running Sentry in Admin This will capture and send various events to Sentry: - Any unhandled exceptions. - Any logger.error calls. - Some request traces. The latter are severely limited to avoid going over the free tier limits for Sentry, and to avoid excess effort on our end.
2021-12-30 14:05:43 +00:00
Remove WhiteNoise We’re now serving assets from S3 when running on PaaS. So we’ll set the appropriate caching headers there or in Cloudfront. This means that the app no longer needs to serve cache headers, which is what we were using WhiteNoise for. This commits removes WhiteNoise in favour of letting Flask handle the serving of static assets.
2018-12-21 10:40:00 +00:00
application = Flask('app')
Expose `application` as a variable This is what Gunicorn is looking for when it’s running the app. Renaming this variable to `app` has caused the app to break once deployed on PaaS. This commit also renames `app` to `flask_app` to make it clear which app is wrapping which other app.
2018-11-29 14:02:20 +00:00
Remove WhiteNoise We’re now serving assets from S3 when running on PaaS. So we’ll set the appropriate caching headers there or in Cloudfront. This means that the app no longer needs to serve cache headers, which is what we were using WhiteNoise for. This commits removes WhiteNoise in favour of letting Flask handle the serving of static assets.
2018-12-21 10:40:00 +00:00
create_app(application)
Reference in New Issue Copy Permalink