일괄 배경 마이그레이션

일괄 배경 마이그레이션은 우리 가이드라인에서 시간 제한을 초과하는 마이그레이션이 있을 때 데이터 마이그레이션을 수행하는 데 사용해야 합니다. 예를 들어, 단일 JSON 열에 저장된 데이터를 별도의 테이블로 마이그레이션하는 경우 일괄 배경 마이그레이션을 사용할 수 있습니다.

참고: 일괄 배경 마이그레이션은 기존의 배경 마이그레이션 프레임워크를 대체했습니다. 그 프레임워크와 관련된 변경 사항에 대한 자세한 내용은 해당 문서를 확인하세요.

참고: 일괄 배경 마이그레이션 프레임워크에는 ChatOps 지원이 있습니다. ChatOps를 사용하면 GitLab 엔지니어가 시스템에 있는 일괄 배경 마이그레이션과 상호 작용할 수 있습니다.

일괄 배경 마이그레이션 사용 시기

일괄 배경 마이그레이션은 표준 Rails 마이그레이션을 사용하여 수행 시 우리 가이드라인의 시간 제한을 초과하는 프로세스가 발생하는 테이블의 데이터를 마이그레이션할 때 사용해야 합니다.

일괄 배경 마이그레이션을 사용해야 하는 경우: - 고트래픽 테이블에서 데이터를 마이그레이션할 때 - 큰 데이터세트의 각 항목에 대해 많은 단일 행 쿼리를 실행할 때. 일반적으로 단일 레코드 패턴의 경우 런타임은 데이터 세트의 크기에 크게 의존합니다. 데이터 세트를 적절하게 분할하고 일괄 배경 마이그레이션에 넣으세요. - 스키마 마이그레이션을 수행하지 않는 경우

배경 마이그레이션은 다음과 같은 경우에 도움이 될 수 있습니다: - 한 테이블에서 여러 개의 별도 테이블로 이벤트를 마이그레이션하는 경우 - 다른 열에 저장된 JSON을 기반으로 한 열을 채우는 경우 - 외부 서비스의 출력에 따라 데이터를 마이그레이션하는 경우(예: API)

참고사항

  • 일괄 배경 마이그레이션이 중요한 업그레이드의 일부인 경우 릴리스 게시물에서 발표해야 합니다. 마이그레이션 항목이 이 범주에 포함되는지 확신하지 못하는 경우 프로젝트 매니저와 상의하세요.
  • 필요한 파일이 기본적으로 생성되도록 일괄 배경 마이그레이션을 생성하기 위해 생성기를 사용해야 합니다.

일괄 배경 마이그레이션 작동 방식

일괄 배경 마이그레이션(BBM)은 Gitlab::BackgroundMigration::BatchedMigrationJob의 하위 클래스로서 perform 메서드를 정의합니다. 첫 번째 단계로 일반 마이그레이션이 필요한 인수와 함께 batched_background_migrations 레코드를 생성합니다. 기본적으로 batched_background_migrations는 활성 상태이며 Sidekiq 워커가 실제 일괄 마이그레이션을 실행하도록 선택합니다.

모든 마이그레이션 클래스는 Gitlab::BackgroundMigration 네임스페이스에 정의해야 합니다. 파일을 lib/gitlab/background_migration/ 디렉토리에 위치시키세요.

실행 메커니즘

일괄 배경 마이그레이션은 대기열에서 대기 중인 순서대로 가져오고 처리됩니다. 여러 개의 마이그레이션이 가져와지며, 활성 상태이고 동일한 데이터베이스 테이블을 대상으로하지 않는한 병렬로 실행됩니다. 병렬로 처리되는 기본 마이그레이션 개수는 2이며, GitLab.com의 경우 이 한계는 4로 구성됩니다. 마이그레이션이 실행될 때마다 마이그레이션의 배치 크기는 마지막 20개의 작업의 성능에 따라 증가 또는 감소할 수 있습니다.

Idempotence

배치된 백그라운드 마이그레이션은 Sidekiq 프로세스의 컨텍스트에서 실행됩니다. 일반적인 Sidekiq 규칙이 적용되는데, 특히 작업은 작고 멱등해야 합니다. 마이그레이션 작업이 다시 시도될 경우 데이터 무결성이 보장되도록 해야 합니다.

자세한 내용은 Sidekiq 최적 사례 가이드라인을 참조하세요.

마이그레이션 최적화

각 작업 실행 후 최적화를 위해 검증이 수행됩니다. 최적화의 기본 메커니즘은 시간 효율성 개념에 기반합니다. 지난 N개의 작업에 대한 시간 효율성의 지수 이동 평균을 계산하고 배치된 백그라운드 마이그레이션의 배치 크기를 최적값으로 업데이트합니다.

작업 재시도 메커니즘

배치된 백그라운드 마이그레이션의 재시도 메커니즘은 작업이 실패한 경우에 다시 실행되도록 보장합니다. 다음 다이어그램은 재시도 메커니즘의 다양한 단계를 보여줍니다:

실패한 배치된 백그라운드 마이그레이션

다음 중 하나라도 해당되는 경우 전체 배치된 백그라운드 마이그레이션이 failed로 표시됩니다 (/chatops run batched_background_migrations status MIGRATION_ID를 실행하면 마이그레이션이 failed로 표시됨):

배치 마이그레이션 쓰로틀링

배치 마이그레이션은 업데이트가 많이 발생하며, 과거에는 데이터베이스가 성능을 발휘하지 못할 때 마이그레이션으로 인한 과부하로 몇 차례 사고가 발생한 바 있기 때문에 쓰로틀링 메커니즘이 존재합니다.

이러한 데이터베이스 지표가 마이그레이션을 쓰로틀링하는 데 사용됩니다. 정지 신호를 받으면 마이그레이션은 설정된 시간(10분) 동안 일시 중지됩니다:

  • 단일 WAL 대기열 아카이브가 임계값을 넘는 경우
  • 마이그레이션이 작동하는 테이블에 활성 autovacuum이 실행 중인 경우
  • Patroni apdex SLI가 SLO를 아래로 내릴 경우
  • WAL 속도가 임계값을 넘는 경우

데이터베이스 헬스 체크 프레임워크를 계속해서 향상시키기 위해 더 많은 지표를 추가하는 작업이 진행 중입니다. 자세한 내용은 epic 7594을 참조하세요.

격리

배치된 백그라운드 마이그레이션은 격리되어야 하며 애플리케이션 코드(예: app/models에 정의된 모델, 단 ApplicationRecord 클래스는 예외)를 사용해서는 안 됩니다. 이러한 마이그레이션은 오랜 시간 동안 실행될 수 있으므로 새 버전이 배포되는 동안에도 마이그레이션이 계속 실행될 수 있습니다.

마이그레이션된 데이터에 종속

일반적인 또는 포스트 마이그레이션과 달리 데이터가 완전히 마이그레이트된 것을 보장하기 위해서는 다음 릴리스를 기다리는 것만으로 충분하지 않습니다. 따라서 데이터에 의존해서는 안 되며, 배치된 백그라운드 마이그레이션이 완료될 때까지 기다려야 합니다. 데이터의 100% 마이그레이션이 필요한 경우, ensure_batched_background_migration_is_finished 헬퍼를 사용하여 마이그레이션이 완료되고 데이터가 완전히 마이그레이션된 것을 보장할 수 있습니다. (예시 보기).

사용법

배치된 백그라운드 마이그레이션 생성

사용자 정의 생성기 batched_background_migration은 필요한 파일을 만들고 table_name, column_name, feature_category를 인수로 사용합니다. 사용법:

bundle exec rails g batched_background_migration my_batched_migration --table_name=<table-name> --column_name=<column-name> --feature_category=<feature-category>

이 명령은 다음 파일을 만듭니다:

  • db/post_migrate/20230214231008_queue_my_batched_migration.rb
  • spec/migrations/20230214231008_queue_my_batched_migration_spec.rb
  • lib/gitlab/background_migration/my_batched_migration.rb
  • spec/lib/gitlab/background_migration/my_batched_migration_spec.rb

배치 배경 마이그레이션 대기열에 등록

배치 배경 마이그레이션을 대기열에 등록해야 할 시점은 배포 후 마이그레이션입니다. 이 queue_batched_background_migration 예제를 사용하여 마이그레이션을 일괄로 실행하도록 대기열에 등록하세요. 클래스 이름과 매개변수를 마이그레이션에서 사용하는 값으로 대체하세요:

queue_batched_background_migration(
  JOB_CLASS_NAME,
  TABLE_NAME,
  JOB_ARGUMENTS,
  JOB_INTERVAL
)

참고: 이 도우미는 제공된 작업 인수의 수가 JOB_CLASS_NAME에서 정의된 작업 인수의 수와 일치하지 않을 경우 오류를 발생시킵니다.

새로 생성된 데이터가 마이그레이션되거나, 생성시 이전 및 새 버전에 저장되어 있는지 확인하세요. 반면에 삭제는 부모 키가 있는 외래 키를 정의함으로써 처리할 수 있습니다.

배치 배경 마이그레이션 완료

배치 배경 마이그레이션 완료는 ensure_batched_background_migration_is_finished을 호출하여 수행됩니다.

안전한 경우에는 모든 배치 배경 마이그레이션을 완료해야 합니다. 이전의 배치 배경 마이그레이션을 그대로 둔 채로 두면 기술적 부채가 발생하며 테스트 및 애플리케이션 동작에서 유지해야 합니다. 이전 배치 배경 마이그레이션이 최종화되기 전까지 어떤 배치 배경 마이그레이션이 완료될 수 있다고 의존해서는 안됩니다.

다음 조건이 모두 충족된 후에 배치 배경 마이그레이션이 완료되는 것을 권장합니다:

  • 배치 배경 마이그레이션이 GitLab.com에서 완료됨
  • 배치 배경 마이그레이션이 필수 중지 이전에 추가되었음

ensure_batched_background_migration_is_finished 호출은 대기열에 등록된 마이그레이션과 정확히 일치해야 합니다. 특히 다음 사항을 주의 깊게 확인하세요:

  • 작업 인수: 대기열에 등록된 마이그레이션을 찾지 못하게 정확히 맞아야 합니다.
  • gitlab_schema: 테이블의 gitlab_schemagitlab_main에서 그 사이에 gitlab_main_cell로 변경되었다 하더라도 gitlab_main으로 최종화해야 합니다.디 초

배치 배경 마이그레이션을 최종화할 때 해당 db/docs/batched_background_migrations 파일의 finalized_by도 업데이트해야 합니다. 값은 최종화하는 데 추가한 마이그레이션의 타임스탬프/버전이어야 합니다.

구체적인 마이그레이션 코드에 대한 자세한 내용은 아래의 예시를 참조하세요.

작업 인수 사용

BatchedMigrationJob은 작업 클래스가 필요로 하는 작업 인수를 정의하기 위해 job_arguments 도우미 메서드를 제공합니다.

queue_batched_background_migration을 사용하여 예약된 배치 마이그레이션은 반드시 도우미를 사용하여 작업 인수를 정의해야 합니다:

queue_batched_background_migration(
  'CopyColumnUsingBackgroundMigrationJob',
  TABLE_NAME,
  'name', 'name_convert_to_text',
  job_interval: DELAY_INTERVAL
)

참고: 예약된 마이그레이션을 스케줄링할 때 정의된 작업 인수의 수가 마이그레이션을 예약할 때 제공된 작업 인수의 수와 일치하지 않으면 queue_batched_background_migration에서 오류가 발생합니다.

이 예제에서 copy_fromname을 반환하고, copy_toname_convert_to_text을 반환합니다.

class CopyColumnUsingBackgroundMigrationJob < BatchedMigrationJob
  job_arguments :copy_from, :copy_to
  operation_name :update_all

  def perform
    from_column = connection.quote_column_name(copy_from)
    to_column = connection.quote_column_name(copy_to)

    assignment_clause = "#{to_column} = #{from_column}"

    each_sub_batch do |relation|
      relation.update_all(assignment_clause)
    end
  end
end

필터 사용

배경 작업을 만들 때 기본적으로 배치 배경 마이그레이션은 지정된 테이블 전체에서 반복됩니다. 이 반복은 PrimaryKeyBatchingStrategy를 사용합니다. 테이블에 1000개의 레코드가 있고 배치 크기가 100이면 작업이 10개로 분할됩니다. 설명을 위해 EachBatch는 다음과 같이 사용됩니다:

# PrimaryKeyBatchingStrategy
Namespace.each_batch(of: 100) do |relation|
  relation.where(type: nil).update_all(type: 'User') # 이 처리는 각 백그라운드 작업에서 발생합니다
end

일부 경우에는 레코드의 일부만 확인해야 합니다. 1000개 레코드 중 10%만 확인해야 하는 경우, 작업의 초기 관계에 필터를 적용하세요:

Namespace.where(type: nil).each_batch(of: 100) do |relation|
  relation.update_all(type: 'User')
end

첫 번째 예에서 각 배치에서 업데이트되는 레코드 수를 알 수 없습니다. (필터링된) 두 번째 예에서는 각 배치에서 정확히 100개가 업데이트됩니다.

BatchedMigrationJob은 추가적인 필터를 적용하여 이를 달성하기 위한 scope_to 도우미 메서드를 제공합니다:

  1. 추가 필터를 정의하고 있는 BatchedMigrationJob를 상속받은 새로운 마이그레이션 작업 클래스를 생성하세요:

    class BackfillNamespaceType < BatchedMigrationJob
      scope_to ->(relation) { relation.where(type: nil) }
      operation_name :update_all
      feature_category :source_code_management
    
      def perform
        each_sub_batch do |sub_batch|
          sub_batch.update_all(type: 'User')
        end
      end
    end
    

    참고: scope_to를 정의하는 EE 마이그레이션에는 모듈이 ActiveSupport::Concern을 확장하는지 확인하세요. 그렇지 않으면 레코드는 범위를 고려하지 않고 처리됩니다.

  2. 배포 후 마이그레이션에서 배치 배경 마이그레이션을 대기열에 등록하세요:

    class BackfillNamespaceType < Gitlab::Database::Migration[2.1]
      MIGRATION = 'BackfillNamespaceType'
      DELAY_INTERVAL = 2.minutes
    
      restrict_gitlab_migration gitlab_schema: :gitlab_main
    
      def up
        queue_batched_background_migration(
          MIGRATION,
          :namespaces,
          :id,
          job_interval: DELAY_INTERVAL
        )
      end
    
      def down
        delete_batched_background_migration(MIGRATION, :namespaces, :id, [])
      end
    end
    

참고: 추가 필터를 적용할 때는 EachBatch 성능을 최적화하기 위해 해당 필터가 적절히 포함되어 있는지 확인하는 것이 중요합니다. 위의 예시에서는 (type, id)에 대한 인덱스가 필요합니다. 자세한 내용은 EachBatch 문서를 참조하세요.

다중 데이터베이스에 대한 액세스 데이터

일반 마이그레이션과 달리 백그라운드 마이그레이션은 여러 데이터베이스에 액세스할 수 있으며 이를 효율적으로 액세스하고 업데이트하는 데 사용할 수 있습니다. 올바른 데이터베이스를 지정하기 위해서는 마이그레이션 코드 내에서 ActiveRecord 모델을 생성하는 것이 좋습니다. 해당 모델은 테이블이 위치한 데이터베이스에 따라 올바른 ApplicationRecord을 사용해야 합니다. 따라서 ActiveRecord::Base의 사용은 해당 테이블에 액세스하기 위해 명시적으로 데이터베이스를 설명하지 않으므로 허용되지 않습니다.

# 좋은 예
class Gitlab::BackgroundMigration::ExtractIntegrationsUrl
  class Project < ::ApplicationRecord
    self.table_name = 'projects'
  end

  class Build < ::Ci::ApplicationRecord
    self.table_name = 'ci_builds'
  end
end

# 나쁜 예
class Gitlab::BackgroundMigration::ExtractIntegrationsUrl
  class Project < ActiveRecord::Base
    self.table_name = 'projects'
  end

  class Build < ActiveRecord::Base
    self.table_name = 'ci_builds'
  end
end

마찬가지로 ActiveRecord::Base.connection의 사용도 허용되지 않으며, 가능하다면 모델 연결을 사용하여 대체해야 합니다.

# 좋은 예
Project.connection.execute("SELECT * FROM projects")

# 적절한 예
ApplicationRecord.connection.execute("SELECT * FROM projects")

# 나쁜 예
ActiveRecord::Base.connection.execute("SELECT * FROM projects")

배치된 백그라운드 마이그레이션 다시 대기열에 넣기

배치된 백그라운드 마이그레이션은 다양한 이유로 다시 실행해야 할 수 있습니다.

  • 마이그레이션에 버그가 있는 경우 (예시).
  • 마이그레이션이 데이터를 정리했지만 응용프로그램 논리 우회로 데이터가 다시 정규화된 경우 (예시).
  • 원래 마이그레이션의 배치 크기로 인해 마이그레이션이 실패하는 경우 (예시).

배치된 백그라운드 마이그레이션을 다시 대기열에 넣으려면 다음을 수행해야 합니다.

  • 원래 마이그레이션 파일의 #up#down 메서드의 내용을 No-op 처리해야 합니다. 그렇지 않으면, 배치된 백그라운드 마이그레이션이 여러 패치 릴리스를 동시에 업그레이드하는 시스템에서 만들어지고 삭제된 후 다시 만들어집니다.
  • 배치된 백그라운드 마이그레이션을 다시 실행하는 새로운 포스트 배포 마이그레이션을 추가해야 합니다.
  • 새로운 포스트 배포 마이그레이션에서 기존의 배치된 백그라운드 마이그레이션을 delete_batched_background_migration 메서드를 사용하여 #up 메서드 시작 시에 삭제하여 기존 실행이 정리되도록 해야 합니다.
  • 원래 마이그레이션에서 db/docs/batched_background_migration/*.yml 파일을 업데이트하여 재대기열에 대한 정보를 포함해야 합니다.

중복되지 않는 열에 대한 배치 처리

기본 배치 전략은 기본 키 열에 대한 효율적인 반복 방법을 제공합니다. 그러나 고유하지 않은 값의 열을 반복하여야 하는 경우 다른 배치 전략을 사용해야 합니다.

LooseIndexScanBatchingStrategy 배치 전략은 특별한 버전의 EachBatch를 사용하여 고유한 열 값에 대해 효율적이고 안정적인 반복을 제공합니다.

이 예제는 issues.project_id 열을 배치 열로 사용하는 배치된 백그라운드 마이그레이션을 보여줍니다.

데이터베이스 포스트 마이그레이션:

class ProjectsWithIssuesMigration < Gitlab::Database::Migration[2.1]
  MIGRATION = 'BatchProjectsWithIssues'
  INTERVAL = 2.minutes
  BATCH_SIZE = 5000
  SUB_BATCH_SIZE = 500
  restrict_gitlab_migration gitlab_schema: :gitlab_main

  disable_ddl_transaction!
  def up
    queue_batched_background_migration(
      MIGRATION,
      :issues,
      :project_id,
      job_interval: INTERVAL,
      batch_size: BATCH_SIZE,
      batch_class_name: 'LooseIndexScanBatchingStrategy', # 기본 배치 전략 재정의
      sub_batch_size: SUB_BATCH_SIZE
    )
  end

  def down
    delete_batched_background_migration(MIGRATION, :issues, :project_id, [])
  end
end

배경 마이그레이션 클래스 구현:

module Gitlab
  module BackgroundMigration
    class BatchProjectsWithIssues < Gitlab::BackgroundMigration::BatchedMigrationJob
      include Gitlab::Database::DynamicModelHelpers

      operation_name :backfill_issues

      def perform
        distinct_each_batch do |batch|
          project_ids = batch.pluck(batch_column)
          # 고유한 project_ids로 작업 수행
        end
      end
    end
  end
end

참고: LooseIndexScanBatchingStrategydistinct_each_batch에 의해 정의된 추가 필터가 무시됩니다.

배치된 백그라운드 마이그레이션의 전체 소요 시간 계산

BBM이 완료되기까지 얼마나 걸릴지 추정할 수 있습니다. GitLab은 이미 db:gitlabcom-database-testing 파이프라인을 통해 추정치를 제공합니다. 이 추정치는 테스트 환경에서 프로덕션 데이터를 샘플링하여 작성되었으며 마이그레이션이 소요할 수 있는 최대 시간을 나타내지만 실제로 소요되는 시간을 반드시 나타내지는 않습니다. 특정 시나리오에서는 db:gitlabcom-database-testing 파이프라인에 의해 제공된 추정치만으로는 마이그레이션되는 레코드 주변의 모든 특성을 계산하기에는 충분하지 않을 수 있으므로 추가 계산이 필요할 수 있습니다. 필요한 경우, interval * number of records / max batch size 공식을 사용하여 마이그레이션이 소요하는 대략적인 예상 시간을 결정할 수 있습니다. intervalmax batch size는 작업에 정의된 옵션을 의미하며 total tuple count는 마이그레이션해야 하는 레코드 수를 의미합니다.

참고: 추정치는 마이그레이션 최적화 메커니즘에 의해 영향을 받을 수 있습니다.

배치 배경 마이그레이션 정리

참고: 남아있는 배경 마이그레이션을 정리해야 하는 경우, 주 버전이나 부 버전에서 수행해야 합니다. 이를 패치 릴리스에서 진행해서는 안 됩니다.

배경 마이그레이션이 오래 걸릴 수 있기 때문에, 큐에 넣은 후 즉시 정리할 수 없습니다. 예를 들어, 마이그레이션 프로세스에서 사용되는 열을 삭제할 수 없으며, 작업이 실패할 수 있습니다. 남아 있는 모든 작업을 완료하는 향후 릴리스에서 별도의 포스트-배포 마이그레이션을 추가하여 작업을 마무리한 후 정리해야 합니다. (예: 열 제거)

큰 JSON 덩어리를 포함한 foo 열의 데이터를 bar 문자열을 포함하는 열로 마이그레이션하려면 다음을 수행해야 합니다:

  1. 릴리스 A:
    1. 특정 ID를 가진 행에 대해 마이그레이션을 수행하는 마이그레이션 클래스를 작성합니다.
    2. 새로운 행을 업데이트하기 위해 다음 기술 중 하나를 사용합니다:
      • 어플리케이션 논리가 필요 없는 복사 작업에 대한 새로운 트리거를 생성합니다.
      • 레코드가 생성되거나 업데이트될 때 모델/서비스에서 이 작업을 처리합니다.
      • 레코드를 업데이트하는 새로운 사용자 정의 배경 작업을 생성합니다.
    3. 모든 기존 행을 위한 배치 배경 마이그레이션을 큐에 넣습니다.
  2. 릴리스 B:
    1. 배치 배경 마이그레이션이 완료되었는지 확인하는 포스트-배포 마이그레이션을 추가합니다.
    2. 응용 프로그램이 새 열을 사용하도록 코드를 배포하고, 새 레코드를 업데이트하지 않도록 합니다.
    3. 이전 열을 삭제합니다.

import/export 버전을 높이는 것이 필요할 수 있으며, GitLab의 이전 버전에서 프로젝트를 가져오려면 데이터를 새 형식으로 변경해야 합니다.

배치 배경 마이그레이션을 지원하기 위해 인덱스 추가

가끔씩 배치 배경 마이그레이션을 지원하기 위해 새로운 또는 임시 인덱스를 추가해야 하는 경우가 있습니다. 이를 위해 배경 마이그레이션을 큐에 넣는 포스트-배포 마이그레이션보다 먼저 인덱스를 생성합니다.

새로운 인덱스를 바로 사용할 수 있도록 하는 일부 특별한 주의가 필요한 경우에 대한 자세한 내용은 데이터베이스 인덱스 추가 문서에서 확인하세요.

데이터베이스 테스트 파이프라인에서 특정 배치 실행

참고: 데이터베이스 유지 관리자만 데이터베이스 테스트 파이프라인 아티팩트를 볼 수 있습니다. 이 방법을 사용해야 하는 경우 도움이 필요한 경우 도움을 요청하세요.

예를 들어, GitLab.com에서 특정 배치에서 배치 배경 마이그레이션이 실패한 경우 어떤 쿼리가 실패했는지, 그 이유를 파악하려고 할 수 있습니다. 현재로서는 쿼리 정보(특히 쿼리 매개변수)를 검색하는 좋은 방법이 없으며, 더 많은 로깅을 추가하여 전체 마이그레이션을 다시 실행하는 것은 오랜 과정이 될 것입니다.

다행히도 데이터베이스 마이그레이션 파이프라인을 활용하여 특정 배치를 더 많은 로깅 및/또는 수정과 함께 다시 실행하여 문제를 해결하는지 확인할 수 있습니다.

예시: 임시: Test PG::CardinalityViolation 수정을 참고하세요. 다만 전체 섹션을 읽어보도록 하세요.

이를 수행하려면 다음과 같이 해야 합니다:

  1. 배치 start_idend_id 찾기
  2. 일반적인 마이그레이션 생성
  3. 마이그레이션 헬퍼에 대한 워크어라운드 적용 (선택 사항)
  4. 데이터베이스 마이그레이션 파이프라인 시작

배치 start_idend_id 찾기

Kibana에서 해당 정보를 찾을 수 있어야 합니다.

일반적인 마이그레이션 생성

정규 마이그레이션의 up 블록에서 배치를 예약하세요:

def up
  instance = Gitlab::BackgroundMigration::YourBackgroundMigrationClass.new(
      start_id: <batch start_id>,
      end_id: <batch end_id>,
      batch_table: <table name>,
      batch_column: <batching column>,
      sub_batch_size: <sub batch size>,
      pause_ms: <miliseconds between batches>,
      job_arguments: <job arguments if any>,
      connection: connection
    )

    instance.perform
end

def down
  # no-op
end

마이그레이션 헬퍼에 대한 워크어라운드 적용 (선택사항)

만약 배치 배경 마이그레이션이 restrict_gitlab_migration 헬퍼를 사용하여 지정한 스키마가 아닌 다른 스키마의 테이블에 영향을 주는 경우(예: 스케줄링 마이그레이션이 restrict_gitlab_migration gitlab_schema: :gitlab_main을 사용하고 있지만 배경 작업이 :gitlab_ci 스키마의 테이블을 사용하는 경우) 마이그레이션이 실패할 것입니다. 이를 방지하기 위해 테스트 파이프라인 작업이 실패하지 않도록 데이터베이스 헬퍼를 먼키 패치해야 합니다:

  1. RestrictGitlabSchema에 스키마 이름 추가하기
diff --git a/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb b/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb
index b8d1d21a0d2d2a23d9e8c8a0a17db98ed1ed40b7..912e20659a6919f771045178c66828563cb5a4a1 100644
--- a/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb
+++ b/lib/gitlab/database/migration_helpers/restrict_gitlab_schema.rb
@@ -55,7 +55,7 @@ def unmatched_schemas
         end

         def allowed_schemas_for_connection
-          Gitlab::Database.gitlab_schemas_for_connection(connection)
+          Gitlab::Database.gitlab_schemas_for_connection(connection) << :gitlab_ci
         end
       end
     end
  1. RestrictAllowedSchemas에 스키마 이름 추가하기
diff --git a/lib/gitlab/database/query_analyzers/restrict_allowed_schemas.rb b/lib/gitlab/database/query_analyzers/restrict_allowed_schemas.rb
index 4ae3622479f0800c0553959e132143ec9051898e..d556ec7f55adae9d46a56665ce02de782cb09f2d 100644
--- a/lib/gitlab/database/query_analyzers/restrict_allowed_schemas.rb
+++ b/lib/gitlab/database/query_analyzers/restrict_allowed_schemas.rb
@@ -79,7 +79,7 @@ def restrict_to_dml_only(parsed)
             tables = self.dml_tables(parsed)
             schemas = self.dml_schemas(tables)

-            if (schemas - self.allowed_gitlab_schemas).any?
+            if (schemas - (self.allowed_gitlab_schemas << :gitlab_ci)).any?
               raise DMLAccessDeniedError, \
                 "Select/DML queries (SELECT/UPDATE/DELETE) do access '#{tables}' (#{schemas.to_a}) " \
                 "which is outside of list of allowed schemas: '#{self.allowed_gitlab_schemas}'. " \

데이터베이스 마이그레이션 파이프라인 시작

변경 내용을 반영한 드래프트 병합 요청을 생성하고 수동으로 db:gitlabcom-database-testing 작업을 트리거합니다.

의존성 설정

일부 경우에는 마이그레이션이 이전에 enqueued된 BBM의 완료를 필요로 합니다. BBM이 여전히 실행 중인 경우, 해당 종속 마이그레이션이 실패합니다. 예를 들어: 큰 테이블에 고유한 인덱스를 도입하는 것은 이전에 enqueued된 BBM이 중복 레코드를 처리하도록 하는 것에 종속될 수 있습니다.

다음 프로세스는 마이그레이션을 작성하는 동안 종속성을 더 명확히 설정하기 위해 구성되었습니다.

  • BBM을 enqueued한 마이그레이션의 버전은 batched_background_migrations 테이블과 BBM 사전 파일에 저장됩니다.
  • DEPENDENT_BATCHED_BACKGROUND_MIGRATIONS 상수가 각 마이그레이션 파일에 추가됩니다(기본적으로 주석 처리됨). 종속성을 설정하려면, 종속 BBM의 queued_migration_version을 추가하세요. 그렇지 않다면 주석 처리된 줄을 제거하세요.
  • Migration::UnfinishedDependencies cop은 종속 BBM이 아직 완료되지 않았는지를 확인합니다. 이는 BBM 사전에서 finalized_by 키를 조회하여 결정합니다.

예시:

# db/post_migrate/20231113120650_queue_backfill_routes_namespace_id.rb
class QueueBackfillRoutesNamespaceId < Gitlab::Database::Migration[2.1]
  MIGRATION = 'BackfillRouteNamespaceId'

  restrict_gitlab_migration gitlab_schema: :gitlab_main
  ...
  ...

  def up
    queue_batched_background_migration(
      MIGRATION,
      ...
    )
  end
end
# 이것은 QueueBackfillRoutesNamespaceId BBM의 완료를 기다립니다.
class AddNotNullToRoutesNamespaceId < Gitlab::Database::Migration[2.1]
  DEPENDENT_BATCHED_BACKGROUND_MIGRATIONS = ["20231113120650"]

  def up
    add_not_null_constraint :routes, :namespace_id
  end

  def down
    remove_not_null_constraint :routes, :namespace_id
  end
end

참고 사항

  • BackgroundMigration::DictionaryFile cop은 BBM 사전에 finalize_afterintroduced_by_url 키의 존재를 보장합니다.
    • finalize_after: 해당 BBM이 완료될 것으로 예상되는 (대략적인) 날짜를 기록합니다.
    • introduced_by_url: finalize_after 날짜 이후에 introduced_by_url의 라벨과 작성자를 사용하여 이슈가 생성됩니다.
      • 작성 당시(2023-08-11), 이슈 #424886는 여전히 열려 있습니다.

관리

주의: BBM 관리는 GitLab 팀 멤버에게만 허용되는 ‘chatops’ 통합을 통해 진행됩니다.

Batched background migrations 목록

시스템에 있는 batched background migrations 목록을 보려면 다음 명령을 실행합니다:

/chatops run batched_background_migrations list

이 명령은 다음 옵션을 지원합니다:

  • 데이터베이스 선택:
    • --database DATABASE_NAME: 지정된 데이터베이스에 연결합니다:
      • main: 기본적으로 메인 데이터베이스를 사용합니다.
      • ci: CI 데이터베이스를 사용합니다.
  • 환경 선택:
    • --dev: dev 환경을 사용합니다.
    • --staging: staging 환경을 사용합니다.
    • --staging_ref: staging_ref 환경을 사용합니다.
    • --production : production 환경을 사용합니다(기본값).

출력 예시:

List command

주의: ChatOps는 created_at(내림차순)으로 정렬된 20개의 batched background migrations를 반환합니다.

Batched background migration 진행 및 상태 모니터링

특정 batched background migration의 상태와 진행률을 확인하려면 다음 명령을 실행합니다:

/chatops run batched_background_migrations status MIGRATION_ID

이 명령은 다음 옵션을 지원합니다:

  • 데이터베이스 선택:
    • --database DATABASE_NAME: 지정된 데이터베이스에 연결합니다:
      • main: 기본적으로 메인 데이터베이스를 사용합니다.
      • ci: CI 데이터베이스를 사용합니다.
  • 환경 선택:
    • --dev: dev 환경을 사용합니다.
    • --staging: staging 환경을 사용합니다.
    • --staging_ref: staging_ref 환경을 사용합니다.
    • --production : production 환경을 사용합니다(기본값).

출력 예시:

Status command

진행률은 완료된 배경 마이그레이션의 백분율을 나타냅니다.

배치된 배경 마이그레이션 상태의 정의:

  • Active: 다음 중 하나:
    • 러너에 의해 선택 가능
    • 실행 중인 배치 작업.
  • Finalizing: 실행 중인 배치 작업.
  • Failed: 실패한 배치된 백그라운드 마이그레이션.
  • Finished: 완료된 배치된 백그라운드 마이그레이션.
  • Paused: 러너에게 보이지 않음.

배치된 백그라운드 마이그레이션 일시 중지

배치된 백그라운드 마이그레이션을 일시 중지하려면 다음 명령을 실행해야 합니다:

/chatops run batched_background_migrations pause MIGRATION_ID

이 명령은 다음 옵션을 지원합니다:

  • 데이터베이스 선택:
    • --database DATABASE_NAME: 주어진 데이터베이스에 연결합니다:
      • main: 기본으로 주 데이터베이스를 사용합니다.
      • ci: CI 데이터베이스를 사용합니다.
  • 환경 선택:
    • --dev: dev 환경을 사용합니다.
    • --staging: staging 환경을 사용합니다.
    • --staging_ref: staging_ref 환경을 사용합니다.
    • --production : 기본값으로 production 환경을 사용합니다.

출력 예시:

일시 중지 명령

참고: active 상태의 배치된 백그라운드 마이그레이션만 일시 중지할 수 있습니다.

배치된 백그라운드 마이그레이션 재개

배치된 백그라운드 마이그레이션을 다시 시작하려면 다음 명령을 실행해야 합니다:

/chatops run batched_background_migrations resume MIGRATION_ID

이 명령은 다음 옵션을 지원합니다:

  • 데이터베이스 선택:
    • --database DATABASE_NAME: 주어진 데이터베이스에 연결합니다:
      • main: 기본으로 주 데이터베이스를 사용합니다.
      • ci: CI 데이터베이스를 사용합니다.
  • 환경 선택:
    • --dev: dev 환경을 사용합니다.
    • --staging: staging 환경을 사용합니다.
    • --staging_ref: staging_ref 환경을 사용합니다.
    • --production : 기본값으로 production 환경을 사용합니다.

출력 예시:

재개 명령

참고: active 상태의 배치된 백그라운드 마이그레이션만 다시 시작할 수 있습니다.

백그라운드 마이그레이션 활성화 또는 비활성화

극히 제한된 상황에서 GitLab 관리자는 다음 기능 플래그 중 하나 또는 양쪽을 비활성화할 수 있습니다:

  • execute_background_migrations
  • execute_batched_migrations_on_schedule

이러한 플래그는 기본적으로 활성화되어 있습니다. 데이터베이스 호스트 유지보수와 같은 특수한 상황에서 데이터베이스 작업을 제한하기 위해 마지막 수단으로만 비활성화하세요.

경고: execute_background_migrations 또는 execute_batched_migrations_on_schedule 기능 플래그 중 하나를 비활성화하지 마세요. 완전히 그 영향을 이해하지 못하는 한 GitLab 업그레이드가 실패하고 데이터 손실이 발생할 수 있습니다.

EE 전용 기능을 위한 배치된 백그라운드 마이그레이션

EE 전용 기능을 위한 모든 백그라운드 마이그레이션 클래스는 GitLab FOSS에 포함되어야 합니다. 이를 위해 GitLab FOSS용 빈 클래스를 만들고 GitLab EE용으로 확장해야 합니다. Enterprise Edition 기능 구현 가이드에서 설명된대로 진행하세요.

참고: 작업 인수를 사용하는 EE 전용 기능을 위한 백그라운드 마이그레이션 클래스는 GitLab FOSS 클래스에 정의되어야 합니다. 이러한 정의는 GitLab FOSS 컨텍스트에서 마이그레이션이 예약될 때 작업 인수 유효성 검사가 실패하는 것을 방지하기 위해 필요합니다.

새로운 배치된 백그라운드 마이그레이션을 생성할 때 --ee-only 플래그를 전달하여 EE 전용 마이그레이션 뼈대(프레임)를 생성하려면 generator를 사용할 수 있습니다.

디버그

실패 오류 로그 보기

두 가지 방법으로 실패를 확인할 수 있습니다:

  • GitLab 로그를 통해:
    1. 배치된 백그라운드 마이그레이션을 실행한 후 작업이 실패하면 Kibana에서 로그를 확인하세요.
      • json.new_state: failed
      • json.job_class_name: <Batched Background Migration 작업 클래스 이름>
      • json.job_arguments: <Batched Background Migration 작업 클래스 인수> 필터링합니다.
    2. 작업이 실패한 이유를 이해하기 위해 json.exception_classjson.exception_message 값을 검토하세요.

    3. 재시도 메커니즘을 기억하세요. 실패가 발생했다고 해서 작업이 실패한 것은 아닙니다. 항상 작업의 최종 상태를 확인하세요.
  • 데이터베이스를 통해:

    1. 배치된 백그라운드 마이그레이션 CLASS_NAME을 가져옵니다.
    2. PostgreSQL 콘솔에서 다음 쿼리를 실행합니다:

       SELECT migration.id, migration.job_class_name, transition_logs.exception_class, transition_logs.exception_message
       FROM batched_background_migrations as migration
       INNER JOIN batched_background_migration_jobs as jobs
       ON jobs.batched_background_migration_id = migration.id
       INNER JOIN batched_background_migration_job_transition_logs as transition_logs
       ON transition_logs.batched_background_migration_job_id = jobs.id
       WHERE transition_logs.next_status = '2' AND migration.job_class_name = "CLASS_NAME";
      

테스트

테스트 작성은 다음을 위해 필요합니다:

  • 배치된 백그라운드 마이그레이션의 큐잉 마이그레이션.
  • 배치된 백그라운드 마이그레이션 자체.
  • 정리 마이그레이션.

배경 마이그레이션 스펙에 대해 :migrationschema: :latest RSpec 태그가 자동으로 설정됩니다. Testing Rails migrations 스타일 가이드를 참조하세요.

beforeafter RSpec 훅이 데이터베이스를 다운 및 업 마이그레이션합니다. 이러한 훅은 다른 배치된 백그라운드 마이그레이션 호출로 이어질 수 있습니다. spy 테스트 더블을 사용하는 것이 좋습니다. it 블록에서 정의된 기대와 RSpec 훅에서 호출된 것이 충돌할 수 있기 때문입니다. 자세한 내용은 issue #35351를 참조하세요.

최선의 방법

  1. 다루고 있는 데이터의 양을 파악하세요.
  2. 일괄 배경 마이그레이션 작업이 동일성을 갖는지 확인하세요.
  3. 작성한 테스트가 거짓 긍정이 아닌지 확인하세요.
  4. 마이그레이션되는 데이터가 중요하고 손실되어서는 안 되는 경우, 완료하기 전에 데이터의 최종 상태를 확인하는 정리 마이그레이션이 필요합니다.
  5. 데이터베이스 전문가와 숫자에 대해 논의하세요. 마이그레이션은 예상보다 DB에 더 많은 압력을 가할 수 있습니다. 스테이징에서 측정하거나 프로덕션에서 측정하도록 누군가에게 요청하세요.
  6. 일괄 배경 마이그레이션을 실행하는 데 필요한 시간을 파악하세요.
  7. 작업 클래스 내에서 무음으로 예외를 구할 때 주의하세요. 이는 실패 시나리오에서도 작업이 성공으로 표시될 수 있기 때문입니다.

    # 좋음
    def perform
      each_sub_batch do |sub_batch|
        sub_batch.update_all(name: 'My Name')
      end
    end
    
    # 허용
    def perform
      each_sub_batch do |sub_batch|
        sub_batch.update_all(name: 'My Name')
      rescue Exception => error
        logger.error(message: error.message, class: error.class)
    
        raise
      end
    end
    
    # 나쁨
    def perform
      each_sub_batch do |sub_batch|
        sub_batch.update_all(name: 'My Name')
      rescue Exception => error
        logger.error(message: error.message, class: self.class.name)
      end
    end
    

예시

라우트 사용 사례

routes 테이블에는 다형 관계에 사용되는 source_type 필드가 있습니다. 데이터베이스 재설계의 일환으로 우리는 다형 관계를 제거하고 있습니다. 작업의 한 부분으로서 source_id 열에서 새로운 단수 외래 키로의 데이터 마이그레이션이 있습니다. 나중에 이전 행을 삭제할 계획이므로, 배경 마이그레이션의 일부로서 업데이트할 필요는 없습니다.

  1. 일괄 배경 마이그레이션 파일을 생성하기 위해 생성기를 사용하여 시작하세요:

    bundle exec rails g batched_background_migration BackfillRouteNamespaceId --table_name=routes --column_name=id --feature_category=source_code_management
    
  2. 마이그레이션 작업( BatchedMigrationJob의 하위 클래스)을 업데이트하여 source_id 값을 namespace_id로 복사하세요:

    class Gitlab::BackgroundMigration::BackfillRouteNamespaceId < BatchedMigrationJob
      # 설명을 위해 로컬 모델을 사용한다면, 아래처럼 `ApplicationRecord`을 기본 클래스로 사용하여 정의할 수 있습니다.
      # class Route < ::ApplicationRecord
      #   self.table_name = 'routes'
      # end
    
      operation_name :update_all
      feature_category :source_code_management
    
      def perform
        each_sub_batch(
          batching_scope: -> (relation) { relation.where("source_type <> 'UnusedType'") }
        ) do |sub_batch|
          sub_batch.update_all('namespace_id = source_id')
        end
      end
    end
    
    note
    작업 클래스는 BatchedMigrationJob를 상속하여 배치 마이그레이션 프레임워크에 의해 올바르게 처리되도록 합니다. BatchedMigrationJob의 하위 클래스는 배치를 실행하고 추적 데이터베이스에 연결하기 위해 필요한 인수로 초기화됩니다.
  3. 데이터베이스에 새로운 트리거를 추가하는 데이터베이스 마이그레이션을 생성하세요. 예시:

    class AddTriggerToRoutesToCopySourceIdToNamespaceId < Gitlab::Database::Migration[2.1]
      FUNCTION_NAME = 'example_function'
      TRIGGER_NAME = 'example_trigger'
    
      def up
        execute(<<~SQL)
          CREATE OR REPLACE FUNCTION #{FUNCTION_NAME}() RETURNS trigger
          LANGUAGE plpgsql
          AS $$
          BEGIN
            NEW."namespace_id" = NEW."source_id"
            RETURN NEW;
          END;
          $$;
    
          CREATE TRIGGER #{TRIGGER_NAME}() AFTER INSERT OR UPDATE
          ON routes
          FOR EACH ROW EXECUTE FUNCTION #{FUNCTION_NAME}();
        SQL
      end
    
      def down
        drop_trigger(TRIGGER_NAME, :routes)
        drop_function(FUNCTION_NAME)
      end
    end
    
  4. 작성된 배포 후 마이그레이션을 필요한 지연 및 배치 크기로 업데이트하세요:

    class QueueBackfillRoutesNamespaceId < Gitlab::Database::Migration[2.1]
      MIGRATION = 'BackfillRouteNamespaceId'
      DELAY_INTERVAL = 2.minutes
      BATCH_SIZE = 1000
      SUB_BATCH_SIZE = 100
    
      restrict_gitlab_migration gitlab_schema: :gitlab_main
    
      def up
        queue_batched_background_migration(
          MIGRATION,
          :routes,
          :id,
          job_interval: DELAY_INTERVAL,
          batch_size: BATCH_SIZE,
          sub_batch_size: SUB_BATCH_SIZE
        )
      end
    
      def down
        delete_batched_background_migration(MIGRATION, :routes, :id, [])
      end
    end
    
     # db/docs/batched_background_migrations/backfill_route_namespace_id.yml
     ---
     migration_job_name: BackfillRouteNamespaceId
     description: Copies source_id values from routes to namespace_id
     feature_category: source_code_management
     introduced_by_url: "https://mr_url"
     milestone: 16.6
     queued_migration_version: 20231113120650
     finalize_after: "2023-11-15"
     finalized_by: # version of the migration that ensured this bbm
    
    note
    일괄 배경 마이그레이션을 대기열에 넣을 때, 실제 변경 사항을 가하는 데이터베이스 스키마를 제한해야 합니다. 본 예시에서는 routes 레코드를 업데이트하고 있으므로, restrict_gitlab_migration gitlab_schema: :gitlab_main로 설정합니다. 그러나 CI 데이터 마이그레이션을 수행해야 하는 경우에는 restrict_gitlab_migration gitlab_schema: :gitlab_ci로 설정해야 합니다.

    배포 후, 우리의 응용 프로그램: - 이전과 같이 데이터를 사용합니다. - 기존 및 새로운 데이터가 모두 마이그레이션되었음을 보장합니다.

  5. 배치된 배경 마이그레이션이 완료되었는지 확인하는 새로운 배포 후 마이그레이션을 추가하세요. 또한 BBM 사전의 finalized_by 속성을 이 마이그레이션 버전으로 업데이트하세요.

    class FinalizeBackfillRouteNamespaceId < Gitlab::Database::Migration[2.1]
      MIGRATION = 'BackfillRouteNamespaceId'
      disable_ddl_transaction!
    
      restrict_gitlab_migration gitlab_schema: :gitlab_main
    
      def up
        ensure_batched_background_migration_is_finished(
          job_class_name: MIGRATION,
          table_name: :routes,
          column_name: :id,
          job_arguments: [],
          finalize: true
        )
      end
    
      def down
        # no-op
      end
    end
    
     # db/docs/batched_background_migrations/backfill_route_namespace_id.yml
     ---
     migration_job_name: BackfillRouteNamespaceId
     description: Copies source_id values from routes to namespace_id
     feature_category: source_code_management
     introduced_by_url: "https://mr_url"
     milestone: 16.6
     queued_migration_version: 20231113120650
     finalize_after: "2023-11-15"
     finalized_by: 20231115120912
    
    note
    일괄 배경 마이그레이션이 완료되지 않았다면, 시스템은 일괄 배경 마이그레이션을 인라인으로 실행합니다. 이 동작을 보고 싶지 않다면 finalize: false를 전달해야 합니다.

    응용 프로그램이 데이터가 100% 마이그레이트되지 않아도 되는 경우(예: 데이터가 자문적이고 필수적이지 않은 경우), 이 단계를 건너뛸 수 있습니다. 이 단계는 마이그레이션이 완료되었고 모든 행이 마이그레이션되었는지 확인합니다.

  6. 트리거를 제거하는 데이터베이스 마이그레이션을 추가하세요.

    class RemoveNamepaceIdTriggerFromRoutes < Gitlab::Database::Migration[2.1]
      FUNCTION_NAME = 'example_function'
      TRIGGER_NAME = 'example_trigger'
    
      def up
        drop_trigger(TRIGGER_NAME, :routes)
        drop_function(FUNCTION_NAME)
      end
    
      def down
        # 추가된 트리거와 함수를 역으로해야 합니다.
      end
    

일괄 마이그레이션이 완료된 후, routes.namespace_id의 데이터를 안전하게 사용할 수 있습니다.