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

[vttablet] Emit Constant “userLabelDisabled” When skip-user-metrics is Enabled #18085

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

harshit-gangal
Copy link
Member

@harshit-gangal harshit-gangal commented Apr 1, 2025

Description

This PR updates Vitess to emit a constant "UserLabelDisabled" instead of per-user labels when skip-user-metrics is enabled. This prevents metric explosion in environments with a high number of unique users, reducing unnecessary cardinality while preserving metric usefulness.

Related Issue(s)

Checklist

  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

@harshit-gangal harshit-gangal added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTTablet labels Apr 1, 2025
Copy link
Contributor

vitess-bot bot commented Apr 1, 2025

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 Apr 1, 2025
@harshit-gangal harshit-gangal removed NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 1, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Apr 1, 2025
@harshit-gangal harshit-gangal changed the title [vttablet] feat: disable user based stats on "skip-user-metrics" option [vttablet] Emit Constant “userLabelDisabled” When skip-user-metrics is Enabled Apr 1, 2025
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal harshit-gangal removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Apr 1, 2025
@harshit-gangal harshit-gangal marked this pull request as ready for review April 1, 2025 11:24
@harshit-gangal harshit-gangal removed the NeedsIssue A linked issue is missing for this Pull Request label Apr 1, 2025
Signed-off-by: Harshit Gangal <[email protected]>
Signed-off-by: Harshit Gangal <[email protected]>
Signed-off-by: Harshit Gangal <[email protected]>
Copy link

codecov bot commented Apr 1, 2025

Codecov Report

Attention: Patch coverage is 90.19608% with 5 lines in your changes missing coverage. Please review.

Project coverage is 67.53%. Comparing base (b0352bd) to head (b8dc249).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/tabletserver/query_executor.go 90.00% 3 Missing ⚠️
go/vt/vttablet/tabletserver/stateful_connection.go 90.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18085      +/-   ##
==========================================
- Coverage   67.61%   67.53%   -0.09%     
==========================================
  Files        1600     1600              
  Lines      260810   261338     +528     
==========================================
+ Hits       176351   176485     +134     
- Misses      84459    84853     +394     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@frouioui frouioui modified the milestones: v22.0.0, v23.0.0 Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTTablet Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prevent username metric explosion
3 participants