Merge branch 'sy-instrument-error-tracking' into 'master'

Instrument error tracking metrics

See merge request gitlab-org/gitlab!82543

app/controllers/projects/error_tracking_controller.rb

@@ -79,7 +79,7 @@ class Projects::ErrorTrackingController < Projects::ErrorTracking::BaseControlle
   end
 
   def list_issues_params
-    params.permit(:search_term, :sort, :cursor, :issue_status)
+    params.permit(:search_term, :sort, :cursor, :issue_status).merge(tracking_event: :error_tracking_view_list)
   end
 
   def issue_update_params
@@ -87,7 +87,7 @@ class Projects::ErrorTrackingController < Projects::ErrorTracking::BaseControlle
   end
 
   def issue_details_params
-    params.permit(:issue_id)
+    params.permit(:issue_id).merge(tracking_event: :error_tracking_view_details)
   end
 
   def set_issue_id

app/services/error_tracking/base_service.rb

 # frozen_string_literal: true
 
 module ErrorTracking
-  class BaseService < ::BaseService
+  class BaseService < ::BaseProjectService
+    include Gitlab::Utils::UsageData
+
+    def initialize(project, user = nil, params = {})
+      super(project: project, current_user: user, params: params.dup)
+    end
+
     def execute
       return unauthorized if unauthorized
 
@@ -21,6 +27,8 @@ module ErrorTracking
 
       yield if block_given?
 
+      track_usage_event(params[:tracking_event], current_user.id) if params[:tracking_event]
+
       success(parse_response(response))
     end
 

config/feature_flags/development/track_error_tracking_activity.yml

+---
+name: track_error_tracking_activity
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/355112
+milestone: '14.9'
+type: development
+group: group::respond
+default_enabled: false

config/metrics/counts_28d/20220309183501_error_tracking_view_details_monthly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_view_details_monthly
+description: Unique users viewing the error details page
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_details
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20220309195504_error_tracking_view_list_monthly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_view_list_monthly
+description: Unique users viewing the list of errors in the project
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_list
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20220315223227_error_tracking_total_unique_counts_monthly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_total_unique_counts_monthly
+description: Total unique users accessing error tracking routes
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_list
+    - error_tracking_view_details
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20220309183454_error_tracking_view_details_weekly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_view_details_weekly
+description: Unique users viewing the error details page
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_details
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20220309195457_error_tracking_view_list_weekly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_view_list_weekly
+description: Unique users viewing the list of errors in the project
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_list
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20220315223220_error_tracking_total_unique_counts_weekly.yml

+---
+key_path: redis_hll_counters.error_tracking.error_tracking_total_unique_counts_weekly
+description: Total unique users accessing error tracking routes
+product_section: ops
+product_stage: monitor
+product_group: respond
+product_category: error_tracking
+value_type: number
+status: active
+milestone: "14.9"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82543
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+    - error_tracking_view_list
+    - error_tracking_view_details
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

ee/spec/controllers/ee/search_controller_spec.rb

@@ -20,8 +20,8 @@ RSpec.describe SearchController, :elastic do
         it_behaves_like 'tracking unique hll events' do
           subject(:request) { get :show, params: { scope: 'projects', search: 'term' } }
 
-          let(:target_id) { 'i_search_advanced' }
-          let(:expected_type) { instance_of(String) }
+          let(:target_event) { 'i_search_advanced' }
+          let(:expected_value) { instance_of(String) }
         end
       end
 
@@ -29,7 +29,7 @@ RSpec.describe SearchController, :elastic do
         let_it_be(:group) { create(:group) }
 
         let(:request_params) { { group_id: group.id, scope: 'blobs', search: 'term' } }
-        let(:target_id) { 'i_search_paid' }
+        let(:target_event) { 'i_search_paid' }
 
         context 'on Gitlab.com' do
           before do
@@ -40,7 +40,7 @@ RSpec.describe SearchController, :elastic do
           it_behaves_like 'tracking unique hll events' do
             subject(:request) { get :show, params: request_params }
 
-            let(:expected_type) { instance_of(String) }
+            let(:expected_value) { instance_of(String) }
           end
         end
 
@@ -57,13 +57,13 @@ RSpec.describe SearchController, :elastic do
             it_behaves_like 'tracking unique hll events' do
               subject(:request) { get :show, params: request_params }
 
-              let(:expected_type) { instance_of(String) }
+              let(:expected_value) { instance_of(String) }
             end
           end
 
           it 'does not track if there is no license available' do
             stub_licensed_features(elastic_search: false)
-            expect(Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event).with(target_id, values: instance_of(String))
+            expect(Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event).with(target_event, values: instance_of(String))
 
             get :show, params: request_params, format: :html
           end

ee/spec/controllers/groups/epic_boards_controller_spec.rb

@@ -114,8 +114,8 @@ RSpec.describe Groups::EpicBoardsController do
       let_it_be(:board) { create(:epic_board, group: group) }
       subject(:request) { list_boards }
 
-      let(:target_id) { 'g_project_management_users_viewing_epic_boards' }
-      let(:expected_type) { instance_of(String) }
+      let(:target_event) { 'g_project_management_users_viewing_epic_boards' }
+      let(:expected_value) { instance_of(String) }
     end
 
     def list_boards(format: :html)
@@ -215,8 +215,8 @@ RSpec.describe Groups::EpicBoardsController do
     it_behaves_like 'tracking unique hll events' do
       subject(:request) { read_board(board: board) }
 
-      let(:target_id) { 'g_project_management_users_viewing_epic_boards' }
-      let(:expected_type) { instance_of(String) }
+      let(:target_event) { 'g_project_management_users_viewing_epic_boards' }
+      let(:expected_value) { instance_of(String) }
     end
 
     def read_board(board:, format: :html)

ee/spec/services/network_policies/resources_service_spec.rb

@@ -51,8 +51,8 @@ RSpec.describe NetworkPolicies::ResourcesService do
     it_behaves_like 'tracking unique hll events' do
       subject(:request) { service.execute }
 
-      let(:target_id) { 'clusters_using_network_policies_ui' }
-      let(:expected_type) { instance_of(Integer) }
+      let(:target_event) { 'clusters_using_network_policies_ui' }
+      let(:expected_value) { instance_of(Integer) }
 
       before do
         allow(kubeclient).to receive(:get_network_policies)

lib/gitlab/usage_data_counters/hll_redis_counter.rb

@@ -26,6 +26,7 @@ module Gitlab
         ecosystem
         epic_boards_usage
         epics_usage
+        error_tracking
         ide_edit
         incident_management
         issues_edit

lib/gitlab/usage_data_counters/known_events/error_tracking.yml

+---
+- name: error_tracking_view_details
+  category: error_tracking
+  redis_slot: error_tracking
+  aggregation: weekly
+  feature_flag: track_error_tracking_activity
+- name: error_tracking_view_list
+  category: error_tracking
+  redis_slot: error_tracking
+  aggregation: weekly
+  feature_flag: track_error_tracking_activity

spec/controllers/projects/blob_controller_spec.rb

@@ -366,8 +366,8 @@ RSpec.describe Projects::BlobController do
     it_behaves_like 'tracking unique hll events' do
       subject(:request) { put :update, params: default_params }
 
-      let(:target_id) { 'g_edit_by_sfe' }
-      let(:expected_type) { instance_of(Integer) }
+      let(:target_event) { 'g_edit_by_sfe' }
+      let(:expected_value) { instance_of(Integer) }
     end
   end
 
@@ -516,8 +516,8 @@ RSpec.describe Projects::BlobController do
     subject(:request) { post :create, params: default_params }
 
     it_behaves_like 'tracking unique hll events' do
-      let(:target_id) { 'g_edit_by_sfe' }
-      let(:expected_type) { instance_of(Integer) }
+      let(:target_event) { 'g_edit_by_sfe' }
+      let(:expected_value) { instance_of(Integer) }
     end
 
     it 'redirects to blob' do

spec/controllers/projects/error_tracking_controller_spec.rb

@@ -50,9 +50,7 @@ RSpec.describe Projects::ErrorTrackingController do
       let(:external_url) { 'http://example.com' }
 
       context 'no data' do
-        let(:permitted_params) do
-          ActionController::Parameters.new({}).permit!
-        end
+        let(:permitted_params) { permit_index_parameters!({}) }
 
         before do
           expect(ErrorTracking::ListIssuesService)
@@ -75,9 +73,7 @@ RSpec.describe Projects::ErrorTrackingController do
         let(:search_term) { 'something' }
         let(:sort) { 'last_seen' }
         let(:params) { project_params(format: :json, search_term: search_term, sort: sort, cursor: cursor) }
-        let(:permitted_params) do
-          ActionController::Parameters.new(search_term: search_term, sort: sort, cursor: cursor).permit!
-        end
+        let(:permitted_params) { permit_index_parameters!(search_term: search_term, sort: sort, cursor: cursor) }
 
         before do
           expect(ErrorTracking::ListIssuesService)
@@ -114,7 +110,7 @@ RSpec.describe Projects::ErrorTrackingController do
       context 'without extra params' do
         before do
           expect(ErrorTracking::ListIssuesService)
-            .to receive(:new).with(project, user, {})
+            .to receive(:new).with(project, user, permit_index_parameters!({}))
             .and_return(list_issues_service)
         end
 
@@ -179,6 +175,15 @@ RSpec.describe Projects::ErrorTrackingController do
         end
       end
     end
+
+    private
+
+    def permit_index_parameters!(params)
+      ActionController::Parameters.new(
+        **params,
+        tracking_event: :error_tracking_view_list
+      ).permit!
+    end
   end
 
   describe 'GET #issue_details' do
@@ -188,7 +193,8 @@ RSpec.describe Projects::ErrorTrackingController do
 
     let(:permitted_params) do
       ActionController::Parameters.new(
-        { issue_id: issue_id.to_s }
+        issue_id: issue_id.to_s,
+        tracking_event: :error_tracking_view_details
       ).permit!
     end
 

spec/controllers/search_controller_spec.rb

@@ -251,8 +251,8 @@ RSpec.describe SearchController do
         it_behaves_like 'tracking unique hll events' do
           subject(:request) { get :show, params: { scope: 'projects', search: 'term' } }
 
-          let(:target_id) { 'i_search_total' }
-          let(:expected_type) { instance_of(String) }
+          let(:target_event) { 'i_search_total' }
+          let(:expected_value) { instance_of(String) }
         end
       end
 

spec/controllers/snippets_controller_spec.rb

@@ -176,8 +176,8 @@ RSpec.describe SnippetsController do
         it_behaves_like 'tracking unique hll events' do
           subject(:request) { get :show, params: { id: public_snippet.to_param } }
 
-          let(:target_id) { 'i_snippets_show' }
-          let(:expected_type) { instance_of(String) }
+          let(:target_event) { 'i_snippets_show' }
+          let(:expected_value) { instance_of(String) }
         end
       end
 

spec/lib/gitlab/usage_data_counters/hll_redis_counter_spec.rb

@@ -52,7 +52,8 @@ RSpec.describe Gitlab::UsageDataCounters::HLLRedisCounter, :clean_gitlab_redis_s
         'geo',
         'growth',
         'work_items',
-        'ci_users'
+        'ci_users',
+        'error_tracking'
       )
     end
   end

spec/requests/api/terraform/state_spec.rb

@@ -36,8 +36,8 @@ RSpec.describe API::Terraform::State do
       let(:current_user) { maintainer }
 
       it_behaves_like 'tracking unique hll events' do
-        let(:target_id) { 'p_terraform_state_api_unique_users' }
-        let(:expected_type) { instance_of(Integer) }
+        let(:target_event) { 'p_terraform_state_api_unique_users' }
+        let(:expected_value) { instance_of(Integer) }
       end
     end
   end

spec/services/error_tracking/base_service_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe ErrorTracking::BaseService do
   describe '#compose_response' do
     let(:project) { double('project') }
-    let(:user) { double('user') }
+    let(:user) { double('user', id: non_existing_record_id) }
     let(:service) { described_class.new(project, user) }
 
     it 'returns bad_request error when response has an error key' do
@@ -68,6 +68,16 @@ RSpec.describe ErrorTracking::BaseService do
           expect(result[:animal]).to eq(:fish)
           expect(result[:status]).to eq(:success)
         end
+
+        context 'when tracking_event is provided' do
+          let(:service) { described_class.new(project, user, tracking_event: :error_tracking_view_list) }
+
+          it_behaves_like 'tracking unique hll events' do
+            let(:target_event) { 'error_tracking_view_list' }
+            let(:expected_value) { non_existing_record_id }
+            let(:request) { service.send(:compose_response, data) }
+          end
+        end
       end
     end
   end

spec/support/shared_examples/controllers/unique_hll_events_examples.rb

@@ -2,14 +2,14 @@
 #
 # Requires a context containing:
 # - request
-# - expected_type
-# - target_id
+# - expected_value
+# - target_event
 
 RSpec.shared_examples 'tracking unique hll events' do
   it 'tracks unique event' do
     expect(Gitlab::UsageDataCounters::HLLRedisCounter).to(
       receive(:track_event)
-        .with(target_id, values: expected_type)
+        .with(target_event, values: expected_value)
         .and_call_original # we call original to trigger additional validations; otherwise the method is stubbed
     )
 

spec/support/shared_examples/controllers/wiki_actions_shared_examples.rb

@@ -220,8 +220,8 @@ RSpec.shared_examples 'wiki controller actions' do
 
       context 'page view tracking' do
         it_behaves_like 'tracking unique hll events' do
-          let(:target_id) { 'wiki_action' }
-          let(:expected_type) { instance_of(String) }
+          let(:target_event) { 'wiki_action' }
+          let(:expected_value) { instance_of(String) }
         end
 
         it 'increases the page view counter' do