Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

docs: add content optimizer page (#85827)

Michael Ebye730814576a3
diff --git a/docs/README.md b/docs/README.md
index 9196ec3fa31..2a837ca19a0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -258,6 +258,7 @@ Metabase's reference documentation.
- [Monitor overview](./monitor/start.md)
- [Dependency diagnostics](./monitor/dependency-diagnostics.md)
+- [Content diagnostics](./monitor/content-diagnostics.md)
- [Erroring questions](./monitor/erroring-questions.md)
- [Alerts management](./monitor/alerts-management.md)
- [Background tasks](./monitor/background-tasks.md)
diff --git a/docs/monitor/content-diagnostics.md b/docs/monitor/content-diagnostics.md
new file mode 100644
index 00000000000..280af23ff65
--- /dev/null
+++ b/docs/monitor/content-diagnostics.md
@@ -0,0 +1,65 @@
+---
+title: Content diagnostics
+summary: Find unused, duplicated, and poorly organized content so you can clean up your Metabase.
+---
+
+# Content diagnostics
+
+_Monitor > Content diagnostics_
+
+{% include plans-blockquote.html feature="Content diagnostics" %}
+
+Content diagnostics scans your Metabase for content that clutters your instance or performs poorly, like questions nobody views, duplicate dashboards, and empty collections. It groups results by finding type so you can review them and clean up your Metabase.
+
+To open Content diagnostics:
+
+1. Open [Monitor](./start.md).
+2. In the left sidebar, click **Content diagnostics**.
+
+Admins, [Data Analysts](../people-and-groups/managing.md#data-analysts), and groups with [Monitoring access](../permissions/application.md#monitoring-access) can view Content diagnostics. You only see findings for content you have permission to view.
+
+## Finding types
+
+Each tab shows one type of finding.
+
+| Tab | What Metabase flags |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Stale** | Questions, models, metrics, dashboards, documents, and transforms that nobody has viewed or run in 90 days or more. |
+| **Duplicated** | Items that share a name with another item of the same type. Metabase ignores case and whitespace when comparing names. |
+| **Slow** | Questions with a median run time over 15 seconds in the last 30 days, the dashboards and documents that contain them, and transforms whose last run took over 60 seconds. |
+| **Empty** | Collections with no items, dashboards with no cards, documents with no content, and questions whose last run returned no results. |
+| **Sparse** | Collections with fewer than 5 items, and dashboards with fewer than 4 cards. |
+| **Crowded** | Collections with more than 100 items, dashboards with more than 5 tabs or more than 20 cards on a tab, and documents with more than 20 cards. |
+
+Metabase doesn't scan items in the Trash, sample content, or usage analytics. To hide items in personal collections, click **Filter** and clear **Include items in personal collections**.
+
+## Review findings
+
+Click an item to open a sidebar with its:
+
+- Type
+- Description
+- Creator, or owner for collections
+- Created date
+
+The sidebar also shows the details behind the finding:
+
+- **Stale**: view count and last used date.
+- **Duplicated**: view count, and a list of the duplicates with their view counts. Click a duplicate to open it.
+- **Slow**: view count and run duration.
+- **Empty**, **Sparse**, and **Crowded**: content count.
+
+## Trash or dismiss findings
+
+1. Select the checkbox next to each item.
+2. Click **Move to trash** or **Dismiss finding**.
+
+**Move to trash** sends items to the [Trash](../exploration-and-organization/delete-and-restore.md), where you can restore them later. The exception is transforms, which Metabase deletes permanently.
+
+**Dismiss finding** hides the finding until content diagnostics runs again. If the problem still exists, the finding comes back.
+
+## When content diagnostics run
+
+Metabase first runs content diagnostics when you upgrade to Metabase 65 or later, and then runs the diagnostics every day at 4:00 AM server time. You can't run diagnostics manually.
+
+If you fix a problem, the finding stays in the list until content diagnostics runs again. Dismiss the finding to hide it sooner.
\ No newline at end of file
diff --git a/docs/monitor/start.md b/docs/monitor/start.md
index b6c52c463c2..74d536ba856 100644
--- a/docs/monitor/start.md
+++ b/docs/monitor/start.md
@@ -23,6 +23,7 @@ Monitor contains three sections:
### Content management
- **[Dependency diagnostics](./dependency-diagnostics.md)**\*: Find content with broken dependencies, and content that nothing else references.
+- **[Content diagnostics](./content-diagnostics.md)**\*: Find unused, duplicated, and poorly organized content so you can clean up your Metabase.
- **[Erroring questions](./erroring-questions.md)**\*: See questions that returned an error the last time they ran.
- **[Alerts management](./alerts-management.md)**: View and manage every alert in your Metabase, including failing and ownerless alerts.
@@ -54,7 +55,7 @@ The AI auditing tabs are only available on [Pro and Enterprise plans](https://ww
Who can see each Monitor page depends on their group:
- **Admin group** can view every page.
-- **[Data Analysts](../people-and-groups/managing.md#data-analysts) group** can view Dependency diagnostics.\*
+- **[Data Analysts](../people-and-groups/managing.md#data-analysts) group** can view Dependency diagnostics and Content diagnostics.\*
- **Groups with [Monitoring access](../permissions/application.md#monitoring-access)** can view every page except Dependency diagnostics, Alerts management, Session management, API key usage, and the [AI auditing](#ai-auditing) pages.\*
\* On OSS, only admins can view Monitor. The Data Analysts group and the Monitoring access permission are only available on [Pro and Enterprise plans](https://www.metabase.com/pricing).
diff --git a/docs/util/data/nav.yml b/docs/util/data/nav.yml
index 1746086a4ab..e521ff0836a 100644
--- a/docs/util/data/nav.yml
+++ b/docs/util/data/nav.yml
@@ -488,6 +488,10 @@ categories:
url: "installation-and-operation/development-instance"
- name: "Monitoring your Metabase"
url: "monitor/start"
+ - name: "Dependency diagnostics"
+ url: "monitor/dependency-diagnostics"
+ - name: "Content diagnostics"
+ url: "monitor/content-diagnostics"
- name: "Observability with Prometheus"
url: "installation-and-operation/observability-with-prometheus"
- name: "Serialization"