debian-mirror-gitlab/lib/gitlab/database/background_migration/batched_migration_wrapper.rb

144 lines
5.3 KiB
Ruby
Raw Normal View History

2021-04-17 20:07:23 +05:30
# frozen_string_literal: true
module Gitlab
module Database
module BackgroundMigration
class BatchedMigrationWrapper
2021-04-29 21:17:54 +05:30
extend Gitlab::Utils::StrongMemoize
2022-04-04 11:22:00 +05:30
def initialize(connection: ApplicationRecord.connection)
@connection = connection
end
2021-04-29 21:17:54 +05:30
# Wraps the execution of a batched_background_migration.
#
# Updates the job's tracking records with the status of the migration
# when starting and finishing execution, and optionally saves batch_metrics
# the migration provides, if any are given.
#
# The job's batch_metrics are serialized to JSON for storage.
2021-04-17 20:07:23 +05:30
def perform(batch_tracking_record)
start_tracking_execution(batch_tracking_record)
execute_batch(batch_tracking_record)
2022-04-04 11:22:00 +05:30
batch_tracking_record.succeed!
rescue Exception => error # rubocop:disable Lint/RescueException
batch_tracking_record.failure!(error: error)
2021-04-17 20:07:23 +05:30
2021-06-08 01:23:25 +05:30
raise
2021-04-17 20:07:23 +05:30
ensure
2021-04-29 21:17:54 +05:30
track_prometheus_metrics(batch_tracking_record)
2021-04-17 20:07:23 +05:30
end
private
2022-04-04 11:22:00 +05:30
attr_reader :connection
2021-04-17 20:07:23 +05:30
def start_tracking_execution(tracking_record)
2022-04-04 11:22:00 +05:30
tracking_record.run!
2021-04-17 20:07:23 +05:30
end
def execute_batch(tracking_record)
2022-04-04 11:22:00 +05:30
job_instance = migration_instance_for(tracking_record.migration_job_class)
2021-04-17 20:07:23 +05:30
job_instance.perform(
tracking_record.min_value,
tracking_record.max_value,
tracking_record.migration_table_name,
tracking_record.migration_column_name,
tracking_record.sub_batch_size,
2021-06-08 01:23:25 +05:30
tracking_record.pause_ms,
2021-04-17 20:07:23 +05:30
*tracking_record.migration_job_arguments)
2021-04-29 21:17:54 +05:30
if job_instance.respond_to?(:batch_metrics)
tracking_record.metrics = job_instance.batch_metrics
end
2021-04-17 20:07:23 +05:30
end
2022-04-04 11:22:00 +05:30
def migration_instance_for(job_class)
if job_class < Gitlab::BackgroundMigration::BaseJob
job_class.new(connection: connection)
else
job_class.new
end
2021-04-17 20:07:23 +05:30
end
2021-04-29 21:17:54 +05:30
def track_prometheus_metrics(tracking_record)
migration = tracking_record.batched_migration
base_labels = migration.prometheus_labels
metric_for(:gauge_batch_size).set(base_labels, tracking_record.batch_size)
metric_for(:gauge_sub_batch_size).set(base_labels, tracking_record.sub_batch_size)
2021-06-08 01:23:25 +05:30
metric_for(:gauge_interval).set(base_labels, tracking_record.batched_migration.interval)
metric_for(:gauge_job_duration).set(base_labels, (tracking_record.finished_at - tracking_record.started_at).to_i)
2021-04-29 21:17:54 +05:30
metric_for(:counter_updated_tuples).increment(base_labels, tracking_record.batch_size)
2021-06-08 01:23:25 +05:30
metric_for(:gauge_migrated_tuples).set(base_labels, tracking_record.batched_migration.migrated_tuple_count)
metric_for(:gauge_total_tuple_count).set(base_labels, tracking_record.batched_migration.total_tuple_count)
metric_for(:gauge_last_update_time).set(base_labels, Time.current.to_i)
2021-04-29 21:17:54 +05:30
if metrics = tracking_record.metrics
metrics['timings']&.each do |key, timings|
summary = metric_for(:histogram_timings)
labels = base_labels.merge(operation: key)
timings.each do |timing|
summary.observe(labels, timing)
end
end
end
end
def metric_for(name)
self.class.metrics[name]
end
def self.metrics
strong_memoize(:metrics) do
{
gauge_batch_size: Gitlab::Metrics.gauge(
:batched_migration_job_batch_size,
'Batch size for a batched migration job'
),
gauge_sub_batch_size: Gitlab::Metrics.gauge(
:batched_migration_job_sub_batch_size,
'Sub-batch size for a batched migration job'
),
2021-06-08 01:23:25 +05:30
gauge_interval: Gitlab::Metrics.gauge(
:batched_migration_job_interval_seconds,
'Interval for a batched migration job'
),
gauge_job_duration: Gitlab::Metrics.gauge(
:batched_migration_job_duration_seconds,
'Duration for a batched migration job'
),
2021-04-29 21:17:54 +05:30
counter_updated_tuples: Gitlab::Metrics.counter(
:batched_migration_job_updated_tuples_total,
'Number of tuples updated by batched migration job'
),
2021-06-08 01:23:25 +05:30
gauge_migrated_tuples: Gitlab::Metrics.gauge(
:batched_migration_migrated_tuples_total,
'Total number of tuples migrated by a batched migration'
),
2021-04-29 21:17:54 +05:30
histogram_timings: Gitlab::Metrics.histogram(
2021-06-08 01:23:25 +05:30
:batched_migration_job_query_duration_seconds,
'Query timings for a batched migration job',
2021-04-29 21:17:54 +05:30
{},
[0.1, 0.25, 0.5, 1, 5].freeze
),
2021-06-08 01:23:25 +05:30
gauge_total_tuple_count: Gitlab::Metrics.gauge(
:batched_migration_total_tuple_count,
'Total tuple count the migration needs to touch'
),
gauge_last_update_time: Gitlab::Metrics.gauge(
:batched_migration_last_update_time_seconds,
'Unix epoch time in seconds'
2021-04-29 21:17:54 +05:30
)
}
end
end
2021-04-17 20:07:23 +05:30
end
end
end
end