Files
supabase/apps/docs/data/content-listings/telemetry.data.ts
Saxon Fletcher e0280cb650 docs: restructure observability navigation and overview (#49505)
<!-- CURSOR_AGENT_PR_BODY_BEGIN -->
## Stack

Draft stack extracted from `docs/monitoring`. Merge bottom-up. The
troubleshooting *catalog* rewrite (`content/troubleshooting` and the
Diagnosing UI) stays out of scope.

1. #49503 move inspect and advisors
2. #49501 split Studio logs from ClickHouse queries
3. #49500 treat reports as signal dashboards
4. #49502 add Observe the data hub
5. #49506 add agent setup components
6. #49504 add hire-an-agent templates
7. **#49505** restructure observability nav, overview, Detecting, and
flatten Observe the data ← **this PR**

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Docs update. Top layer in the observability stack.

## What is the current behavior?

The section is still titled Monitoring and Debugging, with a Debugging /
Monitoring split that does not match the new pages. The debugging guide
is still the master layer-isolation + symptom table. Observe the data is
split into “what data” vs “where to observe it,” which duplicates the
source pages.

## What is the new behavior?

- Section title is Observability
- Overview groups Observe the data, Detect and resolve, Hire an agent,
and Export
- **Observe the data is flattened by source.** Logs, Metrics API,
Database, Advisors, and Reports each list where to read that source.
There is no separate MCP/API/CLI/Studio nav group.
- **Observe vs Detecting:** Observe is the catalog (what exists, how to
access it). Detecting is how to *use* those sources to pick up a Health
/ Security / Performance / Usage signal. Named errors skip to
Diagnosing.
- Studio Logs sits under Logs. Reports sits beside the other sources.
- Troubleshooting stays in the global menu and also appears as
Diagnosing under Detect and resolve

## Additional context

This is the last PR in the stack. Together the seven PRs reconstruct the
`docs/monitoring` observability IA and guide content, without shipping
the troubleshooting catalog overhaul.
<!-- CURSOR_AGENT_PR_BODY_END -->

<div><a
href="https://cursor.com/agents/bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/background-agent?bcId=bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Saxon Fletcher <SaxonF@users.noreply.github.com>
Co-authored-by: Nik Richers <nik@validmind.ai>
2026-09-04 13:38:39 +10:00

126 lines
4.0 KiB
TypeScript

import { monitoringAgents } from '~/data/monitoring-agents.data'
import { getScheduleLabel } from '~/data/monitoring-agents.utils'
import type { ContentListingGroup } from '~/lib/content-listings.schema'
export const telemetryAccessWhat: ContentListingGroup = {
id: 'telemetry-access-what',
type: 'grid',
columns: 2,
items: [
{
title: 'Logs',
href: '/guides/observability/advanced-log-filtering',
description:
'Query ClickHouse logs from Studio, MCP, or the API. Filter events in the Logs UI.',
},
{
title: 'Metrics API',
href: '/guides/observability/metrics',
description: 'Scrape Prometheus-compatible database metrics, or chart a subset in Reports.',
},
{
title: 'Database',
href: '/guides/observability/inspect',
description: 'Inspect live Postgres stats from the CLI, the SQL Editor, or MCP.',
},
{
title: 'Advisors',
href: '/guides/observability/advisors',
description: 'Pull security and performance findings from Studio, MCP, the CLI, or the API.',
},
{
title: 'Reports',
href: '/guides/observability/reports',
description: 'Studio dashboards for API, Auth, Storage, Realtime, and database signals.',
},
],
}
export const telemetryDetect: ContentListingGroup = {
id: 'telemetry-detect',
type: 'grid',
items: [
{
title: 'Detect issues',
href: '/guides/observability/detecting',
description:
'Run health, security, performance, and usage checks against logs and database statistics to pick up a signal.',
},
],
}
export const telemetryDiagnose: ContentListingGroup = {
id: 'telemetry-diagnose',
type: 'grid',
items: [
{
title: 'Diagnose and resolve',
href: '/guides/troubleshooting',
description:
'Use a concrete finding, symptom, or error code to identify the cause and apply a known solution.',
},
],
}
export const telemetryHireAgent: ContentListingGroup = {
id: 'telemetry-hire-agent',
type: 'grid',
columns: 2,
items: [
{
title: 'Generalist',
href: '/guides/observability/automate-with-agents/all',
subtitle: getScheduleLabel(monitoringAgents.all),
description:
'Run all four checks — health, security, performance, and usage — in one daily pass.',
},
{
title: monitoringAgents.health.name,
href: '/guides/observability/automate-with-agents/health',
subtitle: getScheduleLabel(monitoringAgents.health),
description: 'Watch logs for 5xx spikes and Auth failures.',
},
{
title: monitoringAgents.security.name,
href: '/guides/observability/automate-with-agents/security',
subtitle: getScheduleLabel(monitoringAgents.security),
description: 'Review advisor findings and authorization failures.',
},
{
title: monitoringAgents.performance.name,
href: '/guides/observability/automate-with-agents/performance',
subtitle: getScheduleLabel(monitoringAgents.performance),
description: 'Find slow queries, lock waits, and missing indexes.',
},
{
title: monitoringAgents.usage.name,
href: '/guides/observability/automate-with-agents/usage',
subtitle: getScheduleLabel(monitoringAgents.usage),
description: 'Track request growth, error rates, and approaching limits.',
},
],
}
export const telemetryExport: ContentListingGroup = {
id: 'telemetry-export',
type: 'grid',
columns: 3,
items: [
{
title: 'Log drains',
href: '/guides/observability/log-drains',
description: 'Send project logs to your own destination.',
},
{
title: 'Client-side tracing',
href: '/guides/observability/client-side-tracing',
description: 'Propagate W3C trace context from the client through Supabase services.',
},
{
title: 'Sentry integration',
href: '/guides/observability/sentry-monitoring',
description: 'Capture supabase-js errors and spans in Sentry.',
},
],
}