Merge branch '411394/Add_component_usage_tracking' into 'master'

Add ci catalog component usage tracking

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129016



Merged-by: Laura Montemayor <lmontemayor@gitlab.com>
Approved-by: Laura Montemayor <lmontemayor@gitlab.com>
Approved-by: Avielle Wolfe <awolfe@gitlab.com>
Approved-by: Sebastian Rehm <srehm@gitlab.com>
Reviewed-by: Avielle Wolfe <awolfe@gitlab.com>
Co-authored-by: Kasia Misirli <kmisirli@gitlab.com>

config/metrics/counts_28d/20230810124157_count_cicd_component_usage_monthly.yml

+---
+key_path: redis_hll_counters.pipeline_authoring.count_cicd_component_usage_monthly
+description: Monthly count of CI/CD component usage
+product_section: ops
+product_stage: verify
+product_group: pipeline_authoring
+value_type: number
+status: active
+milestone: "16.4"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129016
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+- ce
+tier:
+- premium
+- ultimate
+options:
+  events:
+    - cicd_component_usage

config/metrics/counts_7d/20230810124157_count_cicd_component_usage_weekly.yml

+---
+key_path: redis_hll_counters.pipeline_authoring.count_cicd_component_usage_weekly
+description: Weekly count of CI/CD component usage
+product_section: ops
+product_stage: verify
+product_group: pipeline_authoring
+value_type: number
+status: active
+milestone: "16.4"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/129016
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+- ce
+tier:
+- premium
+- ultimate
+options:
+  events:
+    - cicd_component_usage

lib/gitlab/ci/config/external/file/component.rb

@@ -18,6 +18,8 @@ def initialize(params, context)
             def content
               return unless component_result.success?
 
+              ::Gitlab::UsageDataCounters::HLLRedisCounter.track_event('cicd_component_usage', values: context.user.id)
+
               component_result.payload.fetch(:content)
             end
             strong_memoize_attr :content

spec/lib/gitlab/ci/config/external/file/component_spec.rb

@@ -120,6 +120,41 @@
     end
   end
 
+  describe '#content' do
+    context 'when component is valid' do
+      let(:content) do
+        <<~COMPONENT
+        job:
+        script: echo
+        COMPONENT
+      end
+
+      let(:response) do
+        ServiceResponse.success(payload: {
+          content: content,
+          path: instance_double(::Gitlab::Ci::Components::InstancePath, project: project, sha: '12345')
+        })
+      end
+
+      it 'tracks the event' do
+        expect(::Gitlab::UsageDataCounters::HLLRedisCounter).to receive(:track_event).with('cicd_component_usage',
+          values: external_resource.context.user.id)
+
+        external_resource.content
+      end
+    end
+
+    context 'when component is invalid' do
+      let(:content) { 'the-content' }
+
+      it 'does not track the event' do
+        expect(::Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event)
+
+        external_resource.content
+      end
+    end
+  end
+
   describe '#metadata' do
     subject(:metadata) { external_resource.metadata }