Add metrics for Vulnerability Management actions

Changelog: added
EE: true

ee/app/controllers/concerns/govern_usage_tracking.rb

@@ -5,11 +5,12 @@ module GovernUsageTracking
   extend ActiveSupport::Concern
 
   included do
-    def self.track_govern_activity(page_name, *controller_actions)
+    def self.track_govern_activity(page_name, *controller_actions, conditions: nil)
       track_event(*controller_actions,
         name: "users_visiting_#{page_name}",
         action: 'user_perform_visit',
         label: "redis_hll_counters.govern.users_visiting_#{page_name}_monthly",
+        conditions: conditions,
         destinations: %i[redis_hll snowplow]) { |context| context.current_user&.id }
     end
   end

ee/app/controllers/ee/projects/pipelines_controller.rb

@@ -7,6 +7,8 @@ module PipelinesController
       extend ::Gitlab::Utils::Override
 
       prepended do
+        include GovernUsageProjectTracking
+
         before_action :authorize_read_licenses!, only: [:licenses]
         before_action do
           push_frontend_feature_flag(:pipeline_security_dashboard_graphql, project, type: :development)
@@ -20,6 +22,8 @@ module PipelinesController
         feature_category :code_quality, [:codequality_report]
 
         urgency :low, [:codequality_report, :licenses, :security]
+        track_govern_activity 'pipeline_security', :security,
+          conditions: -> { pipeline.expose_security_dashboard? }
       end
 
       def security

ee/app/controllers/groups/security/dashboard_controller.rb

 # frozen_string_literal: true
 class Groups::Security::DashboardController < Groups::ApplicationController
+  include GovernUsageGroupTracking
+
   layout 'group'
 
   feature_category :vulnerability_management
   urgency :low
+  track_govern_activity 'security_dashboard', :show, conditions: :dashboard_available?
 
   def show
     render :unavailable unless dashboard_available?

ee/app/controllers/groups/security/vulnerabilities_controller.rb

@@ -3,6 +3,8 @@
 module Groups
   module Security
     class VulnerabilitiesController < Groups::ApplicationController
+      include GovernUsageGroupTracking
+
       layout 'group'
 
       before_action do
@@ -11,6 +13,7 @@ class VulnerabilitiesController < Groups::ApplicationController
 
       feature_category :vulnerability_management
       urgency :low
+      track_govern_activity 'security_vulnerabilities', :index, conditions: :dashboard_available?
 
       def index
         render :unavailable unless dashboard_available?

ee/app/controllers/projects/security/dashboard_controller.rb

@@ -5,6 +5,7 @@ module Security
     class DashboardController < Projects::ApplicationController
       include SecurityAndCompliancePermissions
       include SecurityDashboardsPermissions
+      include GovernUsageProjectTracking
 
       alias_method :vulnerable, :project
 
@@ -14,6 +15,7 @@ class DashboardController < Projects::ApplicationController
 
       feature_category :vulnerability_management
       urgency :low
+      track_govern_activity 'security_dashboard', :index
     end
   end
 end

ee/app/controllers/projects/security/vulnerabilities_controller.rb

@@ -4,6 +4,7 @@ module Projects
   module Security
     class VulnerabilitiesController < Projects::ApplicationController
       include IssuableActions
+      include GovernUsageProjectTracking
 
       before_action do
         push_frontend_feature_flag(:create_vulnerability_jira_issue_via_graphql, @project)
@@ -18,6 +19,7 @@ class VulnerabilitiesController < Projects::ApplicationController
 
       feature_category :vulnerability_management
       urgency :low
+      track_govern_activity 'security_vulnerabilities', :show
 
       def show
         push_force_frontend_feature_flag(

ee/app/controllers/projects/security/vulnerability_report_controller.rb

@@ -3,6 +3,8 @@
 module Projects
   module Security
     class VulnerabilityReportController < Projects::ApplicationController
+      include GovernUsageProjectTracking
+
       before_action do
         authorize_read_vulnerability!
         push_frontend_feature_flag(:expose_dismissal_reason, @project)
@@ -10,6 +12,7 @@ class VulnerabilityReportController < Projects::ApplicationController
 
       feature_category :vulnerability_management
       urgency :low
+      track_govern_activity 'security_vulnerability_report', :index
 
       alias_method :vulnerable, :project
     end

ee/app/controllers/security/vulnerabilities_controller.rb

@@ -3,9 +3,22 @@
 module Security
   class VulnerabilitiesController < ::Security::ApplicationController
     layout 'instance_security'
+    include GovernUsageTracking
 
     before_action do
       push_frontend_feature_flag(:expose_dismissal_reason, @project)
     end
+
+    track_govern_activity 'security_vulnerabilities', :index
+
+    private
+
+    def tracking_namespace_source
+      nil
+    end
+
+    def tracking_project_source
+      nil
+    end
   end
 end

ee/config/metrics/counts_28d/20230807111737_users_visiting_govern_pages_monthly.yml

@@ -22,6 +22,10 @@ options:
     - users_creating_merge_requests_with_security_policies
     - users_visiting_dependencies
     - users_visiting_licenses
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
 performance_indicator_type:
 - smau
 distribution:

ee/config/metrics/counts_28d/20230815130614_users_visiting_vulnerability_management_pages_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_vulnerability_management_pages_monthly
+description: Unique count of vulnerability management actions in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: AggregatedMetric
+options:
+  aggregate:
+    operator: OR
+    attribute: user_id
+  events:
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
+    - i_code_review_merge_request_widget_security_reports_expand
+performance_indicator_type: []
+distribution:
+- ee
+tier:
+- ultimate

ee/config/metrics/counts_28d/20230815131251_users_visiting_threat_insights_pages_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_threat_insights_pages_monthly
+description: Unique count of threat insights actions in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: AggregatedMetric
+options:
+  aggregate:
+    operator: OR
+    attribute: user_id
+  events:
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
+    - users_visiting_dependencies
+    - users_visiting_licenses
+    - i_code_review_merge_request_widget_security_reports_expand
+performance_indicator_type: []
+distribution:
+- ee
+tier:
+- ultimate

ee/config/metrics/counts_28d/20230816131559_users_visiting_security_vulnerability_report_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_security_vulnerability_report_monthly
+description: Unique count of users visiting security vulnerability report in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_security_vulnerability_report

ee/config/metrics/counts_28d/20230816131802_users_visiting_security_dashboard_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_security_dashboard_monthly
+description: Unique count of users visiting security dashboard in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_security_dashboard

ee/config/metrics/counts_28d/20230816132116_users_visiting_security_vulnerabilities_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_security_vulnerabilities_monthly
+description: Unique count of users visiting security vulnerabilities in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_security_vulnerabilities

ee/config/metrics/counts_28d/20230816132227_users_visiting_pipeline_security_monthly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_pipeline_security_monthly
+description: Unique count of users visiting pipeline security in a given month
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_pipeline_security

ee/config/metrics/counts_7d/20230807111736_users_visiting_govern_pages_weekly.yml

@@ -22,6 +22,10 @@ options:
     - users_creating_merge_requests_with_security_policies
     - users_visiting_dependencies
     - users_visiting_licenses
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
 performance_indicator_type:
 - smau
 distribution:

ee/config/metrics/counts_7d/20230815130614_users_visiting_vulnerability_management_pages_weekly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_vulnerability_management_pages_weekly
+description: Unique count of vulnerability management actions in a given week
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: AggregatedMetric
+options:
+  aggregate:
+    operator: OR
+    attribute: user_id
+  events:
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
+    - i_code_review_merge_request_widget_security_reports_expand
+performance_indicator_type: []
+distribution:
+- ee
+tier:
+- ultimate

ee/config/metrics/counts_7d/20230815131251_users_visiting_threat_insights_pages_weekly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_threat_insights_pages_weekly
+description: Unique count of threat insights actions in a given week
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: AggregatedMetric
+options:
+  aggregate:
+    operator: OR
+    attribute: user_id
+  events:
+    - users_visiting_security_vulnerability_report
+    - users_visiting_security_dashboard
+    - users_visiting_security_vulnerabilities
+    - users_visiting_pipeline_security
+    - users_visiting_dependencies
+    - users_visiting_licenses
+    - i_code_review_merge_request_widget_security_reports_expand
+performance_indicator_type: []
+distribution:
+- ee
+tier:
+- ultimate

ee/config/metrics/counts_7d/20230816131559_users_visiting_security_vulnerability_report_weekly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_security_vulnerability_report_weekly
+description: Unique count of users visiting security vulnerability report in a given week
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_security_vulnerability_report

ee/config/metrics/counts_7d/20230816131802_users_visiting_security_dashboard_weekly.yml

+---
+key_path: redis_hll_counters.govern.users_visiting_security_dashboard_weekly
+description: Unique count of users visiting security dashboard in a given week
+product_section: sec
+product_stage: govern
+product_group: threat_insights
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129482
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+  - ee
+tier:
+  - ultimate
+options:
+  events:
+    - users_visiting_security_dashboard