Skip to content

Track events coming from the Web IDE

Enrique Alcántara requested to merge 387056-instrument-remote-development-connection-in-the-webide into master

What does this MR do and why?

  • It routes tracking events sent by the Web IDE to Snowplow.

The Web IDE sends three events to identify when connecting to a remote development environment starts, succeeds, or fails.

Event Description
remote_connection_start User starts a connection to a remote development environment
remote_connection_success VSCode successfully connects to a remote development environment
remote_connection_failure VScode could not connect a remote development environment.

Implementation details

Read the following documentation to understand how instrumentation works in the Web IDE: https://gitlab.com/gitlab-org/gitlab-web-ide/-/blob/main/docs/dev/instrumentation.md

Screenshots or screen recordings

This MR does not introduce user-facing changes.

How to set up and validate locally

  1. You can use snowplow Chrome extensions to check that events are sent successfully: https://docs.gitlab.com/ee/development/snowplow/implementation.html#develop-and-test-snowplow
  2. Start a remote development connection in the Web IDE.
  3. Snowplow will capture the events described in the table above depending on the connection outcome.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #387056 (closed)

Edited by Enrique Alcántara

Merge request reports