Home > @rushstack/heft > IMetricsData

IMetricsData interface

Signature:

export interface IMetricsData 

Properties

Property	Modifiers	Type	Description
bootDurationMs		number	The total duration before Heft started executing user-defined tasks, in milliseconds. This metric is for tracking the contribution of Heft itself to total build duration.
command		string	The command that was executed.
commandParameters		Record<string, string>	A map of commandline parameter names to their effective values
encounteredError?		boolean	(Optional) Whether or not the command ran into errors
machineArch		string	The processor's architecture.
machineCores		number	The number of processor cores.
machineOs		string	The name of the operating system provided by NodeJS.
machineProcessor		string	The processor's model name.
machineTotalMemoryMB		number	The total amount of memory the machine has, in megabytes.
taskTotalExecutionMs		number	The total execution duration of all user-defined tasks from heft.json, in milliseconds. This metric is for measuring the cumulative time spent on the underlying build steps for a project. If running in watch mode, this will be the duration of the most recent incremental build.
totalUptimeMs		number	How long the process has been alive, in milliseconds. This metric is for watch mode, to analyze how long developers leave individual Heft sessions running.