add middleware_position feature in django #1903
Open
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
TheAnshul756
changed the title
TheAnshul756
changed the title
sanketmehta28
approved these changes
Aug 7, 2023
ocelotl
reviewed
Aug 10, 2023
| middleware_position = kwargs.pop("middleware_position", 0) | ||
| if len(settings_middleware) < middleware_position: | ||
| _logger.debug( | ||
| "The middleware_position you provided (%d) is less than the current number of middlewares (%d). \ |
There was a problem hiding this comment.
Suggested change
| "The middleware_position you provided (%d) is less than the current number of middlewares (%d). \ | |
| "The middleware_position you provided (%d) is greater than the current number of middlewares (%d). \ |
ocelotl
reviewed
Aug 10, 2023
| if len(settings_middleware) < middleware_position: | ||
| _logger.debug( | ||
| "The middleware_position you provided (%d) is less than the current number of middlewares (%d). \ | ||
| Since the number of middlewares is less than the total, the Otel middleware will be appended at the end of the middleware chain.", |
ocelotl
reviewed
Aug 10, 2023
...on/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py
Show resolved
Hide resolved
ocelotl
reviewed
Aug 10, 2023
srikanthccv
reviewed
Aug 10, 2023
| @@ -53,6 +53,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| ([#1879](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1879)) | |||
| - Add optional distro and configurator selection for auto-instrumentation | |||
| ([#1823](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1823)) | |||
| - Add option to add Opentelemetry middleware at specific position in middleware chain | |||
| ([#1903]https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1903) | |||
There was a problem hiding this comment.
Please move this to the Unreleased section.
| @@ -355,10 +355,23 @@ def _instrument(self, **kwargs): | |||
|
|
|||
| is_sql_commentor_enabled = kwargs.pop("is_sql_commentor_enabled", None) | |||
|
|
|||
| middleware_position = kwargs.pop("middleware_position", 0) | |||
There was a problem hiding this comment.
Can you add an OTEL_PYTHON_DJANGO_MIDDLEWARE_POSITION env so that auto instrumentation people who use opentelemetry-instrument can also use this capability?
|
@TheAnshul756 This PR has enough approvals, seems we only need a few fixes in order to merge it. 👍 |
12 tasks
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
Feature to add middleware at specific location. Added keyword argument
middleware_positionwhich one can set to the number of middleware they want to add before otel middleware to start instrumentation.Fixes #1781
Type of change
How Has This Been Tested?
tox -e linttox -e test-instrumentation-django1tox -e test-instrumentation-django2tox -e test-instrumentation-django3Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.