diff options
Diffstat (limited to 'spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb')
| -rw-r--r-- | spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb | 164 |
1 files changed, 102 insertions, 62 deletions
diff --git a/spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb b/spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb index a84658780b9..c6d6ff6bc1d 100644 --- a/spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb +++ b/spec/support/shared_examples/metrics/active_record_subscriber_shared_examples.rb @@ -1,106 +1,126 @@ # frozen_string_literal: true RSpec.shared_examples 'store ActiveRecord info in RequestStore' do |db_role| + let(:db_config_name) { ::Gitlab::Database.db_config_names.first } + + let(:expected_payload_defaults) do + metrics = + ::Gitlab::Metrics::Subscribers::ActiveRecord.load_balancing_metric_counter_keys + + ::Gitlab::Metrics::Subscribers::ActiveRecord.load_balancing_metric_duration_keys + + ::Gitlab::Metrics::Subscribers::ActiveRecord.db_counter_keys + + metrics.each_with_object({}) do |key, result| + result[key] = 0 + end + end + + def transform_hash(hash, another_hash) + another_hash.each do |key, value| + raise "Unexpected key: #{key}" unless hash[key] + end + + hash.merge(another_hash) + end + it 'prevents db counters from leaking to the next transaction' do 2.times do Gitlab::WithRequestStore.with_request_store do subscriber.sql(event) - connection = event.payload[:connection] - - if db_role == :primary - expected = { - db_count: record_query ? 1 : 0, - db_write_count: record_write_query ? 1 : 0, - db_cached_count: record_cached_query ? 1 : 0, - db_primary_cached_count: record_cached_query ? 1 : 0, - db_primary_count: record_query ? 1 : 0, - db_primary_duration_s: record_query ? 0.002 : 0, - db_replica_cached_count: 0, - db_replica_count: 0, - db_replica_duration_s: 0.0, - db_primary_wal_count: record_wal_query ? 1 : 0, - db_primary_wal_cached_count: record_wal_query && record_cached_query ? 1 : 0, - db_replica_wal_cached_count: 0, - db_replica_wal_count: 0 - } - expected[:"db_primary_#{::Gitlab::Database.dbname(connection)}_duration_s"] = 0.002 if record_query - elsif db_role == :replica - expected = { - db_count: record_query ? 1 : 0, - db_write_count: record_write_query ? 1 : 0, - db_cached_count: record_cached_query ? 1 : 0, - db_primary_cached_count: 0, - db_primary_count: 0, - db_primary_duration_s: 0.0, - db_replica_cached_count: record_cached_query ? 1 : 0, - db_replica_count: record_query ? 1 : 0, - db_replica_duration_s: record_query ? 0.002 : 0, - db_replica_wal_count: record_wal_query ? 1 : 0, - db_replica_wal_cached_count: record_wal_query && record_cached_query ? 1 : 0, - db_primary_wal_cached_count: 0, - db_primary_wal_count: 0 - } - expected[:"db_replica_#{::Gitlab::Database.dbname(connection)}_duration_s"] = 0.002 if record_query - else - expected = { - db_count: record_query ? 1 : 0, - db_write_count: record_write_query ? 1 : 0, - db_cached_count: record_cached_query ? 1 : 0 - } - end + + expected = if db_role == :primary + transform_hash(expected_payload_defaults, { + db_count: record_query ? 1 : 0, + db_write_count: record_write_query ? 1 : 0, + db_cached_count: record_cached_query ? 1 : 0, + db_primary_cached_count: record_cached_query ? 1 : 0, + "db_primary_#{db_config_name}_cached_count": record_cached_query ? 1 : 0, + db_primary_count: record_query ? 1 : 0, + "db_primary_#{db_config_name}_count": record_query ? 1 : 0, + db_primary_duration_s: record_query ? 0.002 : 0, + "db_primary_#{db_config_name}_duration_s": record_query ? 0.002 : 0, + db_primary_wal_count: record_wal_query ? 1 : 0, + "db_primary_#{db_config_name}_wal_count": record_wal_query ? 1 : 0, + db_primary_wal_cached_count: record_wal_query && record_cached_query ? 1 : 0, + "db_primary_#{db_config_name}_wal_cached_count": record_wal_query && record_cached_query ? 1 : 0 + }) + elsif db_role == :replica + transform_hash(expected_payload_defaults, { + db_count: record_query ? 1 : 0, + db_write_count: record_write_query ? 1 : 0, + db_cached_count: record_cached_query ? 1 : 0, + db_replica_cached_count: record_cached_query ? 1 : 0, + "db_replica_#{db_config_name}_cached_count": record_cached_query ? 1 : 0, + db_replica_count: record_query ? 1 : 0, + "db_replica_#{db_config_name}_count": record_query ? 1 : 0, + db_replica_duration_s: record_query ? 0.002 : 0, + "db_replica_#{db_config_name}_duration_s": record_query ? 0.002 : 0, + db_replica_wal_count: record_wal_query ? 1 : 0, + "db_replica_#{db_config_name}_wal_count": record_wal_query ? 1 : 0, + db_replica_wal_cached_count: record_wal_query && record_cached_query ? 1 : 0, + "db_replica_#{db_config_name}_wal_cached_count": record_wal_query && record_cached_query ? 1 : 0 + }) + else + { + db_count: record_query ? 1 : 0, + db_write_count: record_write_query ? 1 : 0, + db_cached_count: record_cached_query ? 1 : 0 + } + end expect(described_class.db_counter_payload).to eq(expected) end end end - context 'when multiple_database_metrics is disabled' do + context 'when the GITLAB_MULTIPLE_DATABASE_METRICS env var is disabled' do before do - stub_feature_flags(multiple_database_metrics: false) + stub_env('GITLAB_MULTIPLE_DATABASE_METRICS', nil) end it 'does not include per database metrics' do Gitlab::WithRequestStore.with_request_store do subscriber.sql(event) - connection = event.payload[:connection] - expect(described_class.db_counter_payload).not_to include(:"db_replica_#{::Gitlab::Database.dbname(connection)}_duration_s") + expect(described_class.db_counter_payload).not_to include(:"db_replica_#{db_config_name}_duration_s") + expect(described_class.db_counter_payload).not_to include(:"db_replica_#{db_config_name}_count") end end end 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) @@ -108,14 +128,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| |