From 7acdbd3351ceafb3537d087ea85bfcbd2360b4f5 Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Tue, 5 Jul 2022 14:27:38 -0600 Subject: [PATCH 1/7] Add instructions for adding metrics to widget extension telemetry --- .../components/extensions/README.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md diff --git a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md new file mode 100644 index 00000000000000..4806fcaf110691 --- /dev/null +++ b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md @@ -0,0 +1,56 @@ +### Widget Extensions + +#### Telemetry + +Telemetry is enabled by default in all widget extensions. + +However, telemetry events are not reported until they have been marked as a "known event" with a Metric Dictionary. + +If telemetry metrics are desired when adding a widget extension, it is important to also create known events. + +The following steps are needed to generate these known events for a single widget: + +1. Widgets should be named `Widget${CamelName}`. + - For example: a widget for "Test Reports" should be `WidgetTestReports` +1. "Compute" the widget name slug by converting the `${CamelName}` to lower-, snake-case. + - The above example would be `test_reports` +1. Ensure the GDK is running (`gdk start`) +1. Generate known events on the command line with the following command. Replace `test_reports` with your appropriate name slug. + ``` + bundle exec rails generate gitlab:usage_metric_definition \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_view \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_full_report_clicked \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_expand \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_success \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_warning \ + counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_failed \ + --dir=all + ``` +1. Modify each newly generated file so that they match the existing files for MR Widget Extension telemetry. + - You can find existing examples by doing a glob search like so: `metrics/**/*_i_merge_request_widget_*` + - Roughly-speaking, each file should have these values: + 1. `description` = A plain English description of this value. Please see existing widget extension telemetry files for examples. + - Keep in mind that the `expand` events also report the widget status, so there needs to be events for the `expand_success`, `expand_warning`, and `expand_failure` states, too. + 1. `product_section` = `dev` + 1. `product_stage` = `create` + 1. `product_group` = `code_review` + 1. `product_category` = `code_review` + 1. `introduced_by_url` = `'[your MR]'` + 1. `options.events` = (the event in the command from above that generated this file, like `i_merge_request_widget_test_reports_count_view`) + - This is how the telemetry events are linked to "metrics" so this is probably one of the more important values + 1. `data_source` = `redis` OR `redis_hll` (depends on whether this is a regular counter or a unique-users counter, respectively) + 1. `data_category` = `optional` +1. Repeat the previous two steps for each of the HLL metrics. Replace `test_reports` with your appropriate name slug. + - Note that the `:redis_hll` command fails to create multiple metrics at once. You will need to create each one, modify it with the correct values, and then move to the next one (blank metrics cause a fatal error when trying to generate the next one). + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_view --class_name=RedisHLLMetric` + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_full_report_clicked --class_name=RedisHLLMetric` + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand --class_name=RedisHLLMetric` + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_success --class_name=RedisHLLMetric` + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_warning --class_name=RedisHLLMetric` + 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_failed --class_name=RedisHLLMetric` +1. Add each of the HLL metrics to `lib/gitlab/usage_data_counters/known_events/code_review_events.yml` + - You **MUST** do this **after** completely finishing all of the generation in the previous steps, or it will create fatal errors. + 1. `name` = [the event] + 1. `redis_slot` = `code_review` + 1. `category` = `code_review` + 1. `aggregation` = `weekly` -- GitLab From 96ae34b302e2f3d490dbb7aa963b0cec50fe40fe Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Fri, 8 Jul 2022 11:42:03 -0600 Subject: [PATCH 2/7] Add metrics for the test Summary MR Widget Extension --- ...quest_widget_test_summary_view_monthly.yml | 25 ++++++++++++++++++ ...st_summary_full_report_clicked_monthly.yml | 25 ++++++++++++++++++ ...est_widget_test_summary_expand_monthly.yml | 25 ++++++++++++++++++ ...et_test_summary_expand_success_monthly.yml | 25 ++++++++++++++++++ ...et_test_summary_expand_warning_monthly.yml | 25 ++++++++++++++++++ ...get_test_summary_expand_failed_monthly.yml | 25 ++++++++++++++++++ ...equest_widget_test_summary_view_weekly.yml | 25 ++++++++++++++++++ ...est_summary_full_report_clicked_weekly.yml | 25 ++++++++++++++++++ ...uest_widget_test_summary_expand_weekly.yml | 25 ++++++++++++++++++ ...get_test_summary_expand_success_weekly.yml | 25 ++++++++++++++++++ ...get_test_summary_expand_warning_weekly.yml | 25 ++++++++++++++++++ ...dget_test_summary_expand_failed_weekly.yml | 25 ++++++++++++++++++ ...request_widget_test_summary_count_view.yml | 24 +++++++++++++++++ ...test_summary_count_full_report_clicked.yml | 24 +++++++++++++++++ ...quest_widget_test_summary_count_expand.yml | 24 +++++++++++++++++ ...dget_test_summary_count_expand_success.yml | 24 +++++++++++++++++ ...dget_test_summary_count_expand_warning.yml | 24 +++++++++++++++++ ...idget_test_summary_count_expand_failed.yml | 24 +++++++++++++++++ .../known_events/code_review_events.yml | 26 +++++++++++++++++++ 19 files changed, 470 insertions(+) create mode 100644 config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml create mode 100644 config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml create mode 100644 config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml create mode 100644 config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml create mode 100644 config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml create mode 100644 config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml create mode 100644 config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml create mode 100644 config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml create mode 100644 config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml create mode 100644 config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml create mode 100644 config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml create mode 100644 config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml create mode 100644 config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml create mode 100644 config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml create mode 100644 config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml create mode 100644 config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml create mode 100644 config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml create mode 100644 config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml diff --git a/config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml b/config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml new file mode 100644 index 00000000000000..49ed079f1b68dc --- /dev/null +++ b/config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_view_monthly +description: The count of unique users (monthly) who were able to see the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_view +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml b/config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml new file mode 100644 index 00000000000000..f907a5845aac12 --- /dev/null +++ b/config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_full_report_clicked_monthly +description: The count of unique users (monthly) who clicked the Full Report button on the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_full_report_clicked +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml b/config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml new file mode 100644 index 00000000000000..b36286af668306 --- /dev/null +++ b/config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_monthly +description: The count of unique users (monthly) who expanded the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml b/config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml new file mode 100644 index 00000000000000..d208d5f18ecad5 --- /dev/null +++ b/config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_success_monthly +description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Success state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_success +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml b/config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml new file mode 100644 index 00000000000000..71c03f3127d1db --- /dev/null +++ b/config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_warning_monthly +description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Warning state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_warning +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml b/config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml new file mode 100644 index 00000000000000..2303dcac5daa61 --- /dev/null +++ b/config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_failed_monthly +description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Failed state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 28d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_failed +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml b/config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml new file mode 100644 index 00000000000000..3a80b6275b6f3a --- /dev/null +++ b/config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_view_weekly +description: The count of unique users (weekly) who were able to see the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_view +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml b/config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml new file mode 100644 index 00000000000000..38f25e69c72689 --- /dev/null +++ b/config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_full_report_clicked_weekly +description: The count of unique users (weekly) who clicked the Full Report button on the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_full_report_clicked +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml b/config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml new file mode 100644 index 00000000000000..4809e1406ef2d7 --- /dev/null +++ b/config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_weekly +description: The count of unique users (weekly) who expanded the Test Summary widget extension +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml b/config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml new file mode 100644 index 00000000000000..bc7d5b11594a82 --- /dev/null +++ b/config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_success_weekly +description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Success state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_success +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml b/config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml new file mode 100644 index 00000000000000..fe9ebc6c06f166 --- /dev/null +++ b/config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_warning_weekly +description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Warning state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_warning +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml b/config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml new file mode 100644 index 00000000000000..7224a309c83482 --- /dev/null +++ b/config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml @@ -0,0 +1,25 @@ +--- +key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_failed_weekly +description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Failed state +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: 7d +data_source: redis_hll +data_category: optional +instrumentation_class: RedisHLLMetric +options: + events: + - i_merge_request_widget_test_summary_expand_failed +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml b/config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml new file mode 100644 index 00000000000000..a4c26823613118 --- /dev/null +++ b/config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_view +description: Total number of times the Test Summary widget extension was viewed (rendered to the screen) +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_view +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml b/config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml new file mode 100644 index 00000000000000..393a721aedb44e --- /dev/null +++ b/config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_full_report_clicked +description: Total number of times the Test Summary widget extension Full Report button was clicked +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_full_report_clicked +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml b/config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml new file mode 100644 index 00000000000000..9d68687c312915 --- /dev/null +++ b/config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand +description: Total number of times the Test Summary widget extension was expanded (in any state) +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_expand +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml b/config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml new file mode 100644 index 00000000000000..dd5b260ab1c2f0 --- /dev/null +++ b/config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_success +description: Total number of times the Test Summary widget extension was expanded (while in its Success state) +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_expand_success +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml b/config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml new file mode 100644 index 00000000000000..d6571ee56cd65a --- /dev/null +++ b/config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_warning +description: Total number of times the Test Summary widget extension was expanded (while in its Warning state) +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_expand_warning +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml b/config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml new file mode 100644 index 00000000000000..9621cd61b07c74 --- /dev/null +++ b/config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml @@ -0,0 +1,24 @@ +--- +key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_failed +description: Total number of times the Test Summary widget extension was expanded (while in its Failed state) +product_section: dev +product_stage: create +product_group: code_review +product_category: code_review +value_type: number +status: active +milestone: "15.2" +introduced_by_url: "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91831" +time_frame: all +data_source: redis +data_category: optional +options: + events: + - i_merge_request_widget_test_summary_count_expand_failed +distribution: +- ce +- ee +tier: +- free +- premium +- ultimate diff --git a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml index 267b7fe673df35..b3d66d48546db3 100644 --- a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml +++ b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml @@ -299,3 +299,29 @@ redis_slot: code_review category: code_review aggregation: weekly +# MR Widget Extensions +## Test Summary +- name: i_merge_request_widget_test_reports_view + redis_slot: code_review + category: code_review + aggregation: weekly +- name: i_merge_request_widget_test_reports_full_report_clicked + redis_slot: code_review + category: code_review + aggregation: weekly +- name: i_merge_request_widget_test_reports_expand + redis_slot: code_review + category: code_review + aggregation: weekly +- name: i_merge_request_widget_test_reports_expand_success + redis_slot: code_review + category: code_review + aggregation: weekly +- name: i_merge_request_widget_test_reports_expand_warning + redis_slot: code_review + category: code_review + aggregation: weekly +- name: i_merge_request_widget_test_reports_expand_failed + redis_slot: code_review + category: code_review + aggregation: weekly -- GitLab From 2712e3254cb8b0384a40cc85e55d402d38d43447 Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Thu, 14 Jul 2022 21:39:36 -0600 Subject: [PATCH 3/7] Product Intelligence Fixes --- ...view_widget_test_summary_view_monthly.yml} | 4 ++-- ...t_summary_full_report_clicked_monthly.yml} | 4 ++-- ...ew_widget_test_summary_expand_monthly.yml} | 4 ++-- ...t_test_summary_expand_success_monthly.yml} | 4 ++-- ...t_test_summary_expand_warning_monthly.yml} | 4 ++-- ...et_test_summary_expand_failed_monthly.yml} | 4 ++-- ...eview_widget_test_summary_view_weekly.yml} | 4 ++-- ...st_summary_full_report_clicked_weekly.yml} | 4 ++-- ...iew_widget_test_summary_expand_weekly.yml} | 4 ++-- ...et_test_summary_expand_success_weekly.yml} | 4 ++-- ...et_test_summary_expand_warning_weekly.yml} | 4 ++-- ...get_test_summary_expand_failed_weekly.yml} | 4 ++-- ...review_widget_test_summary_count_view.yml} | 4 ++-- ...est_summary_count_full_report_clicked.yml} | 4 ++-- ...view_widget_test_summary_count_expand.yml} | 4 ++-- ...get_test_summary_count_expand_success.yml} | 4 ++-- ...get_test_summary_count_expand_warning.yml} | 4 ++-- ...dget_test_summary_count_expand_failed.yml} | 4 ++-- lib/gitlab/usage_data_counters.rb | 3 ++- .../known_events/code_review_events.yml | 12 ++++++------ .../merge_request_widget_extension_counter.rb | 19 +++++++++++++++++++ ...e_request_widget_extension_counter_spec.rb | 9 +++++++++ 22 files changed, 72 insertions(+), 43 deletions(-) rename config/metrics/counts_28d/{20220708162311_i_merge_request_widget_test_summary_view_monthly.yml => 20220708162311_i_code_review_widget_test_summary_view_monthly.yml} (79%) rename config/metrics/counts_28d/{20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml => 20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml} (76%) rename config/metrics/counts_28d/{20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml => 20220708164545_i_code_review_widget_test_summary_expand_monthly.yml} (78%) rename config/metrics/counts_28d/{20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml => 20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml} (77%) rename config/metrics/counts_28d/{20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml => 20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml} (77%) rename config/metrics/counts_28d/{20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml => 20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml} (77%) rename config/metrics/counts_7d/{20220708162305_i_merge_request_widget_test_summary_view_weekly.yml => 20220708162305_i_code_review_widget_test_summary_view_weekly.yml} (79%) rename config/metrics/counts_7d/{20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml => 20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml} (76%) rename config/metrics/counts_7d/{20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml => 20220708164539_i_code_review_widget_test_summary_expand_weekly.yml} (78%) rename config/metrics/counts_7d/{20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml => 20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml} (77%) rename config/metrics/counts_7d/{20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml => 20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml} (77%) rename config/metrics/counts_7d/{20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml => 20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml} (77%) rename config/metrics/counts_all/{20220708154149_i_merge_request_widget_test_summary_count_view.yml => 20220708154149_i_code_review_widget_test_summary_count_view.yml} (78%) rename config/metrics/counts_all/{20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml => 20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml} (74%) rename config/metrics/counts_all/{20220708154201_i_merge_request_widget_test_summary_count_expand.yml => 20220708154201_i_code_review_widget_test_summary_count_expand.yml} (78%) rename config/metrics/counts_all/{20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml => 20220708154206_i_code_review_widget_test_summary_count_expand_success.yml} (76%) rename config/metrics/counts_all/{20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml => 20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml} (76%) rename config/metrics/counts_all/{20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml => 20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml} (76%) create mode 100644 lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb create mode 100644 spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb diff --git a/config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml b/config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml similarity index 79% rename from config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml rename to config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml index 49ed079f1b68dc..50c8bcb36dab40 100644 --- a/config/metrics/counts_28d/20220708162311_i_merge_request_widget_test_summary_view_monthly.yml +++ b/config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_view_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_view_monthly description: The count of unique users (monthly) who were able to see the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_view + - i_code_review_widget_test_summary_view distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml b/config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml similarity index 76% rename from config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml rename to config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml index f907a5845aac12..04a48e9ce5caf0 100644 --- a/config/metrics/counts_28d/20220708163625_i_merge_request_widget_test_summary_full_report_clicked_monthly.yml +++ b/config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_full_report_clicked_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_full_report_clicked_monthly description: The count of unique users (monthly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_full_report_clicked + - i_code_review_widget_test_summary_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml b/config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml similarity index 78% rename from config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml rename to config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml index b36286af668306..7ee9a7fd2b9169 100644 --- a/config/metrics/counts_28d/20220708164545_i_merge_request_widget_test_summary_expand_monthly.yml +++ b/config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand + - i_code_review_widget_test_summary_expand distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml b/config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml similarity index 77% rename from config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml rename to config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml index d208d5f18ecad5..91e4148ccfd5e5 100644 --- a/config/metrics/counts_28d/20220708165638_i_merge_request_widget_test_summary_expand_success_monthly.yml +++ b/config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_success_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_success_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_success + - i_code_review_widget_test_summary_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml b/config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml similarity index 77% rename from config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml rename to config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml index 71c03f3127d1db..0085bce1aba903 100644 --- a/config/metrics/counts_28d/20220708170514_i_merge_request_widget_test_summary_expand_warning_monthly.yml +++ b/config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_warning_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_warning_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_warning + - i_code_review_widget_test_summary_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml b/config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml similarity index 77% rename from config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml rename to config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml index 2303dcac5daa61..a17818b23dbc81 100644 --- a/config/metrics/counts_28d/20220708173741_i_merge_request_widget_test_summary_expand_failed_monthly.yml +++ b/config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_failed_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_failed_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_failed + - i_code_review_widget_test_summary_expand_failed distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml b/config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml similarity index 79% rename from config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml rename to config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml index 3a80b6275b6f3a..6602f0c164c946 100644 --- a/config/metrics/counts_7d/20220708162305_i_merge_request_widget_test_summary_view_weekly.yml +++ b/config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_view_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_view_weekly description: The count of unique users (weekly) who were able to see the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_view + - i_code_review_widget_test_summary_view distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml b/config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml similarity index 76% rename from config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml rename to config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml index 38f25e69c72689..3ebab3c9270b3a 100644 --- a/config/metrics/counts_7d/20220708163619_i_merge_request_widget_test_summary_full_report_clicked_weekly.yml +++ b/config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_full_report_clicked_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_full_report_clicked_weekly description: The count of unique users (weekly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_full_report_clicked + - i_code_review_widget_test_summary_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml b/config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml similarity index 78% rename from config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml rename to config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml index 4809e1406ef2d7..4cf3495a196dd7 100644 --- a/config/metrics/counts_7d/20220708164539_i_merge_request_widget_test_summary_expand_weekly.yml +++ b/config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand + - i_code_review_widget_test_summary_expand distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml b/config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml similarity index 77% rename from config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml rename to config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml index bc7d5b11594a82..c7fc62e7cb2d90 100644 --- a/config/metrics/counts_7d/20220708165632_i_merge_request_widget_test_summary_expand_success_weekly.yml +++ b/config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_success_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_success_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_success + - i_code_review_widget_test_summary_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml b/config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml similarity index 77% rename from config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml rename to config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml index fe9ebc6c06f166..082b737e1190dc 100644 --- a/config/metrics/counts_7d/20220708170508_i_merge_request_widget_test_summary_expand_warning_weekly.yml +++ b/config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_warning_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_warning_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_warning + - i_code_review_widget_test_summary_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml b/config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml similarity index 77% rename from config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml rename to config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml index 7224a309c83482..6bdb1304a44b0f 100644 --- a/config/metrics/counts_7d/20220708173736_i_merge_request_widget_test_summary_expand_failed_weekly.yml +++ b/config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_merge_request_widget_test_summary_expand_failed_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_failed_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_merge_request_widget_test_summary_expand_failed + - i_code_review_widget_test_summary_expand_failed distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml b/config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml similarity index 78% rename from config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml rename to config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml index a4c26823613118..db3611d253a175 100644 --- a/config/metrics/counts_all/20220708154149_i_merge_request_widget_test_summary_count_view.yml +++ b/config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_view +key_path: counts.i_code_review_widget_test_summary_count_view description: Total number of times the Test Summary widget extension was viewed (rendered to the screen) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_view + - i_code_review_widget_test_summary_count_view distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml b/config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml similarity index 74% rename from config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml rename to config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml index 393a721aedb44e..cf2cfc76b70cd2 100644 --- a/config/metrics/counts_all/20220708154156_i_merge_request_widget_test_summary_count_full_report_clicked.yml +++ b/config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_full_report_clicked +key_path: counts.i_code_review_widget_test_summary_count_full_report_clicked description: Total number of times the Test Summary widget extension Full Report button was clicked product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_full_report_clicked + - i_code_review_widget_test_summary_count_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml b/config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml similarity index 78% rename from config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml rename to config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml index 9d68687c312915..7dde47bbdb65d6 100644 --- a/config/metrics/counts_all/20220708154201_i_merge_request_widget_test_summary_count_expand.yml +++ b/config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand +key_path: counts.i_code_review_widget_test_summary_count_expand description: Total number of times the Test Summary widget extension was expanded (in any state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_expand + - i_code_review_widget_test_summary_count_expand distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml b/config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml similarity index 76% rename from config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml rename to config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml index dd5b260ab1c2f0..2e59d9393cad1c 100644 --- a/config/metrics/counts_all/20220708154206_i_merge_request_widget_test_summary_count_expand_success.yml +++ b/config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_success +key_path: counts.i_code_review_widget_test_summary_count_expand_success description: Total number of times the Test Summary widget extension was expanded (while in its Success state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_expand_success + - i_code_review_widget_test_summary_count_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml b/config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml similarity index 76% rename from config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml rename to config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml index d6571ee56cd65a..5387fe52c5f957 100644 --- a/config/metrics/counts_all/20220708154211_i_merge_request_widget_test_summary_count_expand_warning.yml +++ b/config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_warning +key_path: counts.i_code_review_widget_test_summary_count_expand_warning description: Total number of times the Test Summary widget extension was expanded (while in its Warning state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_expand_warning + - i_code_review_widget_test_summary_count_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml b/config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml similarity index 76% rename from config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml rename to config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml index 9621cd61b07c74..c806f3e103ca65 100644 --- a/config/metrics/counts_all/20220708154216_i_merge_request_widget_test_summary_count_expand_failed.yml +++ b/config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml @@ -1,5 +1,5 @@ --- -key_path: counts.mr_widgets.i_merge_request_widget_test_summary_count_expand_failed +key_path: counts.i_code_review_widget_test_summary_count_expand_failed description: Total number of times the Test Summary widget extension was expanded (while in its Failed state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_merge_request_widget_test_summary_count_expand_failed + - i_code_review_widget_test_summary_count_expand_failed distribution: - ce - ee diff --git a/lib/gitlab/usage_data_counters.rb b/lib/gitlab/usage_data_counters.rb index 2a3dcf267c600d..224897ed758c19 100644 --- a/lib/gitlab/usage_data_counters.rb +++ b/lib/gitlab/usage_data_counters.rb @@ -16,7 +16,8 @@ module UsageDataCounters DesignsCounter, KubernetesAgentCounter, DiffsCounter, - ServiceUsageDataCounter + ServiceUsageDataCounter, + MergeRequestWidgetExtensionCounter ].freeze UsageDataCounterError = Class.new(StandardError) diff --git a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml index b3d66d48546db3..7945a6c288781b 100644 --- a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml +++ b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml @@ -301,27 +301,27 @@ aggregation: weekly # MR Widget Extensions ## Test Summary -- name: i_merge_request_widget_test_reports_view +- name: i_code_review_widget_test_summary_view redis_slot: code_review category: code_review aggregation: weekly -- name: i_merge_request_widget_test_reports_full_report_clicked +- name: i_code_review_widget_test_summary_full_report_clicked redis_slot: code_review category: code_review aggregation: weekly -- name: i_merge_request_widget_test_reports_expand +- name: i_code_review_widget_test_summary_expand redis_slot: code_review category: code_review aggregation: weekly -- name: i_merge_request_widget_test_reports_expand_success +- name: i_code_review_widget_test_summary_expand_success redis_slot: code_review category: code_review aggregation: weekly -- name: i_merge_request_widget_test_reports_expand_warning +- name: i_code_review_widget_test_summary_expand_warning redis_slot: code_review category: code_review aggregation: weekly -- name: i_merge_request_widget_test_reports_expand_failed +- name: i_code_review_widget_test_summary_expand_failed redis_slot: code_review category: code_review aggregation: weekly diff --git a/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb b/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb new file mode 100644 index 00000000000000..de7714df779c85 --- /dev/null +++ b/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module Gitlab + module UsageDataCounters + class MergeRequestWidgetExtensionCounter < BaseCounter + KNOWN_EVENTS = %w[view full_report_clicked expand expand_success expand_warning expand_failed].freeze + PREFIX = 'i_code_review_widget' + WIDGETS = %w[test_summary].freeze + + class << self + private + + def known_events + self::WIDGETS.product(self::KNOWN_EVENTS).map { |name_parts| name_parts.join('_count_') } + end + end + end + end +end diff --git a/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb b/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb new file mode 100644 index 00000000000000..e6ae68e487e52c --- /dev/null +++ b/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::UsageDataCounters::MergeRequestWidgetExtensionCounter do + it_behaves_like 'a redis usage counter', 'Widget Extension', :test_summary_count_expand + + it_behaves_like 'a redis usage counter with totals', :i_merge_request_widget, test_summary_count_expand: 5 +end -- GitLab From 4567f705721cac586216bb7f66296f1b26b47bd4 Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Thu, 14 Jul 2022 22:19:45 -0600 Subject: [PATCH 4/7] Add "merge request" in the keypath after "code review" Also: update instructions with new places to add things to --- .../components/extensions/README.md | 33 +++++++++++-------- config/metrics/aggregates/code_review.yml | 12 +++++++ ...uest_widget_test_summary_view_monthly.yml} | 4 +-- ...t_summary_full_report_clicked_monthly.yml} | 4 +-- ...st_widget_test_summary_expand_monthly.yml} | 4 +-- ...t_test_summary_expand_success_monthly.yml} | 4 +-- ...t_test_summary_expand_warning_monthly.yml} | 4 +-- ...et_test_summary_expand_failed_monthly.yml} | 4 +-- ...quest_widget_test_summary_view_weekly.yml} | 4 +-- ...st_summary_full_report_clicked_weekly.yml} | 4 +-- ...est_widget_test_summary_expand_weekly.yml} | 4 +-- ...et_test_summary_expand_success_weekly.yml} | 4 +-- ...et_test_summary_expand_warning_weekly.yml} | 4 +-- ...get_test_summary_expand_failed_weekly.yml} | 4 +-- ...equest_widget_test_summary_count_view.yml} | 4 +-- ...est_summary_count_full_report_clicked.yml} | 4 +-- ...uest_widget_test_summary_count_expand.yml} | 4 +-- ...get_test_summary_count_expand_success.yml} | 4 +-- ...get_test_summary_count_expand_warning.yml} | 4 +-- ...dget_test_summary_count_expand_failed.yml} | 4 +-- .../known_events/code_review_events.yml | 12 +++---- .../merge_request_widget_extension_counter.rb | 2 +- 22 files changed, 75 insertions(+), 56 deletions(-) rename config/metrics/counts_28d/{20220708162311_i_code_review_widget_test_summary_view_monthly.yml => 20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml} (76%) rename config/metrics/counts_28d/{20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml => 20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml} (73%) rename config/metrics/counts_28d/{20220708164545_i_code_review_widget_test_summary_expand_monthly.yml => 20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml} (75%) rename config/metrics/counts_28d/{20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml => 20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml} (75%) rename config/metrics/counts_28d/{20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml => 20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml} (75%) rename config/metrics/counts_28d/{20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml => 20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml} (75%) rename config/metrics/counts_7d/{20220708162305_i_code_review_widget_test_summary_view_weekly.yml => 20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml} (76%) rename config/metrics/counts_7d/{20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml => 20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml} (73%) rename config/metrics/counts_7d/{20220708164539_i_code_review_widget_test_summary_expand_weekly.yml => 20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml} (75%) rename config/metrics/counts_7d/{20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml => 20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml} (75%) rename config/metrics/counts_7d/{20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml => 20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml} (75%) rename config/metrics/counts_7d/{20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml => 20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml} (75%) rename config/metrics/counts_all/{20220708154149_i_code_review_widget_test_summary_count_view.yml => 20220708154149_i_code_review_merge_request_widget_test_summary_count_view.yml} (77%) rename config/metrics/counts_all/{20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml => 20220708154156_i_code_review_merge_request_widget_test_summary_count_full_report_clicked.yml} (73%) rename config/metrics/counts_all/{20220708154201_i_code_review_widget_test_summary_count_expand.yml => 20220708154201_i_code_review_merge_request_widget_test_summary_count_expand.yml} (76%) rename config/metrics/counts_all/{20220708154206_i_code_review_widget_test_summary_count_expand_success.yml => 20220708154206_i_code_review_merge_request_widget_test_summary_count_expand_success.yml} (75%) rename config/metrics/counts_all/{20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml => 20220708154211_i_code_review_merge_request_widget_test_summary_count_expand_warning.yml} (75%) rename config/metrics/counts_all/{20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml => 20220708154216_i_code_review_merge_request_widget_test_summary_count_expand_failed.yml} (75%) diff --git a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md index 4806fcaf110691..201f1d6e76cb42 100644 --- a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md +++ b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md @@ -14,6 +14,7 @@ The following steps are needed to generate these known events for a single widge - For example: a widget for "Test Reports" should be `WidgetTestReports` 1. "Compute" the widget name slug by converting the `${CamelName}` to lower-, snake-case. - The above example would be `test_reports` +1. Add the new widget name slug to `lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb` in the `WIDGETS` list. 1. Ensure the GDK is running (`gdk start`) 1. Generate known events on the command line with the following command. Replace `test_reports` with your appropriate name slug. ``` @@ -27,30 +28,36 @@ The following steps are needed to generate these known events for a single widge --dir=all ``` 1. Modify each newly generated file so that they match the existing files for MR Widget Extension telemetry. - - You can find existing examples by doing a glob search like so: `metrics/**/*_i_merge_request_widget_*` + - You can find existing examples by doing a glob search like so: `metrics/**/*_i_code_review_merge_request_widget_*` - Roughly-speaking, each file should have these values: 1. `description` = A plain English description of this value. Please see existing widget extension telemetry files for examples. - - Keep in mind that the `expand` events also report the widget status, so there needs to be events for the `expand_success`, `expand_warning`, and `expand_failure` states, too. 1. `product_section` = `dev` 1. `product_stage` = `create` 1. `product_group` = `code_review` 1. `product_category` = `code_review` 1. `introduced_by_url` = `'[your MR]'` - 1. `options.events` = (the event in the command from above that generated this file, like `i_merge_request_widget_test_reports_count_view`) + 1. `options.events` = (the event in the command from above that generated this file, like `i_code_review_merge_request_widget_test_reports_count_view`) - This is how the telemetry events are linked to "metrics" so this is probably one of the more important values - 1. `data_source` = `redis` OR `redis_hll` (depends on whether this is a regular counter or a unique-users counter, respectively) + 1. `data_source` = `redis` 1. `data_category` = `optional` -1. Repeat the previous two steps for each of the HLL metrics. Replace `test_reports` with your appropriate name slug. - - Note that the `:redis_hll` command fails to create multiple metrics at once. You will need to create each one, modify it with the correct values, and then move to the next one (blank metrics cause a fatal error when trying to generate the next one). - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_view --class_name=RedisHLLMetric` - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_full_report_clicked --class_name=RedisHLLMetric` - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand --class_name=RedisHLLMetric` - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_success --class_name=RedisHLLMetric` - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_warning --class_name=RedisHLLMetric` - 1. `bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets i_merge_request_widget_test_reports_expand_failed --class_name=RedisHLLMetric` +1. Repeat steps 5 and 6 for the HLL metrics. Replace `test_reports` with your appropriate name slug. + ``` + bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets \ + i_code_review_merge_request_widget_test_reports_view \ + i_code_review_merge_request_widget_test_reports_full_report_clicked \ + i_code_review_merge_request_widget_test_reports_expand \ + i_code_review_merge_request_widget_test_reports_expand_success \ + i_code_review_merge_request_widget_test_reports_expand_warning \ + i_code_review_merge_request_widget_test_reports_expand_failed \ + --class_name=RedisHLLMetric + ``` + - In step 6 for HLL, change the `data_source` to `redis_hll`. 1. Add each of the HLL metrics to `lib/gitlab/usage_data_counters/known_events/code_review_events.yml` - - You **MUST** do this **after** completely finishing all of the generation in the previous steps, or it will create fatal errors. 1. `name` = [the event] 1. `redis_slot` = `code_review` 1. `category` = `code_review` 1. `aggregation` = `weekly` + +##### New Events + +If you are adding a new event to our known events, it will need to be included in `lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb`. Update the list of `KNOWN_EVENTS` with the new event(s). diff --git a/config/metrics/aggregates/code_review.yml b/config/metrics/aggregates/code_review.yml index 2a58540f348fd1..f1bf825bbd3ea0 100644 --- a/config/metrics/aggregates/code_review.yml +++ b/config/metrics/aggregates/code_review.yml @@ -80,6 +80,12 @@ - 'i_code_review_user_create_note_in_ipynb_diff' - 'i_code_review_user_create_note_in_ipynb_diff_mr' - 'i_code_review_user_create_note_in_ipynb_diff_commit' + - 'i_code_review_merge_request_widget_test_summary_view' + - 'i_code_review_merge_request_widget_test_summary_full_report_clicked' + - 'i_code_review_merge_request_widget_test_summary_expand' + - 'i_code_review_merge_request_widget_test_summary_expand_success' + - 'i_code_review_merge_request_widget_test_summary_expand_warning' + - 'i_code_review_merge_request_widget_test_summary_expand_failed' - name: code_review_category_monthly_active_users operator: OR source: redis @@ -148,6 +154,12 @@ - 'i_code_review_user_create_note_in_ipynb_diff' - 'i_code_review_user_create_note_in_ipynb_diff_mr' - 'i_code_review_user_create_note_in_ipynb_diff_commit' + - 'i_code_review_merge_request_widget_test_summary_view' + - 'i_code_review_merge_request_widget_test_summary_full_report_clicked' + - 'i_code_review_merge_request_widget_test_summary_expand' + - 'i_code_review_merge_request_widget_test_summary_expand_success' + - 'i_code_review_merge_request_widget_test_summary_expand_warning' + - 'i_code_review_merge_request_widget_test_summary_expand_failed' - name: code_review_extension_category_monthly_active_users operator: OR source: redis diff --git a/config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml b/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml similarity index 76% rename from config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml rename to config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml index 50c8bcb36dab40..31c41569323291 100644 --- a/config/metrics/counts_28d/20220708162311_i_code_review_widget_test_summary_view_monthly.yml +++ b/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_view_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_view_monthly description: The count of unique users (monthly) who were able to see the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_view + - i_code_review_merge_request_widget_test_summary_view distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml b/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml similarity index 73% rename from config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml rename to config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml index 04a48e9ce5caf0..77ffeb95810a14 100644 --- a/config/metrics/counts_28d/20220708163625_i_code_review_widget_test_summary_full_report_clicked_monthly.yml +++ b/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_full_report_clicked_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly description: The count of unique users (monthly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_full_report_clicked + - i_code_review_merge_request_widget_test_summary_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml b/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml similarity index 75% rename from config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml rename to config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml index 7ee9a7fd2b9169..872d6bb9ef9508 100644 --- a/config/metrics/counts_28d/20220708164545_i_code_review_widget_test_summary_expand_monthly.yml +++ b/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand + - i_code_review_merge_request_widget_test_summary_expand distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml b/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml similarity index 75% rename from config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml rename to config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml index 91e4148ccfd5e5..1ce7a5f77702f5 100644 --- a/config/metrics/counts_28d/20220708165638_i_code_review_widget_test_summary_expand_success_monthly.yml +++ b/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_success_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_success_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_success + - i_code_review_merge_request_widget_test_summary_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml b/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml similarity index 75% rename from config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml rename to config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml index 0085bce1aba903..aa27ef0b9ce4d9 100644 --- a/config/metrics/counts_28d/20220708170514_i_code_review_widget_test_summary_expand_warning_monthly.yml +++ b/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_warning_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_warning_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_warning + - i_code_review_merge_request_widget_test_summary_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml b/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml similarity index 75% rename from config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml rename to config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml index a17818b23dbc81..4706944eba3805 100644 --- a/config/metrics/counts_28d/20220708173741_i_code_review_widget_test_summary_expand_failed_monthly.yml +++ b/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_failed_monthly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_failed_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_failed + - i_code_review_merge_request_widget_test_summary_expand_failed distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml b/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml similarity index 76% rename from config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml rename to config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml index 6602f0c164c946..266134e3519dd9 100644 --- a/config/metrics/counts_7d/20220708162305_i_code_review_widget_test_summary_view_weekly.yml +++ b/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_view_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_view_weekly description: The count of unique users (weekly) who were able to see the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_view + - i_code_review_merge_request_widget_test_summary_view distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml b/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml similarity index 73% rename from config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml rename to config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml index 3ebab3c9270b3a..bfb65ec0e9b87f 100644 --- a/config/metrics/counts_7d/20220708163619_i_code_review_widget_test_summary_full_report_clicked_weekly.yml +++ b/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_full_report_clicked_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly description: The count of unique users (weekly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_full_report_clicked + - i_code_review_merge_request_widget_test_summary_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml b/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml similarity index 75% rename from config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml rename to config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml index 4cf3495a196dd7..9ac8cd115b0d2c 100644 --- a/config/metrics/counts_7d/20220708164539_i_code_review_widget_test_summary_expand_weekly.yml +++ b/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand + - i_code_review_merge_request_widget_test_summary_expand distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml b/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml similarity index 75% rename from config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml rename to config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml index c7fc62e7cb2d90..696960c56fdb94 100644 --- a/config/metrics/counts_7d/20220708165632_i_code_review_widget_test_summary_expand_success_weekly.yml +++ b/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_success_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_success_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_success + - i_code_review_merge_request_widget_test_summary_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml b/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml similarity index 75% rename from config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml rename to config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml index 082b737e1190dc..ba6fe9851e8bb7 100644 --- a/config/metrics/counts_7d/20220708170508_i_code_review_widget_test_summary_expand_warning_weekly.yml +++ b/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_warning_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_warning_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_warning + - i_code_review_merge_request_widget_test_summary_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml b/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml similarity index 75% rename from config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml rename to config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml index 6bdb1304a44b0f..cc7dc9a525a0f7 100644 --- a/config/metrics/counts_7d/20220708173736_i_code_review_widget_test_summary_expand_failed_weekly.yml +++ b/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_widget_test_summary_expand_failed_weekly +key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_failed_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create @@ -15,7 +15,7 @@ data_category: optional instrumentation_class: RedisHLLMetric options: events: - - i_code_review_widget_test_summary_expand_failed + - i_code_review_merge_request_widget_test_summary_expand_failed distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml b/config/metrics/counts_all/20220708154149_i_code_review_merge_request_widget_test_summary_count_view.yml similarity index 77% rename from config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml rename to config/metrics/counts_all/20220708154149_i_code_review_merge_request_widget_test_summary_count_view.yml index db3611d253a175..79d9f062999466 100644 --- a/config/metrics/counts_all/20220708154149_i_code_review_widget_test_summary_count_view.yml +++ b/config/metrics/counts_all/20220708154149_i_code_review_merge_request_widget_test_summary_count_view.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_view +key_path: counts.i_code_review_merge_request_widget_test_summary_count_view description: Total number of times the Test Summary widget extension was viewed (rendered to the screen) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_view + - i_code_review_merge_request_widget_test_summary_count_view distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml b/config/metrics/counts_all/20220708154156_i_code_review_merge_request_widget_test_summary_count_full_report_clicked.yml similarity index 73% rename from config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml rename to config/metrics/counts_all/20220708154156_i_code_review_merge_request_widget_test_summary_count_full_report_clicked.yml index cf2cfc76b70cd2..b4887bbe2197b8 100644 --- a/config/metrics/counts_all/20220708154156_i_code_review_widget_test_summary_count_full_report_clicked.yml +++ b/config/metrics/counts_all/20220708154156_i_code_review_merge_request_widget_test_summary_count_full_report_clicked.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_full_report_clicked +key_path: counts.i_code_review_merge_request_widget_test_summary_count_full_report_clicked description: Total number of times the Test Summary widget extension Full Report button was clicked product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_full_report_clicked + - i_code_review_merge_request_widget_test_summary_count_full_report_clicked distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml b/config/metrics/counts_all/20220708154201_i_code_review_merge_request_widget_test_summary_count_expand.yml similarity index 76% rename from config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml rename to config/metrics/counts_all/20220708154201_i_code_review_merge_request_widget_test_summary_count_expand.yml index 7dde47bbdb65d6..1898fa971faee0 100644 --- a/config/metrics/counts_all/20220708154201_i_code_review_widget_test_summary_count_expand.yml +++ b/config/metrics/counts_all/20220708154201_i_code_review_merge_request_widget_test_summary_count_expand.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_expand +key_path: counts.i_code_review_merge_request_widget_test_summary_count_expand description: Total number of times the Test Summary widget extension was expanded (in any state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_expand + - i_code_review_merge_request_widget_test_summary_count_expand distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml b/config/metrics/counts_all/20220708154206_i_code_review_merge_request_widget_test_summary_count_expand_success.yml similarity index 75% rename from config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml rename to config/metrics/counts_all/20220708154206_i_code_review_merge_request_widget_test_summary_count_expand_success.yml index 2e59d9393cad1c..91cd4d7a232c16 100644 --- a/config/metrics/counts_all/20220708154206_i_code_review_widget_test_summary_count_expand_success.yml +++ b/config/metrics/counts_all/20220708154206_i_code_review_merge_request_widget_test_summary_count_expand_success.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_expand_success +key_path: counts.i_code_review_merge_request_widget_test_summary_count_expand_success description: Total number of times the Test Summary widget extension was expanded (while in its Success state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_expand_success + - i_code_review_merge_request_widget_test_summary_count_expand_success distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml b/config/metrics/counts_all/20220708154211_i_code_review_merge_request_widget_test_summary_count_expand_warning.yml similarity index 75% rename from config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml rename to config/metrics/counts_all/20220708154211_i_code_review_merge_request_widget_test_summary_count_expand_warning.yml index 5387fe52c5f957..970d843c58e709 100644 --- a/config/metrics/counts_all/20220708154211_i_code_review_widget_test_summary_count_expand_warning.yml +++ b/config/metrics/counts_all/20220708154211_i_code_review_merge_request_widget_test_summary_count_expand_warning.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_expand_warning +key_path: counts.i_code_review_merge_request_widget_test_summary_count_expand_warning description: Total number of times the Test Summary widget extension was expanded (while in its Warning state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_expand_warning + - i_code_review_merge_request_widget_test_summary_count_expand_warning distribution: - ce - ee diff --git a/config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml b/config/metrics/counts_all/20220708154216_i_code_review_merge_request_widget_test_summary_count_expand_failed.yml similarity index 75% rename from config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml rename to config/metrics/counts_all/20220708154216_i_code_review_merge_request_widget_test_summary_count_expand_failed.yml index c806f3e103ca65..9b7c5c61602a56 100644 --- a/config/metrics/counts_all/20220708154216_i_code_review_widget_test_summary_count_expand_failed.yml +++ b/config/metrics/counts_all/20220708154216_i_code_review_merge_request_widget_test_summary_count_expand_failed.yml @@ -1,5 +1,5 @@ --- -key_path: counts.i_code_review_widget_test_summary_count_expand_failed +key_path: counts.i_code_review_merge_request_widget_test_summary_count_expand_failed description: Total number of times the Test Summary widget extension was expanded (while in its Failed state) product_section: dev product_stage: create @@ -14,7 +14,7 @@ data_source: redis data_category: optional options: events: - - i_code_review_widget_test_summary_count_expand_failed + - i_code_review_merge_request_widget_test_summary_count_expand_failed distribution: - ce - ee diff --git a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml index 7945a6c288781b..9e7f5487d1a2c1 100644 --- a/lib/gitlab/usage_data_counters/known_events/code_review_events.yml +++ b/lib/gitlab/usage_data_counters/known_events/code_review_events.yml @@ -301,27 +301,27 @@ aggregation: weekly # MR Widget Extensions ## Test Summary -- name: i_code_review_widget_test_summary_view +- name: i_code_review_merge_request_widget_test_summary_view redis_slot: code_review category: code_review aggregation: weekly -- name: i_code_review_widget_test_summary_full_report_clicked +- name: i_code_review_merge_request_widget_test_summary_full_report_clicked redis_slot: code_review category: code_review aggregation: weekly -- name: i_code_review_widget_test_summary_expand +- name: i_code_review_merge_request_widget_test_summary_expand redis_slot: code_review category: code_review aggregation: weekly -- name: i_code_review_widget_test_summary_expand_success +- name: i_code_review_merge_request_widget_test_summary_expand_success redis_slot: code_review category: code_review aggregation: weekly -- name: i_code_review_widget_test_summary_expand_warning +- name: i_code_review_merge_request_widget_test_summary_expand_warning redis_slot: code_review category: code_review aggregation: weekly -- name: i_code_review_widget_test_summary_expand_failed +- name: i_code_review_merge_request_widget_test_summary_expand_failed redis_slot: code_review category: code_review aggregation: weekly diff --git a/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb b/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb index de7714df779c85..5b42589cceda85 100644 --- a/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb +++ b/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter.rb @@ -4,7 +4,7 @@ module Gitlab module UsageDataCounters class MergeRequestWidgetExtensionCounter < BaseCounter KNOWN_EVENTS = %w[view full_report_clicked expand expand_success expand_warning expand_failed].freeze - PREFIX = 'i_code_review_widget' + PREFIX = 'i_code_review_merge_request_widget' WIDGETS = %w[test_summary].freeze class << self -- GitLab From 9a7d24d06055cf33e7aee5567c52c056ae9f4825 Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Thu, 14 Jul 2022 22:36:02 -0600 Subject: [PATCH 5/7] Include `code_review` in the counter spec --- .../merge_request_widget_extension_counter_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb b/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb index e6ae68e487e52c..e073fac504a40c 100644 --- a/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb +++ b/spec/lib/gitlab/usage_data_counters/merge_request_widget_extension_counter_spec.rb @@ -5,5 +5,5 @@ RSpec.describe Gitlab::UsageDataCounters::MergeRequestWidgetExtensionCounter do it_behaves_like 'a redis usage counter', 'Widget Extension', :test_summary_count_expand - it_behaves_like 'a redis usage counter with totals', :i_merge_request_widget, test_summary_count_expand: 5 + it_behaves_like 'a redis usage counter with totals', :i_code_review_merge_request_widget, test_summary_count_expand: 5 end -- GitLab From 64e47c4bc65a75a46d059ef451cbee8127640dc6 Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Fri, 15 Jul 2022 04:28:51 -0600 Subject: [PATCH 6/7] Add instructions for updating the Code Review event aggregates --- .../vue_merge_request_widget/components/extensions/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md index 201f1d6e76cb42..8013ceeb957b2d 100644 --- a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md +++ b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md @@ -57,6 +57,7 @@ The following steps are needed to generate these known events for a single widge 1. `redis_slot` = `code_review` 1. `category` = `code_review` 1. `aggregation` = `weekly` +1. Add each event to the appropriate aggregates in `config/metrics/aggregates/code_review.yml` ##### New Events -- GitLab From 1e1624dfd47ec781892256965c94dc0dc38a5e1b Mon Sep 17 00:00:00 2001 From: Thomas Randolph Date: Fri, 22 Jul 2022 16:02:05 -0600 Subject: [PATCH 7/7] Switch the keypath from "mr_widgets" to "code_review" --- .../components/extensions/README.md | 14 +++++++------- ...ge_request_widget_test_summary_view_monthly.yml | 2 +- ...et_test_summary_full_report_clicked_monthly.yml | 2 +- ..._request_widget_test_summary_expand_monthly.yml | 2 +- ..._widget_test_summary_expand_success_monthly.yml | 2 +- ..._widget_test_summary_expand_warning_monthly.yml | 2 +- ...t_widget_test_summary_expand_failed_monthly.yml | 2 +- ...rge_request_widget_test_summary_view_weekly.yml | 2 +- ...get_test_summary_full_report_clicked_weekly.yml | 2 +- ...e_request_widget_test_summary_expand_weekly.yml | 2 +- ...t_widget_test_summary_expand_success_weekly.yml | 2 +- ...t_widget_test_summary_expand_warning_weekly.yml | 2 +- ...st_widget_test_summary_expand_failed_weekly.yml | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md index 8013ceeb957b2d..e5bb4e1af4ce1d 100644 --- a/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md +++ b/app/assets/javascripts/vue_merge_request_widget/components/extensions/README.md @@ -19,12 +19,12 @@ The following steps are needed to generate these known events for a single widge 1. Generate known events on the command line with the following command. Replace `test_reports` with your appropriate name slug. ``` bundle exec rails generate gitlab:usage_metric_definition \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_view \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_full_report_clicked \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_expand \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_success \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_warning \ - counts.mr_widgets.i_merge_request_widget_test_reports_count_expand_failed \ + counts.code_review.i_merge_request_widget_test_reports_count_view \ + counts.code_review.i_merge_request_widget_test_reports_count_full_report_clicked \ + counts.code_review.i_merge_request_widget_test_reports_count_expand \ + counts.code_review.i_merge_request_widget_test_reports_count_expand_success \ + counts.code_review.i_merge_request_widget_test_reports_count_expand_warning \ + counts.code_review.i_merge_request_widget_test_reports_count_expand_failed \ --dir=all ``` 1. Modify each newly generated file so that they match the existing files for MR Widget Extension telemetry. @@ -42,7 +42,7 @@ The following steps are needed to generate these known events for a single widge 1. `data_category` = `optional` 1. Repeat steps 5 and 6 for the HLL metrics. Replace `test_reports` with your appropriate name slug. ``` - bundle exec rails generate gitlab:usage_metric_definition:redis_hll mr_widgets \ + bundle exec rails generate gitlab:usage_metric_definition:redis_hll code_review \ i_code_review_merge_request_widget_test_reports_view \ i_code_review_merge_request_widget_test_reports_full_report_clicked \ i_code_review_merge_request_widget_test_reports_expand \ diff --git a/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml b/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml index 31c41569323291..07ba085063a544 100644 --- a/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml +++ b/config/metrics/counts_28d/20220708162311_i_code_review_merge_request_widget_test_summary_view_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_view_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_view_monthly description: The count of unique users (monthly) who were able to see the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml b/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml index 77ffeb95810a14..1b27e018e5edbb 100644 --- a/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml +++ b/config/metrics/counts_28d/20220708163625_i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_full_report_clicked_monthly description: The count of unique users (monthly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml b/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml index 872d6bb9ef9508..40134414c5b202 100644 --- a/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml +++ b/config/metrics/counts_28d/20220708164545_i_code_review_merge_request_widget_test_summary_expand_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml b/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml index 1ce7a5f77702f5..a6c08e49a5b104 100644 --- a/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml +++ b/config/metrics/counts_28d/20220708165638_i_code_review_merge_request_widget_test_summary_expand_success_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_success_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_success_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create diff --git a/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml b/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml index aa27ef0b9ce4d9..7636ffae159b7c 100644 --- a/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml +++ b/config/metrics/counts_28d/20220708170514_i_code_review_merge_request_widget_test_summary_expand_warning_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_warning_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_warning_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create diff --git a/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml b/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml index 4706944eba3805..7b84436ad570f6 100644 --- a/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml +++ b/config/metrics/counts_28d/20220708173741_i_code_review_merge_request_widget_test_summary_expand_failed_monthly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_failed_monthly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_failed_monthly description: The count of unique users (monthly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml b/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml index 266134e3519dd9..a1cf41b62f04e9 100644 --- a/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml +++ b/config/metrics/counts_7d/20220708162305_i_code_review_merge_request_widget_test_summary_view_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_view_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_view_weekly description: The count of unique users (weekly) who were able to see the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml b/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml index bfb65ec0e9b87f..73c5799d98481b 100644 --- a/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml +++ b/config/metrics/counts_7d/20220708163619_i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_full_report_clicked_weekly description: The count of unique users (weekly) who clicked the Full Report button on the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml b/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml index 9ac8cd115b0d2c..a3616e92e6f892 100644 --- a/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml +++ b/config/metrics/counts_7d/20220708164539_i_code_review_merge_request_widget_test_summary_expand_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml b/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml index 696960c56fdb94..728ca3034385e2 100644 --- a/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml +++ b/config/metrics/counts_7d/20220708165632_i_code_review_merge_request_widget_test_summary_expand_success_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_success_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_success_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Success state product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml b/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml index ba6fe9851e8bb7..70a2bab68d80ea 100644 --- a/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml +++ b/config/metrics/counts_7d/20220708170508_i_code_review_merge_request_widget_test_summary_expand_warning_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_warning_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_warning_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Warning state product_section: dev product_stage: create diff --git a/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml b/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml index cc7dc9a525a0f7..a25ac7de33c5ed 100644 --- a/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml +++ b/config/metrics/counts_7d/20220708173736_i_code_review_merge_request_widget_test_summary_expand_failed_weekly.yml @@ -1,5 +1,5 @@ --- -key_path: redis_hll_counters.mr_widgets.i_code_review_merge_request_widget_test_summary_expand_failed_weekly +key_path: redis_hll_counters.code_review.i_code_review_merge_request_widget_test_summary_expand_failed_weekly description: The count of unique users (weekly) who expanded the Test Summary widget extension while it is in its Failed state product_section: dev product_stage: create -- GitLab