Skip to content

Migrate VSD metric drill-down event tracking to Internal Events Tracking

Rudy Crespo requested to merge 416584-migrate-vsd-metrics-event-tracking into master

What does this MR do and why?

Migrates Value Streams Dashboard metric drill-down Snowplow event tracking to Internal Events Tracking. As per the guidance in #416584 (comment 1598448198), it creates the following event/metric definitions for each VSD metric to track when they are clicked:

  • value_streams_dashboard_${identifier}_link_clicked
    • Distinct user counts for the 7d 28d time periods
    • Total counts for the 28d time period

In addition, to sum up the above metrics, it creates the following event/metric definitions to track when any VSD metric is clicked:

  • value_streams_dashboard_metric_link_clicked
    • Distinct user counts for the 7d 28d time periods
    • Total counts for the 28d time period

Screenshots or screen recordings

No visual changes.

How to set up and validate locally

  1. Please make sure that you have a GitLab Ultimate license.
  2. Seed VSD data: FILTER=cycle_analytics SEED_VSA=1 bundle exec rake db:seed_fu
  3. Follow the link to the new project return by the seeder above, and visit its VSD: http://${LOCAL_INSTANCE}/groups/${GROUP_PATH}/-/analytics/dashboards/value_streams_dashboard
  4. Start the Internal Events monitor in the terminal (for more details, see the docs)
  5. Click on every VSD metric in the comparison table and ensure that each click event is being tracked in the Internal Events monitor.

Internal Events Monitor

rails runner scripts/internal_events/monitor.rb value_streams_dashboard_metric_link_clicked value_streams_dashboard_issues_completed_link_clicked value_streams_dashboard_lead_time_link_clicked value_streams_dashboard_cycle_time_link_clicked value_streams_dashboard_issues_link_clicked value_streams_dashboard_deploys_link_clicked value_streams_dashboard_deployment_frequency_link_clicked value_streams_dashboard_lead_time_for_changes_link_clicked value_streams_dashboard_time_to_restore_service_link_clicked value_streams_dashboard_change_failure_rate_link_clicked value_streams_dashboard_vulnerability_critical_link_clicked value_streams_dashboard_vulnerability_high_link_clicked value_streams_dashboard_merge_request_throughput_link_clicked

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 #416584 (closed)

Edited by Rudy Crespo

Merge request reports