mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03: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>
66 lines
2.1 KiB
TypeScript
66 lines
2.1 KiB
TypeScript
import type { ContentListingGroup } from '~/lib/content-listings.schema'
|
|
|
|
export const telemetryDebugging: ContentListingGroup = {
|
|
id: 'telemetry-debugging',
|
|
heading: 'Debugging',
|
|
type: 'grid',
|
|
columns: 2,
|
|
items: [
|
|
{
|
|
title: 'Debugging guide',
|
|
href: '/guides/monitoring-and-debugging/debugging',
|
|
description:
|
|
'Isolate the failing layer, read logs as evidence, and match symptoms to troubleshooting guides.',
|
|
},
|
|
{
|
|
title: 'Logging',
|
|
href: '/guides/monitoring-and-debugging/logs',
|
|
description: 'Query events from any Supabase service using the Logs Explorer.',
|
|
},
|
|
{
|
|
title: 'Advanced log filtering',
|
|
href: '/guides/monitoring-and-debugging/advanced-log-filtering',
|
|
description: 'Regex filtering, structured-field queries, and field discovery in ClickHouse.',
|
|
},
|
|
{
|
|
title: 'Troubleshooting index',
|
|
href: '/guides/troubleshooting',
|
|
description: 'Searchable index of known error codes, symptoms, and fixes.',
|
|
},
|
|
],
|
|
}
|
|
|
|
export const telemetryMonitoring: ContentListingGroup = {
|
|
id: 'telemetry-monitoring',
|
|
heading: 'Monitoring',
|
|
type: 'grid',
|
|
columns: 2,
|
|
items: [
|
|
{
|
|
title: 'Log drains',
|
|
href: '/guides/monitoring-and-debugging/log-drains',
|
|
description: 'Forward logs to Datadog, Loki, Axiom, S3, or a custom HTTP endpoint.',
|
|
},
|
|
{
|
|
title: 'Reports',
|
|
href: '/guides/monitoring-and-debugging/reports',
|
|
description: 'Built-in dashboards for API, Auth, Storage, and Realtime activity.',
|
|
},
|
|
{
|
|
title: 'Metrics',
|
|
href: '/guides/monitoring-and-debugging/metrics',
|
|
description: 'Prometheus-compatible database metrics for Grafana and other tools.',
|
|
},
|
|
{
|
|
title: 'Client-side tracing',
|
|
href: '/guides/monitoring-and-debugging/client-side-tracing',
|
|
description: 'Correlate browser requests end-to-end using W3C Trace Context.',
|
|
},
|
|
{
|
|
title: 'Sentry integration',
|
|
href: '/guides/monitoring-and-debugging/sentry-monitoring',
|
|
description: 'Send errors to Sentry for alerting and grouping.',
|
|
},
|
|
],
|
|
}
|