The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
Add log configuration in database settings (#47212)
Joshen Lim0044bb8e4fd7
diff --git a/apps/studio/components/interfaces/Settings/Database/ConnectionLogging.tsx b/apps/studio/components/interfaces/Settings/Database/ConnectionLogging.tsxnew file mode 100644index 00000000000..cf30774357b--- /dev/null+++ b/apps/studio/components/interfaces/Settings/Database/ConnectionLogging.tsx@@ -0,0 +1,164 @@+import { zodResolver } from '@hookform/resolvers/zod'+import { PermissionAction } from '@supabase/shared-types/out/constants'+import { useQuery } from '@tanstack/react-query'+import { useParams } from 'common'+import { useEffect, useMemo } from 'react'+import { SubmitHandler, useForm } from 'react-hook-form'+import { toast } from 'sonner'+import { Button, Card, CardContent, CardFooter, Form, FormControl, FormField, Switch } from 'ui'+import {+ PageSection,+ PageSectionAside,+ PageSectionContent,+ PageSectionMeta,+ PageSectionSummary,+ PageSectionTitle,+} from 'ui-patterns'+import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'+import z from 'zod'++import AlertError from '@/components/ui/AlertError'+import { ButtonTooltip } from '@/components/ui/ButtonTooltip'+import { DocsButton } from '@/components/ui/DocsButton'+import { usePostgresConfigurationUpdateMutation } from '@/data/config/postgres-config-mutation'+import { postgresConfigurationQueryOptions } from '@/data/config/postgres-config-query'+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'+import { DOCS_URL } from '@/lib/constants'++const FormSchema = z.object({+ log_connections: z.boolean(),+ log_disconnections: z.boolean(),+})++export const ConnectionLogging = () => {+ const { ref: projectRef } = useParams()+ const { data: project } = useSelectedProjectQuery()+ const { can: canUpdatePostgresConfiguration } = useAsyncCheckPermissions(+ PermissionAction.UPDATE,+ 'projects',+ { resource: { project_id: project?.id } }+ )++ const {+ data: postgresConfig,+ error,+ isSuccess,+ isError,+ } = useQuery(postgresConfigurationQueryOptions({ projectRef }))++ const { mutate: updatePostgresConfig, isPending: isSaving } =+ usePostgresConfigurationUpdateMutation({+ onSuccess: () => toast('Successfully updated logging settings'),+ })++ const defaultValues = useMemo(+ () => ({+ log_connections: postgresConfig?.log_connections ?? false,+ log_disconnections: postgresConfig?.log_disconnections ?? false,+ }),+ [postgresConfig]+ )++ const form = useForm<z.infer<typeof FormSchema>>({+ resolver: zodResolver(FormSchema),+ values: defaultValues,+ })+ const hasChanges = form.formState.isDirty++ const onSubmit: SubmitHandler<z.infer<typeof FormSchema>> = (payload) => {+ if (!projectRef) return+ updatePostgresConfig({ projectRef, payload })+ }++ useEffect(() => {+ if (isSuccess) form.reset(defaultValues)+ }, [isSuccess, defaultValues, form])++ return (+ <PageSection id="log-connections">+ <PageSectionMeta>+ <PageSectionSummary>+ <PageSectionTitle>Connection logging</PageSectionTitle>+ </PageSectionSummary>+ <PageSectionAside className="flex items-center gap-x-2">+ <DocsButton href={`${DOCS_URL}/guides/platform/postgres-connection-logging`} />+ </PageSectionAside>+ </PageSectionMeta>+ <PageSectionContent>+ {isError ? (+ <AlertError error={error} subject="Failed to retrieve Postgres configuration" />+ ) : (+ <Form {...form}>+ <form onSubmit={form.handleSubmit(onSubmit)}>+ <Card>+ <CardContent>+ <FormField+ control={form.control}+ name="log_connections"+ render={({ field }) => (+ <FormItemLayout+ layout="flex-row-reverse"+ label="Log connections"+ description="Enables logging for each successful connection to the database"+ className="[&>div:first-child]:xl:w-1/5"+ >+ <FormControl>+ <Switch checked={field.value} onCheckedChange={field.onChange} />+ </FormControl>+ </FormItemLayout>+ )}+ />+ </CardContent>+ <CardContent>+ <FormField+ control={form.control}+ name="log_disconnections"+ render={({ field }) => (+ <FormItemLayout+ layout="flex-row-reverse"+ label="Log disconnections"+ description="Enables logging for the end of each session, including its duration"+ className="[&>div:first-child]:xl:w-1/5"+ >+ <FormControl>+ <Switch checked={field.value} onCheckedChange={field.onChange} />+ </FormControl>+ </FormItemLayout>+ )}+ />+ </CardContent>+ <CardFooter className="gap-x-2 justify-end">+ <Button+ type="button"+ variant="default"+ disabled={!hasChanges || isSaving}+ onClick={() => form.reset(defaultValues)}+ >+ Cancel+ </Button>+ <ButtonTooltip+ type="submit"+ variant="primary"+ loading={isSaving}+ disabled={!hasChanges || !canUpdatePostgresConfiguration}+ tooltip={{+ content: {+ side: 'bottom',+ text: !canUpdatePostgresConfiguration+ ? 'You need additional permissions to update this setting'+ : undefined,+ },+ }}+ >+ Save+ </ButtonTooltip>+ </CardFooter>+ </Card>+ </form>+ </Form>+ )}+ </PageSectionContent>+ </PageSection>+ )+}diff --git a/apps/studio/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword.tsx b/apps/studio/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword.tsxindex f31820fbb2a..79de0684859 100644--- a/apps/studio/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword.tsx+++ b/apps/studio/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword.tsx@@ -10,7 +10,7 @@ import {import { ResetDbPasswordDialog } from './ResetDbPasswordDialog'-const ResetDbPassword = ({ disabled = false }) => {+export const ResetDbPassword = ({ disabled = false }) => {return (<PageSection id="database-password"><PageSectionMeta>diff --git a/apps/studio/data/config/keys.ts b/apps/studio/data/config/keys.tsindex 1a01c675641..f72e9876f05 100644--- a/apps/studio/data/config/keys.ts+++ b/apps/studio/data/config/keys.ts@@ -27,4 +27,6 @@ export const configKeys = {diskAutoscaleConfig: (projectRef: string | undefined) =>['projects', projectRef, 'disk-autoscale-config'] as const,deploymentMode: () => ['deployment-mode'] as const,+ postgresConfig: (projectRef: string | undefined) =>+ ['projects', projectRef, 'postgres-config'] as const,}diff --git a/apps/studio/data/config/postgres-config-mutation.ts b/apps/studio/data/config/postgres-config-mutation.tsnew file mode 100644index 00000000000..a8769bc870d--- /dev/null+++ b/apps/studio/data/config/postgres-config-mutation.ts@@ -0,0 +1,67 @@+import { useMutation, useQueryClient } from '@tanstack/react-query'+import { toast } from 'sonner'++import { configKeys } from './keys'+import { handleError, put } from '@/data/fetchers'+import type { ResponseError, UseCustomMutationOptions } from '@/types'++export type PostgresConfigurationUpdateVariables = {+ projectRef: string+ payload: {+ log_connections: boolean+ log_disconnections: boolean+ }+}++export async function updatePostgresConfiguration({+ projectRef,+ payload,+}: PostgresConfigurationUpdateVariables) {+ const { data, error } = await put('/v1/projects/{ref}/config/database/postgres', {+ params: { path: { ref: projectRef } },+ body: payload,+ })++ if (error) handleError(error)+ return data+}++type PostgresConfigurationUpdateData = Awaited<ReturnType<typeof updatePostgresConfiguration>>++export const usePostgresConfigurationUpdateMutation = ({+ onSuccess,+ onError,+ ...options+}: Omit<+ UseCustomMutationOptions<+ PostgresConfigurationUpdateData,+ ResponseError,+ PostgresConfigurationUpdateVariables+ >,+ 'mutationFn'+> = {}) => {+ const queryClient = useQueryClient()++ return useMutation<+ PostgresConfigurationUpdateData,+ ResponseError,+ PostgresConfigurationUpdateVariables+ >({+ mutationFn: (vars) => updatePostgresConfiguration(vars),+ async onSuccess(data, variables, context) {+ const { projectRef } = variables+ await queryClient.invalidateQueries({+ queryKey: configKeys.postgresConfig(projectRef),+ })+ await onSuccess?.(data, variables, context)+ },+ async onError(data, variables, context) {+ if (onError === undefined) {+ toast.error(`Failed to update postgres configuration: ${data.message}`)+ } else {+ onError(data, variables, context)+ }+ },+ ...options,+ })+}diff --git a/apps/studio/data/config/postgres-config-query.ts b/apps/studio/data/config/postgres-config-query.tsnew file mode 100644index 00000000000..67d861f4dfc--- /dev/null+++ b/apps/studio/data/config/postgres-config-query.ts@@ -0,0 +1,38 @@+import { queryOptions } from '@tanstack/react-query'++import { configKeys } from './keys'+import { get, handleError } from '@/data/fetchers'+import type { ResponseError } from '@/types'++export type PostgresConfigurationVariables = {+ projectRef?: string+}++export async function getPostgresConfiguration(+ { projectRef }: PostgresConfigurationVariables,+ signal?: AbortSignal+) {+ if (!projectRef) throw new Error('Project ref is required')++ const { data, error } = await get('/v1/projects/{ref}/config/database/postgres', {+ params: { path: { ref: projectRef } },+ signal,+ })++ if (error) handleError(error)+ return data+}++export type PostgresConfigurationData = Awaited<ReturnType<typeof getPostgresConfiguration>>+export type PostgresConfigurationError = ResponseError++export const postgresConfigurationQueryOptions = (+ { projectRef }: PostgresConfigurationVariables,+ { enabled = true }: { enabled?: boolean } = { enabled: true }+) => {+ return queryOptions({+ queryKey: configKeys.postgresConfig(projectRef),+ queryFn: ({ signal }) => getPostgresConfiguration({ projectRef }, signal),+ enabled: enabled && typeof projectRef !== 'undefined',+ })+}diff --git a/apps/studio/pages/project/[ref]/database/settings.tsx b/apps/studio/pages/project/[ref]/database/settings.tsxindex 303c9d3539f..2a99513ac6f 100644--- a/apps/studio/pages/project/[ref]/database/settings.tsx+++ b/apps/studio/pages/project/[ref]/database/settings.tsx@@ -1,3 +1,4 @@+import { useFlag } from 'common'import { PageContainer } from 'ui-patterns/PageContainer'import {PageHeader,@@ -11,9 +12,10 @@ import { PageSection, PageSectionContent } from 'ui-patterns/PageSection'import { useIsJitDbAccessEnabled } from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext'import { DiskManagementPanelForm } from '@/components/interfaces/DiskManagement/DiskManagementPanelForm'import { BannedIPs } from '@/components/interfaces/Settings/Database/BannedIPs'+import { ConnectionLogging } from '@/components/interfaces/Settings/Database/ConnectionLogging'import { ConnectionPooling } from '@/components/interfaces/Settings/Database/ConnectionPooling/ConnectionPooling'import { DatabaseReadOnlyAlert } from '@/components/interfaces/Settings/Database/DatabaseReadOnlyAlert'-import ResetDbPassword from '@/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword'+import { ResetDbPassword } from '@/components/interfaces/Settings/Database/DatabaseSettings/ResetDbPassword'import { DiskSizeConfiguration } from '@/components/interfaces/Settings/Database/DiskSizeConfiguration'import { JitDbAccessConfiguration } from '@/components/interfaces/Settings/Database/JitDatabaseAccess/JitDbAccessConfiguration'import { NetworkRestrictions } from '@/components/interfaces/Settings/Database/NetworkRestrictions/NetworkRestrictions'@@ -21,7 +23,7 @@ import { PoolingModesModal } from '@/components/interfaces/Settings/Database/Pooimport { SettingsDatabaseEmptyStateLocal } from '@/components/interfaces/Settings/Database/SettingsDatabaseEmptyStateLocal'import { SSLConfiguration } from '@/components/interfaces/Settings/Database/SSLConfiguration'import DatabaseLayout from '@/components/layouts/DatabaseLayout/DatabaseLayout'-import DefaultLayout from '@/components/layouts/DefaultLayout'+import { DefaultLayout } from '@/components/layouts/DefaultLayout'import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'import { useIsAwsCloudProvider, useIsAwsK8sCloudProvider } from '@/hooks/misc/useSelectedProject'import { IS_PLATFORM } from '@/lib/constants'@@ -33,6 +35,7 @@ const DatabaseSettings: NextPageWithLayout = () => {const jitDbAccessEnabled = useIsJitDbAccessEnabled()const showNewDiskManagementUI = isAws || isAwsK8sconst { databaseNetworkRestrictions } = useIsFeatureEnabled(['database:network_restrictions'])+ const databaseLogsConfigurationEnabled = useFlag('databaseLogsConfiguration')return (<>@@ -61,6 +64,7 @@ const DatabaseSettings: NextPageWithLayout = () => {<DiskSizeConfiguration />)}{databaseNetworkRestrictions && <NetworkRestrictions />}+ {databaseLogsConfigurationEnabled && <ConnectionLogging />}<BannedIPs /></PageContainer><PoolingModesModal />