From c6876557568147feacff835a230c91d0efe3e9dd Mon Sep 17 00:00:00 2001 From: Shell Escalante Date: Fri, 30 Aug 2024 13:59:00 -0700 Subject: [PATCH] Update metrics.md updating wording for better match to terms used in coming redesign. --- docs/deep-dives/jetstream/metrics.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/deep-dives/jetstream/metrics.md b/docs/deep-dives/jetstream/metrics.md index 787388fd6..aba3fb3ed 100644 --- a/docs/deep-dives/jetstream/metrics.md +++ b/docs/deep-dives/jetstream/metrics.md @@ -32,15 +32,14 @@ within and between branches of an experiment. ## How do I add a metric to my experiment? -A small set of critical guardrail metrics (called Core Firefox Metrics in Nimbus Console) -specific to each platform is run by default for each experiment. +A small set of default, critical guardrail metrics that are specific to each platform are run by default for each experiment. Sometimes also called Core metrics. These are defined for each platform in the metric-hub repository in [jetstream/defaults/](https://github.com/mozilla/metric-hub/tree/main/jetstream/defaults/). Look at the file for your platform. At the top you will see the metrics collected and the timeframe they are available: daily, weekly, or overall (at the end of the experiment). For help understanding any aspect of guardrail metrics on your platform - link to the file and ask in #ask-experimenter. -[Outcomes](https://experimenter.info/deep-dives/jetstream/outcomes) are collections of metrics that relate to each other. You can associate an Outcome with your experiment in the Experiment Console - Metrics section. +[Pre-defined Metrics, AKA Outcomes](https://experimenter.info/deep-dives/jetstream/outcomes) are collections of metrics that relate to each other. You can associate these pre-defined metrics (outcomes) with your experiment in the Experiment Console - Metrics section. Data scientists can extend and define outcomes in the outcomes path of the [`metric-hub`](https://github.com/mozilla/metric-hub/tree/main/jetstream/outcomes) repository. See what [Outcomes are available](https://mozilla.github.io/metric-hub/outcomes/fenix/default-browser/). -If the metrics you need are not covered by Guardrail/Core metrics or existing Outcomes - you can add a metric to your experiment by working with a data scientist to write a [custom configuration](https://experimenter.info/system-architecture#custom-configuration-aka-jetstream-configuration-files) for your experiment. +If the metrics you need are not covered by Default (guardrail) or existing Pre-defined Outcomes - you can add a metric to your experiment by working with a data scientist to write a [custom configuration](https://experimenter.info/system-architecture#custom-configuration-aka-jetstream-configuration-files) for your experiment.