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

Add a note on QueryCacheHits and QueryCacheMisses in the release notes #16299

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

frouioui
Copy link
Member

Description

This PR modifies the v20 release notes to mention that QueryCacheXX does not refer to an actual query cache but rather to a query plan cache.

The metrics will be renamed in v21 through #16289.

Let's backport this to v20 for the release notes.

Related Issue(s)

Copy link
Contributor

vitess-bot bot commented Jun 28, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jun 28, 2024
@frouioui frouioui added Type: Internal Cleanup Component: Observability Pull requests that touch tracing/metrics/monitoring Component: Documentation docs related issues/PRs Backport to: release-20.0 Needs to be backport to release-20.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jun 28, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Jun 28, 2024
Copy link

codecov bot commented Jun 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.70%. Comparing base (bb76046) to head (4ec48d3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16299      +/-   ##
==========================================
- Coverage   68.71%   68.70%   -0.01%     
==========================================
  Files        1544     1544              
  Lines      198011   198011              
==========================================
- Hits       136064   136051      -13     
- Misses      61947    61960      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@frouioui frouioui merged commit e827f6b into vitessio:main Jul 1, 2024
108 checks passed
@frouioui frouioui deleted the edit-v20-metrics-release-notes branch July 1, 2024 18:40
vitess-bot pushed a commit that referenced this pull request Jul 1, 2024
frouioui pushed a commit that referenced this pull request Jul 1, 2024
…in the release notes (#16299) (#16306)

Signed-off-by: Florent Poinsard <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-20.0 Needs to be backport to release-20.0 Component: Documentation docs related issues/PRs Component: Observability Pull requests that touch tracing/metrics/monitoring Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants