mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
b0597aa5fa
Add docs with bare min information abotut he addition of the 4 new health advisors ## Problem no docs on health advisors ## Solution added docs covering health advisors <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added health advisors for persistently high error rates in the Data API, Auth, Storage, and Edge Functions. * Findings include links to relevant troubleshooting guidance and instructions for reviewing recent errors or failed invocations in Studio Logs, MCP, or the Management API. * **Documentation** * Updated the advisors guide to describe health, security, and performance checks, with examples and links to access advisors in Studio and the Management API. * Clarified that findings may be intentional and can take time to clear after a fix. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Saxon Fletcher <saxonafletcher@gmail.com> Co-authored-by: Nik Richers <nrichers@gmail.com>
56 lines
2.9 KiB
TypeScript
56 lines
2.9 KiB
TypeScript
/**
|
|
* Health advisors read service logs rather than the schema, so they aren't documented in
|
|
* splinter alongside the security and performance lints. `DatabaseAdvisorsIndex` prepends
|
|
* these, matching the order of the advisors in Studio.
|
|
*/
|
|
export const healthAdvisors = [
|
|
{
|
|
path: 'log_data_api_error_rate_high',
|
|
content: `**Summary:** Data API error rate is persistently high
|
|
|
|
**Ramification:** Data API requests are returning 5xx errors, so reads and writes from your app may fail.
|
|
|
|
***
|
|
|
|
### How to Resolve
|
|
|
|
Pull up to five recent 5xx responses on \`/rest/v1\` paths from \`edge_logs\` with their IDs, timestamps, and status. You can use [Logs](/dashboard/project/_/logs/edge-logs) in Studio, the MCP [\`query_logs\`](/docs/guides/observability/advanced-log-filtering#mcp) tool, or the [Management API](/docs/guides/observability/advanced-log-filtering#api). Then follow [API error troubleshooting](/docs/guides/troubleshooting/discovering-and-interpreting-api-errors-in-the-logs-7xREI9).`,
|
|
},
|
|
{
|
|
path: 'log_auth_error_rate_high',
|
|
content: `**Summary:** Auth error rate is persistently high
|
|
|
|
**Ramification:** Users may be unable to sign in or refresh their session.
|
|
|
|
***
|
|
|
|
### How to Resolve
|
|
|
|
Pull up to five recent errors from \`auth_logs\` with their IDs, timestamps, and status. You can use [Logs](/dashboard/project/_/logs/auth-logs) in Studio, the MCP [\`query_logs\`](/docs/guides/observability/advanced-log-filtering#mcp) tool, or the [Management API](/docs/guides/observability/advanced-log-filtering#api). Then use [Auth error codes](/docs/guides/auth/debugging/error-codes) to interpret them.`,
|
|
},
|
|
{
|
|
path: 'log_storage_error_rate_high',
|
|
content: `**Summary:** Storage error rate is persistently high
|
|
|
|
**Ramification:** File uploads and downloads may fail.
|
|
|
|
***
|
|
|
|
### How to Resolve
|
|
|
|
Pull up to five recent errors from \`storage_logs\` with their IDs, timestamps, and status. You can use [Logs](/dashboard/project/_/logs/storage-logs) in Studio, the MCP [\`query_logs\`](/docs/guides/observability/advanced-log-filtering#mcp) tool, or the [Management API](/docs/guides/observability/advanced-log-filtering#api). Then use [Storage error codes](/docs/guides/storage/debugging/error-codes) to interpret them.`,
|
|
},
|
|
{
|
|
path: 'log_edge_function_error_rate_high',
|
|
content: `**Summary:** Edge Function error rate is persistently high
|
|
|
|
**Ramification:** Features that call your Edge Functions may fail.
|
|
|
|
***
|
|
|
|
### How to Resolve
|
|
|
|
Pull up to five recent failed invocations from \`function_edge_logs\` with their IDs, timestamps, and status. You can use [Logs](/dashboard/project/_/logs/edge-functions-logs) in Studio, the MCP [\`query_logs\`](/docs/guides/observability/advanced-log-filtering#mcp) tool, or the [Management API](/docs/guides/observability/advanced-log-filtering#api). Then use [Edge Functions error codes](/docs/guides/functions/error-codes) to interpret them.`,
|
|
},
|
|
]
|