automaxprocs: go.uber.org/automaxprocs/maxprocs Index | Examples | Files

package maxprocs

import "go.uber.org/automaxprocs/maxprocs"

Package maxprocs lets Go programs easily configure runtime.GOMAXPROCS to match the configured Linux CPU quota. Unlike the top-level automaxprocs package, it lets the caller configure logging and handle errors.

Code:

undo, err := maxprocs.Set()
defer undo()
if err != nil {
    log.Fatalf("failed to set GOMAXPROCS: %v", err)
}
// Insert your application logic here.

Index

Examples

Package Files

maxprocs.go version.go

Constants

const Version = "1.2.0"

Version is the current package version.

func Set Uses

func Set(opts ...Option) (func(), error)

Set GOMAXPROCS to match the Linux container CPU quota (if any), returning any error encountered and an undo function.

Set is a no-op on non-Linux systems and in Linux environments without a configured CPU quota.

type Option Uses

type Option interface {
    // contains filtered or unexported methods
}

An Option alters the behavior of Set.

func Logger Uses

func Logger(printf func(string, ...interface{})) Option

Logger uses the supplied printf implementation for log output. By default, Set doesn't log anything.

Code:

// By default, Set doesn't output any logs. You can enable logging by
// supplying a printf implementation.
undo, err := maxprocs.Set(maxprocs.Logger(log.Printf))
defer undo()
if err != nil {
    log.Fatalf("failed to set GOMAXPROCS: %v", err)
}

func Min Uses

func Min(n int) Option

Min sets the minimum GOMAXPROCS value that will be used. Any value below 1 is ignored.

Package maxprocs imports 3 packages (graph) and is imported by 8 packages. Updated 2019-05-07. Refresh now. Tools for package owners.