mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 02:45:07 +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>
85 lines
2.0 KiB
Plaintext
85 lines
2.0 KiB
Plaintext
---
|
|
id: 'storage-logs'
|
|
title: 'Logs'
|
|
description: 'Learn how to check Storage Logs'
|
|
sidebar_label: 'Debugging'
|
|
---
|
|
|
|
The [Storage Logs](/dashboard/project/_/logs/storage-logs) provide a convenient way to examine all incoming request logs to your Storage service. You can filter by time and keyword searches.
|
|
|
|
For more advanced filtering needs, use the [Logs Explorer](/dashboard/project/_/logs/explorer) to query the Storage logs dataset directly. The Logs Explorer is separate from the SQL Editor and uses a subset of the BigQuery SQL syntax rather than traditional SQL.
|
|
|
|
<Admonition type="note">
|
|
|
|
For more details on filtering the log tables, see [Advanced Log Filtering](/docs/guides/monitoring-and-debugging/advanced-log-filtering)
|
|
|
|
</Admonition>
|
|
|
|
### Example Storage queries for the Logs Explorer
|
|
|
|
#### Filter by status 5XX error
|
|
|
|
```sql
|
|
select
|
|
id,
|
|
storage_logs.timestamp,
|
|
event_message,
|
|
r.statusCode,
|
|
e.message as errorMessage,
|
|
e.raw as rawError
|
|
from
|
|
storage_logs
|
|
cross join unnest(metadata) as m
|
|
cross join unnest(m.res) as r
|
|
cross join unnest(m.error) as e
|
|
where r.statusCode >= 500
|
|
order by timestamp desc
|
|
limit 100;
|
|
```
|
|
|
|
#### Filter by status 4XX error
|
|
|
|
```sql
|
|
select
|
|
id,
|
|
storage_logs.timestamp,
|
|
event_message,
|
|
r.statusCode,
|
|
e.message as errorMessage,
|
|
e.raw as rawError
|
|
from
|
|
storage_logs
|
|
cross join unnest(metadata) as m
|
|
cross join unnest(m.res) as r
|
|
cross join unnest(m.error) as e
|
|
where r.statusCode >= 400 and r.statusCode < 500
|
|
order by timestamp desc
|
|
limit 100;
|
|
```
|
|
|
|
#### Filter by method
|
|
|
|
```sql
|
|
select id, storage_logs.timestamp, event_message, r.method
|
|
from
|
|
storage_logs
|
|
cross join unnest(metadata) as m
|
|
cross join unnest(m.req) as r
|
|
where r.method in ("POST")
|
|
order by timestamp desc
|
|
limit 100;
|
|
```
|
|
|
|
#### Filter by IP address
|
|
|
|
```sql
|
|
select id, storage_logs.timestamp, event_message, r.remoteAddress
|
|
from
|
|
storage_logs
|
|
cross join unnest(metadata) as m
|
|
cross join unnest(m.req) as r
|
|
where r.remoteAddress in ("IP_ADDRESS")
|
|
order by timestamp desc
|
|
limit 100;
|
|
```
|