Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: phase 2 of code owner monitoring rollout #870

Merged
merged 2 commits into from
Dec 11, 2024

Conversation

robrap
Copy link
Contributor

@robrap robrap commented Dec 10, 2024

Description

Completes code owner monitoring updates, which drops owner theme and finalizes the code owner span tags. See doc and ADR updates for more details.

  • The code_owner_theme_2 tag was dropped altogether.
  • The temporary suffix (_2) was removed from other span tags.
  • The code_owner (formerly code_owner_2) tag no longer includes the theme name.
  • The new name for the django setting is CODE_OWNER_TO_PATH_MAPPINGS (formerly CODE_OWNER_MAPPINGS).
  • The django setting CODE_OWNER_THEMES was dropped.
  • Updates the generate_code_owner_mappings.py script accordingly.

Also includes a small clean-up of defensive code on a separate commit.

Implements:

Author Concern

I don't think we'll change any decisions, but going to just squad names means that it isn't immediately clear when an enterprise team is involved (for example), unless you know all of the individual squads and where they live.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Removed some unnecessary defensive code
and logging. Added test to show we already
had defensive code for this case.
Completes code owner monitoring updates, which drops owner
theme and finalizes the code owner span tags. See doc and
ADR updates for more details.

* The code_owner_theme_2 tag was dropped altogether.
* The temporary suffix (_2) was removed from other span
  tags.
* The code_owner (formerly code_owner_2) tag no longer
  includes the theme name.
* The new name for the django setting is
  CODE_OWNER_TO_PATH_MAPPINGS (formerly
  CODE_OWNER_MAPPINGS).
* The django setting CODE_OWNER_THEMES was dropped.
* Updates the generate_code_owner_mappings.py script
  accordingly.

Implements:
- #784
@robrap robrap force-pushed the robrap/code-owner-monitoring-phase-2 branch from 5c42586 to a96686d Compare December 10, 2024 17:56

* The owner theme name has been dropped from the ``code_owner`` custom span tag value in this new implementation.
* The ``code_owner_theme`` span tag has been dropped altogether from this new implementation.
* The now deprecated ``code_owner_squad`` span tag, which is redundant with the updated ``code_owner`` tag, will continue to be supported for backward compatibility.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps just temporarily until we update any docs and monitors/dashboards?

Suggested change
* The now deprecated ``code_owner_squad`` span tag, which is redundant with the updated ``code_owner`` tag, will continue to be supported for backward compatibility.
* The now deprecated ``code_owner_squad`` span tag, which is redundant with the updated ``code_owner`` tag, will continue to be supported temporarily for backward compatibility.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went back-and-forth, but I'm going to leave this as-is. It may be permanent if we never choose to update everything, since this is in terraform templates, etc. And if we choose to go from deprecated to removal, the lack of the word "temporarily" doesn't change the fact that this is documented as deprecated.

@robrap robrap merged commit 138ed0e into main Dec 11, 2024
6 checks passed
@robrap robrap deleted the robrap/code-owner-monitoring-phase-2 branch December 11, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants