Files
supabase/apps/studio/components/interfaces/Linter/LintDetail.tsx
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

113 lines
3.5 KiB
TypeScript

import { ExternalLink } from 'lucide-react'
import Link from 'next/link'
import { Button } from 'ui'
import { Markdown } from '../Markdown'
import { asGraphqlExposureLint, GraphqlExposureCallout } from './GraphqlExposureLintCTA'
import { EntityTypeIcon, LintCTA, LintEntity } from './Linter.utils'
import { createLintSummaryPrompt, lintInfoMap } from '@/components/interfaces/Linter/Linter.utils'
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { AiAssistantDropdown } from '@/components/ui/AiAssistantDropdown'
import { Lint } from '@/data/lint/lint-query'
import { DOCS_URL } from '@/lib/constants'
import { useTrack } from '@/lib/telemetry/track'
import { useAiAssistantStateSnapshot } from '@/state/ai-assistant-state'
import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
interface LintDetailProps {
lint: Lint
projectRef: string
onAskAssistant?: () => void
onAfterAction?: () => void
}
export const LintDetail = ({
lint,
projectRef,
onAskAssistant,
onAfterAction,
}: LintDetailProps) => {
const track = useTrack()
const snap = useAiAssistantStateSnapshot()
const { openSidebar } = useSidebarManagerSnapshot()
const isGraphqlExposureLint = !!asGraphqlExposureLint(lint.name)
const handleAskAssistant = () => {
track('advisor_assistant_button_clicked', {
origin: 'lint_detail',
advisorCategory: lint.categories[0],
advisorType: lint.name,
advisorLevel: lint.level,
})
onAskAssistant?.()
openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
snap.newChat({
name: 'Summarize lint',
initialMessage: createLintSummaryPrompt(lint),
})
}
const buildPromptForCopy = () => {
return createLintSummaryPrompt(lint)
}
return (
<div>
<h3 className="text-sm mb-2">Entity</h3>
<div className="flex items-center gap-1 px-2 py-0.5 bg-surface-200 border rounded-lg text-sm mb-6 w-fit">
<EntityTypeIcon type={lint.metadata?.type} />
<LintEntity metadata={lint.metadata} />
</div>
<h3 className="text-sm mb-2">Issue</h3>
<Markdown className="leading-6 text-sm text-foreground-light mb-6">
{lint.detail.replace(/\\`/g, '`')}
</Markdown>
<h3 className="text-sm mb-2">Description</h3>
<Markdown className="text-sm text-foreground-light mb-6">
{lint.description.replace(/\\`/g, '`')}
</Markdown>
{isGraphqlExposureLint && (
<div className="mb-4">
<GraphqlExposureCallout projectRef={projectRef} />
</div>
)}
<h3 className="text-sm mb-2">Resolve</h3>
<div className="flex flex-wrap items-center gap-2">
<AiAssistantDropdown
label="Ask Assistant"
buildPrompt={buildPromptForCopy}
onOpenAssistant={handleAskAssistant}
telemetrySource="lint_detail"
/>
<LintCTA
title={lint.name}
projectRef={projectRef}
metadata={lint.metadata}
onAfterAction={onAfterAction}
/>
<Button asChild variant="text">
<Link
href={
lintInfoMap.find((item) => item.name === lint.name)?.docsLink ||
`${DOCS_URL}/guides/observability/advisors`
}
target="_blank"
rel="noreferrer"
className="no-underline"
>
<span className="flex items-center gap-2">
Learn more <ExternalLink size={14} />
</span>
</Link>
</Button>
</div>
</div>
)
}