From ca48e596cfea27ee4c1b4c38b75c07ab546591b6 Mon Sep 17 00:00:00 2001 From: Illia Basalaiev <44750366+Ellba@users.noreply.github.com> Date: Tue, 23 Jun 2026 19:55:09 +0200 Subject: [PATCH] chore: add audit logs drains to documentation (#47190) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES/NO ## What kind of change does this PR introduce? docs update ## What is the current behavior? missing mention of the audit logs drains ## What is the new behavior? add audit logs drains info ## Additional context CleanShot 2026-06-22 at 18 10 06 ## Summary by CodeRabbit * **Documentation** * Added a new **“Accessing Audit Log Drains”** section explaining how to stream platform audit log events in real time using **Audit Log Drains**, including where to configure this in the dashboard. * Updated the guide’s introduction to reference external streaming via Audit Log Drains. * Revised the **“Limitations”** section to remove the prior note about lacking drain setup, while retaining the dashboard-export limitation and the plan-based retention information. --- .../docs/content/guides/security/platform-audit-logs.mdx | 9 +++++++-- supa-mdx-lint/Rule001HeadingCase.toml | 1 + 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/apps/docs/content/guides/security/platform-audit-logs.mdx b/apps/docs/content/guides/security/platform-audit-logs.mdx index 00818393291..1ead782aa0d 100644 --- a/apps/docs/content/guides/security/platform-audit-logs.mdx +++ b/apps/docs/content/guides/security/platform-audit-logs.mdx @@ -3,7 +3,9 @@ title: 'Platform Audit Logs' description: 'Monitor and track organization member activities via platform API or dashboard.' --- -Any [Platform API](/docs/reference/api/introduction) or [dashboard](/dashboard) actions performed by organization members are logged automatically for auditing and security purposes. This includes actions such as creating a new project, inviting members, modifying an edge function or changing project settings. +This topic covers how to view and stream Platform Audit Logs for your organization. + +Any [Platform API](/docs/reference/api/introduction) or [dashboard](/dashboard) actions performed by organization members are logged automatically for auditing and security purposes. This includes actions such as creating a new project, inviting members, modifying an edge function or changing project settings. You can view these logs in the dashboard or stream them to an external destination using [Audit Log Drains](#accessing-audit-log-drains). Besides Platform Audit Logs, Supabase Auth also provides [Auth Audit Logs](/docs/guides/auth/audit-logs) to monitor authentication-related activities within your projects. @@ -42,8 +44,11 @@ For each audit log, you can see additional details by clicking on the log entry: Each Supabase user account also has access to [Account Audit logs](/dashboard/account/audit) which displays these logs for only the associated user account. +## Accessing Audit Log Drains + +Audit Log Drains can be configured under your [organization's audit log drains](/dashboard/org/_/audit-log-drains). For setup instructions and supported destinations, see the [Log Drains guide](/docs/guides/telemetry/log-drains). + ## Limitations - There is currently no way to export the logs via dashboard -- There is currently no way to set up a log drain of platform audit logs - Retention periods depend on your plan diff --git a/supa-mdx-lint/Rule001HeadingCase.toml b/supa-mdx-lint/Rule001HeadingCase.toml index 9023270acef..26c6a97f1a2 100644 --- a/supa-mdx-lint/Rule001HeadingCase.toml +++ b/supa-mdx-lint/Rule001HeadingCase.toml @@ -15,6 +15,7 @@ may_uppercase = [ "Apache Spark", "Apple", "Assistant", + "Audit Log Drains?", "Audit Logs?", "Auth", "Auth API Gateway",