Skip to content

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

fix(studio): improve memory and swap units in DB reports (#45889)

Jordi Enric5d9cf3971f66
diff --git a/apps/studio/components/ui/Charts/ChartHeader.tsx b/apps/studio/components/ui/Charts/ChartHeader.tsx
index 3b807513217..c553228b0df 100644
--- a/apps/studio/components/ui/Charts/ChartHeader.tsx
+++ b/apps/studio/components/ui/Charts/ChartHeader.tsx
@@ -14,7 +14,7 @@ import { formatPercentage, numberFormatter } from './Charts.utils'
import { useChartHoverState } from './useChartHoverState'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { formatDateTime, useFormatDateTime } from '@/lib/datetime'
-import { formatBytes } from '@/lib/helpers'
+import { formatBytes, formatBytesMinMB } from '@/lib/helpers'
export interface ChartHeaderProps {
title?: string
@@ -41,6 +41,7 @@ export interface ChartHeaderProps {
valuePrecision?: number
shouldFormatBytes?: boolean
isNetworkChart?: boolean
+ isMemoryChart?: boolean
attributes?: any[]
sql?: string
titleTooltip?: string
@@ -76,6 +77,7 @@ export const ChartHeader = ({
sql,
titleTooltip,
showNewBadge,
+ isMemoryChart,
}: ChartHeaderProps) => {
const { ref } = useParams()
const { hoveredIndex, isHovered } = useChartHoverState(syncId || 'default')
@@ -97,7 +99,9 @@ export const ChartHeader = ({
if (shouldFormatBytes) {
const bytesValue = isNetworkChart ? Math.abs(value) : value
- return formatBytes(bytesValue, valuePrecision)
+ return isMemoryChart
+ ? formatBytesMinMB(bytesValue, valuePrecision)
+ : formatBytes(bytesValue, valuePrecision)
}
if (format === '%') {
diff --git a/apps/studio/components/ui/Charts/ComposedChart.tsx b/apps/studio/components/ui/Charts/ComposedChart.tsx
index 39f74ff414d..f7567480aa5 100644
--- a/apps/studio/components/ui/Charts/ComposedChart.tsx
+++ b/apps/studio/components/ui/Charts/ComposedChart.tsx
@@ -44,7 +44,7 @@ import NoDataPlaceholder from './NoDataPlaceholder'
import { ChartHighlight } from './useChartHighlight'
import { useChartHoverState } from './useChartHoverState'
import { formatDateTime, useFormatDateTime } from '@/lib/datetime'
-import { formatBytes } from '@/lib/helpers'
+import { formatBytes, formatBytesMinMB } from '@/lib/helpers'
export interface ComposedChartProps<D = Datum> extends CommonChartProps<D> {
chartId?: string
@@ -221,7 +221,9 @@ export function ComposedChart({
if (shouldFormatBytes) {
const bytesValue = isNetworkChart ? Math.abs(value) : value
- const formatted = formatBytes(bytesValue, valuePrecision)
+ const formatted = isMemoryChart
+ ? formatBytesMinMB(bytesValue, valuePrecision)
+ : formatBytes(bytesValue, valuePrecision)
return format === 'bytes-per-second' ? `${formatted}/s` : formatted
}
@@ -373,6 +375,8 @@ export function ComposedChart({
const isRamChart =
!chartData?.some((att: any) => att.name.toLowerCase() === 'ram_usage') &&
chartData?.some((att: any) => att.name.toLowerCase().includes('ram_'))
+ const isSwapChart = chartData?.some((att: any) => att.name.toLowerCase().includes('swap_'))
+ const isMemoryChart = isRamChart || isSwapChart
const isDiskSpaceChart = chartData?.some((att: any) =>
att.name.toLowerCase().includes('disk_space_')
)
@@ -382,7 +386,7 @@ export function ComposedChart({
const isNetworkChart = chartData?.some((att: any) => att.name.toLowerCase().includes('network_'))
const isBytesFormat = format === 'bytes' || format === 'bytes-per-second'
const shouldFormatBytes =
- isBytesFormat || isRamChart || isDiskSpaceChart || isDBSizeChart || isNetworkChart
+ isBytesFormat || isMemoryChart || isDiskSpaceChart || isDBSizeChart || isNetworkChart
const yMaxFromVisible = Math.max(
0,
...visibleAttributes.map((att) => (typeof att.value === 'number' ? att.value : 0))
@@ -454,6 +458,7 @@ export function ComposedChart({
valuePrecision={valuePrecision}
shouldFormatBytes={shouldFormatBytes}
isNetworkChart={isNetworkChart}
+ isMemoryChart={isMemoryChart}
attributes={attributes}
sql={sql}
/>
diff --git a/apps/studio/components/ui/Charts/ComposedChart.utils.tsx b/apps/studio/components/ui/Charts/ComposedChart.utils.tsx
index 4aa39274dcf..94d80ca6b1c 100644
--- a/apps/studio/components/ui/Charts/ComposedChart.utils.tsx
+++ b/apps/studio/components/ui/Charts/ComposedChart.utils.tsx
@@ -6,7 +6,7 @@ import { cn, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from 'ui
import { CHART_COLORS, DateTimeFormats } from './Charts.constants'
import { formatPercentage, numberFormatter } from './Charts.utils'
import { useFormatDateTime, useTimezone } from '@/lib/datetime'
-import { formatBytes } from '@/lib/helpers'
+import { formatBytes, formatBytesMinMB } from '@/lib/helpers'
export interface ReportAttributes {
id?: string
@@ -174,12 +174,14 @@ export const CustomTooltip = ({
const isRamChart =
!payload?.some((p: any) => p.dataKey.toLowerCase() === 'ram_usage') &&
payload?.some((p: any) => p.dataKey.toLowerCase().includes('ram_'))
+ const isSwapChart = payload?.some((p: any) => p.dataKey.toLowerCase().includes('swap_'))
+ const isMemoryChart = isRamChart || isSwapChart
const isDBSizeChart =
payload?.some((p: any) => p.dataKey.toLowerCase().includes('disk_fs_')) ||
payload?.some((p: any) => p.dataKey.toLowerCase().includes('pg_database_size'))
const isNetworkChart = payload?.some((p: any) => p.dataKey.toLowerCase().includes('network_'))
const isBytesFormat = format === 'bytes' || format === 'bytes-per-second'
- const shouldFormatBytes = isBytesFormat || isRamChart || isDBSizeChart || isNetworkChart
+ const shouldFormatBytes = isBytesFormat || isMemoryChart || isDBSizeChart || isNetworkChart
const byteUnitSuffix = format === 'bytes-per-second' ? '/s' : ''
const attributesToIgnore =
@@ -213,7 +215,9 @@ export const CustomTooltip = ({
const formatNumeric = (value: number) => {
if (!shouldFormatBytes && valuePrecision === 0 && value > 0 && value < 1) return '<1'
if (shouldFormatBytes) {
- return formatBytes(isNetworkChart ? Math.abs(value) : value, valuePrecision)
+ const val = isNetworkChart ? Math.abs(value) : value
+ if (isMemoryChart) return formatBytesMinMB(val, valuePrecision)
+ return formatBytes(val, valuePrecision)
}
const formatted = numberFormatter(value, valuePrecision)
if (
diff --git a/apps/studio/components/ui/Charts/ComposedChartHandler.tsx b/apps/studio/components/ui/Charts/ComposedChartHandler.tsx
index e2d47ed7fcf..5c9e15e32da 100644
--- a/apps/studio/components/ui/Charts/ComposedChartHandler.tsx
+++ b/apps/studio/components/ui/Charts/ComposedChartHandler.tsx
@@ -357,7 +357,7 @@ const useAttributeQueries = (
)
const referenceLineQueries = referenceLines.map((line) => {
- let value = line.value || 0
+ let value = line.value ?? line.customValue ?? 0
return {
data: {
diff --git a/apps/studio/data/reports/database-charts.ts b/apps/studio/data/reports/database-charts.ts
index 61b380dbc8c..57e94cbfe8f 100644
--- a/apps/studio/data/reports/database-charts.ts
+++ b/apps/studio/data/reports/database-charts.ts
@@ -7,7 +7,7 @@ import { DiskAttributesData } from '@/data/config/disk-attributes-query'
import { MaxConnectionsData } from '@/data/database/max-connections-query'
import { Project } from '@/data/projects/project-detail-query'
import { DOCS_URL } from '@/lib/constants'
-import { formatBytes } from '@/lib/helpers'
+import { formatBytes, formatBytesMinMB } from '@/lib/helpers'
// Compute variants below 4XL run on EBS instances that draw on a burst
// credit pool for disk IO, so the burst balance chart only makes sense for
@@ -68,7 +68,7 @@ export const getReportAttributesV2: (
valuePrecision: 2,
YAxisProps: {
width: 75,
- tickFormatter: (value: number) => formatBytes(value, 2),
+ tickFormatter: (value: number) => formatBytesMinMB(value, 2),
},
attributes: [
{
@@ -92,6 +92,14 @@ export const getReportAttributesV2: (
tooltip:
'Unallocated memory available for use. A small portion is always reserved by the operating system',
},
+ {
+ attribute: 'ram_usage_total',
+ provider: 'infra-monitoring',
+ label: 'Total RAM',
+ isMaxValue: true,
+ omitFromTotal: true,
+ tooltip: 'Total RAM available on this instance',
+ },
],
},
{
@@ -109,7 +117,9 @@ export const getReportAttributesV2: (
valuePrecision: 2,
YAxisProps: {
width: 75,
- tickFormatter: (value: number) => formatBytes(value, 2),
+ tickFormatter: (value: number) => formatBytesMinMB(value, 2),
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ domain: [0, (dataMax: number) => Math.max(dataMax, 1024 * 1024 * 1024)] as any,
},
attributes: [
{
diff --git a/apps/studio/lib/helpers.ts b/apps/studio/lib/helpers.ts
index 102a1b6a242..558a5dbf46f 100644
--- a/apps/studio/lib/helpers.ts
+++ b/apps/studio/lib/helpers.ts
@@ -148,6 +148,13 @@ export const formatBytes = (
return isNegative ? '-' + formattedValue : formattedValue
}
+export const formatBytesMinMB = (bytes: any, decimals = 2) => {
+ if (bytes === 0 || bytes === undefined) return '0 MB'
+ const MB = 1024 * 1024
+ if (Math.abs(bytes) < MB) return formatBytes(bytes, decimals, 'MB')
+ return formatBytes(bytes, decimals)
+}
+
export const snakeToCamel = (str: string) =>
str.replace(/([-_][a-z])/g, (group: string) =>
group.toUpperCase().replace('-', '').replace('_', '')