Skip to content

Commit e8de9ef

Browse files
yashikakhuranaYashika Khurana
andauthored
docs: add feature monitoring page (#829)
* docs: add feature monitoring page * docs: address PR feedback on feature monitoring page --------- Co-authored-by: Yashika Khurana <yashikakhurana@Yashikas-MBP.home.local>
1 parent c2474ef commit e8de9ef

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: feature-monitoring
3+
title: Feature Monitoring
4+
slug: /feature-monitoring
5+
---
6+
7+
How to view Grafana dashboards for a feature's health and enrollment metrics on the Feature Health Dashboard in Experimenter.
8+
9+
## What Is Feature Monitoring?
10+
11+
Feature monitoring provides a Grafana dashboard that tracks the health and usage metrics for a specific Nimbus feature config across all live and completed **rollouts**. It is powered by metric definitions in [metric-hub](https://github.com/mozilla/metric-hub/blob/main/featmon/firefox_desktop.toml).
12+
13+
Unlike experiment-level monitoring (which tracks a single experiment), feature monitoring shows aggregate data across all rollouts for a feature, making it easy to spot regressions or unexpected changes in feature behaviour. Note that this is a **health monitoring** tool — it is not designed for statistical comparisons between branches or measuring experiment impact.
14+
15+
## How to Access It
16+
17+
1. Go to the [**Feature Health Dashboard**](https://experimenter.services.mozilla.com/nimbus/features/) in Experimenter.
18+
2. Select an application and a feature config from the dropdowns.
19+
3. If the feature has monitoring configured in metric-hub, a **Open Grafana Dashboard** button appears in the Feature Monitoring card.
20+
4. Click the button to open the dashboard in a new tab.
21+
22+
## Why Is the Dashboard Not Available for My Feature?
23+
24+
If you see the warning **"Grafana dashboard not available"**, it means the feature has not yet been added to the [metric-hub featmon config](https://github.com/mozilla/metric-hub/blob/main/featmon/firefox_desktop.toml).
25+
26+
To enable feature monitoring for your feature, open a pull request against metric-hub adding your feature to `featmon/firefox_desktop.toml`. The file includes examples and comments explaining the required format.
27+
28+
Once your PR is merged, the dashboard will become available for your feature in Experimenter after the next deploy.
29+
30+
## What Metrics Are Available?
31+
32+
The metrics shown in the Grafana dashboard depend on what is configured for your feature in metric-hub. Common metrics include:
33+
34+
- **DAU (Daily Active Users)** — how many users are actively using the feature each day.
35+
- **Event counts** — specific interactions with the feature (clicks, impressions, etc.).
36+
- **Boolean / quantity metrics** — values reported from the feature's Glean metrics.
37+
38+
Metrics are broken down by channel, locale, OS, and country where applicable.
39+
40+
## Need Help?
41+
42+
- To add your feature to metric-hub monitoring, see the [metric-hub featmon config](https://github.com/mozilla/metric-hub/blob/main/featmon/firefox_desktop.toml).
43+
- For questions about what metrics to add or how to interpret the dashboard, ask in [#ask-experimenter](https://mozilla.slack.com/archives/CF94YMZ2T).

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ module.exports = {
6666
"workflow/risk-mitigation",
6767
"workflow/launching",
6868
"workflow/monitoring",
69+
"workflow/feature-monitoring",
6970
"workflow/analyzing",
7071
"workflow/ending"
7172
]

0 commit comments

Comments
 (0)