From 4bd3eb7ded1d26467dbbeab1e08a5ec07dec343f Mon Sep 17 00:00:00 2001 From: lma-git Date: Mon, 28 Aug 2023 15:27:04 -0700 Subject: [PATCH] Remove json.pipeline_includes_count logging This MR removes the logging of 'pipeline_includes_count' from the pipeline creation service. It is no longer necessary. --- app/services/ci/create_pipeline_service.rb | 7 -- lib/gitlab/ci/config/external/context.rb | 2 - lib/gitlab/ci/pipeline/chain/command.rb | 4 -- lib/gitlab/ci/pipeline/chain/sequence.rb | 1 - .../ci/create_pipeline_service/logger_spec.rb | 69 ------------------- 5 files changed, 83 deletions(-) diff --git a/app/services/ci/create_pipeline_service.rb b/app/services/ci/create_pipeline_service.rb index fe0e842f542d08..2231b1dd6bd357 100644 --- a/app/services/ci/create_pipeline_service.rb +++ b/app/services/ci/create_pipeline_service.rb @@ -154,13 +154,6 @@ def build_logger duration >= LOG_MAX_CREATION_THRESHOLD end - - l.log_when do |observations| - pipeline_includes_count = observations['pipeline_includes_count'] - next false unless pipeline_includes_count - - pipeline_includes_count.to_i > Gitlab::Ci::Config::External::Context::TEMP_MAX_INCLUDES - end end end end diff --git a/lib/gitlab/ci/config/external/context.rb b/lib/gitlab/ci/config/external/context.rb index c57391d355c86f..0ce100c283acae 100644 --- a/lib/gitlab/ci/config/external/context.rb +++ b/lib/gitlab/ci/config/external/context.rb @@ -9,8 +9,6 @@ class Context TimeoutError = Class.new(StandardError) - TEMP_MAX_INCLUDES = 100 # For logging; to be removed in https://gitlab.com/gitlab-org/gitlab/-/issues/396776 - include ::Gitlab::Utils::StrongMemoize attr_reader :project, :sha, :user, :parent_pipeline, :variables, :pipeline_config diff --git a/lib/gitlab/ci/pipeline/chain/command.rb b/lib/gitlab/ci/pipeline/chain/command.rb index 4bc2f6c7be70cb..cc3aa33e93b1a5 100644 --- a/lib/gitlab/ci/pipeline/chain/command.rb +++ b/lib/gitlab/ci/pipeline/chain/command.rb @@ -128,10 +128,6 @@ def observe_jobs_count_in_alive_pipelines .observe({ plan: project.actual_plan_name }, jobs_count) end - def observe_pipeline_includes_count(pipeline) - logger.observe(:pipeline_includes_count, pipeline.config_metadata&.[](:includes)&.count, once: true) - end - def increment_pipeline_failure_reason_counter(reason) metrics.pipeline_failure_reason_counter .increment(reason: (reason || :unknown_failure).to_s) diff --git a/lib/gitlab/ci/pipeline/chain/sequence.rb b/lib/gitlab/ci/pipeline/chain/sequence.rb index dd097187955ca4..de14791485052e 100644 --- a/lib/gitlab/ci/pipeline/chain/sequence.rb +++ b/lib/gitlab/ci/pipeline/chain/sequence.rb @@ -30,7 +30,6 @@ def build! @command.observe_creation_duration(current_monotonic_time - @start) @command.observe_pipeline_size(@pipeline) @command.observe_jobs_count_in_alive_pipelines - @command.observe_pipeline_includes_count(@pipeline) @pipeline end diff --git a/spec/services/ci/create_pipeline_service/logger_spec.rb b/spec/services/ci/create_pipeline_service/logger_spec.rb index 6a1987fcc7c826..6b4a1809d9a47b 100644 --- a/spec/services/ci/create_pipeline_service/logger_spec.rb +++ b/spec/services/ci/create_pipeline_service/logger_spec.rb @@ -139,74 +139,5 @@ expect(pipeline).to be_created_successfully end end - - describe 'pipeline includes count' do - before do - stub_const('Gitlab::Ci::Config::External::Context::TEMP_MAX_INCLUDES', 2) - end - - context 'when the includes count exceeds the maximum' do - before do - allow_next_instance_of(Ci::Pipeline) do |pipeline| - allow(pipeline).to receive(:config_metadata) - .and_return({ includes: [{ file: 1 }, { file: 2 }, { file: 3 }] }) - end - end - - it 'creates a log entry' do - expect(Gitlab::AppJsonLogger) - .to receive(:info) - .with(a_hash_including({ 'pipeline_includes_count' => 3 })) - .and_call_original - - expect(pipeline).to be_created_successfully - end - end - - context 'when the includes count does not exceed the maximum' do - before do - allow_next_instance_of(Ci::Pipeline) do |pipeline| - allow(pipeline).to receive(:config_metadata) - .and_return({ includes: [{ file: 1 }, { file: 2 }] }) - end - end - - it 'does not create a log entry but it collects the data' do - expect(Gitlab::AppJsonLogger).not_to receive(:info) - expect(pipeline).to be_created_successfully - - expect(service.logger.observations_hash) - .to match(a_hash_including({ 'pipeline_includes_count' => 2 })) - end - end - - context 'when the includes data is nil' do - before do - allow_next_instance_of(Ci::Pipeline) do |pipeline| - allow(pipeline).to receive(:config_metadata) - .and_return({}) - end - end - - it 'does not create a log entry' do - expect(Gitlab::AppJsonLogger).not_to receive(:info) - expect(pipeline).to be_created_successfully - end - end - - context 'when the pipeline config_metadata is nil' do - before do - allow_next_instance_of(Ci::Pipeline) do |pipeline| - allow(pipeline).to receive(:config_metadata) - .and_return(nil) - end - end - - it 'does not create a log entry but it collects the data' do - expect(Gitlab::AppJsonLogger).not_to receive(:info) - expect(pipeline).to be_created_successfully - end - end - end end end -- GitLab