Metrics

This document enumerates the metrics collected by this project using the Glean SDK. This project may depend on other projects which also collect metrics. This means you might have to go searching through the dependency tree to get a full picture of everything collected by this project.

Pings

• usage

usage

Sent when the mach invocation is completed (regardless of result). Contains information about the mach invocation that was made, its result, and some details about the current environment and hardware.

This ping includes the client id.

Data reviews for this ping:

• https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34

Bugs related to this ping:

• https://bugzilla.mozilla.org/show_bug.cgi?id=1291053

All Glean pings contain built-in metrics in the ping_info and client_info sections.

In addition to those built-in metrics, the following metrics are added to the ping:

Name	Type	Description	Data reviews	Extras	Expiration	Data Sensitivity
mach.argv	string_list	Parameters provided to mach. Absolute paths are sanitized to be relative to one of a few key base paths, such as the “$topsrcdir”, “$topobjdir”, or “$HOME”. For example: “/home/mozilla/dev/firefox/python/mozbuild” would be replaced with “$topsrcdir/python/mozbuild”. If a valid replacement base path cannot be found, the path is replaced with “”.	Bug 1291053		never
mach.command	string	The name of the mach command that was invoked, such as “build”, “doc”, or “try”.	Bug 1291053		never
mach.duration	timespan	How long it took for the command to complete.	Bug 1291053		never
mach.success	boolean	True if the mach invocation succeeded.	Bug 1291053		never
mach.system.cpu_brand	string	CPU brand string from CPUID.	Bug 1291053		never
mach.system.distro	string	The name of the operating system distribution.	Bug 1655845		never
mach.system.distro_version	string	The high-level OS version.	Bug 1655845		never
mach.system.logical_cores	counter	Number of logical CPU cores present.	Bug 1291053		never
mach.system.memory	memory_distribution	Amount of system memory.	Bug 1291053		never
mach.system.physical_cores	counter	Number of physical CPU cores present.	Bug 1291053		never
mach.system.ssh_connection	boolean	True if the current shell is a remote SSH connection.	Bug 1702172		never
mach.system.vscode_running	boolean	True if there is an instance of vscode running.	Bug 1717801		never
mach.system.vscode_terminal	boolean	True if the current terminal is opened via Visual Studio Code.	Bug 1702172		never
mozbuild.artifact	boolean	True if --enable-artifact-builds.	Bug 1291053		never
mozbuild.ccache	boolean	True if --with-ccache.	Bug 1291053		never
mozbuild.clobber	boolean	True if the build was a clobber/full build.	Bug 1526072		never
mozbuild.compiler	string	The compiler type in use (CC_TYPE), such as “clang” or “gcc”.	Bug 1291053		never
mozbuild.debug	boolean	True if --enable-debug.	Bug 1291053		never
mozbuild.icecream	boolean	True if icecream in use.	Bug 1291053		never
mozbuild.opt	boolean	True if --enable-optimize.	Bug 1291053		never
mozbuild.project	string	The project being built.	Bug 1654084		never
mozbuild.sccache	boolean	True if ccache in use is sccache.	Bug 1291053		never
mozbuild.target	string	The target architecture for the build, such as “x86_64-pc-mingw32”.	Bug 1893740		never

Data categories are defined here.