Skip to content

Track clicks on the pipeline editor help drawer

Mireya Andres requested to merge track-pipeline-editor-help-drawer into master

What does this MR do and why?

For #358912 (closed)

This sets up tracking (via snowplow) for when the user clicks on the Help button on the pipeline editor page.

Since we're not sure if we're tracking dot com docs referrals correctly, I also added tracking for the doc links as well.

Screenshots or screen recordings

Screen_Recording_2022-05-23_at_15.17.44

How to set up and validate locally

Set up Snowplow Testing

  1. Make sure Do Not Track browser setting is disabled. Disable other anti-tracking plugins (e.g. uBlock, Ghostery, etc).
  2. Enable Snowplow tracking on admin (Docs). We can use the following values in the form.
Hostname: your-snowplow-collector.net
App ID: gitlab
Cookie domain: .your-gitlab-instance.com
  1. Install the Snowplow Debugger or Snowplow Inspector plugin. Either works. Docs
  2. Optional: Set up Snowplow Micro. This will streamline the events being recorded. If snowplow micro is not set up, multiple events will be recorded as the app tries to resend them.
    1. Make sure docker is running and gdk is configured to use it. To know if micro was set up correctly, visit http://localhost:9091/micro/all.

Verify Changes

  1. Open the debugger menu on the browser then go to the pipeline editor (CI/CD > Editor).
  2. If events are not being recorded, you may need to refresh the page with the menu open.
  3. Click on the Help button and the links that show up in the help drawer.
  4. Verify that the button and link clicks are tracked properly.

MR acceptance checklist

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

Edited by Mireya Andres

Merge request reports