Skip to content

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

query perf improvements FE-2223 (#42026)

Jordi Enricd982417830ae
diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
index a1208c6673d..9cf6198bc35 100644
--- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
+++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceFilterBar.tsx
@@ -1,11 +1,11 @@
import { parseAsArrayOf, parseAsJson, parseAsString, useQueryStates } from 'nuqs'
import { ReactNode, useEffect, useState } from 'react'
-
import {
NumericFilter,
ReportsNumericFilter,
} from 'components/interfaces/Reports/v2/ReportsNumericFilter'
import { FilterInput } from './components/FilterInput'
+import { FilterPill } from './components/FilterPill'
import { IndexAdvisorFilter } from './components/IndexAdvisorFilter'
import { RolesFilterDropdown } from './components/RolesFilterDropdown'
import { SortIndicator } from './components/SortIndicator'
@@ -24,18 +24,29 @@ export const QueryPerformanceFilterBar = ({
const { isIndexAdvisorEnabled } = useIndexAdvisorStatus()
const [
- { search: searchQuery, roles: defaultFilterRoles, callsFilter, indexAdvisor },
+ {
+ search: searchQuery,
+ roles: defaultFilterRoles,
+ callsFilter: callsFilterRaw,
+ totalTimeFilter: totalTimeFilterRaw,
+ indexAdvisor,
+ },
setSearchParams,
] = useQueryStates({
search: parseAsString.withDefault(''),
roles: parseAsArrayOf(parseAsString).withDefault([]),
- callsFilter: parseAsJson((value) => value as NumericFilter | null).withDefault({
- operator: '>=',
- value: 0,
- } as NumericFilter),
+ callsFilter: parseAsJson<NumericFilter | null>((value) =>
+ value === null || value === undefined ? null : (value as NumericFilter)
+ ),
+ totalTimeFilter: parseAsJson<NumericFilter | null>((value) =>
+ value === null || value === undefined ? null : (value as NumericFilter)
+ ),
indexAdvisor: parseAsString.withDefault('false'),
})
+ const callsFilter = callsFilterRaw ?? null
+ const totalTimeFilter = totalTimeFilterRaw ?? null
+
const [filters, setFilters] = useState<{ roles: string[] }>({
roles: defaultFilterRoles,
})
@@ -61,30 +72,84 @@ export const QueryPerformanceFilterBar = ({
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [debouncedInputValue])
+ const getCallsFilterDisplay = () => {
+ if (!callsFilter) return null
+ return `${callsFilter.operator} ${callsFilter.value}`
+ }
+
+ const getTotalTimeFilterDisplay = () => {
+ if (!totalTimeFilter) return null
+ return `${totalTimeFilter.operator} ${totalTimeFilter.value}`
+ }
+
return (
<div className="px-4 py-1.5 bg-surface-200 border-t -mt-px flex justify-between items-center overflow-x-auto overflow-y-hidden w-full flex-shrink-0">
<div className="flex items-center gap-x-4">
<div className="flex items-center gap-x-2">
<FilterInput value={inputValue} onChange={setInputValue} />
- <ReportsNumericFilter
- label="Calls"
- value={callsFilter}
- onChange={(value) => setSearchParams({ callsFilter: value })}
- operators={['=', '>=', '<=', '>', '<', '!=']}
- defaultOperator=">="
- placeholder="e.g. 100"
- min={0}
- className="w-auto"
- />
-
- {showRolesFilter && (
- <RolesFilterDropdown
- activeOptions={filters.roles}
- onSaveFilters={onFilterRolesChange}
+ {callsFilter ? (
+ <FilterPill
+ label="Calls"
+ value={getCallsFilterDisplay() || ''}
+ onClear={(e) => {
+ e.stopPropagation()
+ setSearchParams({ callsFilter: null })
+ }}
+ />
+ ) : (
+ <ReportsNumericFilter
+ label="Calls"
+ value={callsFilter}
+ onChange={(value) => setSearchParams({ callsFilter: value })}
+ operators={['=', '>=', '<=', '>', '<', '!=']}
+ defaultOperator=">="
+ placeholder="e.g. 100"
+ min={0}
+ className="w-auto"
+ />
+ )}
+
+ {totalTimeFilter ? (
+ <FilterPill
+ label="Total Time"
+ value={getTotalTimeFilterDisplay() || ''}
+ onClear={(e) => {
+ e.stopPropagation()
+ setSearchParams({ totalTimeFilter: null })
+ }}
+ />
+ ) : (
+ <ReportsNumericFilter
+ label="Total Time"
+ value={totalTimeFilter}
+ onChange={(value) => setSearchParams({ totalTimeFilter: value })}
+ operators={['=', '>=', '<=', '>', '<', '!=']}
+ defaultOperator=">"
+ placeholder="e.g. 1000"
+ min={0}
+ className="w-auto"
/>
)}
+ {showRolesFilter &&
+ (filters.roles && filters.roles.length > 0 ? (
+ <FilterPill
+ label="Roles"
+ value={filters.roles.join(', ')}
+ onClear={(e) => {
+ e.stopPropagation()
+ setFilters({ roles: [] })
+ setSearchParams({ roles: [] })
+ }}
+ />
+ ) : (
+ <RolesFilterDropdown
+ activeOptions={filters.roles}
+ onSaveFilters={onFilterRolesChange}
+ />
+ ))}
+
{isIndexAdvisorEnabled && (
<IndexAdvisorFilter
isActive={indexAdvisor === 'true'}
diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceMetrics.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceMetrics.tsx
index e6c5a6a5f4c..de6e087098f 100644
--- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceMetrics.tsx
+++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceMetrics.tsx
@@ -1,41 +1,111 @@
import React, { useMemo } from 'react'
+import { parseAsJson, useQueryStates } from 'nuqs'
+import { Info } from 'lucide-react'
-import { Skeleton } from 'ui'
+import { Skeleton, cn, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
import { useQueryPerformanceQuery } from '../Reports/Reports.queries'
+import { NumericFilter } from 'components/interfaces/Reports/v2/ReportsNumericFilter'
export const QueryPerformanceMetrics = () => {
const { data: queryMetrics, isLoading } = useQueryPerformanceQuery({
preset: 'queryMetrics',
})
+ const [, setSearchParams] = useQueryStates({
+ totalTimeFilter: parseAsJson<NumericFilter | null>((value) =>
+ value === null || value === undefined ? null : (value as NumericFilter)
+ ),
+ })
+
const stats = useMemo(() => {
+ const slowQueriesTitle = queryMetrics?.[0]?.slow_queries === 1 ? 'Slow Query' : 'Slow Queries'
+ const slowQueriesValue = queryMetrics?.[0]?.slow_queries || '0'
+
return [
{
- title: queryMetrics?.[0]?.slow_queries === 1 ? 'Slow Query' : 'Slow Queries',
- value: queryMetrics?.[0]?.slow_queries || '0',
+ title: slowQueriesTitle,
+ value: slowQueriesValue,
+ onClick: () => {
+ setSearchParams({
+ totalTimeFilter: {
+ operator: '>',
+ value: 1000,
+ } as NumericFilter,
+ })
+ },
},
{
title: 'Cache Hit Rate',
value: queryMetrics?.[0]?.cache_hit_rate || '0%',
+ tooltip:
+ 'Percentage of data read from cache vs disk. Higher is better - it means faster queries and less database load.',
},
{
title: 'Avg. Rows Per Call',
value: queryMetrics?.[0]?.avg_rows_per_call || '0',
+ tooltip:
+ 'Average number of rows returned per query execution. Helps identify queries that return too much or too little data.',
},
]
- }, [queryMetrics])
+ }, [queryMetrics, setSearchParams])
return (
<section className="px-6 pt-2 pb-4 flex flex-wrap gap-x-6 gap-y-2 w-full">
{stats.map((card, i) => (
<React.Fragment key={i}>
- <div className="flex items-baseline gap-2 heading-subSection text-foreground-light">
+ <div
+ className={cn('flex items-baseline gap-2 heading-subSection text-foreground-light', {
+ 'cursor-pointer hover:text-foreground transition-colors': card.onClick,
+ })}
+ onClick={card.onClick}
+ >
{isLoading ? (
<Skeleton className="h-5 w-24" />
) : (
<>
<span className="text-foreground">{card.value}</span>
- <span>{card.title}</span>
+ <span className="flex items-center gap-1">
+ {card.title}
+ {(card.title === 'Slow Queries' || card.title === 'Slow Query') && (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <button
+ type="button"
+ aria-label="How are slow queries calculated?"
+ className="inline-flex h-4 w-4 items-center justify-center rounded-full bg-surface-200 text-foreground-lighter transition-colors hover:bg-surface-300 hover:text-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-offset-1 focus-visible:ring-foreground-lighter"
+ onClick={(e) => {
+ e.stopPropagation()
+ }}
+ >
+ <Info size={12} />
+ </button>
+ </TooltipTrigger>
+ <TooltipContent side="top" align="start" className="max-w-xs text-xs">
+ Slow queries are those with total execution time (execution time + planning
+ time) greater than 1000ms.
+ </TooltipContent>
+ </Tooltip>
+ )}
+ {card.tooltip && (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <button
+ type="button"
+ aria-label={`What is ${card.title}?`}
+ className="inline-flex h-4 w-4 items-center justify-center rounded-full bg-surface-200 text-foreground-lighter transition-colors hover:bg-surface-300 hover:text-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-offset-1 focus-visible:ring-foreground-lighter"
+ onClick={(e) => {
+ e.stopPropagation()
+ }}
+ >
+ <Info size={12} />
+ </button>
+ </TooltipTrigger>
+ <TooltipContent side="top" align="start" className="max-w-xs text-xs">
+ {card.tooltip}
+ </TooltipContent>
+ </Tooltip>
+ )}
+ </span>
</>
)}
</div>
diff --git a/apps/studio/components/interfaces/QueryPerformance/components/FilterPill.tsx b/apps/studio/components/interfaces/QueryPerformance/components/FilterPill.tsx
new file mode 100644
index 00000000000..65df7af6b0f
--- /dev/null
+++ b/apps/studio/components/interfaces/QueryPerformance/components/FilterPill.tsx
@@ -0,0 +1,30 @@
+import { X } from 'lucide-react'
+
+import { Tooltip, TooltipContent, TooltipTrigger } from 'ui'
+
+interface FilterPillProps {
+ label: string
+ value: string
+ onClear: (e: React.MouseEvent) => void
+}
+
+export const FilterPill = ({ label, value, onClear }: FilterPillProps) => {
+ return (
+ <div className="text-xs border rounded-md px-1.5 md:px-2.5 py-1 h-[26px] flex items-center gap-x-2">
+ <p className="md:inline-flex gap-x-1 hidden truncate">
+ {label}: <span className="text-foreground-lighter">{value}</span>
+ </p>
+ <Tooltip>
+ <TooltipTrigger
+ onClick={(e) => {
+ e.stopPropagation()
+ onClear(e)
+ }}
+ >
+ <X size={14} className="text-foreground-light hover:text-foreground" />
+ </TooltipTrigger>
+ <TooltipContent side="bottom">Clear {label.toLowerCase()} filter</TooltipContent>
+ </Tooltip>
+ </div>
+ )
+}
diff --git a/apps/studio/components/interfaces/Reports/Reports.queries.ts b/apps/studio/components/interfaces/Reports/Reports.queries.ts
index cdfbcaf8cf1..5f2a5216c89 100644
--- a/apps/studio/components/interfaces/Reports/Reports.queries.ts
+++ b/apps/studio/components/interfaces/Reports/Reports.queries.ts
@@ -30,6 +30,7 @@ export type QueryPerformanceQueryOpts = {
roles?: string[]
runIndexAdvisor?: boolean
minCalls?: number
+ minTotalTime?: number
filterIndexAdvisor?: boolean
}
@@ -40,6 +41,7 @@ export const useQueryPerformanceQuery = ({
roles,
runIndexAdvisor = false,
minCalls,
+ minTotalTime,
filterIndexAdvisor = false,
}: QueryPerformanceQueryOpts) => {
const queryPerfQueries = PRESET_CONFIG[Presets.QUERY_PERFORMANCE]
@@ -51,6 +53,9 @@ export const useQueryPerformanceQuery = ({
: '',
searchQuery.length > 0 ? `statements.query ~* '${searchQuery}'` : '',
typeof minCalls === 'number' && minCalls > 0 ? `statements.calls >= ${minCalls}` : '',
+ typeof minTotalTime === 'number' && minTotalTime > 0
+ ? `(statements.total_exec_time + statements.total_plan_time) >= ${minTotalTime}`
+ : '',
]
.filter((x) => x.length > 0)
.join(' AND ')
diff --git a/apps/studio/pages/project/[ref]/observability/query-performance.tsx b/apps/studio/pages/project/[ref]/observability/query-performance.tsx
index 95d3a690753..e51dec02a3a 100644
--- a/apps/studio/pages/project/[ref]/observability/query-performance.tsx
+++ b/apps/studio/pages/project/[ref]/observability/query-performance.tsx
@@ -1,4 +1,5 @@
-import { parseAsArrayOf, parseAsInteger, parseAsString, useQueryStates } from 'nuqs'
+import { parseAsArrayOf, parseAsInteger, parseAsJson, parseAsString, useQueryStates } from 'nuqs'
+import { NumericFilter } from 'components/interfaces/Reports/v2/ReportsNumericFilter'
import { useParams } from 'common'
import { useIndexAdvisorStatus } from 'components/interfaces/QueryPerformance/hooks/useIsIndexAdvisorStatus'
@@ -36,20 +37,34 @@ const QueryPerformanceReport: NextPageWithLayout = () => {
handleDatePickerChange,
} = useReportDateRange(REPORT_DATERANGE_HELPER_LABELS.LAST_60_MINUTES)
- const [{ search: searchQuery, roles, minCalls, indexAdvisor }] = useQueryStates({
+ const [
+ { search: searchQuery, roles, minCalls, totalTimeFilter: totalTimeFilterRaw, indexAdvisor },
+ ] = useQueryStates({
sort: parseAsString,
order: parseAsString,
search: parseAsString.withDefault(''),
roles: parseAsArrayOf(parseAsString).withDefault([]),
minCalls: parseAsInteger,
+ totalTimeFilter: parseAsJson<NumericFilter | null>((value) =>
+ value === null || value === undefined ? null : (value as NumericFilter)
+ ),
indexAdvisor: parseAsString.withDefault('false'),
})
+ const totalTimeFilter = totalTimeFilterRaw ?? null
+
const config = PRESET_CONFIG[Presets.QUERY_PERFORMANCE]
const hooks = queriesFactory(config.queries, ref ?? 'default')
const queryHitRate = hooks.queryHitRate()
const queryMetrics = hooks.queryMetrics()
+ const minTotalTime =
+ totalTimeFilter && totalTimeFilter.operator === '>'
+ ? totalTimeFilter.value
+ : totalTimeFilter && totalTimeFilter.operator === '>='
+ ? totalTimeFilter.value
+ : undefined
+
const queryPerformanceQuery = useQueryPerformanceQuery({
searchQuery,
orderBy: sortConfig || undefined,
@@ -57,6 +72,7 @@ const QueryPerformanceReport: NextPageWithLayout = () => {
roles,
runIndexAdvisor: isIndexAdvisorEnabled,
minCalls: minCalls ?? undefined,
+ minTotalTime,
filterIndexAdvisor: indexAdvisor === 'true',
})