Skip to content

Commit b4f3d71

Browse files
jyejarentkathole
authored andcommitted
docs: Enabling and using DQM in UI
Signed-off-by: Jitendra Yejare <11752425+jyejare@users.noreply.github.com>
1 parent e8a5a4c commit b4f3d71

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

docs/how-to-guides/feature-monitoring.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ This guide covers:
1414
6. [On-demand exploration (transient compute)](#6-on-demand-exploration)
1515
7. [Integrating with orchestrators](#7-integrating-with-orchestrators)
1616
8. [Supported backends](#8-supported-backends)
17+
9. [Monitoring in the Feast UI](#9-monitoring-in-the-feast-ui)
1718

1819
## 1. Prerequisites
1920

@@ -388,3 +389,76 @@ Monitoring respects Feast's existing RBAC:
388389
- **Compute operations** (`POST /monitoring/compute`, `/auto_compute`, `/compute/log`, `/auto_compute/log`) require `AuthzedAction.UPDATE`
389390
- **Transient compute** (`POST /monitoring/compute/transient`) requires `AuthzedAction.DESCRIBE`
390391
- **Read operations** (`GET /monitoring/metrics/*`) require `AuthzedAction.DESCRIBE`
392+
393+
## 9. Monitoring in the Feast UI
394+
395+
The Feast web UI includes a built-in monitoring dashboard accessible from the **Monitoring** item in the sidebar navigation.
396+
397+
### What you see
398+
399+
The monitoring page has three tabs:
400+
401+
| Tab | Shows |
402+
|-----|-------|
403+
| **Features** | Per-feature metrics table with null rate, row count, freshness, and health status |
404+
| **Feature Views** | Aggregated data quality per feature view |
405+
| **Feature Services** | Aggregated metrics per feature service |
406+
407+
### Filters
408+
409+
At the top of the monitoring page you can filter by:
410+
411+
- **Feature View** — scope to a specific feature view or view all
412+
- **Granularity** — select Baseline, Daily, Weekly, Biweekly, Monthly, or Quarterly
413+
- **Source** — filter by batch or log data source
414+
- **Start/End Date** — filter metrics to a specific date range (disabled for Baseline since baseline uses all data)
415+
416+
### Feature detail page
417+
418+
Clicking any feature row navigates to a detail page showing:
419+
420+
- **Distribution histogram** — expandable/zoomable chart of the feature's value distribution
421+
- **Statistics panel** — null rate, mean, stddev, min/max, percentiles (p50–p99)
422+
- **Granularity dropdown** — switch between computed granularities and baseline
423+
- **Time Series Analysis** — trend charts for aggregate metrics drift (Mean/P50/P95) and null rate evolution over time
424+
425+
### Computing metrics from the UI
426+
427+
Click the **Compute Metrics** button in the page header to trigger an `auto_compute` job. This computes all granularities for all feature views (or the selected feature view if filtered). Results appear after the table refreshes.
428+
429+
The **Refresh** button re-fetches already computed metrics from the backend without triggering new computation.
430+
431+
### When no data is available
432+
433+
If no metrics have been computed yet, the page shows a prompt:
434+
435+
> No monitoring data has been computed for this project. Click "Compute Metrics" to run data quality analysis on your feature views.
436+
437+
If the monitoring backend is unreachable, a warning banner appears:
438+
439+
> Could not connect to the monitoring API. Make sure the Feast registry server is running with monitoring enabled.
440+
441+
### Enabling monitoring for the UI
442+
443+
The monitoring page is always accessible in the sidebar. To see actual data:
444+
445+
1. Add `data_quality_monitoring` to your `feature_store.yaml`:
446+
447+
```yaml
448+
data_quality_monitoring:
449+
auto_baseline: true
450+
```
451+
452+
Or, when using the Feast operator, set this in the `FeatureStore` CR:
453+
454+
```yaml
455+
apiVersion: feast.dev/v1
456+
kind: FeatureStore
457+
spec:
458+
feastProject: my_project
459+
dataQualityMonitoring:
460+
autoBaseline: true
461+
```
462+
463+
2. Run `feast apply` — this computes baseline metrics automatically
464+
3. Schedule `feast monitor run` (or click "Compute Metrics" in the UI) to generate daily/weekly/monthly metrics

0 commit comments

Comments
 (0)