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

queryserving, observability: instrument vttablet query cache plan hits/misses #14947

Merged

Conversation

maxenglander
Copy link
Collaborator

@maxenglander maxenglander commented Jan 14, 2024

Description

Add stats counters:

  • QueryCacheHits: Query engine query cache hits
  • QueryCacheMisses: Query engine query cache misses

A query plan cache miss results in VTTablet parsing the query. This can add a significant amount of latency to a query execution. Having better visibility into query plan caching will help isolate or eliminate cache misses as a source of latency when analyzing query performance.

Related Issue(s)

Fixes #14946

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added: content/en/docs/19.0: document QueryCache{Hits,Misses} stats website#1663

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Jan 14, 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 Jan 14, 2024
@maxenglander maxenglander added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving Component: Observability Pull requests that touch tracing/metrics/monitoring 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 Jan 14, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 14, 2024
Copy link

codecov bot commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (696fe0e) 67.41% compared to head (0ff0a63) 67.44%.
Report is 24 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14947      +/-   ##
==========================================
+ Coverage   67.41%   67.44%   +0.02%     
==========================================
  Files        1560     1561       +1     
  Lines      192752   193194     +442     
==========================================
+ Hits       129952   130301     +349     
- Misses      62800    62893      +93     

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

@maxenglander maxenglander marked this pull request as ready for review January 14, 2024 17:43
@frouioui frouioui modified the milestones: v19.0.0, v20.0.0 Feb 6, 2024
Comment on lines 69 to 75
#### <a id="vttablet-query-cache-hits-and-misses"/>VTTablet Query Cache Hits and Misses

VTTablet exposes two counter stats:

* `QueryCacheHits`: Query engine query cache hits
* `QueryCacheMisses`: Query engine query cache misses

Copy link
Member

Choose a reason for hiding this comment

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

This should go in the changelog/20.0/20.0.0/summary.md summary file, if it does not exist yet you can create it.

Copy link
Member

@frouioui frouioui Feb 12, 2024

Choose a reason for hiding this comment

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

Also a small nit pick, reading this it seems like VTTablet is only exposing these two counter stats now, maybe add "new" or something

Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

LGTM but the release notes must be changed. 🥳

Signed-off-by: Max Englander <[email protected]>
Signed-off-by: Max Englander <[email protected]>
@maxenglander maxenglander force-pushed the maxeng-instrument-vtt-plan-cache-miss branch from 33ae74f to 5b81f8c Compare February 12, 2024 16:43
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Still LGTM

@frouioui
Copy link
Member

Conflicts are resolved, should be merged soon!

@frouioui frouioui merged commit 54c6dfc into vitessio:main Feb 16, 2024
102 checks passed
@frouioui frouioui deleted the maxeng-instrument-vtt-plan-cache-miss branch February 16, 2024 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Observability Pull requests that touch tracing/metrics/monitoring Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: instrument vttablet query plan cache hits and misses
3 participants