Merge branch '332945-prometheus-label-db-config-name' into 'master'

Add db_config_name label to prometheus database metrics

See merge request gitlab-org/gitlab!67806

lib/gitlab/metrics/subscribers/active_record.rb

@@ -134,7 +134,12 @@ module Gitlab
                              :"gitlab_transaction_db_#{counter}_total"
                            end
 
-          current_transaction&.increment(prometheus_key, 1)
+          if ENV['GITLAB_MULTIPLE_DATABASE_METRICS']
+            current_transaction&.increment(prometheus_key, 1, { db_config_name: db_config_name })
+          else
+            current_transaction&.increment(prometheus_key, 1)
+          end
+
           Gitlab::SafeRequestStore[log_key] = Gitlab::SafeRequestStore[log_key].to_i + 1
 
           # To avoid confusing log keys we only log the db_config_name metrics
@@ -147,7 +152,13 @@ module Gitlab
         end
 
         def observe(histogram, event, &block)
-          current_transaction&.observe(histogram, event.duration / 1000.0, &block)
+          db_config_name = db_config_name(event.payload)
+
+          if ENV['GITLAB_MULTIPLE_DATABASE_METRICS']
+            current_transaction&.observe(histogram, event.duration / 1000.0, { db_config_name: db_config_name }, &block)
+          else
+            current_transaction&.observe(histogram, event.duration / 1000.0, &block)
+          end
         end
 
         def current_transaction

spec/lib/gitlab/metrics/subscribers/active_record_spec.rb

@@ -8,6 +8,7 @@ RSpec.describe Gitlab::Metrics::Subscribers::ActiveRecord do
   let(:env) { {} }
   let(:subscriber) { described_class.new }
   let(:connection) { ActiveRecord::Base.connection }
+  let(:db_config_name) { ::Gitlab::Database.db_config_name(connection) }
 
   describe '#transaction' do
     let(:web_transaction) { double('Gitlab::Metrics::WebTransaction') }
@@ -36,7 +37,7 @@ RSpec.describe Gitlab::Metrics::Subscribers::ActiveRecord do
       end
 
       it 'captures the metrics for web only' do
-        expect(web_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23)
+        expect(web_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23, db_config_name: db_config_name)
 
         expect(background_transaction).not_to receive(:observe)
         expect(background_transaction).not_to receive(:increment)
@@ -56,7 +57,7 @@ RSpec.describe Gitlab::Metrics::Subscribers::ActiveRecord do
       end
 
       it 'captures the metrics for web only' do
-        expect(web_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23)
+        expect(web_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23, { db_config_name: db_config_name })
 
         expect(background_transaction).not_to receive(:observe)
         expect(background_transaction).not_to receive(:increment)
@@ -76,7 +77,7 @@ RSpec.describe Gitlab::Metrics::Subscribers::ActiveRecord do
       end
 
       it 'captures the metrics for web only' do
-        expect(background_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23)
+        expect(background_transaction).to receive(:observe).with(:gitlab_database_transaction_seconds, 0.23, db_config_name: db_config_name)
 
         expect(web_transaction).not_to receive(:observe)
         expect(web_transaction).not_to receive(:increment)

spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb

@@ -81,36 +81,38 @@ RSpec.shared_examples 'store ActiveRecord info in RequestStore' do |db_role|
 end
 
 RSpec.shared_examples 'record ActiveRecord metrics in a metrics transaction' do |db_role|
+  let(:db_config_name) { ::Gitlab::Database.db_config_name(ApplicationRecord.connection) }
+
   it 'increments only db counters' do
     if record_query
-      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_count_total, 1)
-      expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_count_total".to_sym, 1) if db_role
+      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_count_total, 1, { db_config_name: db_config_name })
+      expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_count_total".to_sym, 1, { db_config_name: db_config_name }) if db_role
     else
-      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_count_total, 1)
-      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_count_total".to_sym, 1) if db_role
+      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_count_total, 1, { db_config_name: db_config_name })
+      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_count_total".to_sym, 1, { db_config_name: db_config_name }) if db_role
     end
 
     if record_write_query
-      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_write_count_total, 1)
+      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_write_count_total, 1, { db_config_name: db_config_name })
     else
-      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_write_count_total, 1)
+      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_write_count_total, 1, { db_config_name: db_config_name })
     end
 
     if record_cached_query
-      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_cached_count_total, 1)
-      expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_cached_count_total".to_sym, 1) if db_role
+      expect(transaction).to receive(:increment).with(:gitlab_transaction_db_cached_count_total, 1, { db_config_name: db_config_name })
+      expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_cached_count_total".to_sym, 1, { db_config_name: db_config_name }) if db_role
     else
-      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_cached_count_total, 1)
-      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_cached_count_total".to_sym, 1) if db_role
+      expect(transaction).not_to receive(:increment).with(:gitlab_transaction_db_cached_count_total, 1, { db_config_name: db_config_name })
+      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_cached_count_total".to_sym, 1, { db_config_name: db_config_name }) if db_role
     end
 
     if record_wal_query
       if db_role
-        expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_count_total".to_sym, 1)
-        expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_cached_count_total".to_sym, 1) if record_cached_query
+        expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_count_total".to_sym, 1, { db_config_name: db_config_name })
+        expect(transaction).to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_cached_count_total".to_sym, 1, { db_config_name: db_config_name }) if record_cached_query
       end
     else
-      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_count_total".to_sym, 1) if db_role
+      expect(transaction).not_to receive(:increment).with("gitlab_transaction_db_#{db_role}_wal_count_total".to_sym, 1, { db_config_name: db_config_name }) if db_role
     end
 
     subscriber.sql(event)
@@ -118,14 +120,34 @@ RSpec.shared_examples 'record ActiveRecord metrics in a metrics transaction' do
 
   it 'observes sql_duration metric' do
     if record_query
-      expect(transaction).to receive(:observe).with(:gitlab_sql_duration_seconds, 0.002)
-      expect(transaction).to receive(:observe).with("gitlab_sql_#{db_role}_duration_seconds".to_sym, 0.002) if db_role
+      expect(transaction).to receive(:observe).with(:gitlab_sql_duration_seconds, 0.002, { db_config_name: db_config_name })
+      expect(transaction).to receive(:observe).with("gitlab_sql_#{db_role}_duration_seconds".to_sym, 0.002, { db_config_name: db_config_name }) if db_role
     else
       expect(transaction).not_to receive(:observe)
     end
 
     subscriber.sql(event)
   end
+
+  context 'when the GITLAB_MULTIPLE_DATABASE_METRICS env var is disabled' do
+    before do
+      stub_env('GITLAB_MULTIPLE_DATABASE_METRICS', nil)
+    end
+
+    it 'does not include db_config_name label' do
+      allow(transaction).to receive(:increment) do |*args|
+        labels = args[2] || {}
+        expect(labels).not_to include(:db_config_name)
+      end
+
+      allow(transaction).to receive(:observe) do |*args|
+        labels = args[2] || {}
+        expect(labels).not_to include(:db_config_name)
+      end
+
+      subscriber.sql(event)
+    end
+  end
 end
 
 RSpec.shared_examples 'record ActiveRecord metrics' do |db_role|