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

Use a throttled logger for exceeded memory warnings #15424

Merged
merged 3 commits into from
Mar 26, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Mar 8, 2024

Description

This PR fixes the issue described in #15423.

We now create a throttled logger and use that to log the warnings for exceeding memory row count.

Related Issue(s)

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

@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving labels Mar 8, 2024
Copy link
Contributor

vitess-bot bot commented Mar 8, 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 Mar 8, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 8, 2024
@systay systay changed the title Use a throttled logger for exeeced memory warnings Use a throttled logger for execed memory warnings Mar 8, 2024
@systay systay changed the title Use a throttled logger for execed memory warnings Use a throttled logger for exceeded memory warnings Mar 8, 2024
@systay systay 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 Mar 8, 2024
@@ -231,7 +234,7 @@ func (e *Executor) Execute(ctx context.Context, mysqlCtx vtgateservice.MySQLConn
if err != nil {
piiSafeSQL = logStats.StmtType
}
log.Warningf("%q exceeds warning threshold of max memory rows: %v. Actual memory rows: %v", piiSafeSQL, warnMemoryRows, len(result.Rows))
exceedMemoryRowsLogger.Warningf("%q exceeds warning threshold of max memory rows: %v. Actual memory rows: %v", piiSafeSQL, warnMemoryRows, len(result.Rows))
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this throttle only on the exact matching len(result.Rows) or also on different lengths? And should it only throttle on exactly the same or should we also throttle if it's a slightly different value?

Copy link
Member

Choose a reason for hiding this comment

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

It feels like the throttler will throttle all max memory warning regardless of the query. I think it would be more useful if we could throttle based on the query we are receiving rather than just the error.

Copy link
Member

@deepthi deepthi Mar 9, 2024

Choose a reason for hiding this comment

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

Right now it will throttle all log messages that are generated by this line. That is, it might be a different query, or it might be a different number of rows. It will only print one message a minute.
I agree that it will be nice to print one message per distinct query. That will need writing a new kind of ThrottledLogger. I don't know if that is worth it. If we believe it is, then let's do it.

Copy link
Member

Choose a reason for hiding this comment

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

On second thought, maybe we should just throttle like before and focus on making sure that this is returned as a warning to the client. With mysql clients, that should be pretty easy. What do we do for grpc clients?

@frouioui frouioui marked this pull request as draft March 11, 2024 23:39
@frouioui
Copy link
Member

Currently working on this PR to add a per-query throttler

@frouioui frouioui marked this pull request as ready for review March 12, 2024 22:10
@frouioui frouioui requested review from deepthi and dbussink March 12, 2024 22:10
@frouioui frouioui changed the title Use a throttled logger for exceeded memory warnings Add ThrottledQueryLogger for exceeded memory warnings Mar 12, 2024
Copy link

codecov bot commented Mar 12, 2024

Codecov Report

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

Project coverage is 65.64%. Comparing base (696fe0e) to head (d27dec5).
Report is 106 commits behind head on main.

Files Patch % Lines
go/vt/vtgate/executor.go 50.00% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15424      +/-   ##
==========================================
- Coverage   67.41%   65.64%   -1.78%     
==========================================
  Files        1560     1563       +3     
  Lines      192752   194405    +1653     
==========================================
- Hits       129952   127621    -2331     
- Misses      62800    66784    +3984     

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

warningMsg := fmt.Sprintf("%q exceeds warning threshold of max memory rows: %v. Actual memory rows: %v", piiSafeSQL, warnMemoryRows, len(result.Rows))
exceedMemoryRowsLogger.Warningf(sql, warningMsg)
safeSession.RecordWarning(&querypb.QueryWarning{
Code: uint32(sqlerror.EROutOfMemory),
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if EROutOfMemory is appropriate, we can also remove the Code altogether

Copy link
Member

@deepthi deepthi Mar 26, 2024

Choose a reason for hiding this comment

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

Should be fine, because the warning we return to the client is descriptive.

Signed-off-by: Florent Poinsard <[email protected]>
@frouioui frouioui force-pushed the throttle-memory-exceed-logging branch from 3f88408 to 1b6c139 Compare March 12, 2024 23:40
@frouioui frouioui changed the title Add ThrottledQueryLogger for exceeded memory warnings Use a throttled logger for exceeded memory warnings Mar 12, 2024
@frouioui
Copy link
Member

Validated the change with a local test by setting warnMemoryRows to 1 and running the 101 script.

mysql> show tables;
+--------------------+
| Tables_in_commerce |
+--------------------+
| corder             |
| customer           |
| product            |
+--------------------+
3 rows in set, 1 warning (0.00 sec)

mysql> show warnings;
+---------+------+--------------------------------------------------------------------------------------+
| Level   | Code | Message                                                                              |
+---------+------+--------------------------------------------------------------------------------------+
| Warning | 1037 | "show tables" exceeds warning threshold of max memory rows: 1. Actual memory rows: 3 |
+---------+------+--------------------------------------------------------------------------------------+
1 row in set, 1 warning (0.00 sec)

mysql> 

Signed-off-by: Florent Poinsard <[email protected]>
Copy link
Member Author

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM!

@deepthi deepthi merged commit bec2180 into vitessio:main Mar 26, 2024
102 checks passed
@deepthi deepthi deleted the throttle-memory-exceed-logging branch March 26, 2024 15:11
@deepthi
Copy link
Member

deepthi commented Mar 26, 2024

Currently working on this PR to add a per-query throttler

Just a note that we abandoned this because it seemed like too much work for log throttling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Throttle logs for exceeding of max memory rows
5 participants