Skip to main content

Module types

Module types 

Source

Structs§

BoundProcess
One process, identified across PID reuse.
BusyUsage
Average load of a lease holder’s session over only the samples in which it was busy, so the idle time before and after the command does not water the load down.
CpuStats
Machine-wide CPU load.
DriveUsage
Space and activity of one fixed drive.
EnforcedLimits
Caps the OS enforces on a lease’s cgroup; each is None when not enforced.
GpuAdapter
One GPU adapter.
GpuEngines
Utilization of one GPU’s engine groups, as percentages.
Holder
The process a session’s leases live and die with.
JobProfile
Resources a job is expected to need while it runs.
JobRun
One finished lease with what its holder’s session used, kept for history-based estimates.
Lease
A reservation of machine resources for one job.
LeaseBinding
The command a lease covers, as the PreToolUse hook reported it, and the process tree it runs as once that is found. A later report for the same lease replaces it.
LeaseId
Identifies a lease. Assigned by the daemon’s database when the lease is first stored.
LeaseIsolation
How a lease’s command is accounted for and stopped.
MemStats
Machine-wide physical memory and commit charge.
NoiseReport
Load from processes outside the holder’s session while a benchmark lease was active.
ProcessUsage
Usage of a single process.
ResourceUsage
Resources used by a process or a group of processes, in the units of JobProfile.
Rolling
One measurement averaged over the sampler’s rolling windows.
SessionKey
Identifies a Claude Code session by its CLAUDE_CODE_SESSION_ID.
SessionUsage
Usage of a session’s whole process subtree.
Snapshot
A point-in-time view of the machine.

Enums§

Accuracy
How well a GPU source measures something per process.
EndCause
Why a lease ended.
GpuSource
Where a GPU adapter’s numbers come from.
IsolationKind
How a lease’s processes are found and stopped.
JobClass
Named job profiles. Their values come from the [classes] section of the config.
LeaseKind
How a lease shares the machine.
LeaseState
Where a lease is in its lifecycle.

Constants§

LOW_IMPACT_MAX_CORES
The most cores a low-impact job may use.
LOW_IMPACT_MAX_RAM_MB
The most memory a low-impact job may use.
QUICK_MAX_SECS
The longest expected run time of a quick job.