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

grpc: upgrade to 1.66.2 and use Codec v2 #16790

Merged
merged 3 commits into from
Oct 17, 2024
Merged

grpc: upgrade to 1.66.2 and use Codec v2 #16790

merged 3 commits into from
Oct 17, 2024

Conversation

vmg
Copy link
Collaborator

@vmg vmg commented Sep 16, 2024

Description

This PR upgrades our GRPC version to 1.66.2 and introduces the new Codec v2 for serializing and deserializing protobuf messages. The goal of this codec is to enable memory pooling and hopefully increase real-world performance of Vitess clusters by reducing the number of memory allocations used when working with GRPC. You can can read up on the implementation details and next steps for the codec in this discussion PR.

This is the very first iteration of these changes, which only implements buffer pooling, but does not attempt to pool the objects themselves. Our hope is that this should already show in the benchmarks, so if it doesn't it'll be a bit disappointing! 🤞

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

Copy link
Contributor

vitess-bot bot commented Sep 16, 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 Sep 16, 2024
@vmg vmg added Type: Performance Benchmark me Add label to PR to run benchmarks 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 Sep 16, 2024
Copy link
Contributor

vitess-bot bot commented Sep 16, 2024

Hello! 👋

This Pull Request is now handled by arewefastyet. The current HEAD and future commits will be benchmarked.

You can find the performance comparison on the arewefastyet website.

@vitess-bot vitess-bot modified the milestones: v21.0.0, v22.0.0 Oct 8, 2024
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 69.37%. Comparing base (da49d08) to head (fedf867).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/servenv/grpc_codec.go 87.50% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16790      +/-   ##
==========================================
+ Coverage   69.35%   69.37%   +0.02%     
==========================================
  Files        1571     1571              
  Lines      204183   204188       +5     
==========================================
+ Hits       141601   141658      +57     
+ Misses      62582    62530      -52     

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

@vmg
Copy link
Collaborator Author

vmg commented Oct 17, 2024

Wow so this actually worked:

https://benchmark.vitess.io/compare?old=main&new=fedf86784d6510a1837aa4d0f96817edab0b1fb8

image
image

We're missing TPCC which is not running atm for an unknown reasons but these numbers are huge. 3% increase in QPS and 13% reduction in allocated memory per requests is a huge win at this point in the lifetime of the project. And this is without adapting the vtprotobuf codegen to be aware of the new interfaces.

I think this is good to merge, as it's a drop-in replacement and the numbers are fantastic. The next steps involve updating vtprotobuf. I'll sit down with @mattlord or whoever has the cycles to pick this up to discuss the changes. 👌

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

❤️ 🥳

@vmg vmg merged commit dc692fa into main Oct 17, 2024
191 checks passed
@vmg vmg deleted the vmg/grpc-66-buf-pool branch October 17, 2024 13:21
ijsong added a commit to kakao/varlog that referenced this pull request Dec 21, 2024
This PR updates the gRPC codec from v1 to v2, enhancing performance and reducing
memory allocations by utilizing a memory pool for encoded messages.

Refs:
- grpc/grpc-go#7356
- vitessio/vitess#16790
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants