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

docker: Introduce helper for better labeling in Query Monitor #39365

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

oskosk
Copy link
Contributor

@oskosk oskosk commented Sep 11, 2024

Due to the paths used in the monorepo, it is not trivial for Query Monitor to infer the type and name of the files being monitored.

This PR adds a new plugin that helps Query Monitor with labeling components better

Before After
image image

Before image
After image

Fixes #

Proposed changes:

  • Introduces new mu-plugin hooking into some filter from the Query Monitor plugin
  • Makes it so files in the monorepo are correctly identified as plugins or packages

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Go to '..'
  • Install Query Monitor in you docker environment
  • Open Query Monitor settings
  • Confirm you see the Plugin: jetpack as a component in the database queries panel

Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@oskosk oskosk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Sep 11, 2024
Due to the paths used it is not trivial for Query Monitor to infer the type and name of the files being monitored.
@oskosk oskosk force-pushed the add/dev-en-mu-plugin-for-fixing-component-names branch from 5bf64fd to 2038b74 Compare September 11, 2024 23:28
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

Nice improvement, thank you! It tests well for me, should be good to merge.

Of note, I pushed a commit to address some linting errors, but I made no actual functionality changes.

@jeherve jeherve added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Focus] Performance [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Sep 12, 2024
@oskosk
Copy link
Contributor Author

oskosk commented Sep 12, 2024

thank you!

@oskosk oskosk merged commit 2461714 into trunk Sep 12, 2024
55 checks passed
@oskosk oskosk deleted the add/dev-en-mu-plugin-for-fixing-component-names branch September 12, 2024 11:25
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Sep 12, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Introduce helper for better labeling in Query Monitor
Due to the paths used it is not trivial for Query Monitor to infer the type and name of the files being monitored.

* Apply indenting / spacing / phpcs fixes to avoid linting errors

---------

Co-authored-by: Jeremy Herve <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docker [Focus] Performance [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants