mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
bf5a729f2d
## Summary - Renames the **Telemetry** nav section to **Monitoring and Debugging** (nav label + sidebar title) - Rewrites the section overview (`telemetry.mdx`) as a clean navigation page using `ContentListings` — three panels (Debugging / Monitoring / AI & automation) with no how-to prose - Adds new `telemetry.data.ts` content-listings data file with three groups registered in `index.ts` - Adds a new **Debugging** guide (`debugging.mdx`) — request-stack model, symptom-to-layer router with troubleshooting links for every service, logging guidance - Adds cross-links between `debugging.mdx`, `logs.mdx`, and `advanced-log-filtering.mdx` - Adds a new **AI agents and MCP** page (`ai-agents.mdx`) — MCP tools table, `get_logs` usage, debugging skill workflow - Restructures sidebar into three groups: **Debugging** / **Monitoring** / **AI & automation** ## Motivation - No central entry point existed for debugging — content was scattered across products with no index - The overview page had almost no links for agents to follow - The section name "Telemetry" caused confusion (also used for CLI usage telemetry) - Unblocks the `supabase` debugging skill, which routes agents to this section as its source of truth ## Test plan - [ ] `/docs/guides/telemetry` — three ContentListings panels render, no prose how-to text - [ ] `/docs/guides/telemetry.md` (markdown) — clean link list, navigable by LLMs - [ ] `/docs/guides/telemetry/debugging` — renders correctly, symptom table links resolve - [ ] `/docs/guides/telemetry/ai-agents` — new page renders correctly - [ ] Sidebar shows 3 groups: Debugging / Monitoring / AI & automation - [ ] All cross-links between debugging, logs, and advanced-log-filtering resolve <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary - **New Features** - Added new documentation coverage for AI agent–assisted monitoring and debugging, including an observability-driven troubleshooting workflow. - **Documentation** - Updated the “Telemetry” area to “Monitoring and Debugging” with a refreshed landing page and reorganized sections (Debugging, Monitoring, and AI). - Revised the debugging and logs guides to improve step-by-step guidance and highlight advanced log filtering. - **Navigation** - Renamed and restructured the top-level navigation entry to reflect the new Monitoring and Debugging content layout. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
53 lines
1.9 KiB
TypeScript
53 lines
1.9 KiB
TypeScript
export type MetricsStackOption = {
|
||
title: string
|
||
description: string
|
||
href: string
|
||
iconKind: 'grafana' | 'datadog' | 'flame'
|
||
iconColor: string
|
||
iconBg: string
|
||
badges: { label: string; variant: 'default' | 'community' }[]
|
||
}
|
||
|
||
export const metricsStackOptions: MetricsStackOption[] = [
|
||
{
|
||
title: 'Grafana Cloud (SaaS)',
|
||
description:
|
||
'Use Grafana Cloud’s managed Prometheus (works on Free + Pro tiers) and import the Supabase dashboard without running any infrastructure.',
|
||
href: '/guides/monitoring-and-debugging/metrics/grafana-cloud',
|
||
iconKind: 'grafana',
|
||
iconColor: '#F05A28',
|
||
iconBg: 'rgba(240,90,40,0.1)',
|
||
badges: [{ label: 'Supabase guide', variant: 'default' }],
|
||
},
|
||
{
|
||
title: 'Grafana + self-hosted Prometheus',
|
||
description:
|
||
'Run Prometheus yourself following the official installation guidance and pair it with Grafana plus our dashboard JSON and alert pack.',
|
||
href: '/guides/monitoring-and-debugging/metrics/grafana-self-hosted',
|
||
iconKind: 'grafana',
|
||
iconColor: '#F05A28',
|
||
iconBg: 'rgba(240,90,40,0.1)',
|
||
badges: [{ label: 'Supabase guide', variant: 'default' }],
|
||
},
|
||
{
|
||
title: 'Datadog',
|
||
description:
|
||
'Scrape the Metrics API with the Datadog Agent or Prometheus remote write and monitor Supabase alongside your app telemetry.',
|
||
href: 'https://docs.datadoghq.com/integrations/supabase/',
|
||
iconKind: 'datadog',
|
||
iconColor: '#632CA6',
|
||
iconBg: 'rgba(99,44,166,0.1)',
|
||
badges: [{ label: 'Community', variant: 'community' }],
|
||
},
|
||
{
|
||
title: 'Vendor-agnostic / BYO Prometheus',
|
||
description:
|
||
'Connect AWS AMP, Grafana Mimir, VictoriaMetrics, or any Prometheus-compatible SaaS with the same scrape job pattern.',
|
||
href: '/guides/monitoring-and-debugging/metrics/vendor-agnostic',
|
||
iconKind: 'flame',
|
||
iconColor: '#0BA678',
|
||
iconBg: 'rgba(11,166,120,0.1)',
|
||
badges: [{ label: 'Supabase guide', variant: 'default' }],
|
||
},
|
||
]
|