Skip to content

Update README.md to explain the difference vs container-aware-gomaxprocs in stdlib #99

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.

Sign up for GitHub

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

Open
rabbbit wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md to explain the difference vs container-aware-gomaxprocs in stdlib #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Automatically set `GOMAXPROCS` to match Linux container CPU quota.

While this package predates Go 1.25 [container-aware-gomaxprocs], we continue to use it in production. This is because, unlike the stdlib, this package rounds any fractional cores down. This is to reduce latency spikes at a cost of potentially wasted capacity. We use fractional cores (example 8.1) to constrain the Go runtime to 8 cores, while 0.1 is left for anything else running in the container.

## Installation

`go get -u go.uber.org/automaxprocs`
Expand Down Expand Up @@ -67,5 +69,6 @@ Released under the [MIT License](LICENSE).
[ci]: https://github.com/uber-go/automaxprocs/actions/workflows/go.yml
[cov-img]: https://codecov.io/gh/uber-go/automaxprocs/branch/master/graph/badge.svg
[cov]: https://codecov.io/gh/uber-go/automaxprocs
[container-aware-gomaxprocs]: https://go.dev/doc/go1.25#container-aware-gomaxprocs


Loading