Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(studio): organization audit log drains settings O11Y-1685 (#46614)

Jordi Enric776381ea983a
diff --git a/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.test.tsx b/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.test.tsx
index a632e8d1523..582ed9cdc7e 100644
--- a/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.test.tsx
+++ b/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.test.tsx
@@ -1,6 +1,7 @@
import { fireEvent, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import type { ComponentProps } from 'react'
+import { toast } from 'sonner'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { LogDrainDestinationSheetForm } from './LogDrainDestinationSheetForm'
@@ -110,6 +111,37 @@ describe('LogDrainDestinationSheetForm', () => {
expect(screen.getByRole('button', { name: 'Save destination' })).toBeInTheDocument()
})
+ it('blocks submission when the destination name matches an existing drain', async () => {
+ const user = userEvent.setup()
+ const { onSubmit } = renderForm({ existingDrainNames: ['existing-drain'] })
+
+ await screen.findByRole('dialog')
+
+ await user.type(screen.getByPlaceholderText('My Destination'), 'existing-drain')
+ submitForm()
+
+ await waitFor(() => expect(toast.error).toHaveBeenCalledWith('Log drain name already exists'))
+ expect(onSubmit).not.toHaveBeenCalled()
+ })
+
+ it('invokes onSaveClick with the destination type when saving', async () => {
+ const user = userEvent.setup()
+ const onSaveClick = vi.fn()
+ const { onSubmit } = renderForm({ onSaveClick })
+
+ await screen.findByRole('dialog')
+
+ await user.type(screen.getByPlaceholderText('My Destination'), 'Webhook sink')
+ await user.type(
+ screen.getByPlaceholderText('https://example.com/log-drain'),
+ 'https://logs.example.com/ingest'
+ )
+ submitForm()
+
+ await waitFor(() => expect(onSubmit).toHaveBeenCalledTimes(1))
+ expect(onSaveClick).toHaveBeenCalledWith('webhook')
+ })
+
it('shows the protobuf content type header for OTLP create mode', async () => {
renderForm({
defaultValues: { type: 'otlp' },
diff --git a/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.tsx b/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.tsx
index 7ea07ca59ee..4b974b2c727 100644
--- a/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.tsx
+++ b/apps/studio/components/interfaces/LogDrains/LogDrainDestinationSheetForm.tsx
@@ -1,5 +1,5 @@
import { zodResolver } from '@hookform/resolvers/zod'
-import { IS_PLATFORM, useFlag, useParams } from 'common'
+import { IS_PLATFORM, useFlag } from 'common'
import Link from 'next/link'
import { ReactNode, useEffect, useMemo, useRef } from 'react'
import { useForm } from 'react-hook-form'
@@ -53,9 +53,8 @@ import {
} from './LogDrains.utils'
import { TaxDisclaimer } from '@/components/interfaces/Billing/TaxDisclaimer'
import { Shortcut } from '@/components/ui/Shortcut'
-import { LogDrainData, useLogDrainsQuery } from '@/data/log-drains/log-drains-query'
+import { LogDrainData } from '@/data/log-drains/log-drains-query'
import { DOCS_URL } from '@/lib/constants'
-import { useTrack } from '@/lib/telemetry/track'
import { httpEndpointUrlSchema } from '@/lib/validation/http-url'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
@@ -263,7 +262,9 @@ type LogDrainDestinationSubmitValues = z.infer<typeof submitSchema>
const HEADER_ENABLED_TYPES = ['webhook', 'loki', 'otlp'] as const
-function toSubmitValues(values: LogDrainDestinationFormValues): LogDrainDestinationSubmitValues {
+export function toSubmitValues(
+ values: LogDrainDestinationFormValues
+): LogDrainDestinationSubmitValues {
if (!HEADER_ENABLED_TYPES.includes(values.type as (typeof HEADER_ENABLED_TYPES)[number])) {
return submitSchema.parse(values)
}
@@ -321,6 +322,8 @@ export function LogDrainDestinationSheetForm({
onSubmit,
isLoading,
mode,
+ existingDrainNames = [],
+ onSaveClick,
}: {
open: boolean
onOpenChange: (v: boolean) => void
@@ -328,6 +331,8 @@ export function LogDrainDestinationSheetForm({
isLoading?: boolean
onSubmit: (values: LogDrainDestinationSubmitValues) => void
mode: 'create' | 'update'
+ existingDrainNames?: string[]
+ onSaveClick?: (type: LogDrainType) => void
}) {
// NOTE(kamil): This used to be `any` for a long long time, but after moving to Zod,
// it produces a correct union type of all possible configs. Unfortunately, this type was not designed correctly
@@ -349,12 +354,6 @@ export function LogDrainDestinationSheetForm({
const last9Enabled = useFlag('Last9LogDrain')
const syslogEnabled = useFlag('syslogLogDrain')
- const { ref } = useParams()
- const { data: logDrains } = useLogDrainsQuery({
- ref,
- })
-
- const track = useTrack()
const formRef = useRef<HTMLFormElement>(null)
const formValues = useMemo(() => {
@@ -435,17 +434,16 @@ export function LogDrainDestinationSheetForm({
// Temp check to make sure the name is unique
const logDrainName = form.getValues('name')
- const logDrainExists =
- !!logDrains?.length && logDrains?.find((drain) => drain.name === logDrainName)
+ const logDrainExists = existingDrainNames.includes(logDrainName)
if (logDrainExists && mode === 'create') {
toast.error('Log drain name already exists')
return
}
- form.handleSubmit((values) => onSubmit(toSubmitValues(values)))(e)
- track('log_drain_save_button_clicked', {
- destination: form.getValues('type'),
- })
+ form.handleSubmit((values) => {
+ onSubmit(toSubmitValues(values))
+ onSaveClick?.(values.type)
+ })(e)
}}
>
<div className="space-y-8 px-content">
diff --git a/apps/studio/components/interfaces/LogDrains/LogDrains.tsx b/apps/studio/components/interfaces/LogDrains/LogDrains.tsx
index 0c773fc5b50..a4bb37db5f2 100644
--- a/apps/studio/components/interfaces/LogDrains/LogDrains.tsx
+++ b/apps/studio/components/interfaces/LogDrains/LogDrains.tsx
@@ -1,30 +1,10 @@
-import { IS_PLATFORM, useFlag, useParams } from 'common'
-import { MoreHorizontal, TrashIcon } from 'lucide-react'
-import { cloneElement, useState } from 'react'
+import { useParams } from 'common'
import { toast } from 'sonner'
-import {
- Button,
- Card,
- cn,
- DropdownMenu,
- DropdownMenuContent,
- DropdownMenuItem,
- DropdownMenuTrigger,
- Table,
- TableBody,
- TableCell,
- TableHead,
- TableHeader,
- TableRow,
-} from 'ui'
-import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
-import { LOG_DRAIN_TYPES, LogDrainType } from './LogDrains.constants'
-import { LogDrainsCard } from './LogDrainsCard'
+import { LogDrainType } from './LogDrains.constants'
import { LogDrainsEmpty } from './LogDrainsEmpty'
-import { VoteLink } from './VoteLink'
-import AlertError from '@/components/ui/AlertError'
+import { LogDrainsList } from './LogDrainsList'
import { useDeleteLogDrainMutation } from '@/data/log-drains/delete-log-drain-mutation'
import { LogDrainData, useLogDrainsQuery } from '@/data/log-drains/log-drains-query'
import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'
@@ -37,44 +17,25 @@ export function LogDrains({
onNewDrainClick: (src: LogDrainType) => void
onUpdateDrainClick: (drain: LogDrainData) => void
}) {
+ const { ref } = useParams()
+ const track = useTrack()
const { hasAccess: hasAccessToLogDrains, isLoading: isLoadingEntitlement } =
useCheckEntitlements('log_drains')
- const track = useTrack()
- const [isDeleteModalOpen, setIsDeleteModalOpen] = useState(false)
- const [selectedLogDrain, setSelectedLogDrain] = useState<LogDrainData | null>(null)
- const { ref } = useParams()
+
const {
data: logDrains,
isPending: isLoading,
error,
isError,
- } = useLogDrainsQuery(
- { ref },
- {
- enabled: hasAccessToLogDrains,
- }
- )
- const sentryEnabled = useFlag('SentryLogDrain')
- const s3Enabled = useFlag('S3logdrain')
- const axiomEnabled = useFlag('axiomLogDrain')
- const otlpEnabled = useFlag('otlpLogDrain')
- const last9Enabled = useFlag('Last9LogDrain')
- const syslogEnabled = useFlag('syslogLogDrain')
- const hasLogDrains = !!logDrains?.length
+ } = useLogDrainsQuery({ ref }, { enabled: hasAccessToLogDrains })
- const { mutate: deleteLogDrain } = useDeleteLogDrainMutation({
- onSuccess: () => {
- setIsDeleteModalOpen(false)
- setSelectedLogDrain(null)
- },
+ const { mutate: deleteLogDrain, isPending: isDeleting } = useDeleteLogDrainMutation({
onError: () => {
- setIsDeleteModalOpen(false)
- setSelectedLogDrain(null)
toast.error('Failed to delete log drain')
},
})
- if (isLoading || isLoadingEntitlement) {
+ if (isLoadingEntitlement) {
return (
<div>
<GenericSkeletonLoader />
@@ -82,151 +43,24 @@ export function LogDrains({
)
}
- if (!isLoadingEntitlement && !hasAccessToLogDrains) {
+ if (!hasAccessToLogDrains) {
return <LogDrainsEmpty />
}
- if (isError) {
- return <AlertError subject="Failed to load log drains" error={error}></AlertError>
- }
-
- if (!isLoading && !hasLogDrains) {
- return (
- <>
- <div className="grid lg:grid-cols-3 gap-4">
- {LOG_DRAIN_TYPES.filter((t) => {
- if (t.value === 'sentry') return sentryEnabled
- if (t.value === 's3') return s3Enabled
- if (t.value === 'axiom') return axiomEnabled
- if (t.value === 'otlp') return otlpEnabled
- if (t.value === 'last9') return last9Enabled
- if (t.value === 'syslog') return syslogEnabled
- return true
- }).map((src) => (
- <LogDrainsCard
- key={src.value}
- title={src.name}
- description={src.description}
- icon={src.icon}
- rightLabel={IS_PLATFORM ? 'Additional $60' : undefined}
- onClick={() => {
- onNewDrainClick(src.value)
- }}
- />
- ))}
- </div>
- <VoteLink />
- </>
- )
- }
-
return (
- <>
- <Card>
- <Table>
- <TableHeader>
- <TableRow>
- <TableHead className="max-w-[200px]">Name</TableHead>
- <TableHead className="w-96">Description</TableHead>
- <TableHead className="w-48">Destination</TableHead>
- <TableHead className="text-right">
- <div className="sr-only">Actions</div>
- </TableHead>
- </TableRow>
- </TableHeader>
- <TableBody>
- {logDrains
- ?.slice()
- .sort((a, b) => b.id - a.id)
- .map((drain) => (
- <TableRow key={drain.id}>
- <TableCell className="font-medium truncate max-w-72" title={drain.name}>
- {drain.name}
- </TableCell>
- <TableCell
- className={cn(
- 'truncate max-w-96',
- drain.description ? 'text-foreground-light' : 'text-foreground-muted'
- )}
- title={drain.description}
- >
- {drain.description || '-'}
- </TableCell>
- <TableCell className="text-foreground-light">
- <div className="flex items-center gap-2">
- {LOG_DRAIN_TYPES.find((t) => t.value === drain.type)?.icon && (
- <span className="text-foreground-light">
- {cloneElement(LOG_DRAIN_TYPES.find((t) => t.value === drain.type)!.icon, {
- height: 16,
- width: 16,
- })}
- </span>
- )}
- <span className="truncate max-w-40">
- {LOG_DRAIN_TYPES.find((t) => t.value === drain.type)?.name ?? drain.type}
- </span>
- </div>
- </TableCell>
- <TableCell className="text-right">
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <Button
- type="text"
- className="px-1 opacity-50 hover:opacity-100 bg-transparent! shrink-0"
- icon={<MoreHorizontal />}
- />
- </DropdownMenuTrigger>
- <DropdownMenuContent className="max-w-[140px]" align="end">
- {/* Jordi: Updating log drains is disabled temporarily.
- <DropdownMenuItem
- onClick={() => {
- onUpdateDrainClick(drain)
- }}
- >
- <Pencil className="h-4 w-4 mr-2" />
- Update
- </DropdownMenuItem> */}
- <DropdownMenuItem
- onClick={() => {
- setSelectedLogDrain(drain)
- setIsDeleteModalOpen(true)
- }}
- >
- <TrashIcon className="h-4 w-4 mr-2" />
- Delete
- </DropdownMenuItem>
- </DropdownMenuContent>
- </DropdownMenu>
- </TableCell>
- </TableRow>
- ))}
- </TableBody>
-
- <ConfirmationModal
- confirmLabel="Delete"
- variant="destructive"
- title="Delete Log Drain"
- visible={isDeleteModalOpen}
- onConfirm={() => {
- if (selectedLogDrain && ref) {
- deleteLogDrain({ token: selectedLogDrain.token, projectRef: ref })
- track('log_drain_removed', {
- destination: selectedLogDrain.type,
- })
- }
- }}
- onCancel={() => setIsDeleteModalOpen(false)}
- >
- <div className="text-foreground-light text-sm">
- <p>
- Are you sure you want to delete{' '}
- <span className="text-foreground">{selectedLogDrain?.name}</span>?
- </p>
- <p>This action cannot be undone.</p>
- </div>
- </ConfirmationModal>
- </Table>
- </Card>
- </>
+ <LogDrainsList
+ logDrains={logDrains}
+ isLoading={isLoading}
+ isError={isError}
+ error={error}
+ isDeleting={isDeleting}
+ onNewDrainClick={onNewDrainClick}
+ onDeleteDrain={(drain) => {
+ if (ref) {
+ deleteLogDrain({ token: drain.token, projectRef: ref })
+ track('log_drain_removed', { destination: drain.type })
+ }
+ }}
+ />
)
}
diff --git a/apps/studio/components/interfaces/LogDrains/LogDrainsList.tsx b/apps/studio/components/interfaces/LogDrains/LogDrainsList.tsx
new file mode 100644
index 00000000000..10946a80749
--- /dev/null
+++ b/apps/studio/components/interfaces/LogDrains/LogDrainsList.tsx
@@ -0,0 +1,202 @@
+import { IS_PLATFORM } from 'common'
+import { MoreHorizontal, PlugZap, TrashIcon } from 'lucide-react'
+import { cloneElement, useEffect, useRef, useState } from 'react'
+import {
+ Button,
+ Card,
+ cn,
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableRow,
+} from 'ui'
+import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
+import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
+
+import { LOG_DRAIN_TYPES, LogDrainType } from './LogDrains.constants'
+import { LogDrainsCard } from './LogDrainsCard'
+import { useEnabledLogDrainTypes } from './useEnabledLogDrainTypes'
+import { VoteLink } from './VoteLink'
+import AlertError from '@/components/ui/AlertError'
+import { LogDrainData } from '@/data/log-drains/log-drains-query'
+import type { ResponseError } from '@/types'
+
+export function LogDrainsList({
+ logDrains,
+ isLoading,
+ isError,
+ error,
+ isDeleting,
+ onNewDrainClick,
+ onDeleteDrain,
+ onTestDrain,
+}: {
+ logDrains: LogDrainData[] | undefined
+ isLoading: boolean
+ isError: boolean
+ error: ResponseError | null
+ isDeleting?: boolean
+ onNewDrainClick: (src: LogDrainType) => void
+ onDeleteDrain: (drain: LogDrainData) => void
+ onTestDrain?: (drain: LogDrainData) => void
+}) {
+ const [isDeleteModalOpen, setIsDeleteModalOpen] = useState(false)
+ const [selectedLogDrain, setSelectedLogDrain] = useState<LogDrainData | null>(null)
+
+ const enabledDrainTypes = useEnabledLogDrainTypes()
+ const hasLogDrains = !!logDrains?.length
+
+ const wasDeleting = useRef(false)
+ useEffect(() => {
+ if (wasDeleting.current && !isDeleting) {
+ setIsDeleteModalOpen(false)
+ setSelectedLogDrain(null)
+ }
+ wasDeleting.current = !!isDeleting
+ }, [isDeleting])
+
+ if (isLoading) {
+ return (
+ <div>
+ <GenericSkeletonLoader />
+ </div>
+ )
+ }
+
+ if (isError) {
+ return <AlertError subject="Failed to load log drains" error={error}></AlertError>
+ }
+
+ if (!hasLogDrains) {
+ return (
+ <>
+ <div className="grid lg:grid-cols-3 gap-4">
+ {enabledDrainTypes.map((src) => (
+ <LogDrainsCard
+ key={src.value}
+ title={src.name}
+ description={src.description}
+ icon={src.icon}
+ rightLabel={IS_PLATFORM ? 'Additional $60' : undefined}
+ onClick={() => {
+ onNewDrainClick(src.value)
+ }}
+ />
+ ))}
+ </div>
+ <VoteLink />
+ </>
+ )
+ }
+
+ return (
+ <>
+ <Card>
+ <Table>
+ <TableHeader>
+ <TableRow>
+ <TableHead className="max-w-[200px]">Name</TableHead>
+ <TableHead className="w-96">Description</TableHead>
+ <TableHead className="w-48">Destination</TableHead>
+ <TableHead className="text-right">
+ <div className="sr-only">Actions</div>
+ </TableHead>
+ </TableRow>
+ </TableHeader>
+ <TableBody>
+ {logDrains
+ ?.slice()
+ .sort((a, b) => b.id - a.id)
+ .map((drain) => (
+ <TableRow key={drain.id}>
+ <TableCell className="font-medium truncate max-w-72" title={drain.name}>
+ {drain.name}
+ </TableCell>
+ <TableCell
+ className={cn(
+ 'truncate max-w-96',
+ drain.description ? 'text-foreground-light' : 'text-foreground-muted'
+ )}
+ title={drain.description}
+ >
+ {drain.description || '-'}
+ </TableCell>
+ <TableCell className="text-foreground-light">
+ <div className="flex items-center gap-2">
+ {LOG_DRAIN_TYPES.find((t) => t.value === drain.type)?.icon && (
+ <span className="text-foreground-light">
+ {cloneElement(LOG_DRAIN_TYPES.find((t) => t.value === drain.type)!.icon, {
+ height: 16,
+ width: 16,
+ })}
+ </span>
+ )}
+ <span className="truncate max-w-40">
+ {LOG_DRAIN_TYPES.find((t) => t.value === drain.type)?.name ?? drain.type}
+ </span>
+ </div>
+ </TableCell>
+ <TableCell className="text-right">
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button
+ type="text"
+ className="px-1 opacity-50 hover:opacity-100 bg-transparent! shrink-0"
+ icon={<MoreHorizontal />}
+ />
+ </DropdownMenuTrigger>
+ <DropdownMenuContent className="max-w-[160px]" align="end">
+ {onTestDrain && (
+ <DropdownMenuItem onClick={() => onTestDrain(drain)}>
+ <PlugZap className="h-4 w-4 mr-2" />
+ Test connection
+ </DropdownMenuItem>
+ )}
+ <DropdownMenuItem
+ onClick={() => {
+ setSelectedLogDrain(drain)
+ setIsDeleteModalOpen(true)
+ }}
+ >
+ <TrashIcon className="h-4 w-4 mr-2" />
+ Delete
+ </DropdownMenuItem>
+ </DropdownMenuContent>
+ </DropdownMenu>
+ </TableCell>
+ </TableRow>
+ ))}
+ </TableBody>
+
+ <ConfirmationModal
+ confirmLabel="Delete"
+ variant="destructive"
+ title="Delete Log Drain"
+ visible={isDeleteModalOpen}
+ loading={isDeleting}
+ onConfirm={() => {
+ if (selectedLogDrain) {
+ onDeleteDrain(selectedLogDrain)
+ }
+ }}
+ onCancel={() => setIsDeleteModalOpen(false)}
+ >
+ <div className="text-foreground-light text-sm">
+ <p>
+ Are you sure you want to delete{' '}
+ <span className="text-foreground">{selectedLogDrain?.name}</span>?
+ </p>
+ <p>This action cannot be undone.</p>
+ </div>
+ </ConfirmationModal>
+ </Table>
+ </Card>
+ </>
+ )
+}
diff --git a/apps/studio/components/interfaces/LogDrains/OrgAuditLogDrains.tsx b/apps/studio/components/interfaces/LogDrains/OrgAuditLogDrains.tsx
new file mode 100644
index 00000000000..ef1a849ce07
--- /dev/null
+++ b/apps/studio/components/interfaces/LogDrains/OrgAuditLogDrains.tsx
@@ -0,0 +1,285 @@
+import { PermissionAction } from '@supabase/shared-types/out/constants'
+import { IS_PLATFORM, useParams } from 'common'
+import { ChevronDown } from 'lucide-react'
+import { cloneElement, useState } from 'react'
+import { toast } from 'sonner'
+import {
+ Alert,
+ Button,
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+} from 'ui'
+import { GenericSkeletonLoader } from 'ui-patterns'
+import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
+
+import { LogDrainDestinationSheetForm } from './LogDrainDestinationSheetForm'
+import { LogDrainType } from './LogDrains.constants'
+import { LogDrainsList } from './LogDrainsList'
+import { useEnabledLogDrainTypes } from './useEnabledLogDrainTypes'
+import { Shortcut } from '@/components/ui/Shortcut'
+import { UpgradePlanButton } from '@/components/ui/UpgradePlanButton'
+import { useAuditLogDrainsQuery } from '@/data/log-drains/audit-log-drains-query'
+import {
+ AuditLogDrainConfig,
+ AuditLogDrainCreateVariables,
+ useCreateAuditLogDrainMutation,
+} from '@/data/log-drains/create-audit-log-drain-mutation'
+import { useDeleteAuditLogDrainMutation } from '@/data/log-drains/delete-audit-log-drain-mutation'
+import { LogDrainData } from '@/data/log-drains/log-drains-query'
+import { useTestAuditLogDrainMutation } from '@/data/log-drains/test-audit-log-drain-mutation'
+import { useUpdateAuditLogDrainMutation } from '@/data/log-drains/update-audit-log-drain-mutation'
+import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'
+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
+import { useTrack } from '@/lib/telemetry/track'
+import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
+
+export function OrgAuditLogDrains() {
+ const { slug } = useParams() as { slug: string }
+ const track = useTrack()
+
+ const { can: canManageLogDrains, isLoading: isLoadingPermissions } = useAsyncCheckPermissions(
+ PermissionAction.ANALYTICS_ADMIN_WRITE,
+ 'logflare'
+ )
+
+ const { hasAccess: hasAccessToLogDrains, isLoading: isLoadingEntitlement } = useCheckEntitlements(
+ 'audit_log_drains',
+ slug
+ )
+
+ const [open, setOpen] = useState(false)
+ const [mode, setMode] = useState<'create' | 'update'>('create')
+ const [selectedLogDrain, setSelectedLogDrain] = useState<Partial<LogDrainData> | null>(null)
+ const [isCreateConfirmModalOpen, setIsCreateConfirmModalOpen] = useState(false)
+ const [pendingLogDrainValues, setPendingLogDrainValues] =
+ useState<AuditLogDrainCreateVariables | null>(null)
+
+ const enabledDrainTypes = useEnabledLogDrainTypes()
+
+ const {
+ data: logDrains,
+ isPending: isLoadingDrains,
+ error,
+ isError,
+ } = useAuditLogDrainsQuery({ slug }, { enabled: !isLoadingEntitlement && hasAccessToLogDrains })
+
+ const { mutate: createLogDrain, isPending: createLoading } = useCreateAuditLogDrainMutation({
+ onSuccess: () => {
+ toast.success('Audit log drain destination created')
+ setPendingLogDrainValues(null)
+ setIsCreateConfirmModalOpen(false)
+ setOpen(false)
+ },
+ onError: () => {
+ toast.error('Failed to create audit log drain')
+ },
+ })
+
+ const { mutate: updateLogDrain, isPending: updateLoading } = useUpdateAuditLogDrainMutation({
+ onSuccess: () => {
+ toast.success('Audit log drain updated')
+ setOpen(false)
+ },
+ onError: () => {
+ setOpen(false)
+ toast.error('Failed to update audit log drain')
+ },
+ })
+
+ const { mutate: deleteLogDrain, isPending: isDeleting } = useDeleteAuditLogDrainMutation({
+ onError: () => {
+ toast.error('Failed to delete audit log drain')
+ },
+ })
+
+ const { mutate: testLogDrain } = useTestAuditLogDrainMutation({
+ onSuccess: () => {
+ toast.success('Audit log drain connection test succeeded')
+ },
+ })
+
+ const isLoading = createLoading || updateLoading
+
+ function handleNewClick(src: LogDrainType) {
+ setSelectedLogDrain({ type: src })
+ setMode('create')
+ setOpen(true)
+ }
+
+ function handleAddDestinationClick() {
+ setSelectedLogDrain(null)
+ setMode('create')
+ setOpen(true)
+ }
+
+ if (isLoadingPermissions || isLoadingEntitlement) {
+ return <GenericSkeletonLoader />
+ }
+
+ if (!hasAccessToLogDrains) {
+ return (
+ <div className="flex flex-col items-center gap-4 rounded border border-dashed py-12 px-6 text-center">
+ <div className="flex flex-col gap-1">
+ <p className="text-foreground">Audit log drains are not available on your plan</p>
+ <p className="text-sm text-foreground-light">
+ Upgrade to a Team or Enterprise Plan to export your organization audit logs to your
+ preferred destination.
+ </p>
+ </div>
+ <UpgradePlanButton
+ plan="Team"
+ source="audit-log-drains-empty-state"
+ featureProposition="use Audit Log Drains"
+ />
+ </div>
+ )
+ }
+
+ if (!canManageLogDrains) {
+ return <Alert variant="default">You do not have permission to manage audit log drains</Alert>
+ }
+
+ return (
+ <div className="flex flex-col gap-6">
+ {!!logDrains?.length && (
+ <div className="flex items-center justify-end">
+ <div className="flex items-center">
+ <Shortcut
+ id={SHORTCUT_IDS.LOG_DRAINS_ADD_DESTINATION}
+ onTrigger={handleAddDestinationClick}
+ options={{ enabled: canManageLogDrains }}
+ side="bottom"
+ tooltipOpen={open ? false : undefined}
+ >
+ <Button
+ disabled={!canManageLogDrains}
+ onClick={handleAddDestinationClick}
+ type="primary"
+ className="rounded-r-none px-3"
+ >
+ Add destination
+ </Button>
+ </Shortcut>
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button
+ type="primary"
+ title="Choose destination type"
+ className="rounded-l-none px-[4px] py-[5px]"
+ icon={<ChevronDown />}
+ />
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end" side="bottom">
+ {enabledDrainTypes.map((drainType) => (
+ <DropdownMenuItem
+ key={drainType.value}
+ onClick={() => handleNewClick(drainType.value)}
+ >
+ <div className="flex items-center gap-3">
+ {cloneElement(drainType.icon, { height: 16, width: 16 })}
+ <div className="space-y-1">
+ <p className="block text-foreground">{drainType.name}</p>
+ {IS_PLATFORM && (
+ <p className="text-xs text-foreground-lighter">Additional $60</p>
+ )}
+ </div>
+ </div>
+ </DropdownMenuItem>
+ ))}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ </div>
+ </div>
+ )}
+
+ <LogDrainDestinationSheetForm
+ mode={mode}
+ open={open}
+ onOpenChange={(v) => {
+ if (!v) {
+ setSelectedLogDrain(null)
+ }
+ setOpen(v)
+ }}
+ defaultValues={{
+ ...selectedLogDrain,
+ type: selectedLogDrain?.type ? selectedLogDrain.type : 'webhook',
+ }}
+ isLoading={isLoading}
+ existingDrainNames={(logDrains ?? []).map((drain) => drain.name)}
+ onSaveClick={(type) => {
+ track('log_drain_save_button_clicked', { destination: type })
+ }}
+ onSubmit={({ name, description, type, ...values }) => {
+ const logDrainValues = {
+ name,
+ description: description || '',
+ type,
+ config: values as AuditLogDrainConfig,
+ id: selectedLogDrain?.id,
+ slug,
+ token: selectedLogDrain?.token,
+ }
+
+ if (mode === 'create') {
+ setPendingLogDrainValues(logDrainValues)
+ setIsCreateConfirmModalOpen(true)
+ } else {
+ if (!selectedLogDrain?.token) {
+ toast.error('Audit log drain token is required')
+ return
+ }
+ updateLogDrain(logDrainValues)
+ }
+ }}
+ />
+
+ <LogDrainsList
+ logDrains={logDrains}
+ isLoading={isLoadingDrains}
+ isError={isError}
+ error={error}
+ isDeleting={isDeleting}
+ onNewDrainClick={handleNewClick}
+ onDeleteDrain={(drain) => {
+ deleteLogDrain({ token: drain.token, slug })
+ track('log_drain_removed', { destination: drain.type })
+ }}
+ onTestDrain={(drain) => testLogDrain({ token: drain.token, slug })}
+ />
+
+ <ConfirmationModal
+ confirmLabel="Add destination"
+ variant="default"
+ title="Confirm Audit Log Drain Creation"
+ visible={isCreateConfirmModalOpen}
+ loading={createLoading}
+ onConfirm={() => {
+ if (pendingLogDrainValues && !createLoading) {
+ createLogDrain(pendingLogDrainValues)
+ }
+ }}
+ onCancel={() => {
+ setIsCreateConfirmModalOpen(false)
+ setPendingLogDrainValues(null)
+ }}
+ >
+ <div className="text-foreground-light text-sm space-y-2">
+ <p>
+ You are about to create a new audit log drain destination:{' '}
+ <span className="text-foreground">{pendingLogDrainValues?.name}</span>
+ </p>
+ {IS_PLATFORM && (
+ <p>
+ This will incur an additional <span className="text-foreground">$60 per month</span>{' '}
+ charge to your subscription.
+ </p>
+ )}
+ <p>Are you sure you want to proceed?</p>
+ </div>
+ </ConfirmationModal>
+ </div>
+ )
+}
diff --git a/apps/studio/components/interfaces/LogDrains/useEnabledLogDrainTypes.ts b/apps/studio/components/interfaces/LogDrains/useEnabledLogDrainTypes.ts
new file mode 100644
index 00000000000..a722f15187c
--- /dev/null
+++ b/apps/studio/components/interfaces/LogDrains/useEnabledLogDrainTypes.ts
@@ -0,0 +1,22 @@
+import { useFlag } from 'common'
+
+import { LOG_DRAIN_TYPES } from './LogDrains.constants'
+
+export function useEnabledLogDrainTypes() {
+ const sentryEnabled = useFlag('SentryLogDrain')
+ const s3Enabled = useFlag('S3logdrain')
+ const axiomEnabled = useFlag('axiomLogDrain')
+ const otlpEnabled = useFlag('otlpLogDrain')
+ const last9Enabled = useFlag('Last9LogDrain')
+ const syslogEnabled = useFlag('syslogLogDrain')
+
+ return LOG_DRAIN_TYPES.filter((t) => {
+ if (t.value === 'sentry') return sentryEnabled
+ if (t.value === 's3') return s3Enabled
+ if (t.value === 'axiom') return axiomEnabled
+ if (t.value === 'otlp') return otlpEnabled
+ if (t.value === 'last9') return last9Enabled
+ if (t.value === 'syslog') return syslogEnabled
+ return true
+ })
+}
diff --git a/apps/studio/components/layouts/ProjectLayout/OrganizationSettingsLayout.tsx b/apps/studio/components/layouts/ProjectLayout/OrganizationSettingsLayout.tsx
index 0c2a1cf5a14..ca4ef9ef2cc 100644
--- a/apps/studio/components/layouts/ProjectLayout/OrganizationSettingsLayout.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/OrganizationSettingsLayout.tsx
@@ -18,6 +18,7 @@ interface OrganizationSettingsMenuItemsProps {
showLegalDocuments?: boolean
showPlatformWebhooks?: boolean
showPrivateApps?: boolean
+ showAuditLogDrains?: boolean
}
interface OrganizationSettingsSectionsProps extends OrganizationSettingsMenuItemsProps {
@@ -33,6 +34,7 @@ export const generateOrganizationSettingsMenuItems = ({
showLegalDocuments = true,
showPlatformWebhooks = true,
showPrivateApps: _showPrivateApps = false,
+ showAuditLogDrains = false,
}: OrganizationSettingsMenuItemsProps) => [
{
key: 'general',
@@ -76,6 +78,15 @@ export const generateOrganizationSettingsMenuItems = ({
label: 'Audit Logs',
href: `/org/${slug}/audit`,
},
+ ...(showAuditLogDrains
+ ? [
+ {
+ key: 'audit-log-drains',
+ label: 'Audit Log Drains',
+ href: `/org/${slug}/audit-log-drains`,
+ },
+ ]
+ : []),
...(showLegalDocuments
? [
{
@@ -95,6 +106,7 @@ export const generateOrganizationSettingsSections = ({
showLegalDocuments = true,
showPlatformWebhooks = true,
showPrivateApps = false,
+ showAuditLogDrains = false,
}: OrganizationSettingsSectionsProps): SidebarSection[] => {
const isLinkActive = (key: string, href: string) =>
key === 'webhooks'
@@ -166,6 +178,16 @@ export const generateOrganizationSettingsSections = ({
href: `/org/${slug}/audit`,
shortcutId: SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT,
},
+ ...(showAuditLogDrains
+ ? [
+ {
+ key: 'audit-log-drains',
+ label: 'Audit Log Drains',
+ href: `/org/${slug}/audit-log-drains`,
+ shortcutId: SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT_LOG_DRAINS,
+ },
+ ]
+ : []),
...(showLegalDocuments
? [
{
@@ -210,6 +232,7 @@ export function OrganizationSettingsLayout({ children }: PropsWithChildren) {
const { slug } = useParams()
const showPlatformWebhooks = useIsPlatformWebhooksEnabled()
const showPrivateApps = useFlag('privateApps')
+ const showAuditLogDrains = useFlag('auditLogsLogDrain')
const fullCurrentPath = useCurrentPath()
const currentPath = normalizeOrganizationSettingsPath(fullCurrentPath)
@@ -231,6 +254,7 @@ export function OrganizationSettingsLayout({ children }: PropsWithChildren) {
showLegalDocuments,
showPlatformWebhooks,
showPrivateApps,
+ showAuditLogDrains,
})
const orgSettingsMenu = useMemo(
diff --git a/apps/studio/data/log-drains/audit-log-drains-query.ts b/apps/studio/data/log-drains/audit-log-drains-query.ts
new file mode 100644
index 00000000000..9e65a789cde
--- /dev/null
+++ b/apps/studio/data/log-drains/audit-log-drains-query.ts
@@ -0,0 +1,51 @@
+import { useQuery } from '@tanstack/react-query'
+
+import { logDrainsKeys } from './keys'
+import { LogDrainData } from './log-drains-query'
+import { get, handleError } from '@/data/fetchers'
+import { MAX_RETRY_FAILURE_COUNT } from '@/data/query-client'
+import type { ResponseError, UseCustomQueryOptions } from '@/types'
+
+export type AuditLogDrainsVariables = {
+ slug?: string
+}
+
+export async function getAuditLogDrains({ slug }: AuditLogDrainsVariables, signal?: AbortSignal) {
+ if (!slug) {
+ throw new Error('slug is required')
+ }
+
+ const { data, error } = await get('/platform/organizations/{slug}/analytics/audit-log-drains', {
+ params: { path: { slug } },
+ signal,
+ })
+
+ if (error) handleError(error)
+
+ return (data ?? []) as LogDrainData[]
+}
+
+export type AuditLogDrainsData = LogDrainData[]
+export type AuditLogDrainsError = ResponseError
+
+export const useAuditLogDrainsQuery = <TData = AuditLogDrainsData>(
+ { slug }: AuditLogDrainsVariables,
+ {
+ enabled = true,
+ ...options
+ }: UseCustomQueryOptions<AuditLogDrainsData, AuditLogDrainsError, TData> = {}
+) =>
+ useQuery<AuditLogDrainsData, AuditLogDrainsError, TData>({
+ queryKey: logDrainsKeys.auditList(slug),
+ queryFn: ({ signal }) => getAuditLogDrains({ slug }, signal),
+ enabled: enabled && !!slug,
+ refetchOnMount: false,
+ retry: (failureCount, error) => {
+ if (error.code === 500 || error.message.includes('API error happened')) return false
+ if (failureCount < MAX_RETRY_FAILURE_COUNT) {
+ return true
+ }
+ return false
+ },
+ ...options,
+ })
diff --git a/apps/studio/data/log-drains/audit-log-drains.test.tsx b/apps/studio/data/log-drains/audit-log-drains.test.tsx
new file mode 100644
index 00000000000..b1e3d300272
--- /dev/null
+++ b/apps/studio/data/log-drains/audit-log-drains.test.tsx
@@ -0,0 +1,74 @@
+import { waitFor } from '@testing-library/react'
+import { http, HttpResponse } from 'msw'
+import { describe, expect, it } from 'vitest'
+
+import { useAuditLogDrainsQuery } from './audit-log-drains-query'
+import { useCreateAuditLogDrainMutation } from './create-audit-log-drain-mutation'
+import { useDeleteAuditLogDrainMutation } from './delete-audit-log-drain-mutation'
+import { API_URL } from '@/lib/constants'
+import { customRenderHook } from '@/tests/lib/custom-render'
+import { mswServer } from '@/tests/lib/msw'
+
+const SLUG = 'my-org'
+const BASE = `${API_URL}/platform/organizations/:slug/analytics/audit-log-drains`
+
+const DRAIN = {
+ id: 1,
+ token: 'tok-1',
+ name: 'Audit drain',
+ description: '',
+ type: 'webhook',
+ config: { url: 'https://example.com' },
+}
+
+describe('org audit log drain hooks', () => {
+ it('lists audit log drains for an organization', async () => {
+ mswServer.use(http.get(BASE, () => HttpResponse.json([DRAIN])))
+
+ const { result } = customRenderHook(() => useAuditLogDrainsQuery({ slug: SLUG }))
+
+ await waitFor(() => expect(result.current.isSuccess).toBe(true))
+ expect(result.current.data).toHaveLength(1)
+ expect(result.current.data?.[0].name).toBe('Audit drain')
+ })
+
+ it('creates an audit log drain at the org-scoped path', async () => {
+ let receivedSlug: string | undefined
+ mswServer.use(
+ http.post(BASE, ({ params }) => {
+ receivedSlug = params.slug as string
+ return HttpResponse.json(DRAIN)
+ })
+ )
+
+ const { result } = customRenderHook(() => useCreateAuditLogDrainMutation())
+
+ result.current.mutate({
+ slug: SLUG,
+ name: 'Audit drain',
+ description: '',
+ type: 'webhook',
+ config: {} as any,
+ })
+
+ await waitFor(() => expect(result.current.isSuccess).toBe(true))
+ expect(receivedSlug).toBe(SLUG)
+ })
+
+ it('deletes an audit log drain by token', async () => {
+ let receivedToken: string | undefined
+ mswServer.use(
+ http.delete(`${BASE}/:token`, ({ params }) => {
+ receivedToken = params.token as string
+ return new HttpResponse(null, { status: 204 })
+ })
+ )
+
+ const { result } = customRenderHook(() => useDeleteAuditLogDrainMutation())
+
+ result.current.mutate({ slug: SLUG, token: 'tok-1' })
+
+ await waitFor(() => expect(result.current.isSuccess).toBe(true))
+ expect(receivedToken).toBe('tok-1')
+ })
+})
diff --git a/apps/studio/data/log-drains/create-audit-log-drain-mutation.ts b/apps/studio/data/log-drains/create-audit-log-drain-mutation.ts
new file mode 100644
index 00000000000..de5518bbb26
--- /dev/null
+++ b/apps/studio/data/log-drains/create-audit-log-drain-mutation.ts
@@ -0,0 +1,65 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { toast } from 'sonner'
+
+import { logDrainsKeys } from './keys'
+import { LogDrainType } from '@/components/interfaces/LogDrains/LogDrains.constants'
+import type { components } from '@/data/api'
+import { handleError, post } from '@/data/fetchers'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+export type AuditLogDrainConfig = components['schemas']['CreateBackendParamsOpenapi']['config']
+
+export type AuditLogDrainCreateVariables = {
+ slug: string
+ name: string
+ description: string
+ config: AuditLogDrainConfig
+ type: LogDrainType
+}
+
+export async function createAuditLogDrain(payload: AuditLogDrainCreateVariables) {
+ const { data, error } = await post('/platform/organizations/{slug}/analytics/audit-log-drains', {
+ params: { path: { slug: payload.slug } },
+ body: {
+ name: payload.name,
+ description: payload.description,
+ type: payload.type,
+ config: payload.config,
+ },
+ })
+
+ if (error) handleError(error)
+ return data
+}
+
+type AuditLogDrainCreateData = Awaited<ReturnType<typeof createAuditLogDrain>>
+
+export const useCreateAuditLogDrainMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<AuditLogDrainCreateData, ResponseError, AuditLogDrainCreateVariables>,
+ 'mutationFn'
+> = {}) => {
+ const queryClient = useQueryClient()
+
+ return useMutation<AuditLogDrainCreateData, ResponseError, AuditLogDrainCreateVariables>({
+ mutationFn: (vars) => createAuditLogDrain(vars),
+ async onSuccess(data, variables, context) {
+ const { slug } = variables
+
+ await queryClient.invalidateQueries({ queryKey: logDrainsKeys.auditList(slug) })
+
+ await onSuccess?.(data, variables, context)
+ },
+ async onError(data, variables, context) {
+ if (onError === undefined) {
+ toast.error(`Failed to mutate: ${data.message}`)
+ } else {
+ onError(data, variables, context)
+ }
+ },
+ ...options,
+ })
+}
diff --git a/apps/studio/data/log-drains/delete-audit-log-drain-mutation.ts b/apps/studio/data/log-drains/delete-audit-log-drain-mutation.ts
new file mode 100644
index 00000000000..67897d1fc30
--- /dev/null
+++ b/apps/studio/data/log-drains/delete-audit-log-drain-mutation.ts
@@ -0,0 +1,55 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { toast } from 'sonner'
+
+import { logDrainsKeys } from './keys'
+import { del, handleError } from '@/data/fetchers'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+export type AuditLogDrainDeleteVariables = {
+ slug: string
+ token: string
+}
+
+export async function deleteAuditLogDrain({ slug, token }: AuditLogDrainDeleteVariables) {
+ const { data, error } = await del(
+ '/platform/organizations/{slug}/analytics/audit-log-drains/{token}',
+ {
+ params: { path: { slug, token } },
+ }
+ )
+
+ if (error) handleError(error)
+ return data
+}
+
+type AuditLogDrainDeleteData = Awaited<ReturnType<typeof deleteAuditLogDrain>>
+
+export const useDeleteAuditLogDrainMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<AuditLogDrainDeleteData, ResponseError, AuditLogDrainDeleteVariables>,
+ 'mutationFn'
+> = {}) => {
+ const queryClient = useQueryClient()
+
+ return useMutation<AuditLogDrainDeleteData, ResponseError, AuditLogDrainDeleteVariables>({
+ mutationFn: (vars) => deleteAuditLogDrain(vars),
+ async onSuccess(data, variables, context) {
+ const { slug } = variables
+
+ await queryClient.invalidateQueries({ queryKey: logDrainsKeys.auditList(slug) })
+
+ await onSuccess?.(data, variables, context)
+ },
+ async onError(data, variables, context) {
+ if (onError === undefined) {
+ toast.error(`Failed to mutate: ${data.message}`)
+ } else {
+ onError(data, variables, context)
+ }
+ },
+ ...options,
+ })
+}
diff --git a/apps/studio/data/log-drains/keys.ts b/apps/studio/data/log-drains/keys.ts
index afc0219b7ee..288a0b892d6 100644
--- a/apps/studio/data/log-drains/keys.ts
+++ b/apps/studio/data/log-drains/keys.ts
@@ -1,3 +1,4 @@
export const logDrainsKeys = {
list: (projectRef: string | undefined) => ['projects', projectRef, 'log-drains'] as const,
+ auditList: (slug: string | undefined) => ['organizations', slug, 'audit-log-drains'] as const,
}
diff --git a/apps/studio/data/log-drains/test-audit-log-drain-mutation.ts b/apps/studio/data/log-drains/test-audit-log-drain-mutation.ts
new file mode 100644
index 00000000000..2ced95d2d59
--- /dev/null
+++ b/apps/studio/data/log-drains/test-audit-log-drain-mutation.ts
@@ -0,0 +1,48 @@
+import { useMutation } from '@tanstack/react-query'
+import { toast } from 'sonner'
+
+import { handleError, post } from '@/data/fetchers'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+export type AuditLogDrainTestVariables = {
+ slug: string
+ token: string
+}
+
+export async function testAuditLogDrain({ slug, token }: AuditLogDrainTestVariables) {
+ const { data, error } = await post(
+ '/platform/organizations/{slug}/analytics/audit-log-drains/{token}/test',
+ {
+ params: { path: { slug, token } },
+ }
+ )
+
+ if (error) handleError(error)
+ return data
+}
+
+type AuditLogDrainTestData = Awaited<ReturnType<typeof testAuditLogDrain>>
+
+export const useTestAuditLogDrainMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<AuditLogDrainTestData, ResponseError, AuditLogDrainTestVariables>,
+ 'mutationFn'
+> = {}) => {
+ return useMutation<AuditLogDrainTestData, ResponseError, AuditLogDrainTestVariables>({
+ mutationFn: (vars) => testAuditLogDrain(vars),
+ async onSuccess(data, variables, context) {
+ await onSuccess?.(data, variables, context)
+ },
+ async onError(data, variables, context) {
+ if (onError === undefined) {
+ toast.error(`Failed to test log drain: ${data.message}`)
+ } else {
+ onError(data, variables, context)
+ }
+ },
+ ...options,
+ })
+}
diff --git a/apps/studio/data/log-drains/update-audit-log-drain-mutation.ts b/apps/studio/data/log-drains/update-audit-log-drain-mutation.ts
new file mode 100644
index 00000000000..eb97f751d7f
--- /dev/null
+++ b/apps/studio/data/log-drains/update-audit-log-drain-mutation.ts
@@ -0,0 +1,71 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { toast } from 'sonner'
+
+import { AuditLogDrainConfig } from './create-audit-log-drain-mutation'
+import { logDrainsKeys } from './keys'
+import { LogDrainType } from '@/components/interfaces/LogDrains/LogDrains.constants'
+import { handleError, put } from '@/data/fetchers'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+export type AuditLogDrainUpdateVariables = {
+ slug: string
+ token?: string
+ name: string
+ description?: string
+ type: LogDrainType
+ config: AuditLogDrainConfig
+}
+
+export async function updateAuditLogDrain(payload: AuditLogDrainUpdateVariables) {
+ if (!payload.token) {
+ throw new Error('Token is required')
+ }
+
+ const { data, error } = await put(
+ '/platform/organizations/{slug}/analytics/audit-log-drains/{token}',
+ {
+ params: { path: { slug: payload.slug, token: payload.token } },
+ body: {
+ name: payload.name,
+ description: payload.description,
+ type: payload.type,
+ config: payload.config,
+ },
+ }
+ )
+
+ if (error) handleError(error)
+ return data
+}
+
+type AuditLogDrainUpdateData = Awaited<ReturnType<typeof updateAuditLogDrain>>
+
+export const useUpdateAuditLogDrainMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<AuditLogDrainUpdateData, ResponseError, AuditLogDrainUpdateVariables>,
+ 'mutationFn'
+> = {}) => {
+ const queryClient = useQueryClient()
+
+ return useMutation<AuditLogDrainUpdateData, ResponseError, AuditLogDrainUpdateVariables>({
+ mutationFn: (vars) => updateAuditLogDrain(vars),
+ async onSuccess(data, variables, context) {
+ const { slug } = variables
+
+ await queryClient.invalidateQueries({ queryKey: logDrainsKeys.auditList(slug) })
+
+ await onSuccess?.(data, variables, context)
+ },
+ async onError(data, variables, context) {
+ if (onError === undefined) {
+ toast.error(`Failed to mutate: ${data.message}`)
+ } else {
+ onError(data, variables, context)
+ }
+ },
+ ...options,
+ })
+}
diff --git a/apps/studio/pages/org/[slug]/audit-log-drains.tsx b/apps/studio/pages/org/[slug]/audit-log-drains.tsx
new file mode 100644
index 00000000000..30dac663361
--- /dev/null
+++ b/apps/studio/pages/org/[slug]/audit-log-drains.tsx
@@ -0,0 +1,53 @@
+import { IS_PLATFORM, useFlag, useParams } from 'common'
+import { PageContainer } from 'ui-patterns/PageContainer'
+import {
+ PageHeader,
+ PageHeaderDescription,
+ PageHeaderMeta,
+ PageHeaderSummary,
+ PageHeaderTitle,
+} from 'ui-patterns/PageHeader'
+
+import { OrgAuditLogDrains } from '@/components/interfaces/LogDrains/OrgAuditLogDrains'
+import { DefaultLayout } from '@/components/layouts/DefaultLayout'
+import OrganizationLayout from '@/components/layouts/OrganizationLayout'
+import { OrganizationSettingsLayout } from '@/components/layouts/ProjectLayout/OrganizationSettingsLayout'
+import { UnknownInterface } from '@/components/ui/UnknownInterface'
+import type { NextPageWithLayout } from '@/types'
+
+const OrgAuditLogDrainsPage: NextPageWithLayout = () => {
+ const { slug } = useParams()
+ const showAuditLogDrains = useFlag('auditLogsLogDrain')
+
+ if (!IS_PLATFORM || !showAuditLogDrains) {
+ return <UnknownInterface urlBack={`/org/${slug}/audit`} />
+ }
+
+ return (
+ <>
+ <PageHeader size="default">
+ <PageHeaderMeta>
+ <PageHeaderSummary>
+ <PageHeaderTitle>Audit Log Drains</PageHeaderTitle>
+ <PageHeaderDescription>
+ Export your organization audit logs to third party destinations
+ </PageHeaderDescription>
+ </PageHeaderSummary>
+ </PageHeaderMeta>
+ </PageHeader>
+ <PageContainer size="default">
+ <OrgAuditLogDrains />
+ </PageContainer>
+ </>
+ )
+}
+
+OrgAuditLogDrainsPage.getLayout = (page) => (
+ <DefaultLayout>
+ <OrganizationLayout title="Audit Log Drains">
+ <OrganizationSettingsLayout>{page}</OrganizationSettingsLayout>
+ </OrganizationLayout>
+ </DefaultLayout>
+)
+
+export default OrgAuditLogDrainsPage
diff --git a/apps/studio/pages/project/[ref]/settings/log-drains.tsx b/apps/studio/pages/project/[ref]/settings/log-drains.tsx
index 1db356abac7..f2ede559130 100644
--- a/apps/studio/pages/project/[ref]/settings/log-drains.tsx
+++ b/apps/studio/pages/project/[ref]/settings/log-drains.tsx
@@ -1,5 +1,5 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
-import { IS_PLATFORM, useFlag, useParams } from 'common'
+import { IS_PLATFORM, useParams } from 'common'
import { ChevronDown } from 'lucide-react'
import { cloneElement, useState, type ReactElement } from 'react'
import { toast } from 'sonner'
@@ -16,10 +16,8 @@ import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
import { LogDrainDestinationSheetForm } from '@/components/interfaces/LogDrains/LogDrainDestinationSheetForm'
import { LogDrains } from '@/components/interfaces/LogDrains/LogDrains'
-import {
- LOG_DRAIN_TYPES,
- LogDrainType,
-} from '@/components/interfaces/LogDrains/LogDrains.constants'
+import { LogDrainType } from '@/components/interfaces/LogDrains/LogDrains.constants'
+import { useEnabledLogDrainTypes } from '@/components/interfaces/LogDrains/useEnabledLogDrainTypes'
import DefaultLayout from '@/components/layouts/DefaultLayout'
import { PageLayout } from '@/components/layouts/PageLayout/PageLayout'
import SettingsLayout from '@/components/layouts/ProjectSettingsLayout/SettingsLayout'
@@ -35,6 +33,7 @@ import { useUpdateLogDrainMutation } from '@/data/log-drains/update-log-drain-mu
import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
import { DOCS_URL } from '@/lib/constants'
+import { useTrack } from '@/lib/telemetry/track'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
import type { NextPageWithLayout } from '@/types'
@@ -44,6 +43,7 @@ const LogDrainsSettings: NextPageWithLayout = () => {
'logflare'
)
+ const track = useTrack()
const [open, setOpen] = useState(false)
const { ref } = useParams() as { ref: string }
const [selectedLogDrain, setSelectedLogDrain] = useState<Partial<LogDrainData> | null>(null)
@@ -55,12 +55,7 @@ const LogDrainsSettings: NextPageWithLayout = () => {
const { hasAccess: hasAccessToLogDrains, isLoading: isLoadingEntitlement } =
useCheckEntitlements('log_drains')
- const sentryEnabled = useFlag('SentryLogDrain')
- const s3Enabled = useFlag('S3logdrain')
- const axiomEnabled = useFlag('axiomLogDrain')
- const otlpEnabled = useFlag('otlpLogDrain')
- const last9Enabled = useFlag('Last9LogDrain')
- const syslogEnabled = useFlag('syslogLogDrain')
+ const enabledDrainTypes = useEnabledLogDrainTypes()
const { data: logDrains } = useLogDrainsQuery(
{ ref },
@@ -128,6 +123,10 @@ const LogDrainsSettings: NextPageWithLayout = () => {
type: selectedLogDrain?.type ? selectedLogDrain.type : 'webhook',
}}
isLoading={isLoading}
+ existingDrainNames={(logDrains ?? []).map((drain) => drain.name)}
+ onSaveClick={(type) => {
+ track('log_drain_save_button_clicked', { destination: type })
+ }}
onSubmit={({ name, description, type, ...values }) => {
const logDrainValues = {
name,
@@ -144,10 +143,10 @@ const LogDrainsSettings: NextPageWithLayout = () => {
setIsCreateConfirmModalOpen(true)
} else {
if (!logDrainValues.id || !selectedLogDrain?.token) {
- throw new Error('Log drain ID and token is required')
- } else {
- updateLogDrain(logDrainValues)
+ toast.error('Unable to update log drain: missing ID or token')
+ return
}
+ updateLogDrain(logDrainValues)
}
}}
/>
@@ -231,15 +230,7 @@ const LogDrainsSettings: NextPageWithLayout = () => {
/>
</DropdownMenuTrigger>
<DropdownMenuContent align="end" side="bottom">
- {LOG_DRAIN_TYPES.filter((t) => {
- if (t.value === 'sentry') return sentryEnabled
- if (t.value === 's3') return s3Enabled
- if (t.value === 'axiom') return axiomEnabled
- if (t.value === 'otlp') return otlpEnabled
- if (t.value === 'last9') return last9Enabled
- if (t.value === 'syslog') return syslogEnabled
- return true
- }).map((drainType) => (
+ {enabledDrainTypes.map((drainType) => (
<DropdownMenuItem
key={drainType.value}
onClick={() => handleNewClick(drainType.value)}
diff --git a/apps/studio/state/shortcuts/registry/org-settings-nav.ts b/apps/studio/state/shortcuts/registry/org-settings-nav.ts
index df31254acb3..0669ffb57ec 100644
--- a/apps/studio/state/shortcuts/registry/org-settings-nav.ts
+++ b/apps/studio/state/shortcuts/registry/org-settings-nav.ts
@@ -16,6 +16,7 @@ export const ORG_SETTINGS_NAV_SHORTCUT_IDS = {
NAV_ORG_SETTINGS_PRIVATE_APPS: 'nav.org-settings-private-apps',
NAV_ORG_SETTINGS_WEBHOOKS: 'nav.org-settings-webhooks',
NAV_ORG_SETTINGS_AUDIT: 'nav.org-settings-audit',
+ NAV_ORG_SETTINGS_AUDIT_LOG_DRAINS: 'nav.org-settings-audit-log-drains',
NAV_ORG_SETTINGS_DOCUMENTS: 'nav.org-settings-documents',
} as const
@@ -79,6 +80,14 @@ export const orgSettingsNavRegistry: RegistryDefinations<OrgSettingsNavShortcutI
referenceGroup: SHORTCUT_REFERENCE_GROUPS.NAVIGATION_ORG_SETTINGS,
options: { ignoreInputs: true },
},
+ [ORG_SETTINGS_NAV_SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT_LOG_DRAINS]: {
+ id: ORG_SETTINGS_NAV_SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT_LOG_DRAINS,
+ label: 'Go to Audit log drains',
+ sequence: ['S', 'N'],
+ showInSettings: false,
+ referenceGroup: SHORTCUT_REFERENCE_GROUPS.NAVIGATION_ORG_SETTINGS,
+ options: { ignoreInputs: true },
+ },
[ORG_SETTINGS_NAV_SHORTCUT_IDS.NAV_ORG_SETTINGS_DOCUMENTS]: {
id: ORG_SETTINGS_NAV_SHORTCUT_IDS.NAV_ORG_SETTINGS_DOCUMENTS,
label: 'Go to Legal documents',
diff --git a/apps/studio/state/shortcuts/registry/org-shortcuts.test.ts b/apps/studio/state/shortcuts/registry/org-shortcuts.test.ts
index ca9e04f0486..5bda3061fc5 100644
--- a/apps/studio/state/shortcuts/registry/org-shortcuts.test.ts
+++ b/apps/studio/state/shortcuts/registry/org-shortcuts.test.ts
@@ -12,6 +12,7 @@ describe('Org settings nav shortcuts', () => {
SHORTCUT_IDS.NAV_ORG_SETTINGS_PRIVATE_APPS,
SHORTCUT_IDS.NAV_ORG_SETTINGS_WEBHOOKS,
SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT,
+ SHORTCUT_IDS.NAV_ORG_SETTINGS_AUDIT_LOG_DRAINS,
SHORTCUT_IDS.NAV_ORG_SETTINGS_DOCUMENTS,
]