Adding Config switch for Xray #2261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
jimleroyer
reviewed
Aug 21, 2024
| signals.task_postrun.connect(xray_task_postrun) | ||
| signals.task_prerun.connect(xray_task_prerun) | ||
| signals.beat_init.connect(xray_task_prerun) | ||
| if app.config["AWS_XRAY_ENABLED"] == "true": |
There was a problem hiding this comment.
To minimize typo and typing errors, we want:
current_app.config["AWS_XRAY_ENABLED"] is True
But that would require for the AWS_XRAY_ENABLED constant to be declared using the bool function of the environs module as such:
AWS_XRAY_ENABLED = env.bool("AWS_XRAY_ENABLED", False)
The environs module is a nifty library to make configuration parsing more reliable in general.
jimleroyer
reviewed
Aug 21, 2024
| @@ -240,6 +240,9 @@ class Config(object): | |||
| DEBUG = False | |||
| NOTIFY_LOG_PATH = os.getenv("NOTIFY_LOG_PATH") | |||
|
|
|||
| # AWS Xray | |||
| AWS_XRAY_ENABLED = os.getenv("AWS_XRAY_ENABLED", "false") | |||
There was a problem hiding this comment.
AWS_XRAY_ENABLED = env.bool("AWS_XRAY_ENABLED", False)
jimleroyer
reviewed
Aug 21, 2024
| XRayMiddleware(application, xray_recorder) | ||
| if application.config["AWS_XRAY_ENABLED"] == "true": | ||
| xray_recorder.configure(service='celery') | ||
| XRayMiddleware(application, xray_recorder) |
There was a problem hiding this comment.
I wonder how that XRayMiddleware object works, because we do not make use of it afterward. The xray_celery_handlers do get a hold of the xray_recorder via an import and I guess this might be a singleton? but the XRayMiddleware is just left alone afterward. 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary | Résumé
Adding logic to rely upon an environment variable to turn Xray Tracing on or off
Related Issues | Cartes liées
https://app.zenhub.com/workspaces/notify-planning-core-6411dfb7c95fb80014e0cab0/issues/gh/cds-snc/notification-planning-core/400
Test instructions | Instructions pour tester la modification
Release Instructions | Instructions pour le déploiement
Verify the config value in the production .env file to ensure it's what we want it to be.
Reviewer checklist | Liste de vérification du réviseur