Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-25 05:41:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a335851da6
gecko-dev/python/mozbuild/metrics.yaml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

141 lines
4.1 KiB
YAML
Raw Normal View History

Bug 1654074: Publish glean handle to mach commands r=firefox-build-system-reviewers,rstewart Allows mach commands to define their own glean metrics with the `metrics_path` @CommandProvider parameter. When `metrics_path` is defined: * A `metrics` kwarg is provided to the decorated class. This `metrics` handle is a Glean instance, so Glean documentation should be consulted for usage information. * When `mach doc telemetry` is run, metrics docs will be generated from all the registered metrics files. Note: there was some consideration between making `metrics_path` a @CommandProvider or @Command parameter. In the end, @CommandProvider seemed like a better fit because: * Metrics seem to be more associated with the entire class than a specific command/method. This is because a class represents a "domain", and that domain may have different commands that have overlapping metrics. Accordingly, all the metrics should be defined once as available to the entire class. * Currently, @Command methods only take parameters that map one-to-one with CLI arguments. It could seem inconsistent to have one exception: the metrics handle Differential Revision: https://phabricator.services.mozilla.com/D85953
2020-09-15 21:15:20 +00:00
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# If this file is changed, update the generated docs:
# https://firefox-source-docs.mozilla.org/mach/telemetry.html#updating-generated-metrics-docs
Bug 1741674 - Advise in each metrics.yaml that we have docs for adding metrics r=TravisLong,nalexander Depends on D131639 Differential Revision: https://phabricator.services.mozilla.com/D131640
2021-11-22 20:07:38 +00:00
# Adding a new metric? We have docs for that!
# https://mozilla.github.io/glean/book/user/metrics/adding-new-metrics.html
Bug 1654074: Publish glean handle to mach commands r=firefox-build-system-reviewers,rstewart Allows mach commands to define their own glean metrics with the `metrics_path` @CommandProvider parameter. When `metrics_path` is defined: * A `metrics` kwarg is provided to the decorated class. This `metrics` handle is a Glean instance, so Glean documentation should be consulted for usage information. * When `mach doc telemetry` is run, metrics docs will be generated from all the registered metrics files. Note: there was some consideration between making `metrics_path` a @CommandProvider or @Command parameter. In the end, @CommandProvider seemed like a better fit because: * Metrics seem to be more associated with the entire class than a specific command/method. This is because a class represents a "domain", and that domain may have different commands that have overlapping metrics. Accordingly, all the metrics should be defined once as available to the entire class. * Currently, @Command methods only take parameters that map one-to-one with CLI arguments. It could seem inconsistent to have one exception: the metrics handle Differential Revision: https://phabricator.services.mozilla.com/D85953
2020-09-15 21:15:20 +00:00
---
$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0
mozbuild:
compiler:
type: string
description: The compiler type in use (CC_TYPE), such as "clang" or "gcc".
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
artifact:
type: boolean
description: True if `--enable-artifact-builds`.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
debug:
type: boolean
description: True if `--enable-debug`.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
opt:
type: boolean
description: True if `--enable-optimize`.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
ccache:
type: boolean
description: True if `--with-ccache`.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
sccache:
type: boolean
description: True if ccache in use is sccache.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
icecream:
type: boolean
description: True if icecream in use.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
clobber:
type: boolean
description: True if the build was a clobber/full build.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1526072
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1526072#c15
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
Bug 1654084 - Log build project to telemetry r=firefox-build-system-reviewers,dmajor Differential Revision: https://phabricator.services.mozilla.com/D94868
2020-10-27 18:08:49 +00:00
project:
type: string
description: The project being built.
lifetime: application
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1654084
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1654084#c2
notification_emails:
- build-telemetry@mozilla.com
- mhentges@mozilla.com
expires: never
send_in_pings:
- usage
Reference in New Issue Copy Permalink