mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
<!-- 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>
209 lines
7.1 KiB
TypeScript
209 lines
7.1 KiB
TypeScript
import { type GuideModel } from '../../../resources/guide/guideModel.js'
|
|
import { GuideModelLoader } from '../../../resources/guide/guideModelLoader.js'
|
|
import { LintWarningsGuideLoader, type LintWarningsGuideSource } from './lint-warnings-guide.js'
|
|
import { MarkdownLoader, type MarkdownSource } from './markdown.js'
|
|
import { fetchPartners, IntegrationLoader, type IntegrationSource } from './partner-integrations.js'
|
|
import {
|
|
ClientLibReferenceLoader,
|
|
CliReferenceLoader,
|
|
loadClientLibReferenceFromNewPipeline,
|
|
OpenApiReferenceLoader,
|
|
type ClientLibReferenceSource,
|
|
type CliReferenceSource,
|
|
type OpenApiReferenceSource,
|
|
} from './reference-doc.js'
|
|
import { fetchTroubleshootingSources, type TroubleshootingSource } from './troubleshooting.js'
|
|
|
|
export type SearchSource =
|
|
| MarkdownSource
|
|
| OpenApiReferenceSource
|
|
| ClientLibReferenceSource
|
|
| CliReferenceSource
|
|
| TroubleshootingSource
|
|
| IntegrationSource
|
|
| LintWarningsGuideSource
|
|
|
|
export async function fetchGuideSources() {
|
|
const guides = (await GuideModelLoader.allFromFs()).unwrapLeft()
|
|
|
|
return guides.map((guide: GuideModel) => MarkdownLoader.fromGuideModel('guide', guide))
|
|
}
|
|
|
|
export async function fetchOpenApiReferenceSource() {
|
|
return new OpenApiReferenceLoader(
|
|
'api',
|
|
'/reference/api',
|
|
{ title: 'Management API Reference' },
|
|
'spec/transforms/api_v1_openapi_deparsed.json',
|
|
'spec/common-api-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchJsLibReferenceSource() {
|
|
// JS v2 is driven by the new reference pipeline. Ingest search sources from
|
|
// the generated `content/reference/javascript/v2/` outputs so embeddings
|
|
// never drift from what the renderer shows.
|
|
return loadClientLibReferenceFromNewPipeline({
|
|
source: 'js-lib',
|
|
path: '/reference/javascript',
|
|
meta: { title: 'JavaScript Reference', language: 'JavaScript' },
|
|
contentDir: 'content/reference/javascript/v2',
|
|
})
|
|
}
|
|
|
|
export async function fetchServerLibReferenceSource() {
|
|
// Server SDK is driven by the new reference pipeline. Ingest search sources
|
|
// from the generated `content/reference/server/v1/` outputs so embeddings
|
|
// never drift from what the renderer shows.
|
|
return loadClientLibReferenceFromNewPipeline({
|
|
source: 'server-lib',
|
|
path: '/reference/server',
|
|
meta: { title: 'Server Reference', language: 'TypeScript' },
|
|
contentDir: 'content/reference/server/v1',
|
|
})
|
|
}
|
|
|
|
export async function fetchMiddlewareLibReferenceSource() {
|
|
// Middleware SDK is driven by the new reference pipeline. Ingest search
|
|
// sources from the generated `content/reference/middleware/v1/` outputs so
|
|
// embeddings never drift from what the renderer shows.
|
|
return loadClientLibReferenceFromNewPipeline({
|
|
source: 'middleware-lib',
|
|
path: '/reference/middleware',
|
|
meta: { title: 'Middleware Reference', language: 'TypeScript' },
|
|
contentDir: 'content/reference/middleware/v1',
|
|
})
|
|
}
|
|
|
|
export async function fetchDartLibReferenceSource() {
|
|
// Dart v2 is driven by the new reference pipeline. Ingest search sources from
|
|
// the generated `content/reference/dart/v2/` outputs so embeddings never
|
|
// drift from what the renderer shows.
|
|
return loadClientLibReferenceFromNewPipeline({
|
|
source: 'dart-lib',
|
|
path: '/reference/dart',
|
|
meta: { title: 'Dart Reference', language: 'Dart' },
|
|
contentDir: 'content/reference/dart/v2',
|
|
})
|
|
}
|
|
|
|
export async function fetchPythonLibReferenceSource() {
|
|
return new ClientLibReferenceLoader(
|
|
'python-lib',
|
|
'/reference/python',
|
|
{ title: 'Python Reference', language: 'Python' },
|
|
'spec/supabase_py_v2.yml',
|
|
'spec/common-client-libs-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchCSharpLibReferenceSource() {
|
|
return new ClientLibReferenceLoader(
|
|
'csharp-lib',
|
|
'/reference/csharp',
|
|
{ title: 'C# Reference', language: 'C#' },
|
|
'spec/supabase_csharp_v0.yml',
|
|
'spec/common-client-libs-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchSwiftLibReferenceSource() {
|
|
return new ClientLibReferenceLoader(
|
|
'swift-lib',
|
|
'/reference/swift',
|
|
{ title: 'Swift Reference', language: 'Swift' },
|
|
'spec/supabase_swift_v2.yml',
|
|
'spec/common-client-libs-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchKtLibReferenceSource() {
|
|
return new ClientLibReferenceLoader(
|
|
'kt-lib',
|
|
'/reference/kotlin',
|
|
{ title: 'Kotlin Reference', language: 'Kotlin' },
|
|
'spec/supabase_kt_v1.yml',
|
|
'spec/common-client-libs-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchCliLibReferenceSource() {
|
|
return new CliReferenceLoader(
|
|
'cli',
|
|
'/reference/cli',
|
|
{ title: 'CLI Reference', platform: 'cli' },
|
|
'spec/cli_v1_commands.yaml',
|
|
'spec/common-cli-sections.json'
|
|
).load()
|
|
}
|
|
|
|
export async function fetchLintWarningsGuideSources() {
|
|
return new LintWarningsGuideLoader(
|
|
'guide',
|
|
'/guides/observability/advisors',
|
|
'supabase',
|
|
'splinter',
|
|
'main',
|
|
'docs'
|
|
).load()
|
|
}
|
|
|
|
/**
|
|
* Fetches all the sources we want to index for search
|
|
*/
|
|
export async function fetchAllSources(fullIndex: boolean) {
|
|
const guideSources = fetchGuideSources()
|
|
const lintWarningsGuideSources = fetchLintWarningsGuideSources()
|
|
const openApiReferenceSource = fetchOpenApiReferenceSource()
|
|
const jsLibReferenceSource = fetchJsLibReferenceSource()
|
|
const serverLibReferenceSource = fullIndex ? fetchServerLibReferenceSource() : []
|
|
const middlewareLibReferenceSource = fullIndex ? fetchMiddlewareLibReferenceSource() : []
|
|
const dartLibReferenceSource = fullIndex ? fetchDartLibReferenceSource() : []
|
|
const pythonLibReferenceSource = fullIndex ? fetchPythonLibReferenceSource() : []
|
|
const cSharpLibReferenceSource = fullIndex ? fetchCSharpLibReferenceSource() : []
|
|
const swiftLibReferenceSource = fullIndex ? fetchSwiftLibReferenceSource() : []
|
|
const ktLibReferenceSource = fullIndex ? fetchKtLibReferenceSource() : []
|
|
const cliReferenceSource = fullIndex ? fetchCliLibReferenceSource() : []
|
|
|
|
const partnerIntegrationSources = fullIndex
|
|
? fetchPartners()
|
|
.then((partners) =>
|
|
partners
|
|
? Promise.all(
|
|
partners.map((partner) => new IntegrationLoader(partner.slug, partner).load())
|
|
)
|
|
: []
|
|
)
|
|
.then((data) => data.flat())
|
|
: []
|
|
|
|
// Load troubleshooting articles from local MDX files
|
|
const troubleshootingSources = fetchTroubleshootingSources()
|
|
.then((loaders) => Promise.all(loaders.map((loader) => loader.load())))
|
|
.then((data) => data.flat())
|
|
|
|
// Type assertion required because ReferenceLoader.load() returns Promise<BaseSource[]>
|
|
// which widens the inferred union type. All concrete sources in this array are valid
|
|
// SearchSource types (MarkdownSource, OpenApiReferenceSource, etc.).
|
|
const sources = (
|
|
await Promise.all([
|
|
guideSources,
|
|
lintWarningsGuideSources,
|
|
openApiReferenceSource,
|
|
jsLibReferenceSource,
|
|
serverLibReferenceSource,
|
|
middlewareLibReferenceSource,
|
|
dartLibReferenceSource,
|
|
pythonLibReferenceSource,
|
|
cSharpLibReferenceSource,
|
|
swiftLibReferenceSource,
|
|
ktLibReferenceSource,
|
|
cliReferenceSource,
|
|
partnerIntegrationSources,
|
|
troubleshootingSources,
|
|
])
|
|
).flat() as SearchSource[]
|
|
|
|
return sources
|
|
}
|