Files
Jordi Enric 168c084f4e feat(o11y): overview page (#42098)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Observability Dashboard: unified overview for service health and
database infrastructure with interactive charts and metric cards (CPU,
memory, disk I/O, connections, error rate, slow queries).
* Service Health Monitoring: per-service health cards and a
multi-service table with error/warning counts and drill-down links to
reports/logs.
* Interval Selector: new chart-interval dropdown with plan-aware
retention messaging.
* Menu & Reports: updated Observability menu with Overview entry and
Custom Reports management.
* **Documentation**
  * Added a footer link to troubleshooting guides.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-01-30 14:00:01 +00:00

287 lines
10 KiB
TypeScript

import { useParams } from 'common'
import NoDataPlaceholder from 'components/ui/Charts/NoDataPlaceholder'
import { ChartIntervalDropdown } from 'components/ui/Logs/ChartIntervalDropdown'
import { CHART_INTERVALS } from 'components/ui/Logs/logs.utils'
import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
import dayjs from 'dayjs'
import { useCurrentOrgPlan } from 'hooks/misc/useCurrentOrgPlan'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useMemo, useState } from 'react'
import { Card, CardContent, CardHeader, CardTitle, Loading } from 'ui'
import { Row } from 'ui-patterns'
import { LogsBarChart } from 'ui-patterns/LogsBarChart'
import { useServiceHealthMetrics } from '../Observability/useServiceHealthMetrics'
import { normalizeChartBuckets } from './ChartDataTransform.utils'
import type { LogsBarChartDatum } from './ProjectUsage.metrics'
import {
computeSuccessAndNonSuccessRates,
sumErrors,
sumTotal,
sumWarnings,
} from './ProjectUsage.metrics'
type ChartIntervalKey = '1hr' | '1day' | '7day'
type ServiceKey = 'db' | 'functions' | 'auth' | 'storage' | 'realtime'
type ServiceEntry = {
key: ServiceKey
title: string
href?: string
route: string
enabled: boolean
}
type ServiceComputed = ServiceEntry & {
data: LogsBarChartDatum[]
total: number
warn: number
err: number
isLoading: boolean
error: unknown | null
}
export const ProjectUsageSection = () => {
const router = useRouter()
const { ref: projectRef } = useParams()
const { data: organization } = useSelectedOrganizationQuery()
const { mutate: sendEvent } = useSendEventMutation()
const { projectAuthAll: authEnabled, projectStorageAll: storageEnabled } = useIsFeatureEnabled([
'project_auth:all',
'project_storage:all',
])
const { plan } = useCurrentOrgPlan()
const DEFAULT_INTERVAL: ChartIntervalKey = plan?.id === 'free' ? '1hr' : '1day'
const [interval, setInterval] = useState<ChartIntervalKey>(DEFAULT_INTERVAL)
const [refreshKey, setRefreshKey] = useState(0)
const selectedInterval = CHART_INTERVALS.find((i) => i.key === interval) || CHART_INTERVALS[1]
const { datetimeFormat } = useMemo(() => {
const format = selectedInterval.format || 'MMM D, ha'
return { datetimeFormat: format }
}, [selectedInterval])
const {
services: healthServices,
isLoading: isHealthLoading,
endDate,
} = useServiceHealthMetrics(projectRef!, interval, refreshKey)
const serviceBase: ServiceEntry[] = useMemo(
() => [
{
key: 'db',
title: 'Database requests',
href: `/project/${projectRef}/editor`,
route: '/logs/postgres-logs',
enabled: true,
},
{
key: 'functions',
title: 'Functions requests',
route: '/logs/edge-functions-logs',
enabled: true,
},
{
key: 'auth',
title: 'Auth requests',
href: `/project/${projectRef}/auth/users`,
route: '/logs/auth-logs',
enabled: authEnabled,
},
{
key: 'storage',
title: 'Storage requests',
href: `/project/${projectRef}/storage/buckets`,
route: '/logs/storage-logs',
enabled: storageEnabled,
},
{
key: 'realtime',
title: 'Realtime requests',
route: '/logs/realtime-logs',
enabled: true,
},
],
[projectRef, authEnabled, storageEnabled]
)
const services: ServiceComputed[] = useMemo(
() =>
serviceBase.map((s) => {
const healthData = healthServices[s.key]
// Normalize chart data to consistent bucket sizes using the same endDate from the query
const normalizedData = normalizeChartBuckets(
healthData.eventChartData,
interval,
new Date(endDate)
)
const total = sumTotal(normalizedData)
const warn = sumWarnings(normalizedData)
const err = sumErrors(normalizedData)
return {
...s,
data: normalizedData,
total,
warn,
err,
isLoading: healthData.isLoading,
error: healthData.error,
}
}),
[serviceBase, healthServices, interval, endDate]
)
const isLoading = isHealthLoading
const handleBarClick =
(logRoute: string, serviceKey: ServiceKey) => (datum: LogsBarChartDatum) => {
if (!datum?.timestamp) return
const datumTimestamp = dayjs(datum.timestamp).toISOString()
const start = dayjs(datumTimestamp).subtract(1, 'minute').toISOString()
const end = dayjs(datumTimestamp).add(1, 'minute').toISOString()
const queryParams = new URLSearchParams({
iso_timestamp_start: start,
iso_timestamp_end: end,
})
router.push(`/project/${projectRef}${logRoute}?${queryParams.toString()}`)
if (projectRef && organization?.slug) {
sendEvent({
action: 'home_project_usage_chart_clicked',
properties: {
service_type: serviceKey,
bar_timestamp: datum.timestamp,
},
groups: {
project: projectRef,
organization: organization.slug,
},
})
}
}
const enabledServices = services.filter((s) => s.enabled)
const totalRequests = enabledServices.reduce((sum, s) => sum + (s.total || 0), 0)
const totalErrors = enabledServices.reduce((sum, s) => sum + (s.err || 0), 0)
const totalWarnings = enabledServices.reduce((sum, s) => sum + (s.warn || 0), 0)
const { successRate } = computeSuccessAndNonSuccessRates(
totalRequests,
totalWarnings,
totalErrors
)
return (
<div className="space-y-6">
<div className="flex flex-row justify-between items-center gap-x-2">
<div className="flex flex-col md:flex-row md:items-center md:gap-6">
<div className="flex items-start gap-2 heading-section text-foreground-light">
<span className="text-foreground">{totalRequests.toLocaleString()}</span>
<span>Total Requests</span>
</div>
<div className="flex items-start gap-2 heading-section text-foreground-light">
<span className="text-foreground">
{successRate === 100 ? '100' : successRate.toFixed(1)}%
</span>
<span>Success Rate</span>
</div>
</div>
<ChartIntervalDropdown
value={interval}
onChange={(interval) => setInterval(interval as ChartIntervalKey)}
planId={plan?.id}
planName={plan?.name}
organizationSlug={organization?.slug}
dropdownAlign="end"
tooltipSide="left"
/>
</div>
<Row columns={[3, 2, 1]}>
{enabledServices.map((s) => (
<Card key={s.key} className="mb-0 md:mb-0 h-full flex flex-col h-64">
<CardHeader className="flex flex-row items-end justify-between gap-2 space-y-0 pb-0 border-b-0">
<div className="flex items-center gap-2">
<div className="flex flex-col">
<div className="flex items-center gap-2">
<CardTitle className="text-foreground-light">
{s.href ? (
<Link
href={s.href}
onClick={() => {
if (projectRef && organization?.slug) {
sendEvent({
action: 'home_project_usage_service_clicked',
properties: {
service_type: s.key,
total_requests: s.total || 0,
error_count: s.err || 0,
},
groups: {
project: projectRef,
organization: organization.slug,
},
})
}
}}
>
{s.title}
</Link>
) : (
s.title
)}
</CardTitle>
</div>
<span className="text-foreground text-xl">{(s.total || 0).toLocaleString()}</span>
</div>
</div>
<div className="flex items-end gap-4 text-foreground-light">
<div className="flex flex-col items-end">
<div className="flex items-center gap-2">
<div className="w-1.5 h-1.5 bg-warning rounded-full" />
<span className="heading-meta">Warn</span>
</div>
<span className="text-foreground text-xl">{(s.warn || 0).toLocaleString()}</span>
</div>
<div className="flex flex-col items-end">
<div className="flex items-center gap-2">
<div className="w-1.5 h-1.5 bg-destructive rounded-full" />
<span className="heading-meta">Err</span>
</div>
<span className="text-foreground text-xl">{(s.err || 0).toLocaleString()}</span>
</div>
</div>
</CardHeader>
<CardContent className="p-6 pt-4 flex-1 h-full overflow-hidden">
<Loading isFullHeight active={isLoading}>
<LogsBarChart
isFullHeight
data={s.data}
DateTimeFormat={datetimeFormat}
onBarClick={handleBarClick(s.route, s.key)}
EmptyState={
<NoDataPlaceholder
size="small"
message="No data for selected period"
isFullHeight
/>
}
/>
</Loading>
</CardContent>
</Card>
))}
</Row>
</div>
)
}