Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

telemetry: add notifications telemetry #5956

Merged
merged 1 commit into from
Nov 8, 2024

Conversation

hayemaxi
Copy link
Contributor

@hayemaxi hayemaxi commented Nov 7, 2024

I explored sending telemetry if the user hides or unhides the notification view panel. However, there is no VSC hook to detect this and other ways (e.g. checking visible property) are not reliable. So, we cannot track this.

  • toolkit_showNotification
    • for displaying notifications on receive or when clicked on
  • toolkit_invokeAction
    • invoking an action from a notification, e.g. clicking on a button in the notification or opening a text document
  • ui_click for clicking on the notifications node or dismiss button

License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

@hayemaxi hayemaxi requested a review from a team as a code owner November 7, 2024 21:45
Comment on lines 212 to 217
telemetry.ui_click.emit({
elementId: `${getNotificationTelemetryId(notification)}:DISMISS`,
result: 'Succeeded',
})

await NotificationsController.instance.dismissNotification(notification.id)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it worth forming it as a run() around this call?

elementId: getNotificationTelemetryId(n),
result: 'Succeeded',
})
return this.openNotification(n)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

telemetry.ui_click.run() ?

await openUrl(vscode.Uri.parse(selectedButton.url))
} else {
throw new ToolkitError('url not provided')
return vscode.window
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Future: could use #5776 here.

I explored sending telemetry if the user hides or unhides the notification view panel. However, there is no VSC hook to detect this and other ways (e.g. checking visible property) are not reliable. So, we cannot track this.

- toolkit_showNotification
  - for displaying notifications on receive or when clicked on
- toolkit_invokeAction
  - invoking an action from a notification, e.g. clicking on a button in the notification or opening a text document
- ui_click for clicking on the notifications node or dismiss button
@hayemaxi hayemaxi merged commit aac385c into aws:master Nov 8, 2024
23 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants