package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

GetCGoMemStats collects non-Go memory statistics.
GetDiskCounters returns DiskStats for all disks.
GetProcCPUTime returns the cumulative user/system time (in ms) since the process start.
GetTotalMemory returns either the total system memory (in bytes) or if possible the cgroups available memory.
GetTotalMemoryWithoutLogging is the same as GetTotalMemory, but returns any warning as a string instead of logging it.
NewGoRuntimeSampler constructs a new GoRuntimeSampler object.
NewHealthChecker creates a new health checker that emits alerts whenever the given metrics are nonzero.
NewMetricsRecorder initializes a new MetricsRecorder object that uses the given clock.
NewRuntimeStatSampler constructs a new RuntimeStatSampler object.

# Variables

ChildMetricsEnabled enables exporting of additional prometheus time series with extra labels.

# Structs

CGoMemStats reports what has been allocated outside of Go.
DiskStats contains the disk statistics returned by the operating system.
GoRuntimeSampler are a collection of metrics to sample from golang's runtime environment and runtime metrics metadata.
A HealthChecker inspects the node metrics and optionally a NodeStatus for anomalous conditions that the operator should be alerted to.
MetricsRecorder is used to periodically record the information in a number of metric registries.
RuntimeStatSampler is used to periodically sample the runtime environment for useful statistics, performing some rudimentary calculations and storing the resulting information in a format that can be easily consumed by status logging systems.