feat: refactor code_owner code from edx-dajango-utils #838
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
This is the code_owner code as found in edx-django-utils.
Initial rollout of moving code_owner monitoring code from edx-django-utils to this plugin. - Adds near duplicate of code owner middleware from edx-django-utils. - Adds code owner for celery using Datadog span processing of celery.run spans. - Uses temporary span tags names using `_2`, like `code_owner_2`, for rollout and comparison with the original span tags. See #784
robrap
commented
Oct 23, 2024
Comment on lines
+91
to
+93
| code_owner_mappings = getattr(settings, 'CODE_OWNER_MAPPINGS', None) | ||
| if code_owner_mappings is None: | ||
| return None |
There was a problem hiding this comment.
Note for Reviewer: A bug was found in this code, because there was a bug in the original test for this that didn't catch this problem.
As a reviewer, feel free to mark this resolved once you have read this.
There was a problem hiding this comment.
What impact would this have had?
robrap
commented
Oct 23, 2024
robrap
force-pushed
the
robrap/add-code-owner-monitoring
branch
from
ce0a75e
to
1d3af1c
Compare
|
Note to Reviewer: I did initial local testing to POC the celery span resource name was available locally, but I did not do a final local test. I wasn't able to get to a real celery task locally. |
timmc-edx
reviewed
Oct 28, 2024
| # We can use this for celery spans, because the resource name is more predictable | ||
| # and available from the start. For django requests, we'll instead continue to use | ||
| # django middleware for setting code owner. | ||
| get_code_owner_from_module(span.resource) |
There was a problem hiding this comment.
Shouldn't this be set_code_owner_attribute_from_module?
timmc-edx
reviewed
Oct 28, 2024
| code_owner_squad IN ('old-squad-name', 'new-squad-name') | ||
| code_owner_theme IN ('old-theme-name', 'new-theme-name') | ||
| code_owner_2_squad:('old-squad-name', 'new-squad-name') | ||
| code_owner_2_theme:('old-theme-name', 'new-theme-name') | ||
|
|
||
| Example contract phase NRQL:: |
There was a problem hiding this comment.
Still some NRQL references here.
timmc-edx
reviewed
Oct 29, 2024
|
|
||
| Usage:: | ||
|
|
||
| @task() | ||
| @set_code_owner_attribute | ||
| @set_code_owner_2_attribute |
There was a problem hiding this comment.
Unneeded change here -- can just delete these functions, though.
timmc-edx
reviewed
Oct 29, 2024
|
|
||
| If you first need some background on the ``code_owner_2_squad`` and ``code_owner_2_theme`` custom attributes, see `Using Code_Owner Custom Span Tags`_. | ||
|
|
||
| .. _Using Code_Owner Custom Span Tags: https://github.com/openedx/edx-arch-experiments/blob/master/edx_arch_experiments/datadog_monitoring/docs/how_tos/add_code_owner_custom_attribute_to_an_ida.rst |
There was a problem hiding this comment.
Suggested change
| .. _Using Code_Owner Custom Span Tags: https://github.com/openedx/edx-arch-experiments/blob/master/edx_arch_experiments/datadog_monitoring/docs/how_tos/add_code_owner_custom_attribute_to_an_ida.rst | |
| .. _Using Code_Owner Custom Span Tags: https://github.com/edx/edx-arch-experiments/blob/main/edx_arch_experiments/datadog_monitoring/docs/how_tos/add_code_owner_custom_attribute_to_an_ida.rst |
timmc-edx
reviewed
Oct 29, 2024
| class TestDatadogMonitoringSpanProcessor(TestCase): | ||
| """Tests for DatadogMonitoringSpanProcessor.""" | ||
|
|
||
| @patch('edx_arch_experiments.datadog_monitoring.apps.get_code_owner_from_module') |
There was a problem hiding this comment.
Should these patches be adjusted to mock out the setter?
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.
Note to Reviewer: The original edx-django-utils code was copied in as a separate commit to make it easier to see what was added and what was updated if you review commit by commit.
Initial rollout of moving code_owner monitoring code from edx-django-utils to this plugin.
_2, likecode_owner_2, for rollout and comparison with the original span tags.See #784
Merge checklist:
Check off if complete or not applicable: