mirror of
https://github.com/supabase/supabase.git
synced 2026-10-12 04:45:08 +03:00
## 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 <img width="942" height="396" alt="CleanShot 2026-06-22 at 18 10 06" src="https://github.com/user-attachments/assets/7ca29e42-3d18-4a6a-9e2e-e9a274f393f4" /> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
55 lines
2.1 KiB
Plaintext
55 lines
2.1 KiB
Plaintext
---
|
|
title: 'Platform Audit Logs'
|
|
description: 'Monitor and track organization member activities via platform API or dashboard.'
|
|
---
|
|
|
|
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.
|
|
|
|
<Admonition type="note">
|
|
|
|
Platform Audit Logs are only available on the [Team and Enterprise plans](/pricing).
|
|
|
|
</Admonition>
|
|
|
|
## Accessing audit logs
|
|
|
|
Platform Audit Logs can be found under your [organization's audit logs](/dashboard/org/_/audit).
|
|
|
|
<Image
|
|
alt="Platform audit logs"
|
|
src={{
|
|
light: '/docs/img/guides/security/platform-audit-logs--light.png',
|
|
dark: '/docs/img/guides/security/platform-audit-logs--dark.png',
|
|
}}
|
|
|
|
width={2414}
|
|
height={958}
|
|
/>
|
|
|
|
For each audit log, you can see additional details by clicking on the log entry:
|
|
|
|
- Timestamp of action
|
|
- Actor who performed the action
|
|
- IP address
|
|
- Email
|
|
- Token Type
|
|
- Action performed
|
|
- Name
|
|
- Metadata such as route and response status
|
|
- Action Target (Project, organization, Edge Function, ...)
|
|
|
|
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
|
|
- Retention periods depend on your plan
|