Sylvestre Ledru
df0583fb15
Convert build/docs/*.rst (top-level and mozbuild/) to MyST-flavored
Markdown.
- Keep build/docs/mozbuild-symbols.rst as RST. The mozbuildsymbols
custom directive emits nodes that confuse autosectionlabel when
wrapped in a MyST eval-rst block.
- Keep build/docs/supported-configurations.rst as RST so that
docs/contributing/build/supported.md can continue to use the MyST
{include} directive on the original source.
- Refresh allowed-warnings globs to match the .md filenames for
code-quality, contributing, crash-reporting, gtest, jsloader, js,
overview, setup, and js/build.
Differential Revision: https://phabricator.services.mozilla.com/D304226
47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
(buildtelemetry)=
|
|
|
|
# Build Telemetry
|
|
|
|
The build system (specifically, all the build tooling hooked
|
|
up to `./mach`) has been configured to collect metrics data
|
|
points and errors for various build system actions. This data
|
|
helps drive team planning for the build team and ensure that
|
|
resources are applied to build processes that need them most.
|
|
You can adjust your telemetry settings by editing your
|
|
`~/.mozbuild/machrc` file.
|
|
|
|
## Glean Telemetry
|
|
|
|
Mozbuild reports data using [Glean](https://mozilla.github.io/glean/) via
|
|
{ref}`mach-telemetry`. The metrics collected are documented {ref}`here<metrics>`.
|
|
|
|
## Error Reporting
|
|
|
|
`./mach` uses [Sentry](https://sentry.io/welcome/)
|
|
to automatically report errors to [our issue-tracking dashboard](https://sentry.prod.mozaws.net/operations/mach/).
|
|
|
|
### Information captured
|
|
|
|
Sentry automatically collects useful information surrounding
|
|
the error to help the build team discover what caused the
|
|
issue and how to reproduce it. This information includes:
|
|
|
|
- Environmental information, such as the computer name, timestamp, Python runtime and Python module versions
|
|
|
|
- Process arguments
|
|
|
|
- The stack trace of the error, including contextual information:
|
|
|
|
> - The data contained in the exception
|
|
> - Functions and their respective source file names, line numbers
|
|
> - Variables in each frame
|
|
|
|
- [Sentry "Breadcrumbs"](https://docs.sentry.io/platforms/python/default-integrations/),
|
|
which are important events that have happened which help contextualize the error, such as:
|
|
|
|
> - An HTTP request has occurred
|
|
> - A subprocess has been spawned
|
|
> - Logging has occurred
|
|
|
|
Note that file paths may be captured, which include absolute paths (potentially including usernames).
|