package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
MakeMonitorName constructs a MonitorName with the given name.
MakeMonitorNameWithID constructs a MonitorName with the given name and ID.
NewMonitor creates a new monitor.
NewMonitorInheritWithLimit creates a new monitor with a limit local to this monitor with all other attributes inherited from the passed in monitor.
NewStandaloneBudget creates a BoundAccount suitable for root monitors.
NewStandaloneUnlimitedAccount returns a BoundAccount that is actually not bound to any BytesMonitor.
NewUnlimitedMonitor creates a new monitor and starts the monitor in "detached" mode without a pool and without a maximum budget.
ReadAll is like ioctx.ReadAll except it additionally asks the BoundAccount acct permission if it grows its buffer while reading.
# Variables
DefaultPoolAllocationSize specifies the unit of allocation used by a monitor to reserve and release bytes to a pool.
# Structs
BoundAccount tracks the cumulated allocations for one client of a pool or monitor.
BytesMonitor defines an object that can track and limit memory/disk usage by other CockroachDB components.
ConcurrentBoundAccount is a thread safe wrapper around BoundAccount.
EarmarkedBoundAccount extends BoundAccount to pre-reserve large allocations up front.
MonitorName is used to identify monitors in logging messages.
MonitorState describes the current state of a single monitor.
Options encompasses all arguments to the NewMonitor and NewUnlimitedMonitor calls.
# Type aliases
Resource indicates the type of resource a BytesMonitor is tracking.