build/docs/telemetry.rst

   1 .. _buildtelemetry:
   2
   3 ===============
   4 Build Telemetry
   5 ===============
   6
   7 The build system (specifically, all the build tooling hooked
   8 up to ``./mach``) has been configured to collect metrics data
   9 points and errors for various build system actions. This data
  10 helps drive team planning for the build team and ensure that
  11 resources are applied to build processes that need them most.
  12 You can adjust your telemetry settings by editing your
  13 ``~/.mozbuild/machrc`` file.
  14
  15 Glean Telemetry
  16 ===============
  17
  18 Mozbuild reports data using `Glean <https://mozilla.github.io/glean/>`_ via
  19 :ref:`mach_telemetry`.  The metrics collected are documented :ref:`here<metrics>`.
  20
  21 Error Reporting
  22 ===============
  23
  24 ``./mach`` uses `Sentry <https://sentry.io/welcome/>`_
  25 to automatically report errors to `our issue-tracking dashboard
  26 <https://sentry.prod.mozaws.net/operations/mach/>`_.
  27
  28 Information captured
  29 ++++++++++++++++++++
  30
  31 Sentry automatically collects useful information surrounding
  32 the error to help the build team discover what caused the
  33 issue and how to reproduce it. This information includes:
  34
  35 * Environmental information, such as the computer name, timestamp, Python runtime and Python module versions
  36 * Process arguments
  37 * The stack trace of the error, including contextual information:
  38
  39     * The data contained in the exception
  40     * Functions and their respective source file names, line numbers
  41     * Variables in each frame
  42 * `Sentry "Breadcrumbs" <https://docs.sentry.io/platforms/python/default-integrations/>`_,
  43   which are important events that have happened which help contextualize the error, such as:
  44
  45     * An HTTP request has occurred
  46     * A subprocess has been spawned
  47     * Logging has occurred
  48
  49 Note that file paths may be captured, which include absolute paths (potentially including usernames).