Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion src/platform/telemetry/TelemetryRegistry.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import type {
AgentPanelOpenedMetadata,
AgentPaywallCtaMetadata,
AgentPaywallShownMetadata,
AgentStarterPromptClickedMetadata,
AgentWorkflowAppliedMetadata,
BillingTelemetryEvent,
CheckoutJourneyTelemetryEvent,
Expand Down Expand Up @@ -298,8 +299,19 @@ describe('TelemetryRegistry', () => {
thread_id: 'th-1',
workflow_id: 'w1',
client_message_id: 'cm-1',
input_method: 'typed'
input_method: 'typed',
starter_prompt_id: null,
starter_prompt_click_id: null
} satisfies AgentMessageSentMetadata
const starterPromptClickedMetadata = {
prompt_id: 'generate_image',
prompt_index: 0,
prompt_count: 5,
prompt_text_hash: 'deadbeef',
locale: 'en',
click_id: 'click-1',
draft_was_empty: true
} satisfies AgentStarterPromptClickedMetadata
const consentShownMetadata = {
trigger: 'button_click'
} satisfies AgentConsentShownMetadata
Expand Down Expand Up @@ -365,6 +377,12 @@ describe('TelemetryRegistry', () => {
invoke: (registry) =>
registry.trackAgentMessageSent(messageSentMetadata)
},
{
method: 'trackAgentStarterPromptClicked',
expected: { ...starterPromptClickedMetadata },
invoke: (registry) =>
registry.trackAgentStarterPromptClicked(starterPromptClickedMetadata)
},
{
method: 'trackAgentConsentShown',
expected: { ...consentShownMetadata },
Expand Down
9 changes: 9 additions & 0 deletions src/platform/telemetry/TelemetryRegistry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import type {
AgentRunApprovalResolvedMetadata,
AgentRunApprovalShownMetadata,
AgentRunModeChangedMetadata,
AgentStarterPromptClickedMetadata,
AgentStopClickedMetadata,
AgentThreadStartedMetadata,
AgentWorkflowBoundMetadata,
Expand Down Expand Up @@ -420,6 +421,14 @@ export class TelemetryRegistry implements TelemetryDispatcher {
this.dispatch((provider) => provider.trackAgentMessageSent?.(metadata))
}

trackAgentStarterPromptClicked(
metadata: AgentStarterPromptClickedMetadata
): void {
this.dispatch((provider) =>
provider.trackAgentStarterPromptClicked?.(metadata)
)
}

trackAgentNodeTagged(metadata: AgentNodeTaggedMetadata): void {
this.dispatch((provider) => provider.trackAgentNodeTagged?.(metadata))
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,9 @@ describe('PostHogTelemetryProvider', () => {
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'suggestion'
input_method: 'suggestion',
starter_prompt_id: 'list_workflows',
starter_prompt_click_id: 'click-1'
})

expect(hoisted.mockCapture).toHaveBeenCalledWith(
Expand All @@ -483,7 +485,37 @@ describe('PostHogTelemetryProvider', () => {
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'suggestion'
input_method: 'suggestion',
starter_prompt_id: 'list_workflows',
starter_prompt_click_id: 'click-1'
}
)
})

it('captures a starter prompt click with its slot identity', async () => {
const provider = createProvider()
await vi.dynamicImportSettled()

provider.trackAgentStarterPromptClicked({
prompt_id: 'find_workflow',
prompt_index: 2,
prompt_count: 5,
prompt_text_hash: 'deadbeef',
locale: 'en',
click_id: 'click-1',
draft_was_empty: true
})

expect(hoisted.mockCapture).toHaveBeenCalledWith(
TelemetryEvents.AGENT_STARTER_PROMPT_CLICKED,
{
prompt_id: 'find_workflow',
prompt_index: 2,
prompt_count: 5,
prompt_text_hash: 'deadbeef',
locale: 'en',
click_id: 'click-1',
draft_was_empty: true
}
)
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import type {
AgentRunApprovalResolvedMetadata,
AgentRunApprovalShownMetadata,
AgentRunModeChangedMetadata,
AgentStarterPromptClickedMetadata,
AgentStopClickedMetadata,
AgentThreadStartedMetadata,
AgentWorkflowBoundMetadata,
Expand Down Expand Up @@ -782,6 +783,12 @@ export class PostHogTelemetryProvider implements TelemetryProvider {
this.trackEvent(TelemetryEvents.AGENT_MESSAGE_SENT, metadata)
}

trackAgentStarterPromptClicked(
metadata: AgentStarterPromptClickedMetadata
): void {
this.trackEvent(TelemetryEvents.AGENT_STARTER_PROMPT_CLICKED, metadata)
}

trackAgentNodeTagged(metadata: AgentNodeTaggedMetadata): void {
this.trackEvent(TelemetryEvents.AGENT_NODE_TAGGED, metadata)
}
Expand Down
213 changes: 124 additions & 89 deletions src/platform/telemetry/providers/host/HostTelemetrySink.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,118 @@ describe('HostTelemetrySink', () => {
})

it.for([
{
name: TelemetryEvents.AGENT_MESSAGE_FEEDBACK,
track: (sink: HostTelemetrySink) =>
sink.trackAgentMessageFeedback({
message_id: 'message-1',
turn_id: 'message-1',
vote: 'up',
workflow_id: 'workflow-1'
}),
properties: {
message_id: 'message-1',
turn_id: 'message-1',
vote: 'up',
workflow_id: 'workflow-1'
}
},
{
name: TelemetryEvents.AGENT_PANEL_OPENED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentPanelOpened({ source: 'topbar_button' }),
properties: { source: 'topbar_button' }
},
{
name: TelemetryEvents.AGENT_PANEL_CLOSED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentPanelClosed({
source: 'close_button',
open_duration_ms: 1234
}),
properties: { source: 'close_button', open_duration_ms: 1234 }
},
{
name: TelemetryEvents.AGENT_ENTRY_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentEntryButtonClicked({ resulting_state: 'opened' }),
properties: { resulting_state: 'opened' }
},
{
name: TelemetryEvents.AGENT_CLOSE_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) => sink.trackAgentCloseButtonClicked(),
properties: undefined
},
{
name: TelemetryEvents.AGENT_MESSAGE_SENT,
track: (sink: HostTelemetrySink) =>
sink.trackAgentMessageSent({
attachment_count: 2,
node_tag_count: 1,
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'suggestion',
starter_prompt_id: 'list_workflows',
starter_prompt_click_id: 'click-1'
}),
properties: {
attachment_count: 2,
node_tag_count: 1,
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'suggestion',
starter_prompt_id: 'list_workflows',
starter_prompt_click_id: 'click-1'
}
},
{
name: TelemetryEvents.AGENT_MESSAGE_SENT,
track: (sink: HostTelemetrySink) =>
sink.trackAgentMessageSent({
attachment_count: 0,
node_tag_count: 0,
thread_id: null,
workflow_id: null,
client_message_id: 'client-message-2',
input_method: 'typed',
starter_prompt_id: null,
starter_prompt_click_id: null
}),
properties: {
attachment_count: 0,
node_tag_count: 0,
thread_id: null,
workflow_id: null,
client_message_id: 'client-message-2',
input_method: 'typed',
starter_prompt_id: null,
starter_prompt_click_id: null
}
},
{
name: TelemetryEvents.AGENT_STARTER_PROMPT_CLICKED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentStarterPromptClicked({
prompt_id: 'explain_selected_node',
prompt_index: 3,
prompt_count: 5,
prompt_text_hash: 'deadbeef',
locale: 'en',
click_id: 'click-1',
draft_was_empty: false
}),
properties: {
prompt_id: 'explain_selected_node',
prompt_index: 3,
prompt_count: 5,
prompt_text_hash: 'deadbeef',
locale: 'en',
click_id: 'click-1',
draft_was_empty: false
}
},
{
name: TelemetryEvents.AGENT_CONSENT_SHOWN,
track: (sink: HostTelemetrySink) =>
Expand All @@ -252,6 +364,18 @@ describe('HostTelemetrySink', () => {
sink.trackAgentOnboardingStep({ step: 4, action: 'finish' }),
properties: { step: 4, action: 'finish' }
},
{
name: TelemetryEvents.AGENT_NODE_TAGGED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentNodeTagged({ source: 'mention_picker' }),
properties: { source: 'mention_picker' }
},
{
name: TelemetryEvents.AGENT_ATTACH_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentAttachButtonClicked({ method: 'drag_drop' }),
properties: { method: 'drag_drop' }
},
{
name: TelemetryEvents.AGENT_STOP_CLICKED,
track: (sink: HostTelemetrySink) =>
Expand Down Expand Up @@ -312,95 +436,6 @@ describe('HostTelemetrySink', () => {
sink.trackAgentThreadStarted({ source: 'new_chat_button' }),
properties: { source: 'new_chat_button' }
},
{
name: TelemetryEvents.AGENT_CONSENT_NOT_OFFERED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentConsentNotOffered({ reason: 'tour_active' }),
properties: { reason: 'tour_active' }
},
{
name: TelemetryEvents.AGENT_ONBOARDING_NOT_SHOWN,
track: (sink: HostTelemetrySink) =>
sink.trackAgentOnboardingNotShown({
reason: 'target_missing',
step: 2
}),
properties: { reason: 'target_missing', step: 2 }
},
{
name: TelemetryEvents.AGENT_MESSAGE_FEEDBACK,
track: (sink: HostTelemetrySink) =>
sink.trackAgentMessageFeedback({
message_id: 'message-1',
turn_id: 'message-1',
vote: 'up',
workflow_id: 'workflow-1'
}),
properties: {
message_id: 'message-1',
turn_id: 'message-1',
vote: 'up',
workflow_id: 'workflow-1'
}
},
{
name: TelemetryEvents.AGENT_PANEL_OPENED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentPanelOpened({ source: 'topbar_button' }),
properties: { source: 'topbar_button' }
},
{
name: TelemetryEvents.AGENT_PANEL_CLOSED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentPanelClosed({
source: 'close_button',
open_duration_ms: 1234
}),
properties: { source: 'close_button', open_duration_ms: 1234 }
},
{
name: TelemetryEvents.AGENT_ENTRY_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentEntryButtonClicked({ resulting_state: 'opened' }),
properties: { resulting_state: 'opened' }
},
{
name: TelemetryEvents.AGENT_CLOSE_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) => sink.trackAgentCloseButtonClicked(),
properties: undefined
},
{
name: TelemetryEvents.AGENT_MESSAGE_SENT,
track: (sink: HostTelemetrySink) =>
sink.trackAgentMessageSent({
attachment_count: 2,
node_tag_count: 1,
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'typed'
}),
properties: {
attachment_count: 2,
node_tag_count: 1,
thread_id: 'thread-1',
workflow_id: 'workflow-1',
client_message_id: 'client-message-1',
input_method: 'typed'
}
},
{
name: TelemetryEvents.AGENT_NODE_TAGGED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentNodeTagged({ source: 'mention_picker' }),
properties: { source: 'mention_picker' }
},
{
name: TelemetryEvents.AGENT_ATTACH_BUTTON_CLICKED,
track: (sink: HostTelemetrySink) =>
sink.trackAgentAttachButtonClicked({ method: 'drag_drop' }),
properties: { method: 'drag_drop' }
},
{
name: TelemetryEvents.AGENT_WORKFLOW_APPLIED,
track: (sink: HostTelemetrySink) =>
Expand Down
Loading
Loading