120 lines
4.2 KiB
Ruby
120 lines
4.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Gitlab
|
|
module Database
|
|
module BackgroundMigration
|
|
class BatchedMigrationWrapper
|
|
extend Gitlab::Utils::StrongMemoize
|
|
|
|
# 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.
|
|
def perform(batch_tracking_record)
|
|
start_tracking_execution(batch_tracking_record)
|
|
|
|
execute_batch(batch_tracking_record)
|
|
|
|
batch_tracking_record.status = :succeeded
|
|
rescue => e
|
|
batch_tracking_record.status = :failed
|
|
|
|
raise e
|
|
ensure
|
|
finish_tracking_execution(batch_tracking_record)
|
|
track_prometheus_metrics(batch_tracking_record)
|
|
end
|
|
|
|
private
|
|
|
|
def start_tracking_execution(tracking_record)
|
|
tracking_record.update!(attempts: tracking_record.attempts + 1, status: :running, started_at: Time.current)
|
|
end
|
|
|
|
def execute_batch(tracking_record)
|
|
job_instance = tracking_record.migration_job_class.new
|
|
|
|
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,
|
|
*tracking_record.migration_job_arguments)
|
|
|
|
if job_instance.respond_to?(:batch_metrics)
|
|
tracking_record.metrics = job_instance.batch_metrics
|
|
end
|
|
end
|
|
|
|
def finish_tracking_execution(tracking_record)
|
|
tracking_record.finished_at = Time.current
|
|
tracking_record.save!
|
|
end
|
|
|
|
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)
|
|
metric_for(:counter_updated_tuples).increment(base_labels, tracking_record.batch_size)
|
|
|
|
# Time efficiency: Ratio of duration to interval (ideal: less than, but close to 1)
|
|
efficiency = (tracking_record.finished_at - tracking_record.started_at).to_i / migration.interval.to_f
|
|
metric_for(:histogram_time_efficiency).observe(base_labels, efficiency)
|
|
|
|
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'
|
|
),
|
|
counter_updated_tuples: Gitlab::Metrics.counter(
|
|
:batched_migration_job_updated_tuples_total,
|
|
'Number of tuples updated by batched migration job'
|
|
),
|
|
histogram_timings: Gitlab::Metrics.histogram(
|
|
:batched_migration_job_duration_seconds,
|
|
'Timings for a batched migration job',
|
|
{},
|
|
[0.1, 0.25, 0.5, 1, 5].freeze
|
|
),
|
|
histogram_time_efficiency: Gitlab::Metrics.histogram(
|
|
:batched_migration_job_time_efficiency,
|
|
'Ratio of job duration to interval',
|
|
{},
|
|
[0.5, 0.9, 1, 1.5, 2].freeze
|
|
)
|
|
}
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|