Skip to content

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

Joshen/fe 4027 telemetry for database connections (#48435)

Joshen Lim6fea2be680c7
diff --git a/apps/studio/components/interfaces/Observability/DatabaseConnections/Activity.tsx b/apps/studio/components/interfaces/Observability/DatabaseConnections/Activity.tsx
index 4cd5b3f8227..f31ee12d219 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseConnections/Activity.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseConnections/Activity.tsx
@@ -11,6 +11,7 @@ import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { useDatabaseRolesQuery } from '@/data/database-roles/database-roles-query'
import { useDatabaseActivityQuery } from '@/data/database/activity-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { useTrack } from '@/lib/telemetry/track'
const DEFAULT_ROLES_FILTER = ['anon', 'authenticated', 'postgres']
@@ -19,6 +20,7 @@ interface ActivityProps {
}
export const Activity = ({ live }: ActivityProps) => {
+ const track = useTrack()
const { data: project } = useSelectedProjectQuery()
const [
@@ -150,6 +152,7 @@ export const Activity = ({ live }: ActivityProps) => {
})
const onResetFilters = () => {
+ track('database_connections_filter_updated', { type: 'reset' })
setQueryStates({
search: '',
states: [],
@@ -175,7 +178,11 @@ export const Activity = ({ live }: ActivityProps) => {
label="State"
options={stateOptions}
value={statesFilter ?? []}
- onChange={(states) => setQueryStates({ states })}
+ onChange={(states) => {
+ if (isEqual(states, statesFilter)) return
+ track('database_connections_filter_updated', { type: 'state' })
+ setQueryStates({ states })
+ }}
isLoading={isPending}
popoverClassName="w-60"
/>
@@ -184,7 +191,11 @@ export const Activity = ({ live }: ActivityProps) => {
label="Roles"
options={roleOptions}
value={rolesFilter ?? []}
- onChange={(roles) => setQueryStates({ roles })}
+ onChange={(roles) => {
+ if (isEqual(roles, rolesFilter)) return
+ track('database_connections_filter_updated', { type: 'roles' })
+ setQueryStates({ roles })
+ }}
isLoading={isPending}
popoverClassName="w-72"
/>
@@ -193,14 +204,23 @@ export const Activity = ({ live }: ActivityProps) => {
label="Application"
options={applicationOptions}
value={applicationsFilter ?? []}
- onChange={(applications) => setQueryStates({ applications })}
+ onChange={(applications) => {
+ if (isEqual(applications, applicationsFilter)) return
+ track('database_connections_filter_updated', { type: 'application' })
+ setQueryStates({ applications })
+ }}
isLoading={isPending}
popoverClassName="w-60"
/>
<ButtonTooltip
variant={viewFilter === 'blockers' ? 'default' : 'dashed'}
iconRight={rootBlockers.length > 0 ? <span>{rootBlockers.length}</span> : null}
- onClick={() => setQueryStates({ view: viewFilter === 'blockers' ? '' : 'blockers' })}
+ onClick={() => {
+ track('database_connections_blocker_view_clicked', {
+ newState: viewFilter === 'blockers' ? 'disabled' : 'enabled',
+ })
+ setQueryStates({ view: viewFilter === 'blockers' ? '' : 'blockers' })
+ }}
tooltip={{
content: {
side: 'bottom',
diff --git a/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx b/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
index e9bc18e2201..ee10aafd1d2 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseConnections/ActivityRow.tsx
@@ -48,6 +48,7 @@ import { useDatabaseActivityQuery, type DatabaseActivity } from '@/data/database
import { useQueryAbortMutation } from '@/data/sql/abort-query-mutation'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { formatSql } from '@/lib/formatSql'
+import { useTrack } from '@/lib/telemetry/track'
export const GroupedActivityRow = ({ activity }: { activity: DatabaseActivity }) => {
const { data: project } = useSelectedProjectQuery()
@@ -103,6 +104,7 @@ export const ActivityRow = ({
isLast?: boolean
onExpand?: () => void
}) => {
+ const track = useTrack()
const { data: project } = useSelectedProjectQuery()
const [showTerminateConfirmDialog, setShowTerminateConfirmDialog] = useState(false)
const [selectedPid, setSelectedPid] = useQueryState('pid', parseAsInteger)
@@ -139,6 +141,8 @@ export const ActivityRow = ({
durationSeconds >= WARN_DURATION_IDLE_TXN))
const onConfirmTerminate = async () => {
+ const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
+ track('session_terminate_submitted', { activityState: activity.state, isBlocking })
try {
await abortQuery({
pid: activity.pid,
@@ -391,7 +395,14 @@ export const ActivityRow = ({
<DropdownMenuItemTooltip
className="gap-x-2"
disabled={superuserRoles?.includes(activity.role_name)}
- onClick={() => setShowTerminateConfirmDialog(true)}
+ onClick={() => {
+ const isBlocking = (data ?? []).some((x) => x.blocked_by.includes(activity.pid))
+ track('session_terminate_button_clicked', {
+ activityState: activity.state,
+ isBlocking,
+ })
+ setShowTerminateConfirmDialog(true)
+ }}
tooltip={{
content: {
side: 'left',
diff --git a/apps/studio/components/interfaces/Observability/DatabaseConnections/Overview.tsx b/apps/studio/components/interfaces/Observability/DatabaseConnections/Overview.tsx
index 6c1c1c94911..378ae54317e 100644
--- a/apps/studio/components/interfaces/Observability/DatabaseConnections/Overview.tsx
+++ b/apps/studio/components/interfaces/Observability/DatabaseConnections/Overview.tsx
@@ -14,12 +14,14 @@ import { useDatabaseRolesQuery } from '@/data/database-roles/database-roles-quer
import { useDatabaseActivityQuery } from '@/data/database/activity-query'
import { useMaxConnectionsQuery } from '@/data/database/max-connections-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { useTrack } from '@/lib/telemetry/track'
interface OverviewProps {
live?: boolean
}
export const Overview = ({ live }: OverviewProps) => {
+ const track = useTrack()
const { data: project } = useSelectedProjectQuery()
const [, setSelectedPid] = useQueryState('pid', parseAsInteger)
@@ -71,6 +73,24 @@ export const Overview = ({ live }: OverviewProps) => {
document.getElementById(pid.toString())?.scrollIntoView({ behavior: 'smooth', block: 'center' })
}
+ const onSelectLongestBlocked = () => {
+ if (!longestBlockedQuery) return
+ track('database_connections_overview_metric_card_clicked', { type: 'longest_blocked' })
+ onSelectPid(longestBlockedQuery.activity.pid)
+ }
+
+ const onSelectTopBlocker = () => {
+ if (!queryBlockingTheMostQueries) return
+ track('database_connections_overview_metric_card_clicked', { type: 'top_blocker' })
+ onSelectPid(queryBlockingTheMostQueries.activity.pid)
+ }
+
+ const onSelectLongestRunning = () => {
+ if (!longestRunningQuery) return
+ track('database_connections_overview_metric_card_clicked', { type: 'longest_running' })
+ onSelectPid(longestRunningQuery.activity.pid)
+ }
+
return (
<div className="flex flex-col gap-y-4">
<div className="flex gap-x-4">
@@ -193,11 +213,11 @@ export const Overview = ({ live }: OverviewProps) => {
'hover:text-foreground hover:underline',
'focus:text-foreground focus:underline'
)}
- onClick={() => onSelectPid(longestBlockedQuery.activity.pid)}
+ onClick={() => onSelectLongestBlocked()}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
- onSelectPid(longestBlockedQuery.activity.pid)
+ onSelectLongestBlocked()
}
}}
>
@@ -243,11 +263,11 @@ export const Overview = ({ live }: OverviewProps) => {
role="button"
tabIndex={0}
className="normal-nums cursor-pointer hover:underline focus:underline"
- onClick={() => onSelectPid(queryBlockingTheMostQueries.activity.pid)}
+ onClick={() => onSelectTopBlocker()}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
- onSelectPid(queryBlockingTheMostQueries.activity.pid)
+ onSelectTopBlocker()
}
}}
>
@@ -300,11 +320,11 @@ export const Overview = ({ live }: OverviewProps) => {
role="button"
tabIndex={0}
className="normal-nums hover:underline focus:underline cursor-pointer"
- onClick={() => onSelectPid(longestRunningQuery.activity.pid)}
+ onClick={() => onSelectLongestRunning()}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
- onSelectPid(longestRunningQuery.activity.pid)
+ onSelectLongestRunning()
}
}}
>
diff --git a/apps/studio/components/ui/AiAssistantDropdown.tsx b/apps/studio/components/ui/AiAssistantDropdown.tsx
index 512340d4cc6..10acb318719 100644
--- a/apps/studio/components/ui/AiAssistantDropdown.tsx
+++ b/apps/studio/components/ui/AiAssistantDropdown.tsx
@@ -142,6 +142,7 @@ export function AiAssistantDropdown({
<DropdownMenu open={isOpen} onOpenChange={setIsOpen}>
<DropdownMenuTrigger asChild>
<Button
+ aria-label="More actions"
variant={variant}
size={size}
disabled={disabled}
diff --git a/apps/studio/pages/project/[ref]/observability/connections.tsx b/apps/studio/pages/project/[ref]/observability/connections.tsx
index ab3a73a5a7b..e6102a2ae03 100644
--- a/apps/studio/pages/project/[ref]/observability/connections.tsx
+++ b/apps/studio/pages/project/[ref]/observability/connections.tsx
@@ -14,6 +14,7 @@ import { AiAssistantDropdown } from '@/components/ui/AiAssistantDropdown'
import { ShortcutTooltip } from '@/components/ui/ShortcutTooltip'
import { useDatabaseActivityQuery } from '@/data/database/activity-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { useTrack } from '@/lib/telemetry/track'
import { useAiAssistantStateSnapshot } from '@/state/ai-assistant-state'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
import { useShortcut } from '@/state/shortcuts/useShortcut'
@@ -21,6 +22,7 @@ import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
import type { NextPageWithLayout } from '@/types'
export const DatabaseConnections: NextPageWithLayout = () => {
+ const track = useTrack()
const { data: project } = useSelectedProjectQuery()
const { openSidebar } = useSidebarManagerSnapshot()
const aiSnap = useAiAssistantStateSnapshot()
@@ -46,6 +48,11 @@ export const DatabaseConnections: NextPageWithLayout = () => {
function handleToggleLive() {
const nextLive = !live
+
+ track('database_connections_live_mode_clicked', {
+ newState: nextLive ? 'enabled' : 'disabled',
+ })
+
setLive(nextLive)
if (nextLive) {
setNow(dayjs.utc())
@@ -112,8 +119,7 @@ export const DatabaseConnections: NextPageWithLayout = () => {
buildPrompt={buildPrompt}
onOpenAssistant={handleSummarizeActivity}
disabled={isLoadingActivity}
- isLoading={isLoadingActivity}
- // @ts-ignore [Joshen] To add proper telemetry source in subsequent PR
+ loading={isLoadingActivity}
telemetrySource="database_connections"
size="tiny"
variant="default"
diff --git a/packages/common/telemetry-constants.ts b/packages/common/telemetry-constants.ts
index 937d4804e91..6e91ad815e9 100644
--- a/packages/common/telemetry-constants.ts
+++ b/packages/common/telemetry-constants.ts
@@ -5,7 +5,7 @@
*
* ## Naming conventions
* Event names and actions should use standardized past-tense verbs for data quality and consistency.
- * Only use verbs already established in this file or in https://github.com/supabase/platform/blob/develop/shared/src/telemetry.ts
+ * Only use verbs already established in this file or in https://github.com/supabase/platform/blob/develop/packages/api-core/src/shared/telemetry.ts
* Adding new verbs requires @growth-eng review to prevent data pollution.
*
* @module telemetry-frontend
@@ -1479,6 +1479,113 @@ export interface IndexAdvisorTabClickedEvent {
groups: TelemetryGroups
}
+/**
+ * User toggled live mode on the Database Connections observability page.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface DatabaseConnectionsLiveModeClickedEvent {
+ action: 'database_connections_live_mode_clicked'
+ properties: {
+ newState: 'enabled' | 'disabled'
+ }
+ groups: TelemetryGroups
+}
+
+/**
+ * User clicked a metric card PID in the Overview panel of the Database Connections observability page, selecting it in the activity table below.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface DatabaseConnectionsOverviewMetricCardClickedEvent {
+ action: 'database_connections_overview_metric_card_clicked'
+ properties: {
+ type: 'longest_blocked' | 'top_blocker' | 'longest_running'
+ }
+ groups: TelemetryGroups
+}
+
+/**
+ * User updated a filter on the Sessions table of the Database Connections observability page.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface DatabaseConnectionsFilterUpdatedEvent {
+ action: 'database_connections_filter_updated'
+ properties: {
+ type: 'state' | 'roles' | 'application' | 'reset'
+ }
+ groups: TelemetryGroups
+}
+
+/**
+ * User clicked the Root blockers filter button on the Database Connections activity table.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface DatabaseConnectionsBlockerViewClickedEvent {
+ action: 'database_connections_blocker_view_clicked'
+ properties: {
+ newState: 'enabled' | 'disabled'
+ }
+ groups: TelemetryGroups
+}
+
+type DatabaseActivityState =
+ | 'idle'
+ | 'active'
+ | 'idle in transaction'
+ | 'idle in transaction (aborted)'
+ | 'fastpath function call'
+ | 'disabled'
+ | null
+
+/**
+ * User clicked the Terminate menu item for a database session in the Database Connections activity table, opening the confirmation dialog.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface SessionTerminateButtonClickedEvent {
+ action: 'session_terminate_button_clicked'
+ properties: {
+ activityState: DatabaseActivityState
+ /**
+ * Whether the session being terminated was itself blocking one or more other sessions.
+ */
+ isBlocking: boolean
+ }
+ groups: TelemetryGroups
+}
+
+/**
+ * User confirmed terminating a database session in the Database Connections activity table.
+ *
+ * @group Events
+ * @source studio
+ * @page /dashboard/project/{ref}/observability/connections
+ */
+export interface SessionTerminateSubmittedEvent {
+ action: 'session_terminate_submitted'
+ properties: {
+ activityState: DatabaseActivityState
+ /**
+ * Whether the terminated session was itself blocking one or more other sessions.
+ */
+ isBlocking: boolean
+ }
+ groups: TelemetryGroups
+}
+
/**
* Index Advisor create indexes button clicked event.
*
@@ -2859,6 +2966,7 @@ export type AiAssistantSource =
| 'log_explorer'
| 'error_code'
| 'advisor_signal_detail'
+ | 'database_connections'
/**
* User copied an AI prompt to clipboard instead of using the built-in assistant.
@@ -3665,6 +3773,12 @@ export type TelemetryEvent =
| IndexAdvisorEnableButtonClickedEvent
| IndexAdvisorBannerDismissButtonClickedEvent
| IndexAdvisorTabClickedEvent
+ | DatabaseConnectionsLiveModeClickedEvent
+ | DatabaseConnectionsOverviewMetricCardClickedEvent
+ | DatabaseConnectionsFilterUpdatedEvent
+ | DatabaseConnectionsBlockerViewClickedEvent
+ | SessionTerminateButtonClickedEvent
+ | SessionTerminateSubmittedEvent
| IndexAdvisorCreateIndexesButtonClickedEvent
| EdgeFunctionDeployButtonClickedEvent
| EdgeFunctionDeployUpdatesConfirmClickedEvent