Process webhook notification to send HLLRedis metrics

Metrics will be pushed when users delete or push
a tag or a repository. The user can be a User or
a DeployToken.

Add new HLLRedis category: container_registries

Changelog: added
EE: true

app/models/container_registry/event.rb

@@ -8,6 +8,21 @@ class Event
     PUSH_ACTION = 'push'
     DELETE_ACTION = 'delete'
     EVENT_TRACKING_CATEGORY = 'container_registry:notification'
+    EVENT_PREFIX = "i_container_registry"
+
+    ALLOWED_ACTOR_TYPES = %w(
+      personal_access_token
+      build
+      gitlab_or_ldap
+    ).freeze
+
+    TRACKABLE_ACTOR_EVENTS = %w(
+      push_tag
+      delete_tag
+      push_repository
+      delete_repository
+      create_repository
+    ).freeze
 
     attr_reader :event
 
@@ -32,6 +47,9 @@ def track!
       end
 
       ::Gitlab::Tracking.event(EVENT_TRACKING_CATEGORY, tracking_action)
+
+      event = usage_data_event_for(tracking_action)
+      ::Gitlab::UsageDataCounters::HLLRedisCounter.track_event(event, values: originator.id) if event
     end
 
     private
@@ -81,6 +99,29 @@ def project
       container_registry_path&.repository_project
     end
 
+    # counter name for unique user tracking (for MAU)
+    def usage_data_event_for(tracking_action)
+      return unless originator
+      return unless TRACKABLE_ACTOR_EVENTS.include?(tracking_action)
+
+      "#{EVENT_PREFIX}_#{tracking_action}_user"
+    end
+
+    def originator_type
+      event.dig('actor', 'user_type')
+    end
+
+    def originator
+      return unless ALLOWED_ACTOR_TYPES.include?(originator_type)
+
+      username = event.dig('actor', 'name')
+      return unless username
+
+      strong_memoize(:originator) do
+        User.find_by_username(username)
+      end
+    end
+
     def update_project_statistics
       return unless supported?
       return unless target_tag? || (action_delete? && target_digest?)

config/metrics/counts_28d/20230129134935_i_container_registry_push_tag_user_monthly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_push_tag_user_monthly
+description: A monthly count of users that have pushed a tag to the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_push_tag_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20230129135520_i_container_registry_delete_tag_user_monthly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_delete_tag_user_monthly
+description: A monthly count of users that have deleted a tag from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_delete_tag_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20230129135748_i_container_registry_push_repository_user_monthly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_push_repository_user_monthly
+description: A monthly count of users that have pushed a repository to the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_push_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20230129140646_i_container_registry_delete_repository_user_monthly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_delete_repository_user_monthly
+description: A monthly count of users that have deleted a repository from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_delete_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_28d/20230129140954_i_container_registry_create_repository_user_monthly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_create_repository_user_monthly
+description: A monthly count of users that have created a repository from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_create_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20230129032841_i_container_registry_push_tag_user_weekly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_push_tag_user_weekly
+description: A weekly count of users that have pushed a tag to the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_push_tag_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20230129034513_i_container_registry_delete_tag_user_weekly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_delete_tag_user_weekly
+description: A weekly count of users that have deleted a tag from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_delete_tag_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20230129034950_i_container_registry_push_repository_user_weekly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_push_repository_user_weekly
+description: A weekly count of users that have pushed a repository to the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_push_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20230129035454_i_container_registry_delete_repository_user_weekly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_delete_repository_user_weekly
+description: A weekly count of users that have deleted a repository from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_delete_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/20230129035748_i_container_registry_create_repository_user_weekly.yml

+---
+key_path: redis_hll_counters.user_container_registry.i_container_registry_create_repository_user_weekly
+description: A weekly count of users that have created a repository from the registry
+product_section: ops
+product_stage: package
+product_group: package
+product_category: container_registry
+value_type: number
+status: active
+milestone: '15.9'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/107918
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+options:
+  events:
+  - i_container_registry_create_repository_user
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate

ee/spec/lib/ee/gitlab/usage_data_counters/hll_redis_counter_spec.rb

@@ -63,6 +63,7 @@
         'source_code',
         'terraform',
         'testing',
+        'user_container_registry',
         'user_packages',
         'work_items',
         # EE-specific categories

lib/gitlab/usage_data_counters/known_events/container_registry_events.yml

+---
+- name: i_container_registry_push_tag_user
+  category: user_container_registry
+  aggregation: weekly
+  redis_slot: container_registry
+- name: i_container_registry_delete_tag_user
+  category: user_container_registry
+  aggregation: weekly
+  redis_slot: container_registry
+- name: i_container_registry_push_repository_user
+  category: user_container_registry
+  aggregation: weekly
+  redis_slot: container_registry
+- name: i_container_registry_delete_repository_user
+  category: user_container_registry
+  aggregation: weekly
+  redis_slot: container_registry
+- name: i_container_registry_create_repository_user
+  category: user_container_registry
+  aggregation: weekly
+  redis_slot: container_registry
+  
\ No newline at end of file

spec/models/container_registry/event_spec.rb

@@ -116,6 +116,24 @@
 
     subject { described_class.new(raw_event).track! }
 
+    shared_examples 'tracking event is sent to HLLRedisCounter with event and originator ID' do |originator_type|
+      it 'fetches the event originator based on username' do
+        count.times do
+          expect(User).to receive(:find_by_username).with(originator.username)
+        end
+
+        subject
+      end
+
+      it 'sends a tracking event to HLLRedisCounter' do
+        expect(::Gitlab::UsageDataCounters::HLLRedisCounter)
+        .to receive(:track_event).with("i_container_registry_#{event}_#{originator_type}", values: originator.id)
+        .exactly(count).time
+
+        subject
+      end
+    end
+
     context 'with a respository target' do
       let(:target) do
         {
@@ -164,5 +182,58 @@
         end
       end
     end
+
+    context 'with a deploy token as the actor' do
+      let!(:originator) { create(:deploy_token, username: 'username', id: 3) }
+      let(:raw_event) do
+        {
+          'action' => 'push',
+          'target' => { 'tag' => 'latest' },
+          'actor' => { 'user_type' => 'deploy_token', 'name' => originator.username }
+        }
+      end
+
+      it 'does not send a tracking event to HLLRedisCounter' do
+        expect(::Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event)
+
+        subject
+      end
+    end
+
+    context 'with a user as the actor' do
+      let_it_be(:originator) { create(:user, username: 'username') }
+      let(:raw_event) do
+        {
+          'action' => action,
+          'target' => target,
+          'actor' => { 'user_type' => user_type, 'name' => originator.username }
+        }
+      end
+
+      where(:target, :action, :event, :user_type, :count) do
+        { 'tag' => 'latest' }          | 'push'     | 'push_tag'           |  'personal_access_token'   |  1
+        { 'tag' => 'latest' }          | 'delete'   | 'delete_tag'         |  'personal_access_token'   |  1
+        { 'repository' => 'foo/bar' }  | 'push'     | 'create_repository'  |  'build'                   |  1
+        { 'repository' => 'foo/bar' }  | 'delete'   | 'delete_repository'  |  'gitlab_or_ldap'          |  1
+        { 'repository' => 'foo/bar' }  | 'delete'   | 'delete_repository'  |  'not_a_user'              |  0
+        { 'tag' => 'latest' }          | 'copy'     | ''                   |  nil                       |  0
+        { 'repository' => 'foo/bar' }  | 'copy'     | ''                   |  ''                        |  0
+      end
+
+      with_them do
+        it_behaves_like 'tracking event is sent to HLLRedisCounter with event and originator ID', :user
+      end
+    end
+
+    context 'without an actor name' do
+      let(:raw_event) { { 'action' => 'push', 'target' => {}, 'actor' => { 'user_type' => 'personal_access_token' } } }
+
+      it 'does not send a tracking event to HLLRedisCounter' do
+        expect(User).not_to receive(:find_by_username)
+        expect(::Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event)
+
+        subject
+      end
+    end
   end
 end