Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

feat: add events for span detail open and trace view (#13358)

Gaurav Tewariafbe1ac7a63e
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/TraceDetailsTabs.tsx b/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/TraceDetailsTabs.tsx
index 0ddd61a387..9023832d6a 100644
--- a/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/TraceDetailsTabs.tsx
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/TraceDetailsTabs.tsx
@@ -1,6 +1,9 @@
import { ToggleGroup } from '@signozhq/ui/toggle-group';
+import { useAppParams } from 'lib/router/useAppParams';
import { TraceDetailsTab } from '../constants';
+import { TraceDetailEventKeys, TraceDetailEvents } from '../events';
+import { useTraceDetailLogEvent } from '../hooks/useTraceDetailLogEvent';
import { useTraceDetailsTab } from '../hooks/useTraceDetailsTab';
import styles from './TraceDetailsHeader.module.scss';
@@ -19,9 +22,15 @@ const TAB_ITEMS = [
];
function TraceDetailsTabs(): JSX.Element {
+ const { id: traceId = '' } = useAppParams<'id'>();
const [tab, setTab] = useTraceDetailsTab();
+ const logTraceEvent = useTraceDetailLogEvent('v3', traceId);
const handleChange = (value: string): void => {
+ logTraceEvent(TraceDetailEvents.DetailsTabChanged, {
+ [TraceDetailEventKeys.From]: tab,
+ [TraceDetailEventKeys.To]: value,
+ });
// Pushed so the thread's "Go back" returns to the previous tab, not the previous page.
void setTab(value as TraceDetailsTab, { history: 'push' });
};
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/__tests__/TraceDetailsHeader.test.tsx b/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/__tests__/TraceDetailsHeader.test.tsx
index 2e53e4abdf..cdb2edf8b8 100644
--- a/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/__tests__/TraceDetailsHeader.test.tsx
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsHeader/__tests__/TraceDetailsHeader.test.tsx
@@ -1,12 +1,17 @@
import { getYAxisFormattedValue } from 'components/Graph/yAxisConfig';
+import logEvent from 'api/common/logEvent';
import type { SpantypesGettableTraceSummaryDTO } from 'api/generated/services/sigNoz.schemas';
import { NuqsTestingAdapter } from 'nuqs/adapters/testing';
import ROUTES from 'constants/routes';
import { fireEvent, render, screen, userEvent } from 'tests/test-utils';
+import { TraceDetailsTab } from '../../constants';
+import { TraceDetailEvents } from '../../events';
import TraceDetailsHeader from '../TraceDetailsHeader';
import { useTraceSummary } from '../useTraceSummary';
+jest.mock('api/common/logEvent');
+
jest.mock('../useTraceSummary', () => ({
useTraceSummary: jest.fn(() => ({ data: undefined, isLoading: false })),
}));
@@ -416,4 +421,23 @@ describe('TraceDetailsHeader – tabs', () => {
'false',
);
});
+
+ it('logs the tab change with the previous and next tab', async () => {
+ const user = userEvent.setup({ delay: null });
+ renderHeader();
+ jest.mocked(logEvent).mockClear();
+
+ await user.click(screen.getByTestId('trace-details-tab-overview'));
+ expect(logEvent).not.toHaveBeenCalled();
+
+ await user.click(screen.getByTestId('trace-details-tab-thread'));
+
+ expect(logEvent).toHaveBeenCalledTimes(1);
+ expect(logEvent).toHaveBeenCalledWith(TraceDetailEvents.DetailsTabChanged, {
+ view: 'v3',
+ traceId: 'trace-123',
+ from: TraceDetailsTab.Overview,
+ to: TraceDetailsTab.Thread,
+ });
+ });
});
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsOverview/TraceDetailsOverview.tsx b/frontend/src/pages/TraceDetailsV3/TraceDetailsOverview/TraceDetailsOverview.tsx
index 68a194a0b7..9ed8257ccb 100644
--- a/frontend/src/pages/TraceDetailsV3/TraceDetailsOverview/TraceDetailsOverview.tsx
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsOverview/TraceDetailsOverview.tsx
@@ -27,7 +27,9 @@ import { getUnstableCurrentSearchParams } from 'utils/getUnstableCurrentSearchPa
import { ResizableBox } from 'periscope/components/ResizableBox';
import { SpanV3 } from 'types/api/trace/getTraceV3';
+import { TraceDetailsTab } from '../constants';
import { TraceDetailEventKeys, TraceDetailEvents } from '../events';
+import { useSpanDetailsOpenedEvent } from '../hooks/useSpanDetailsOpenedEvent';
import { useSpanDetailVariant } from '../hooks/useSpanDetailVariant';
import { useTraceDetailLogEvent } from '../hooks/useTraceDetailLogEvent';
import NoData from '../NoData/NoData';
@@ -106,6 +108,12 @@ function TraceDetailsOverview({
entityId: selectedSpanId,
onClose: handleSpanDetailsClose,
});
+ useSpanDetailsOpenedEvent({
+ isOpen: panelState.isOpen,
+ spanId: selectedSpan?.span_id,
+ detailsTab: TraceDetailsTab.Overview,
+ logTraceEvent,
+ });
const allSpansRef = useRef<SpanV3[]>([]);
const deepLinkResolvedRef = useRef(false);
@@ -199,6 +207,7 @@ function TraceDetailsOverview({
dataLoadedFiredForRef.current = traceId;
const numServices = new Set(payload.spans.map((s) => s['service.name'])).size;
logTraceEvent(TraceDetailEvents.DataLoaded, {
+ [TraceDetailEventKeys.DetailsTab]: TraceDetailsTab.Overview,
[TraceDetailEventKeys.TotalSpansCount]: totalSpansCount,
[TraceDetailEventKeys.NumServices]: numServices,
[TraceDetailEventKeys.TraceDurationMs]:
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/TraceDetailsThread.tsx b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/TraceDetailsThread.tsx
index 2a6e727ae9..0b84730daa 100644
--- a/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/TraceDetailsThread.tsx
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/TraceDetailsThread.tsx
@@ -1,11 +1,15 @@
+import { MutableRefObject } from 'react';
import { Callout } from '@signozhq/ui/callout';
import { back, hasInAppHistory } from 'lib/router/navigation';
import { useAppParams } from 'lib/router/useAppParams';
import { TraceDetailsTab } from '../constants';
+import { useSpanDetailsOpenedEvent } from '../hooks/useSpanDetailsOpenedEvent';
import { useSpanDetailVariant } from '../hooks/useSpanDetailVariant';
+import { useTraceDetailLogEvent } from '../hooks/useTraceDetailLogEvent';
import { useTraceDetailsTab } from '../hooks/useTraceDetailsTab';
import { SpanDetailVariant } from '../SpanDetailsPanel/constants';
+import { useThreadDataLoadedEvent } from './hooks/useThreadDataLoadedEvent';
import { useThreadSpanSelection } from './hooks/useThreadSpanSelection';
import { useThreadView } from './hooks/useThreadView';
import { useTraceThread } from './hooks/useTraceThread';
@@ -23,7 +27,14 @@ import styles from './TraceDetailsThread.module.scss';
const INITIAL_LOADER_COUNT = 4;
-function TraceDetailsThread(): JSX.Element {
+interface TraceDetailsThreadProps {
+ // Owned by the page so the load event fires once per trace, not per tab visit.
+ dataLoadedFiredForRef: MutableRefObject<string>;
+}
+
+function TraceDetailsThread({
+ dataLoadedFiredForRef,
+}: TraceDetailsThreadProps): JSX.Element {
const { id: traceId } = useAppParams<'id'>();
const [, setTab] = useTraceDetailsTab();
const [view, setView] = useThreadView();
@@ -62,6 +73,21 @@ function TraceDetailsThread(): JSX.Element {
const [spanDetailVariant, setSpanDetailVariant] = useSpanDetailVariant();
const isBottomDocked = spanDetailVariant === SpanDetailVariant.DOCKED;
+ const logTraceEvent = useTraceDetailLogEvent('v3', traceId || '');
+ useThreadDataLoadedEvent({
+ traceId: traceId || '',
+ hasSpans: spans.length > 0,
+ spanPanelVariant: spanDetailVariant,
+ firedForRef: dataLoadedFiredForRef,
+ logTraceEvent,
+ });
+ useSpanDetailsOpenedEvent({
+ isOpen: panelState.isOpen,
+ spanId: selectedSpan?.span_id,
+ detailsTab: TraceDetailsTab.Thread,
+ logTraceEvent,
+ });
+
const spanDetails = panelState.isOpen && selectedSpan && (
<ThreadSpanDetails
panelState={panelState}
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/__tests__/useThreadDataLoadedEvent.test.tsx b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/__tests__/useThreadDataLoadedEvent.test.tsx
new file mode 100644
index 0000000000..7dd56fb8e4
--- /dev/null
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/__tests__/useThreadDataLoadedEvent.test.tsx
@@ -0,0 +1,174 @@
+import { MutableRefObject, ReactNode } from 'react';
+import { QueryClient, QueryClientProvider } from 'react-query';
+import {
+ GetTraceSummary200,
+ SpantypesGettableTraceSummaryDTO,
+} from 'api/generated/services/sigNoz.schemas';
+import { getGetTraceSummaryQueryKey } from 'api/generated/services/tracedetail';
+import { rest, server } from 'mocks-server/server';
+import { renderHook, waitFor } from 'tests/test-utils';
+
+import { TraceDetailsTab } from '../../../constants';
+import { TraceDetailEvents } from '../../../events';
+import { TraceDetailLogEvent } from '../../../hooks/useTraceDetailLogEvent';
+import { SpanDetailVariant } from '../../../SpanDetailsPanel/constants';
+import { useThreadDataLoadedEvent } from '../useThreadDataLoadedEvent';
+
+const SUMMARIES: Record<string, SpantypesGettableTraceSummaryDTO> = {
+ 'trace-a': {
+ startTimestampMillis: 1_000,
+ endTimestampMillis: 4_000,
+ totalSpansCount: 12,
+ totalErrorSpansCount: 2,
+ hasMissingSpans: false,
+ rootServiceEntryPoint: 'POST /chat',
+ rootServiceName: 'agent',
+ rootSpanStatusCode: 'STATUS_CODE_ERROR',
+ },
+ 'trace-b': {
+ startTimestampMillis: 5_000,
+ endTimestampMillis: 5_500,
+ totalSpansCount: 3,
+ totalErrorSpansCount: 0,
+ hasMissingSpans: false,
+ rootServiceEntryPoint: 'POST /chat',
+ rootServiceName: 'agent',
+ rootSpanStatusCode: 'STATUS_CODE_OK',
+ },
+};
+
+interface HookProps {
+ traceId: string;
+ hasSpans: boolean;
+ spanPanelVariant?: SpanDetailVariant;
+}
+
+function renderDataLoadedEvent(
+ initialProps: HookProps,
+ firedForRef: MutableRefObject<string> = { current: '' },
+): {
+ logTraceEvent: jest.MockedFunction<TraceDetailLogEvent>;
+ rerender: (props: HookProps) => void;
+ queryClient: QueryClient;
+} {
+ const logTraceEvent = jest.fn() as jest.MockedFunction<TraceDetailLogEvent>;
+ const queryClient = new QueryClient({
+ defaultOptions: { queries: { retry: false } },
+ });
+ const wrapper = ({ children }: { children: ReactNode }): JSX.Element => (
+ <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+ );
+ const { rerender } = renderHook(
+ ({ traceId, hasSpans, spanPanelVariant }: HookProps) =>
+ useThreadDataLoadedEvent({
+ traceId,
+ hasSpans,
+ spanPanelVariant: spanPanelVariant ?? SpanDetailVariant.DOCKED_RIGHT,
+ firedForRef,
+ logTraceEvent,
+ }),
+ { initialProps, wrapper },
+ );
+ return { logTraceEvent, rerender, queryClient };
+}
+
+describe('useThreadDataLoadedEvent', () => {
+ beforeEach(() => {
+ server.use(
+ rest.get('*/api/v1/traces/:traceId/summary', (req, res, ctx) => {
+ const body: GetTraceSummary200 = {
+ status: 'success',
+ data: SUMMARIES[req.params.traceId as string],
+ };
+ return res(ctx.status(200), ctx.json(body));
+ }),
+ );
+ });
+
+ it('waits for the trace summary, then reports it as a thread load', async () => {
+ const { logTraceEvent } = renderDataLoadedEvent({
+ traceId: 'trace-a',
+ hasSpans: true,
+ });
+
+ expect(logTraceEvent).not.toHaveBeenCalled();
+
+ await waitFor(() => expect(logTraceEvent).toHaveBeenCalledTimes(1));
+ expect(logTraceEvent).toHaveBeenCalledWith(TraceDetailEvents.DataLoaded, {
+ detailsTab: TraceDetailsTab.Thread,
+ totalSpansCount: 12,
+ traceDurationMs: 3_000,
+ hadErrors: true,
+ spanPanelVariant: SpanDetailVariant.DOCKED_RIGHT,
+ });
+ });
+
+ it('waits for the thread spans even when the summary is already loaded', async () => {
+ const { logTraceEvent, rerender, queryClient } = renderDataLoadedEvent({
+ traceId: 'trace-a',
+ hasSpans: false,
+ });
+ await waitFor(() =>
+ expect(
+ queryClient.getQueryData(
+ getGetTraceSummaryQueryKey({ traceID: 'trace-a' }),
+ ),
+ ).toBeDefined(),
+ );
+ rerender({ traceId: 'trace-a', hasSpans: false });
+
+ expect(logTraceEvent).not.toHaveBeenCalled();
+
+ rerender({ traceId: 'trace-a', hasSpans: true });
+
+ expect(logTraceEvent).toHaveBeenCalledTimes(1);
+ });
+
+ it('reports a trace once, including when the tab is visited again', async () => {
+ const firedForRef = { current: '' };
+ const firstVisit = renderDataLoadedEvent(
+ { traceId: 'trace-a', hasSpans: true },
+ firedForRef,
+ );
+ await waitFor(() =>
+ expect(firstVisit.logTraceEvent).toHaveBeenCalledTimes(1),
+ );
+ firstVisit.rerender({
+ traceId: 'trace-a',
+ hasSpans: true,
+ spanPanelVariant: SpanDetailVariant.DOCKED,
+ });
+
+ const secondVisit = renderDataLoadedEvent(
+ { traceId: 'trace-a', hasSpans: true },
+ firedForRef,
+ );
+ await waitFor(() =>
+ expect(
+ secondVisit.queryClient.getQueryData(
+ getGetTraceSummaryQueryKey({ traceID: 'trace-a' }),
+ ),
+ ).toBeDefined(),
+ );
+ secondVisit.rerender({ traceId: 'trace-a', hasSpans: true });
+
+ expect(firstVisit.logTraceEvent).toHaveBeenCalledTimes(1);
+ expect(secondVisit.logTraceEvent).not.toHaveBeenCalled();
+ });
+
+ it('reports the next trace with its own summary', async () => {
+ const { logTraceEvent, rerender } = renderDataLoadedEvent({
+ traceId: 'trace-a',
+ hasSpans: true,
+ });
+ await waitFor(() => expect(logTraceEvent).toHaveBeenCalledTimes(1));
+
+ rerender({ traceId: 'trace-b', hasSpans: true });
+
+ await waitFor(() => expect(logTraceEvent).toHaveBeenCalledTimes(2));
+ expect(logTraceEvent).toHaveBeenLastCalledWith(
+ TraceDetailEvents.DataLoaded,
+ expect.objectContaining({ totalSpansCount: 3, traceDurationMs: 500 }),
+ );
+ });
+});
diff --git a/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/useThreadDataLoadedEvent.ts b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/useThreadDataLoadedEvent.ts
new file mode 100644
index 0000000000..0c6ed4121d
--- /dev/null
+++ b/frontend/src/pages/TraceDetailsV3/TraceDetailsThread/hooks/useThreadDataLoadedEvent.ts
@@ -0,0 +1,45 @@
+import { MutableRefObject, useEffect } from 'react';
+import { useGetTraceSummary } from 'api/generated/services/tracedetail';
+
+import { TraceDetailsTab } from '../../constants';
+import { TraceDetailEventKeys, TraceDetailEvents } from '../../events';
+import { TraceDetailLogEvent } from '../../hooks/useTraceDetailLogEvent';
+import { SpanDetailVariant } from '../../SpanDetailsPanel/constants';
+
+interface ThreadDataLoadedEventArgs {
+ traceId: string;
+ hasSpans: boolean;
+ spanPanelVariant: SpanDetailVariant;
+ firedForRef: MutableRefObject<string>;
+ logTraceEvent: TraceDetailLogEvent;
+}
+
+export function useThreadDataLoadedEvent({
+ traceId,
+ hasSpans,
+ spanPanelVariant,
+ firedForRef,
+ logTraceEvent,
+}: ThreadDataLoadedEventArgs): void {
+ // No keepPreviousData: a previous trace's summary must not be reported for this one.
+ const { data } = useGetTraceSummary(
+ { traceID: traceId },
+ { query: { enabled: !!traceId, refetchOnMount: false } },
+ );
+ const summary = data?.data;
+
+ useEffect(() => {
+ if (!traceId || firedForRef.current === traceId || !hasSpans || !summary) {
+ return;
+ }
+ firedForRef.current = traceId;
+ logTraceEvent(TraceDetailEvents.DataLoaded, {
+ [TraceDetailEventKeys.DetailsTab]: TraceDetailsTab.Thread,
+ [TraceDetailEventKeys.TotalSpansCount]: summary.totalSpansCount,
+ [TraceDetailEventKeys.TraceDurationMs]:
+ summary.endTimestampMillis - summary.startTimestampMillis,
+ [TraceDetailEventKeys.HadErrors]: summary.totalErrorSpansCount > 0,
+ [TraceDetailEventKeys.SpanPanelVariant]: spanPanelVariant,
+ });
+ }, [traceId, hasSpans, summary, spanPanelVariant, firedForRef, logTraceEvent]);
+}
diff --git a/frontend/src/pages/TraceDetailsV3/events.ts b/frontend/src/pages/TraceDetailsV3/events.ts
index 039170845d..0c95300688 100644
--- a/frontend/src/pages/TraceDetailsV3/events.ts
+++ b/frontend/src/pages/TraceDetailsV3/events.ts
@@ -12,6 +12,8 @@ export enum TraceDetailEvents {
SpanPercentileTimeRangeChanged = 'Trace Detail: Span percentile time range changed',
SpanPercentileAttributesSelectorToggled = 'Trace Detail: Span percentile attributes selector toggled',
SpanPercentileAttributeChanged = 'Trace Detail: Span percentile attribute changed',
+ SpanDetailsOpened = 'Trace Detail: Span details opened',
+ DetailsTabChanged = 'Trace Detail: Details tab changed',
}
export enum TraceDetailEventKeys {
@@ -28,7 +30,7 @@ export enum TraceDetailEventKeys {
SpanPanelVariant = 'spanPanelVariant',
ColorByField = 'colorByField',
PreviewFieldsCount = 'previewFieldsCount',
- // View switched
+ // View switched / details tab changed
From = 'from',
To = 'to',
DwellMs = 'dwellMs',
@@ -44,6 +46,8 @@ export enum TraceDetailEventKeys {
PercentileValue = 'percentileValue',
ResourceAttributeKey = 'resourceAttributeKey',
Selected = 'selected',
+ // Data loaded / span details opened: which tab the user is on
+ DetailsTab = 'detailsTab',
}
export type TraceDetailView = 'v2' | 'v3';
diff --git a/frontend/src/pages/TraceDetailsV3/hooks/__tests__/useSpanDetailsOpenedEvent.test.tsx b/frontend/src/pages/TraceDetailsV3/hooks/__tests__/useSpanDetailsOpenedEvent.test.tsx
new file mode 100644
index 0000000000..c8682a5990
--- /dev/null
+++ b/frontend/src/pages/TraceDetailsV3/hooks/__tests__/useSpanDetailsOpenedEvent.test.tsx
@@ -0,0 +1,90 @@
+import { renderHook } from 'tests/test-utils';
+
+import { TraceDetailsTab } from '../../constants';
+import { TraceDetailEvents } from '../../events';
+import { useSpanDetailsOpenedEvent } from '../useSpanDetailsOpenedEvent';
+import { TraceDetailLogEvent } from '../useTraceDetailLogEvent';
+
+interface PanelProps {
+ isOpen: boolean;
+ spanId?: string;
+}
+
+function renderOpenedEvent(initialProps: PanelProps): {
+ logTraceEvent: jest.MockedFunction<TraceDetailLogEvent>;
+ rerender: (props: PanelProps) => void;
+} {
+ const logTraceEvent = jest.fn() as jest.MockedFunction<TraceDetailLogEvent>;
+ const { rerender } = renderHook(
+ ({ isOpen, spanId }: PanelProps) =>
+ useSpanDetailsOpenedEvent({
+ isOpen,
+ spanId,
+ detailsTab: TraceDetailsTab.Thread,
+ logTraceEvent,
+ }),
+ { initialProps },
+ );
+ return { logTraceEvent, rerender };
+}
+
+function openedSpanIds(
+ logTraceEvent: jest.MockedFunction<TraceDetailLogEvent>,
+): unknown[] {
+ return logTraceEvent.mock.calls.map(([, attributes]) => attributes?.spanId);
+}
+
+describe('useSpanDetailsOpenedEvent', () => {
+ it('waits for the panel to be open on a span, then reports it with the tab', () => {
+ const { logTraceEvent, rerender } = renderOpenedEvent({ isOpen: false });
+ rerender({ isOpen: true });
+ rerender({ isOpen: false, spanId: 'span-1' });
+
+ expect(logTraceEvent).not.toHaveBeenCalled();
+
+ rerender({ isOpen: true, spanId: 'span-1' });
+
+ expect(logTraceEvent).toHaveBeenCalledTimes(1);
+ expect(logTraceEvent).toHaveBeenCalledWith(
+ TraceDetailEvents.SpanDetailsOpened,
+ { spanId: 'span-1', detailsTab: TraceDetailsTab.Thread },
+ );
+ });
+
+ it('does not repeat while the same span stays open', () => {
+ const { logTraceEvent, rerender } = renderOpenedEvent({
+ isOpen: true,
+ spanId: 'span-1',
+ });
+ rerender({ isOpen: true, spanId: 'span-1' });
+ rerender({ isOpen: true, spanId: 'span-1' });
+
+ expect(logTraceEvent).toHaveBeenCalledTimes(1);
+ });
+
+ it('reports the same span again after the panel is closed and reopened', () => {
+ const { logTraceEvent, rerender } = renderOpenedEvent({
+ isOpen: true,
+ spanId: 'span-1',
+ });
+ rerender({ isOpen: false });
+ rerender({ isOpen: true, spanId: 'span-1' });
+
+ expect(openedSpanIds(logTraceEvent)).toStrictEqual(['span-1', 'span-1']);
+ });
+
+ it('reports each span selected while the panel stays open', () => {
+ const { logTraceEvent, rerender } = renderOpenedEvent({
+ isOpen: true,
+ spanId: 'span-1',
+ });
+ rerender({ isOpen: true, spanId: 'span-2' });
+ rerender({ isOpen: true, spanId: 'span-3' });
+
+ expect(openedSpanIds(logTraceEvent)).toStrictEqual([
+ 'span-1',
+ 'span-2',
+ 'span-3',
+ ]);
+ });
+});
diff --git a/frontend/src/pages/TraceDetailsV3/hooks/useSpanDetailsOpenedEvent.ts b/frontend/src/pages/TraceDetailsV3/hooks/useSpanDetailsOpenedEvent.ts
new file mode 100644
index 0000000000..198dd57020
--- /dev/null
+++ b/frontend/src/pages/TraceDetailsV3/hooks/useSpanDetailsOpenedEvent.ts
@@ -0,0 +1,30 @@
+import { useEffect } from 'react';
+
+import { TraceDetailsTab } from '../constants';
+import { TraceDetailEventKeys, TraceDetailEvents } from '../events';
+import { TraceDetailLogEvent } from './useTraceDetailLogEvent';
+
+interface SpanDetailsOpenedEventArgs {
+ isOpen: boolean;
+ spanId: string | undefined;
+ detailsTab: TraceDetailsTab;
+ logTraceEvent: TraceDetailLogEvent;
+}
+
+// Fires once per span shown in the details panel; resets when the panel closes.
+export function useSpanDetailsOpenedEvent({
+ isOpen,
+ spanId,
+ detailsTab,
+ logTraceEvent,
+}: SpanDetailsOpenedEventArgs): void {
+ useEffect(() => {
+ if (!isOpen || !spanId) {
+ return;
+ }
+ logTraceEvent(TraceDetailEvents.SpanDetailsOpened, {
+ [TraceDetailEventKeys.SpanId]: spanId,
+ [TraceDetailEventKeys.DetailsTab]: detailsTab,
+ });
+ }, [isOpen, spanId, detailsTab, logTraceEvent]);
+}
diff --git a/frontend/src/pages/TraceDetailsV3/index.tsx b/frontend/src/pages/TraceDetailsV3/index.tsx
index dfd4732107..7dc571171d 100644
--- a/frontend/src/pages/TraceDetailsV3/index.tsx
+++ b/frontend/src/pages/TraceDetailsV3/index.tsx
@@ -16,6 +16,7 @@ function TraceDetailsV3(): JSX.Element {
// Tracks which traceId the load event already fired for, so navigating
// between traces (the route component stays mounted) re-fires it once each.
const dataLoadedFiredForRef = useRef<string>('');
+ const threadDataLoadedFiredForRef = useRef<string>('');
const handleFilteredSpansChange = useCallback(
(spanIds: string[], isActive: boolean): void => {
@@ -39,7 +40,7 @@ function TraceDetailsV3(): JSX.Element {
dataLoadedFiredForRef={dataLoadedFiredForRef}
/>
) : (
- <TraceDetailsThread />
+ <TraceDetailsThread dataLoadedFiredForRef={threadDataLoadedFiredForRef} />
)}
</TraceDetailsWrapper>
);