Skip to content

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

fix(studio): clarify disk IO balance FDBKPRI-2885 (#51943)

Jordi Enric4825c6d9f571
diff --git a/apps/docs/content/guides/platform/compute-and-disk.mdx b/apps/docs/content/guides/platform/compute-and-disk.mdx
index 66c8694561a..ba5284349cf 100644
--- a/apps/docs/content/guides/platform/compute-and-disk.mdx
+++ b/apps/docs/content/guides/platform/compute-and-disk.mdx
@@ -98,7 +98,9 @@ Larger compute instances (4XL and above) are designed for sustained, high perfor
### Choosing the right compute instance for consistent disk performance
-If you need consistent disk performance, choose the 4XL or larger compute instance. If you're unsure of how much throughput or IOPS your application requires, you can load test your project and inspect these [metrics in the Dashboard](/dashboard/project/_/observability). If the `Disk IO % consumed` stat is more than 1%, it indicates that your workload has exceeded the baseline IO throughput during the day. If this metric goes to 100%, the workload has used up all available disk IO budget. Projects that use any disk IO budget are good candidates for upgrading to a larger compute instance with higher throughput.
+If you need consistent disk performance, choose the 4XL or larger compute instance. If you're unsure how much throughput or IOPS your application requires, load test your project and inspect **Disk IO balance** in [Observability](/dashboard/project/_/observability). The metric uses the lower remaining balance of throughput and IOPS. A value of 100% means the balance is full, and 0% means it is exhausted.
+
+Observability shows the average balance for the selected time window, so it can hide periods when the balance was exhausted. To see the lowest sampled balance over the last seven days and its chart, open [Infrastructure settings](/dashboard/project/_/settings/infrastructure). Projects that use disk IO budget are good candidates for upgrading to a larger compute instance with higher throughput.
### Provisioned disk throughput and IOPS
diff --git a/apps/docs/content/troubleshooting/exhaust-disk-io.mdx b/apps/docs/content/troubleshooting/exhaust-disk-io.mdx
index 31613c87049..afa3db92e6f 100644
--- a/apps/docs/content/troubleshooting/exhaust-disk-io.mdx
+++ b/apps/docs/content/troubleshooting/exhaust-disk-io.mdx
@@ -23,7 +23,7 @@ Running out of Disk IO Budget means that your instance is using more disk than i
## Monitor your disk IO budget
-To check your Disk IO Budget on the Supabase Platform, head over to [Database Health in the Observability section](/dashboard/project/_/observability/database).
+To monitor **Disk IO balance**, open the [Observability overview](/dashboard/project/_/observability). The metric shows the average remaining burst balance for the selected time window, using the lower of throughput and IOPS balances. A value of 100% means the balance is full, and 0% means it is exhausted. An average above 0% does not rule out exhaustion during part of the window. For the lowest sampled balance over the last seven days and its chart, open [Infrastructure settings](/dashboard/project/_/settings/infrastructure).
It is also possible to monitor your resources and set up alerts using Prometheus/Grafana. With Grafana you will be able to pinpoint potential causes and see more fine-grained metrics like how much of your RAM is used for caching and your Swap usage. Read the [Metrics Guide](/docs/guides/observability/metrics) to learn more.
diff --git a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.test.tsx b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.test.tsx
index c66f7bfcada..a3bd50ba8ee 100644
--- a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.test.tsx
+++ b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.test.tsx
@@ -1,276 +1,142 @@
-import { render, screen } from '@testing-library/react'
-import type { ReactNode } from 'react'
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { QueryClient } from '@tanstack/react-query'
+import { act, screen } from '@testing-library/react'
+import { HttpResponse } from 'msw'
+import { afterEach, describe, expect, it, vi } from 'vitest'
import { ComputeAndDiskUsageCharts } from './ComputeAndDiskUsageCharts'
import type { InfraMonitoringMultiResponse } from '@/data/analytics/infra-monitoring-query'
-
-const { mockGetInfraMonitoringAttributes, mockUseInfraMonitoringAttributesQuery, mockUseProject } =
- vi.hoisted(() => ({
- mockGetInfraMonitoringAttributes: vi.fn(),
- mockUseInfraMonitoringAttributesQuery: vi.fn(),
- mockUseProject: vi.fn(),
- }))
-
-vi.mock('common', () => ({
- useParams: () => ({ ref: 'project-ref' }),
-}))
-
-vi.mock('ui', () => ({
- cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
-}))
-
-vi.mock('ui-patterns/Chart', async () => {
- const React = await vi.importActual<typeof import('react')>('react')
- const ChartStateContext = React.createContext({ isLoading: false, isErrored: false })
-
- return {
- Chart: ({
- children,
- isLoading,
- isErrored,
- }: {
- children: ReactNode
- isLoading: boolean
- isErrored: boolean
- }) => (
- <ChartStateContext.Provider value={{ isLoading, isErrored }}>
- {children}
- </ChartStateContext.Provider>
- ),
- ChartCard: ({ children, className }: { children: ReactNode; className?: string }) => (
- <div className={className}>{children}</div>
- ),
- ChartContent: ({
- children,
- isEmpty,
- loadingState,
- errorState,
- emptyState,
- }: {
- children: ReactNode
- isEmpty: boolean
- loadingState: ReactNode
- errorState: ReactNode
- emptyState: ReactNode
- }) => {
- const { isLoading, isErrored } = React.useContext(ChartStateContext)
-
- if (isLoading) return loadingState
- if (isErrored) return errorState
- if (isEmpty) return emptyState
- return children
+import { analyticsKeys } from '@/data/analytics/keys'
+import { projectKeys } from '@/data/projects/keys'
+import { customRender } from '@/tests/lib/custom-render'
+import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
+
+function renderUsage(
+ balances: Array<string | undefined>,
+ computeSize = 'micro',
+ options: { hasError?: boolean; responseReady?: Promise<void> } = {}
+) {
+ const windows: Array<{ startDate: string | null; endDate: string | null }> = []
+ addAPIMock({
+ method: 'get',
+ path: '/platform/projects/:ref/infra-monitoring',
+ response: async ({ request }) => {
+ await options.responseReady
+ if (options.hasError) {
+ return HttpResponse.json<APIErrorBody>({ message: 'Usage unavailable' }, { status: 500 })
+ }
+ const params = new URL(request.url).searchParams
+ windows.push({ startDate: params.get('startDate'), endDate: params.get('endDate') })
+ const attributes = new URL(request.url).searchParams.get('attributes')?.split(',') ?? []
+ const data = balances.map((balance, index) => ({
+ period_start: `2026-10-${10 + index}T00:00:00.000Z`,
+ values: {
+ max_cpu_usage: '40',
+ ram_usage: '60',
+ disk_io_budget: attributes.includes('disk_io_budget') ? balance : undefined,
+ disk_io_consumption: balance === undefined ? undefined : String(100 - Number(balance)),
+ pg_database_size: '40',
+ disk_fs_used_wal: '5',
+ disk_fs_used_system: '5',
+ disk_fs_size: '100',
+ },
+ }))
+ return HttpResponse.json<InfraMonitoringMultiResponse>({ series: {}, data })
},
- ChartEmptyState: ({ title, description }: { title: string; description?: string }) => (
- <div>
- <span>{title}</span>
- {description && <span>{description}</span>}
- </div>
- ),
- ChartHeader: ({ children }: { children: ReactNode }) => <div>{children}</div>,
- ChartLine: ({ dataKey, dataKeys }: { dataKey: string; dataKeys: string[] }) => (
- <div data-testid={`chart-line-${dataKey}`} data-keys={dataKeys.join(',')} />
- ),
- ChartLoadingState: () => <div>Loading chart</div>,
- ChartMetric: ({
- label,
- value,
- status,
- tooltip,
- }: {
- label: string
- value: ReactNode
- status?: string
- tooltip?: ReactNode
- }) => (
- <div
- data-testid={`metric-${label}`}
- data-status={status}
- data-has-tooltip={tooltip !== undefined}
- >
- {label}: {value}
- </div>
- ),
- }
-})
-
-vi.mock('@/data/analytics/infra-monitoring-query', () => ({
- getInfraMonitoringAttributes: mockGetInfraMonitoringAttributes,
- useInfraMonitoringAttributesQuery: mockUseInfraMonitoringAttributesQuery,
-}))
-
-vi.mock('@/hooks/misc/useSelectedProject', () => ({
- useSelectedProjectQuery: mockUseProject,
-}))
-
-vi.mock('@/lib/helpers', () => ({
- formatBytes: (bytes: number) => `${bytes} bytes`,
-}))
+ })
+ const queryClient = new QueryClient({
+ defaultOptions: { queries: { retry: false, staleTime: Infinity } },
+ })
+ queryClient.setQueryData(projectKeys.detail('default'), {
+ ref: 'default',
+ status: 'ACTIVE_HEALTHY',
+ infra_compute_size: computeSize,
+ })
-const buildUsageResponse = ({
- cpu = 40,
- memory = 50,
- diskIo = 60,
- database = 40,
- wal = 5,
- system = 5,
- diskSize = 100,
-}: {
- cpu?: number
- memory?: number
- diskIo?: number
- database?: number
- wal?: number
- system?: number
- diskSize?: number
-} = {}): InfraMonitoringMultiResponse => ({
- series: {},
- data: [
- {
- period_start: '2026-07-20T00:00:00.000Z',
- values: {
- max_cpu_usage: String(cpu),
- ram_usage: String(memory),
- disk_io_consumption: String(diskIo),
- pg_database_size: String(database),
- disk_fs_used_wal: String(wal),
- disk_fs_used_system: String(system),
- disk_fs_size: String(diskSize),
- },
- },
- ],
-})
+ const rendered = customRender(<ComputeAndDiskUsageCharts />, { queryClient })
+ return { ...rendered, queryClient, windows }
+}
describe('ComputeAndDiskUsageCharts', () => {
- beforeEach(() => {
- mockUseProject.mockReturnValue({ data: { infra_compute_size: 'micro' } })
- mockUseInfraMonitoringAttributesQuery.mockReturnValue({
- data: buildUsageResponse(),
- isLoading: false,
- isError: false,
- })
- mockGetInfraMonitoringAttributes.mockResolvedValue(buildUsageResponse())
- })
-
afterEach(() => {
vi.useRealTimers()
})
- it('renders warning and critical summaries and all chart data', () => {
- mockUseInfraMonitoringAttributesQuery.mockReturnValue({
- data: buildUsageResponse({
- cpu: 80,
- memory: 91,
- diskIo: 70,
- database: 80,
- wal: 5,
- system: 5,
- }),
- isLoading: false,
- isError: false,
- })
+ it('shows empty states without presenting missing disk metrics as zero', async () => {
+ renderUsage([])
- const { container } = render(<ComputeAndDiskUsageCharts />)
+ expect(await screen.findByText('No compute data')).toBeInTheDocument()
+ expect(screen.getByText('No disk data')).toBeInTheDocument()
+ expect(screen.queryByText('0%')).not.toBeInTheDocument()
+ })
- expect(screen.getByTestId('metric-Compute')).toHaveTextContent('91%')
- expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-status', 'negative')
- expect(screen.getByTestId('metric-CPU')).toHaveAttribute('data-status', 'warning')
- expect(screen.getByTestId('metric-Memory')).toHaveAttribute('data-status', 'negative')
- expect(screen.getByTestId('metric-Disk IO')).toHaveAttribute('data-status', 'default')
- expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-has-tooltip', 'true')
- expect(screen.getByTestId('metric-Disk')).toHaveAttribute('data-has-tooltip', 'true')
- for (const label of ['CPU', 'Memory', 'Disk IO', 'Database', 'WAL', 'System']) {
- expect(screen.getByTestId(`metric-${label}`)).toHaveAttribute('data-has-tooltip', 'false')
- }
- expect(screen.getByTestId('metric-Disk')).toHaveTextContent('90%')
- expect(screen.getByTestId('metric-Disk')).toHaveAttribute('data-status', 'negative')
- expect(screen.getByTestId('chart-line-maxCpuUsage')).toHaveAttribute(
- 'data-keys',
- 'maxCpuUsage,ramUsage,diskIoConsumption'
- )
- expect(container.firstElementChild).toHaveClass(
- 'grid-cols-1',
- '@[680px]:grid-cols-2',
- '@[680px]:items-stretch'
- )
- expect(container.querySelector('#cpu')).toBeInTheDocument()
- expect(container.querySelector('#ram')).toBeInTheDocument()
- expect(container.querySelector('#disk_io')).toBeInTheDocument()
- expect(container.querySelector('#disk')).toBeInTheDocument()
+ it('shows both chart errors when the usage request fails', async () => {
+ renderUsage([], 'micro', { hasError: true })
+
+ expect(await screen.findAllByText('Failed to load usage data')).toHaveLength(2)
})
- it('hides burst-only disk IO and excludes it from status on dedicated-I/O compute', () => {
- mockUseProject.mockReturnValue({ data: { infra_compute_size: '4xlarge' } })
- mockUseInfraMonitoringAttributesQuery.mockReturnValue({
- data: buildUsageResponse({ cpu: 40, memory: 50, diskIo: 95 }),
- isLoading: false,
- isError: false,
- })
+ it('waits for loaded data before showing metrics or empty states', async () => {
+ const { promise: responseReady, resolve } = Promise.withResolvers<void>()
+ renderUsage(['99'], 'micro', { responseReady })
- render(<ComputeAndDiskUsageCharts />)
+ expect(screen.queryByText('99%')).not.toBeInTheDocument()
+ expect(screen.queryByText('No compute data')).not.toBeInTheDocument()
+ expect(screen.queryByText('No disk data')).not.toBeInTheDocument()
+ resolve()
+ expect(await screen.findByText('99%')).toBeInTheDocument()
+ })
- expect(screen.getByTestId('metric-Compute')).toHaveTextContent('50%')
- expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-status', 'default')
- expect(screen.queryByTestId('metric-Disk IO')).not.toBeInTheDocument()
- expect(screen.getByTestId('chart-line-maxCpuUsage')).toHaveAttribute(
- 'data-keys',
- 'maxCpuUsage,ramUsage'
+ it('refreshes the request window after seven days without remounting', async () => {
+ vi.useFakeTimers({ toFake: ['Date'] })
+ vi.setSystemTime(new Date('2026-10-12T12:00:00.000Z'))
+ const { queryClient, windows } = renderUsage(['99'])
+ expect(await screen.findByText('99%')).toBeInTheDocument()
+
+ vi.setSystemTime(new Date('2026-10-19T12:00:00.000Z'))
+ await act(() =>
+ queryClient.refetchQueries({
+ queryKey: analyticsKeys.infraMonitoringGroup('default', {}).slice(0, -1),
+ })
)
- })
- it('renders empty states without presenting missing disk metrics as zero', () => {
- mockUseInfraMonitoringAttributesQuery.mockReturnValue({
- data: undefined,
- isLoading: false,
- isError: false,
- })
+ expect(windows).toEqual([
+ { startDate: '2026-10-05T12:00:00.000Z', endDate: '2026-10-12T12:00:00.000Z' },
+ { startDate: '2026-10-12T12:00:00.000Z', endDate: '2026-10-19T12:00:00.000Z' },
+ ])
+ })
- render(<ComputeAndDiskUsageCharts />)
+ it('displays remaining balance without inflating healthy compute usage', async () => {
+ renderUsage(['99'])
- expect(screen.getByText('No compute data')).toBeInTheDocument()
- expect(screen.getByText('No disk data')).toBeInTheDocument()
- expect(screen.getByTestId('metric-Database')).toHaveTextContent('—')
- expect(screen.getByTestId('metric-WAL')).toHaveTextContent('—')
- expect(screen.getByTestId('metric-System')).toHaveTextContent('—')
+ expect(await screen.findByText('99%')).toBeInTheDocument()
+ expect(screen.getByRole('heading', { name: 'Disk IO balance' })).toBeInTheDocument()
+ expect(screen.getAllByText('60%')).toHaveLength(2)
+ expect(screen.queryByText('1%')).not.toBeInTheDocument()
})
- it.each([
- {
- state: 'loading',
- queryState: { data: undefined, isLoading: true, isError: false },
- expectedText: 'Loading chart',
- },
- {
- state: 'error',
- queryState: { data: undefined, isLoading: false, isError: true },
- expectedText: 'Failed to load usage data',
- },
- ])('renders both $state states', ({ queryState, expectedText }) => {
- mockUseInfraMonitoringAttributesQuery.mockReturnValue(queryState)
+ it('displays the lowest sampled balance and scores its consumed amount', async () => {
+ renderUsage(['99', '5', '90'])
- render(<ComputeAndDiskUsageCharts />)
-
- expect(screen.getAllByText(expectedText)).toHaveLength(2)
+ expect(await screen.findByText('5%')).toBeInTheDocument()
+ expect(screen.getByText('95%')).toBeInTheDocument()
})
- it('uses a fresh rolling seven-day window when the query refetches', async () => {
- vi.useFakeTimers()
- vi.setSystemTime(new Date('2026-07-20T12:00:00.000Z'))
+ it('hides burst balance and excludes it from compute usage on dedicated IO compute', async () => {
+ renderUsage(['5'], '4xlarge')
- render(<ComputeAndDiskUsageCharts />)
+ expect(await screen.findByText('40%')).toBeInTheDocument()
+ expect(screen.queryByRole('heading', { name: 'Disk IO balance' })).not.toBeInTheDocument()
+ expect(screen.getAllByText('60%')).toHaveLength(2)
+ expect(screen.queryByText('95%')).not.toBeInTheDocument()
+ })
- const [, options] = mockUseInfraMonitoringAttributesQuery.mock.calls[0]
- vi.setSystemTime(new Date('2026-07-27T12:00:00.000Z'))
- await options.queryFn({ signal: undefined })
+ it('displays missing balance as unavailable without inflating compute usage', async () => {
+ renderUsage([undefined])
- expect(mockGetInfraMonitoringAttributes).toHaveBeenCalledWith(
- expect.objectContaining({
- projectRef: 'project-ref',
- startDate: '2026-07-20T12:00:00.000Z',
- endDate: '2026-07-27T12:00:00.000Z',
- interval: '1d',
- }),
- undefined
- )
+ expect(await screen.findByText('40%')).toBeInTheDocument()
+ expect(screen.getByText('—')).toBeInTheDocument()
+ expect(screen.getAllByText('60%')).toHaveLength(2)
+ expect(screen.queryByText('0%')).not.toBeInTheDocument()
+ expect(screen.queryByText('100%')).not.toBeInTheDocument()
})
})
diff --git a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.tsx b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.tsx
index 74f64c0e5a1..8662b1d8e07 100644
--- a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.tsx
+++ b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.tsx
@@ -35,7 +35,7 @@ import { formatBytes } from '@/lib/helpers'
const USAGE_ATTRIBUTES = [
'max_cpu_usage',
'ram_usage',
- 'disk_io_consumption',
+ 'disk_io_budget',
'disk_fs_used_system',
'disk_fs_used_wal',
'pg_database_size',
@@ -62,8 +62,8 @@ const COMPUTE_CHART_CONFIG = {
label: 'Memory',
color: 'hsl(var(--warning-default))',
},
- diskIoConsumption: {
- label: 'Disk IO',
+ diskIoBalance: {
+ label: 'Disk IO balance',
color: 'hsl(var(--destructive-500))',
},
} satisfies ChartConfig
@@ -140,7 +140,8 @@ export const ComputeAndDiskUsageCharts = ({ className }: { className?: string })
const {
peakCpuUsage,
peakMemoryUsage,
- peakDiskIoUsage,
+ minDiskIoBalance,
+ diskIoStatus,
peakComputeUsage,
status: computeUsageStatus,
} = useMemo(
@@ -174,7 +175,7 @@ export const ComputeAndDiskUsageCharts = ({ className }: { className?: string })
label="Compute"
tooltip={
supportsBurstableIO
- ? 'Peak CPU, memory, and disk IO usage over the last 7 days. Sustained high usage may require a larger compute size.'
+ ? 'Highest CPU usage, memory usage, or consumed disk IO burst balance over the last 7 days; sustained high usage may require a larger compute size.'
: 'Peak CPU and memory usage over the last 7 days. Sustained high usage may require a larger compute size.'
}
value={formatUsagePercent(peakComputeUsage)}
@@ -195,9 +196,10 @@ export const ComputeAndDiskUsageCharts = ({ className }: { className?: string })
/>
{supportsBurstableIO && (
<ChartMetric
- label="Disk IO"
- value={formatUsagePercent(peakDiskIoUsage)}
- status={getUsageMetricStatus(peakDiskIoUsage)}
+ label="Disk IO balance"
+ tooltip="Lowest sampled remaining disk IO burst balance over the last 7 days, using the lower of throughput and IOPS balances; 100% is full and 0% is exhausted."
+ value={formatUsagePercent(minDiskIoBalance)}
+ status={diskIoStatus}
align="end"
/>
)}
@@ -229,7 +231,7 @@ export const ComputeAndDiskUsageCharts = ({ className }: { className?: string })
dataKey="maxCpuUsage"
dataKeys={
supportsBurstableIO
- ? ['maxCpuUsage', 'ramUsage', 'diskIoConsumption']
+ ? ['maxCpuUsage', 'ramUsage', 'diskIoBalance']
: ['maxCpuUsage', 'ramUsage']
}
DateTimeFormat="MMM D"
diff --git a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.test.ts b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.test.ts
index ad79f432675..270c3265a44 100644
--- a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.test.ts
+++ b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.test.ts
@@ -174,7 +174,8 @@ describe('ComputeAndDiskUsageCharts utils', () => {
values: {
max_cpu_usage: '120', // over 100 -> clamped
ram_usage: '-5', // under 0 -> clamped
- disk_io_consumption: '33',
+ disk_io_budget: '99',
+ disk_io_consumption: '1',
},
},
])
@@ -185,11 +186,32 @@ describe('ComputeAndDiskUsageCharts utils', () => {
timestamp: '2024-01-01T00:00:00Z',
maxCpuUsage: 100,
ramUsage: 0,
- diskIoConsumption: 33,
+ diskIoBalance: 99,
},
])
})
+ test.each([undefined, '', 'invalid'])(
+ 'keeps unavailable balance %s out of the chart and score',
+ (balance) => {
+ const { computeChartData } = buildUsageChartData(
+ buildMultiResponse([
+ {
+ period_start: '2024-01-01T00:00:00Z',
+ values: {
+ max_cpu_usage: '20',
+ ram_usage: '30',
+ disk_io_budget: balance,
+ },
+ },
+ ])
+ )
+
+ expect(computeChartData[0].diskIoBalance).toBeUndefined()
+ expect(getComputeUsageSummary(computeChartData).peakComputeUsage).toBe(30)
+ }
+ )
+
test('computes disk usage percentages relative to the disk size', () => {
const result = buildUsageChartData(
buildMultiResponse([
@@ -239,7 +261,7 @@ describe('ComputeAndDiskUsageCharts utils', () => {
expect(result.computeChartData).toHaveLength(2)
})
- test('treats missing compute values as 0', () => {
+ test('keeps missing disk IO balance unavailable', () => {
const result = buildUsageChartData(
buildMultiResponse([{ period_start: '2024-01-01T00:00:00Z', values: {} }])
)
@@ -249,18 +271,48 @@ describe('ComputeAndDiskUsageCharts utils', () => {
timestamp: '2024-01-01T00:00:00Z',
maxCpuUsage: 0,
ramUsage: 0,
- diskIoConsumption: 0,
+ diskIoBalance: undefined,
},
])
})
})
describe('getComputeUsageSummary', () => {
+ test.each([
+ [99, 50, 'default'],
+ [25, 75, 'warning'],
+ [10, 90, 'negative'],
+ [0, 100, 'negative'],
+ [undefined, 50, 'default'],
+ ])('scores %s remaining balance as compute pressure %s', (balance, pressure, status) => {
+ const summary = getComputeUsageSummary([
+ { timestamp: 't1', maxCpuUsage: 40, ramUsage: 50, diskIoBalance: balance },
+ ])
+
+ expect(summary.minDiskIoBalance).toBe(balance)
+ expect(summary.peakComputeUsage).toBe(pressure)
+ expect(summary.status).toBe(status)
+ expect(summary.diskIoStatus).toBe(status)
+ })
+
+ test('uses the lowest sampled balance to capture burst exhaustion', () => {
+ const summary = getComputeUsageSummary([
+ { timestamp: 't1', maxCpuUsage: 20, ramUsage: 30, diskIoBalance: 99 },
+ { timestamp: 't2', maxCpuUsage: 25, ramUsage: 35, diskIoBalance: 5 },
+ { timestamp: 't3', maxCpuUsage: 10, ramUsage: 20, diskIoBalance: undefined },
+ ])
+
+ expect(summary.minDiskIoBalance).toBe(5)
+ expect(summary.peakComputeUsage).toBe(95)
+ expect(summary.status).toBe('negative')
+ })
+
test('returns undefined peaks and default status for empty data', () => {
expect(getComputeUsageSummary([])).toEqual({
peakCpuUsage: undefined,
peakMemoryUsage: undefined,
- peakDiskIoUsage: undefined,
+ minDiskIoBalance: undefined,
+ diskIoStatus: 'default',
peakComputeUsage: undefined,
status: 'default',
})
@@ -268,14 +320,15 @@ describe('ComputeAndDiskUsageCharts utils', () => {
test('computes per-metric peaks, the overall peak, and the worst status', () => {
const data: ComputeUsageChartDatum[] = [
- { timestamp: 't1', maxCpuUsage: 40, ramUsage: 92, diskIoConsumption: 10 },
- { timestamp: 't2', maxCpuUsage: 60, ramUsage: 80, diskIoConsumption: 20 },
+ { timestamp: 't1', maxCpuUsage: 40, ramUsage: 92, diskIoBalance: 90 },
+ { timestamp: 't2', maxCpuUsage: 60, ramUsage: 80, diskIoBalance: 80 },
]
expect(getComputeUsageSummary(data)).toEqual({
peakCpuUsage: 60,
peakMemoryUsage: 92,
- peakDiskIoUsage: 20,
+ minDiskIoBalance: 80,
+ diskIoStatus: 'default',
peakComputeUsage: 92,
status: 'negative', // memory peak of 92 is critical
})
@@ -283,13 +336,14 @@ describe('ComputeAndDiskUsageCharts utils', () => {
test('excludes disk IO from the overall peak and status for dedicated-I/O instances', () => {
const data: ComputeUsageChartDatum[] = [
- { timestamp: 't1', maxCpuUsage: 40, ramUsage: 50, diskIoConsumption: 95 },
+ { timestamp: 't1', maxCpuUsage: 40, ramUsage: 50, diskIoBalance: 5 },
]
expect(getComputeUsageSummary(data, false)).toEqual({
peakCpuUsage: 40,
peakMemoryUsage: 50,
- peakDiskIoUsage: 95,
+ minDiskIoBalance: 5,
+ diskIoStatus: 'negative',
peakComputeUsage: 50,
status: 'default',
})
diff --git a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.ts b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.ts
index 5f18c7a23d7..0317e8fbca1 100644
--- a/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.ts
+++ b/apps/studio/components/interfaces/DiskManagement/ComputeAndDiskUsageCharts.utils.ts
@@ -6,7 +6,7 @@ export type ComputeUsageChartDatum = {
timestamp: string
maxCpuUsage: number
ramUsage: number
- diskIoConsumption: number
+ diskIoBalance?: number
}
export type DiskUsageChartDatum = {
@@ -73,12 +73,19 @@ export const buildUsageChartData = (
return { computeChartData: [], diskChartData: [] }
}
- const computeChartData = usageData.data.map((point) => ({
- timestamp: point.period_start,
- maxCpuUsage: clampPercentage(toNumber(point.values.max_cpu_usage)),
- ramUsage: clampPercentage(toNumber(point.values.ram_usage)),
- diskIoConsumption: clampPercentage(toNumber(point.values.disk_io_consumption)),
- }))
+ const computeChartData = usageData.data.map((point) => {
+ const datum: ComputeUsageChartDatum = {
+ timestamp: point.period_start,
+ maxCpuUsage: clampPercentage(toNumber(point.values.max_cpu_usage)),
+ ramUsage: clampPercentage(toNumber(point.values.ram_usage)),
+ }
+ const balance = point.values.disk_io_budget
+ const parsedBalance = balance?.trim() ? Number(balance) : undefined
+ if (parsedBalance !== undefined && Number.isFinite(parsedBalance)) {
+ datum.diskIoBalance = clampPercentage(parsedBalance)
+ }
+ return datum
+ })
const diskChartData = usageData.data.flatMap((point) => {
const databaseBytes = toNumber(point.values.pg_database_size)
@@ -109,12 +116,16 @@ export const getComputeUsageSummary = (
) => {
const peakCpuUsage = getPeakChartValue(data, 'maxCpuUsage')
const peakMemoryUsage = getPeakChartValue(data, 'ramUsage')
- const peakDiskIoUsage = getPeakChartValue(data, 'diskIoConsumption')
+ const balances = data.flatMap(({ diskIoBalance }) =>
+ diskIoBalance === undefined ? [] : [diskIoBalance]
+ )
+ const minDiskIoBalance = balances.length > 0 ? Math.min(...balances) : undefined
+ const peakDiskIoConsumption = minDiskIoBalance === undefined ? undefined : 100 - minDiskIoBalance
const supportedPeaks = [
peakCpuUsage,
peakMemoryUsage,
- ...(includeDiskIo ? [peakDiskIoUsage] : []),
+ ...(includeDiskIo ? [peakDiskIoConsumption] : []),
]
const peaks = supportedPeaks.filter((value): value is number => value !== undefined)
const peakComputeUsage = peaks.length > 0 ? Math.max(...peaks) : undefined
@@ -122,7 +133,8 @@ export const getComputeUsageSummary = (
return {
peakCpuUsage,
peakMemoryUsage,
- peakDiskIoUsage,
+ minDiskIoBalance,
+ diskIoStatus: getUsageMetricStatus(peakDiskIoConsumption),
peakComputeUsage,
status: getWorstUsageMetricStatus(...supportedPeaks),
}
diff --git a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.test.tsx b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.test.tsx
index 8489965673e..664f637ff6a 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.test.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.test.tsx
@@ -13,7 +13,7 @@ import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
const values: Record<string, number> = {
avg_cpu_usage: 25,
ram_usage: 60,
- disk_io_consumption: 40,
+ disk_io_budget: 99,
disk_fs_used_system: 10,
disk_fs_used_wal: 5,
pg_database_size: 35,
@@ -99,7 +99,7 @@ describe('DatabaseInfrastructureSection batched metrics', () => {
expect(await card('CPU').findByText('25%')).toBeInTheDocument()
expect(await card('Memory').findByText('60%')).toBeInTheDocument()
- expect(await card('Disk IO').findByText('40%')).toBeInTheDocument()
+ expect(await card('Disk IO balance').findByText('99%')).toBeInTheDocument()
expect(await card('Disk Usage').findByText('50%')).toBeInTheDocument()
expect(await card('Peak Connections').findByText('12/100')).toBeInTheDocument()
expect(requests).toHaveLength(1)
@@ -108,7 +108,7 @@ describe('DatabaseInfrastructureSection batched metrics', () => {
)
it.each([
- ['disk_io_consumption', 'Disk IO'],
+ ['disk_io_budget', 'Disk IO balance'],
['disk_fs_used_wal', 'Disk Usage'],
['pg_stat_database_num_backends', 'Peak Connections'],
])('isolates a failed %s result to %s', async (attribute, label) => {
@@ -131,9 +131,9 @@ describe('DatabaseInfrastructureSection batched metrics', () => {
})
it('does not display missing series as zero', async () => {
- mockMetrics('disk_io_consumption', false)
+ mockMetrics('disk_io_budget', false)
renderMetrics()
- expect(await card('Disk IO').findByText('Error loading data')).toBeInTheDocument()
+ expect(await card('Disk IO balance').findByText('Error loading data')).toBeInTheDocument()
expect(await card('CPU').findByText('25%')).toBeInTheDocument()
})
diff --git a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.tsx b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.tsx
index edb59f9790e..5b092e729ae 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureMetric.tsx
@@ -32,9 +32,10 @@ const METRICS = {
attributes: ['disk_fs_used_system', 'disk_fs_used_wal', 'pg_database_size', 'disk_fs_size'],
},
diskIo: {
- label: 'Disk IO',
- tooltip: 'Disk I/O consumption percentage. High values may indicate disk bottlenecks',
- attributes: ['disk_io_consumption'],
+ label: 'Disk IO balance',
+ tooltip:
+ 'Average remaining disk IO burst balance in the selected window, using the lower of throughput and IOPS balances; 100% is full and 0% is exhausted.',
+ attributes: ['disk_io_budget'],
},
ram: {
label: 'Memory',
@@ -99,7 +100,8 @@ export const DatabaseInfrastructureMetric = ({
if (connections.max > 0) value = `${connections.peak}/${connections.max}`
} else {
const metrics = parseInfrastructureMetrics(data)
- if (metrics) value = `${metrics[metric].current.toFixed(0)}%`
+ const current = metrics?.[metric].current
+ if (current !== undefined) value = `${current.toFixed(0)}%`
}
}
diff --git a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.test.ts b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.test.ts
index 75e97896df7..9fc2ae19310 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.test.ts
+++ b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.test.ts
@@ -69,7 +69,7 @@ describe('parseInfrastructureMetrics', () => {
totalAverage: 200,
yAxisLimit: 100,
},
- disk_io_consumption: {
+ disk_io_budget: {
format: 'percent',
total: 210,
totalAverage: 70,
@@ -118,7 +118,7 @@ describe('parseInfrastructureMetrics', () => {
totalAverage: '200.0',
yAxisLimit: 100,
},
- disk_io_consumption: {
+ disk_io_budget: {
format: 'percent',
total: 210,
totalAverage: '70.2',
@@ -137,7 +137,22 @@ describe('parseInfrastructureMetrics', () => {
})
})
- it('returns 0 for missing metrics', () => {
+ it('uses average remaining balance in the selected window rather than consumed IO or its lowest sample', () => {
+ const response: InfraMonitoringMultiResponse = {
+ data: [
+ { period_start: 't1', values: { disk_io_budget: '98', disk_io_consumption: '2' } },
+ { period_start: 't2', values: { disk_io_budget: '100', disk_io_consumption: '0' } },
+ ],
+ series: {
+ disk_io_budget: { format: '%', total: 198, totalAverage: 99, yAxisLimit: 100 },
+ disk_io_consumption: { format: '%', total: 2, totalAverage: 1, yAxisLimit: 100 },
+ },
+ }
+
+ expect(parseInfrastructureMetrics(response)?.diskIo.current).toBe(99)
+ })
+
+ it('keeps missing disk IO balance unavailable', () => {
const mockResponse: InfraMonitoringMultiResponse = {
data: [],
series: {},
@@ -149,7 +164,7 @@ describe('parseInfrastructureMetrics', () => {
cpu: { current: 0, max: 100 },
ram: { current: 0, max: 100 },
disk: { current: 0, max: 100 },
- diskIo: { current: 0, max: 100 },
+ diskIo: { current: undefined, max: 100 },
})
})
@@ -167,7 +182,7 @@ describe('parseInfrastructureMetrics', () => {
cpu: { current: 50, max: 100 },
ram: { current: 0, max: 100 },
disk: { current: 0, max: 100 },
- diskIo: { current: 0, max: 100 },
+ diskIo: { current: undefined, max: 100 },
})
})
@@ -186,7 +201,7 @@ describe('parseInfrastructureMetrics', () => {
cpu: { current: 0, max: 100 },
ram: { current: 0, max: 100 },
disk: { current: 0, max: 100 },
- diskIo: { current: 0, max: 100 },
+ diskIo: { current: undefined, max: 100 },
})
})
})
diff --git a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.ts b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.ts
index 85ae7b5f058..a123c0651bc 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.ts
+++ b/apps/studio/components/interfaces/Observability/DatabaseInfrastructureSection.utils.ts
@@ -21,7 +21,7 @@ type InfrastructureMetrics = {
cpu: MetricData
ram: MetricData
disk: MetricData
- diskIo: MetricData
+ diskIo: { current: number | undefined; max: number }
}
export function parseInfrastructureMetrics(
@@ -41,7 +41,13 @@ export function parseInfrastructureMetrics(
const diskSizeValue = parseNumericValue(series.disk_fs_size?.totalAverage)
const diskUsedValue = diskSystemValue + diskWalValue + diskDatabaseValue
const diskUsageValue = diskSizeValue > 0 ? (diskUsedValue / diskSizeValue) * 100 : 0
- const diskIoValue = parseNumericValue(series.disk_io_consumption?.totalAverage)
+ const diskIoAverage = series.disk_io_budget?.totalAverage
+ const parsedDiskIoAverage = Number(diskIoAverage)
+ const hasDiskIoBalance =
+ diskIoAverage !== undefined &&
+ String(diskIoAverage).trim() !== '' &&
+ Number.isFinite(parsedDiskIoAverage)
+ const diskIoValue = hasDiskIoBalance ? parsedDiskIoAverage : undefined
return {
cpu: {