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

Tablet throttler multi-metrics incremental PR: introducing metric names and scopes #16041

Conversation

shlomi-noach
Copy link
Contributor

Description

Incremental PR in the Tablet Throttler multi-metric series of PRs as per #16012 and merging into #16012.

This PR merely introduces (and does not use yet) two noteworthy types:

  • MetricName - a formalized name of a metric (lag, threads_running, etc.). There is a limited known set of names, though these are easily expandable programmatically.
  • Scope - the range of tablets for which a metric is collected. This is either he local tablet (self) or the entire shard (shard). When we speak of "the entire shard" we only regard the list of tables that participate in throttler activity. By default those are primary and replica.

This PR merges into vitessio:throttler-multi-metrics-incremental, which is a Draft PR, and not into main.

https://github.com/planetscale/vitess/compare/vitessio:vitess:throttler-multi-metrics-incremental...planetscale:vitess:throttler-multi-metrics-incremental-metric-names?expand=1

Related Issue(s)

#15624

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 or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

…es and scopes

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Throttler labels Jun 2, 2024
Copy link
Contributor

vitess-bot bot commented Jun 2, 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 2, 2024
@shlomi-noach shlomi-noach 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 2, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Jun 2, 2024
Copy link

codecov bot commented Jun 2, 2024

Codecov Report

Attention: Patch coverage is 69.64286% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 68.26%. Comparing base (e9b68ee) to head (bdfce5a).

Files Patch % Lines
...blet/tabletserver/throttle/base/throttle_metric.go 69.64% 17 Missing ⚠️
Additional details and impacted files
@@                           Coverage Diff                           @@
##           throttler-multi-metrics-incremental   #16041      +/-   ##
=======================================================================
- Coverage                                68.61%   68.26%   -0.36%     
=======================================================================
  Files                                     1562     1562              
  Lines                                   201191   197374    -3817     
=======================================================================
- Hits                                    138047   134733    -3314     
+ Misses                                   63144    62641     -503     

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

@shlomi-noach shlomi-noach modified the milestones: v20.0.0, v20.0.1 Jun 27, 2024
@shlomi-noach
Copy link
Contributor Author

shlomi-noach commented Jul 2, 2024

We ended up deciding to review #15988 as a whole. Closing this PR to avoid confusion.

@shlomi-noach shlomi-noach deleted the throttler-multi-metrics-incremental-metric-names branch July 2, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Throttler Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant