README

automaxprocs GoDoc Build Status Coverage Status

Automatically set GOMAXPROCS to match Linux container CPU quota.

Installation

go get -u go.uber.org/automaxprocs

Quick Start

import _ "go.uber.org/automaxprocs"

func main() {
  // Your application logic here.
}

Development Status: Stable

All APIs are finalized, and no breaking changes will be made in the 1.x series of releases. Users of semver-aware dependency management systems should pin automaxprocs to ^1.

Contributing

We encourage and support an active, healthy community of contributors — including you! Details are in the contribution guide and the code of conduct. The automaxprocs maintainers keep an eye on issues and pull requests, but you can also report any negative conduct to oss-conduct@uber.com. That email list is a private, safe space; even the automaxprocs maintainers don't have access, so don't hesitate to hold us to a high standard.


Released under the MIT License.

Expand ▾ Collapse ▴

Documentation

Overview

Package automaxprocs automatically sets GOMAXPROCS to match the Linux container CPU quota, if any.

Example

Code:

package main

// Importing automaxprocs automatically adjusts GOMAXPROCS.
import _ "go.uber.org/automaxprocs"

// To render a whole-file example, we need a package-level declaration.
var _ = ""

func main() {}

Source Files

Directories

Path Synopsis
internal/cgroups Package cgroups provides utilities to access Linux control group (CGroups) parameters (CPU quota, for example) for a given process.
internal/runtime
maxprocs Package maxprocs lets Go programs easily configure runtime.GOMAXPROCS to match the configured Linux CPU quota.