Use url.rule instead of request.endpoint for span name flask instrumentation #1260
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
lzchen
requested review from
a team,
codeboten and
aabmass
and removed request for
a team
codeboten
reviewed
Oct 20, 2020
owais
reviewed
Oct 20, 2020
| @@ -110,7 +110,7 @@ def _before_request(): | |||
| return | |||
|
|
|||
| environ = flask.request.environ | |||
| span_name = flask.request.endpoint or otel_wsgi.get_default_span_name( | |||
| span_name = flask.request.url_rule.rule or otel_wsgi.get_default_span_name( | |||
There was a problem hiding this comment.
Not familiar enough with flask. Is url_rule always available? What if the rule is not defined and the request is a 404?
There was a problem hiding this comment.
It is not always available. If it's not, we default to the wsgi implementation which is HTTP +
There was a problem hiding this comment.
Would this raise attribute error if request.url_rule is not always present? or is url_rule always present but rule can be None?
There was a problem hiding this comment.
I added a try catch for attribute error in my latest commit.
codeboten
added
the
instrumentation
|
@codeboten |
codeboten
approved these changes
Oct 20, 2020
| except AttributeError: | ||
| pass | ||
| if span_name is None: | ||
| span_name = otel_wsgi.get_default_span_name(environ) |
There was a problem hiding this comment.
is there a test that exerts this code path?
There was a problem hiding this comment.
The test_404 test covers this.
owais
approved these changes
Oct 21, 2020
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.
From the title, we don't want to be using
endpointfor the span name. See specs for span name.Use
url.ruleinstead if exists. If not, default to HTTP