Skip to main content

Module model

Module model 

Source
Expand description

The platform-neutral data model.

Every type here is plain data. Nothing in this module knows how /proc is parsed or how a process row is coloured — that is the dependency direction §10.1 requires, and it is what makes the whole model testable with fixtures.

Structs§

AncestorEntry
One entry in a process’s ancestry chain.
BatteryCapacity
A battery’s design capacity beside the capacity it can hold today.
BatterySnapshot
Battery state.
CapabilitySnapshot
Every capability the UI branches on.
CollectorHealth
Overall collector health.
CollectorIssue
A recurring collector problem, aggregated rather than logged per occurrence.
ContainerIdentity
A container identified from a cgroup path.
CoreClass
A class of logical CPUs that differ in kind, not just in load.
CpuBreakdown
The per-state split of CPU time.
CpuQuota
A cgroup CPU quota: how much CPU time the group may use per period.
CpuSnapshot
System-wide CPU state.
CpuUsage
Aggregate or per-core CPU utilization.
DiskSnapshot
Throughput of one block device.
DiskTotals
Cumulative device counters, kept alongside rates so the Inspect screen can show totals as well as throughput.
FilesystemSnapshot
Capacity of one mounted filesystem.
HostEnvironment
A heuristic environment classification together with its evidence.
HostSnapshot
System identity, mostly from the slow sampling tier (§8.6).
InodeUsage
Inode occupancy of one filesystem.
InterfaceAddress
An address assigned to an interface.
InterfaceErrors
Error and drop counters.
LoadSnapshot
Load averages, which are run-queue lengths rather than percentages.
Measurement
A labelled raw measurement, used as pressure evidence and diagnostic evidence.
MemoryDetail
The secondary memory breakdown.
MemorySnapshot
System memory state.
NetworkSnapshot
State of one network interface.
OpenFileEntry
One open file descriptor of a process.
OpenFileList
The descriptors of one process, as far as the listing cap allowed.
PressureSignal
One radar signal.
PressureSnapshot
The whole radar.
ProcessDetail
The expensive per-process fields, collected on demand for the selected process only (§8.6).
ProcessIdentity
A process identity that survives PID reuse.
ProcessIo
Per-process disk I/O.
ProcessMemory
Per-process memory figures.
ProcessSnapshot
The cheap per-process fields collected on every fast tick.
PsiResource
The Linux PSI figures for one resource.
PsiSnapshot
All three Linux PSI resources.
SelfOverhead
monitrs’s own resource use.
SensorSnapshot
All sensor readings.
SwapSnapshot
Swap capacity and activity.
SystemSnapshot
One complete, internally consistent observation of the system.
TemperatureReading
One temperature sensor reading.
TierHealth
Timing and failure counts for one tier.
TrafficTotals
Cumulative byte and packet counters.
UserIdentity
The owning user of a process.

Enums§

CapabilityState
Whether one capability is usable on this system.
ChargeState
Whether the battery is charging.
Confidence
How much the evidence actually supports a heuristic conclusion.
ContainerRuntime
A container runtime recognised from a cgroup path.
CpuNormalization
How process CPU percentages are scaled (§8.3).
EnvironmentKind
Whether we appear to be running on hardware, in a VM, or in a container.
FilesystemKind
What kind of filesystem a mount point is backed by.
InterfaceKind
What kind of interface this is.
LinkState
Operational state of a link.
MeasuredValue
A raw measured quantity, tagged with what kind of quantity it is.
MemorySemantics
Which platform definition produced the headline memory numbers.
MetricState
The availability of a single metric in a single sample.
OpenFileKind
What kind of object a file descriptor refers to.
PressureId
Which resource a signal describes.
PressureState
The three states a pressure signal can be in (§2.3).
ProcessDetailResult
The outcome of a detail lookup, which may fail because the process exited.
ProcessState
The kernel scheduling state of a process.
Severity
How serious a finding is.
Tier
Which sampling tier a measurement belongs to (§8.6).
UnavailableReason
Why a normally-available metric is missing from this particular sample.

Constants§

MAX_RETAINED_ISSUES
The maximum number of distinct issues retained.