Provide excluded_urls argument to Flask instrumentation #604
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
The FastAPI instrumentation accepts an 'explicit_urls' argument on initialization. This commit translates that concept to the Flask instrumentation.
mattoberle
requested review from
a team,
owais and
lzchen
and removed request for
a team
|
|
lzchen
reviewed
Jul 23, 2021
Co-authored-by: Leighton Chen <lechen@microsoft.com>
lzchen
reviewed
Jul 26, 2021
| @@ -209,6 +217,10 @@ def __init__(self, *args, **kwargs): | |||
| ) | |||
| self._before_request = _before_request | |||
| self.before_request(_before_request) | |||
There was a problem hiding this comment.
Does _before_request and _rewrapped_app need the excluded_urls passed in as well?
There was a problem hiding this comment.
Good catch.
I need to extend test_automatic.py to cover this case and then I'll push up the change.
There was a problem hiding this comment.
GitHub didn't update the comment since the change is a few lines up, but this should be taken care of now on line 220 in this commit:
lzchen
reviewed
Jul 26, 2021
| parse_excluded_urls(excluded_urls) | ||
| if excluded_urls is not None | ||
| else _excluded_urls_from_env | ||
| ) | ||
| app._original_wsgi_app = app.wsgi_app | ||
| app.wsgi_app = _rewrapped_app(app.wsgi_app, response_hook) |
There was a problem hiding this comment.
Suggested change
| app.wsgi_app = _rewrapped_app(app.wsgi_app, response_hook) | |
| app.wsgi_app = _rewrapped_app(app.wsgi_app, response_hook, excluded_urls) |
The Flask instrumentation can be applied on two levels: * The `module` level (auto-instrumentation), which patches the `Flask` class. * The `app` level, which patches a `Flask` instance. This commit applies a few missing `excluded_urls` keyword arguments to ensure the auto-instrumentation provides the same configurability as the app-level instrumentation.
lzchen
approved these changes
Jul 29, 2021
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.
Description
Proposal to solve #375 for the
FlaskInstrumentor, based on theFastAPIInstrumentorsolution in #486.This PR allows users to pass an explicit
excluded_urlsargument during instrumentation.The explicit argument will override values set via environment variable.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
test_programmaticmodule was modified to test both environment-based and explicit exclusions.Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.