mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
e0280cb650
<!-- 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> <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> </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>
56 lines
2.1 KiB
TypeScript
56 lines
2.1 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
|
|
import { AiPrompt } from './AiPrompt'
|
|
|
|
describe('AiPrompt markdown schema', () => {
|
|
it('omits prompts by default', () => {
|
|
expect(AiPrompt({ props: { id: 'nextjs' } })).toBe('')
|
|
})
|
|
|
|
it('serializes an opted-in prompt from the shared registry', () => {
|
|
const markdown = AiPrompt({
|
|
props: { id: 'nextjs', includeInMarkdown: true },
|
|
})
|
|
|
|
expect(markdown).toContain('**AI Prompt**')
|
|
expect(markdown).toContain('Help me add Supabase to my Next.js project.')
|
|
expect(markdown).toContain('```text')
|
|
})
|
|
|
|
it.each([
|
|
['monitoring-agent-health', 'Health monitor', 'health'],
|
|
['monitoring-agent-security', 'Security monitor', 'security'],
|
|
['monitoring-agent-performance', 'Performance monitor', 'performance'],
|
|
['monitoring-agent-usage', 'Capacity monitor', 'usage'],
|
|
])('serializes the %s agent prompt', (id, persona, detectionSection) => {
|
|
const markdown = AiPrompt({ props: { id, includeInMarkdown: true } })
|
|
|
|
expect(markdown).toContain('**AI Prompt**')
|
|
expect(markdown).toContain(persona)
|
|
expect(markdown).toContain('read-only')
|
|
expect(markdown).toContain(
|
|
`https://supabase.com/docs/guides/observability/detecting.md#${detectionSection}`
|
|
)
|
|
expect(markdown).toContain('```text')
|
|
})
|
|
|
|
it('serializes the monitoring overview prompt', () => {
|
|
const markdown = AiPrompt({
|
|
props: { id: 'monitoring-and-debugging', includeInMarkdown: true },
|
|
})
|
|
|
|
expect(markdown).toContain('Help me monitor and debug my Supabase project.')
|
|
expect(markdown).toContain('npm install -g supabase')
|
|
expect(markdown).toContain('npx plugins add supabase-community/supabase-plugin')
|
|
expect(markdown).toContain('read-only')
|
|
expect(markdown).toContain('https://supabase.com/docs/guides/observability.md')
|
|
expect(markdown).toContain('```text')
|
|
})
|
|
|
|
it('fails clearly for an unknown opted-in prompt', () => {
|
|
expect(() => AiPrompt({ props: { id: 'missing-prompt', includeInMarkdown: true } })).toThrow(
|
|
'Unknown AiPrompt id: missing-prompt'
|
|
)
|
|
})
|
|
})
|