ClickHouse를 사용한 병합 요청 분석

병합 요청 분석 기능은 프로젝트에서 병합된 병합 요청에 대한 통계를 보여주며 레코드 수준의 메타데이터를 노출합니다. 집계에는 다음이 포함됩니다.

  • 평균 병합 시간: 생성 시간과 병합 시간 간의 기간.
  • 월별 집계: 병합된 병합 요청의 12개월 차트입니다.

차트 아래에서 사용자는 병합 요청의 페이지별 목록을 볼 수 있으며 한 페이지에 12개월씩 표시됩니다.

필터링 가능합니다.

  • 작성자
  • 담당자
  • 라벨
  • 마일스톤
  • 출처 브랜치
  • 대상 브랜치

현재 성능 문제

  • 집계 쿼리에는 추가 디스크 공간을 소비하는 특수한 인덱스가 필요합니다 (인덱스 전용 스캔).
  • 전체 12개월을 쿼리하는 것은 느립니다 (문장 제한 시간). 대신 프론트엔드는 월별 데이터를 요청합니다 (12개의 데이터베이스 쿼리).
  • 특수한 인덱스가 있더라도 기능을 그룹 수준에서 사용 가능하게 하는 것은 가능하지 않을 것입니다. 왜냐하면 병합 요청의 대량이기 때문입니다.

쿼리 예시

특정 월에 병합된 병합 요청 수를 구합니다. 

SELECT COUNT(*)
FROM "merge_requests"
INNER JOIN "merge_request_metrics" ON "merge_request_metrics"."merge_request_id" = "merge_requests"."id"
WHERE (NOT EXISTS
         (SELECT 1
          FROM "banned_users"
          WHERE (merge_requests.author_id = banned_users.user_id)))
  AND "merge_request_metrics"."target_project_id" = 278964
  AND "merge_request_metrics"."merged_at" >= '2022-12-01 00:00:00'
  AND "merge_request_metrics"."merged_at" <= '2023-01-01 00:00:00'

merge_request_metrics 테이블은 첫 페이지 로드 시간을 개선하기 위해 정규화되었으며, 쿼리 자체는 작은 날짜 범위에 대해 잘 작동하지만, 날짜 범위가 커질수록 시간 초과될 수 있습니다.

추가 필터가 추가되면, 쿼리가 복잡해지므로 merge_requests 테이블도 필터링해야 합니다.

ClickHouse에 병합 요청 데이터 저장

ClickHouse에서 병합 요청 데이터를 저장하고 쿼리하는 다른 몇 가지 사용 사례가 존재합니다. 이 문서에서는 특정 기능에 초점을 맞춥니다.

핵심 데이터는 merge_request_metrics 및 merge_requests 데이터베이스 테이블에 있습니다. 일부 필터는 추가 테이블과 조인이 필요합니다.

  • banned_users: 금지된 사용자가 만든 병합 요청을 걸러냅니다.
  • labels: 병합 요청에는 하나 이상의 지정된 라벨이 있을 수 있습니다.
  • assignees: 병합 요청에는 하나 이상의 담당자가 있을 수 있습니다.
  • merged_at: merged_at 열은 merge_request_metrics 테이블에 있습니다.

merge_requests 테이블에는 직접 필터링할 수 있는 데이터가 들어 있습니다.

  • 작성자: author_id 열을 통해.
  • 마일스톤: milestone_id 열을 통해.
  • 출처 브랜치.
  • 대상 브랜치.
  • 프로젝트: project_id 열을 통해.

ClickHouse 데이터 최신 상태 유지

merge_requests 테이블을 복제하거나 동기화하는 것만으로는 충분하지 않습니다. De-normalized merge_requests 행을 ClickHouse 데이터베이스에 삽입하려면 관련 테이블에 대한 별도의 쿼리가 필요합니다.

변경 감지는 구현이 어렵습니다. 우리가 절충할 수 있는 몇 가지 부분은 다음과 같습니다.

  • 이 기능은 GitLab 프리미엄 및 GitLab 얼티밋 고객을 위해 사용 가능합니다. 모든 데이터를 동기화할 필요는 없고, 라이선스가 부여된 그룹에 속한 merge_requests 레코드만 동기화하면 됩니다.
  • 데이터 변경은 주로 MergeRequest 서비스를 통해 발생하며, updated_at 타임스탬프 열을 증가시키는 것이 대부분 일관성 있습니다. 어떤 종류의 점진적 동기화 프로세스를 구현할 수 있을 것입니다.
  • 우리는 병합된 병합 요청만 쿼리할 필요가 있습니다. 병합 후 레코드는 거의 변경되지 않습니다.

데이터베이스 테이블 구조

데이터베이스 테이블 구조는 모든 필요한 열을 하나의 데이터베이스 테이블로 사용할 수 있도록 정규화를 사용합니다. 이로써 JOIN이 필요하지 않습니다. 

CREATE TABLE merge_requests
(
    `id` UInt64,
    `project_id` UInt64 DEFAULT 0 NOT NULL,
    `author_id` UInt64 DEFAULT 0 NOT NULL,
    `milestone_id` UInt64 DEFAULT 0 NOT NULL,
    `label_ids` Array(UInt64) DEFAULT [] NOT NULL,
    `assignee_ids` Array(UInt64) DEFAULT [] NOT NULL,
    `source_branch` String DEFAULT '' NOT NULL,
    `target_branch` String DEFAULT '' NOT NULL,
    `merged_at` DateTime64(6, 'UTC') NOT NULL,
    `created_at` DateTime64(6, 'UTC') DEFAULT now() NOT NULL,
    `updated_at` DateTime64(6, 'UTC') DEFAULT now() NOT NULL
)
ENGINE = ReplacingMergeTree(updated_at)
ORDER BY (project_id, merged_at, id);

활동 데이터 예시와 마찬가지로 ReplacingMergeTree 엔진을 사용합니다. 병합 요청 레코드의 여러 열이 변경될 수 있기 때문에 테이블을 최신 상태로 유지하는 것이 중요합니다.

데이터베이스 테이블은 project_id, merged_at, id 열로 정렬됩니다. 이러한 순서는 프로젝트의 merged_at 열을 쿼리하는 경우를 최적화하여 테이블 데이터를 최적화합니다.

count 쿼리 다시 쓰기

먼저 테이블에 대한 데이터를 생성해 봅시다. 

INSERT INTO merge_requests (id, project_id, author_id, milestone_id, label_ids, merged_at, created_at)
SELECT id, project_id, author_id, milestone_id, label_ids, merged_at, created_at
FROM generateRandom('id UInt64, project_id UInt8, author_id UInt8, milestone_id UInt8, label_ids Array(UInt8), merged_at DateTime64(6, \'UTC\'), created_at DateTime64(6, \'UTC\')')
LIMIT 1000000;

참고: 일부 정수 데이터 유형은 UInt8로 캐스트되었으므로 서로 다른 행에서 동일한 값을 가질 가능성이 매우 높습니다.

원래 count 쿼리는 데이터를 한 달간만 집계했습니다. ClickHouse를 사용하면 전체 연도에 대한 데이터를 집계할 수 있습니다.

PostgreSQL 기반 count 쿼리: 

SELECT COUNT(*)
FROM "merge_requests"
INNER JOIN "merge_request_metrics" ON "merge_request_metrics"."merge_request_id" = "merge_requests"."id"
WHERE (NOT EXISTS
         (SELECT 1
          FROM "banned_users"
          WHERE (merge_requests.author_id = banned_users.user_id)))
  AND "merge_request_metrics"."target_project_id" = 278964
  AND "merge_request_metrics"."merged_at" >= '2022-12-01 00:00:00'
  AND "merge_request_metrics"."merged_at" <= '2023-01-01 00:00:00'

ClickHouse 쿼리: 

SELECT
  toYear(merged_at) AS year,
  toMonth(merged_at) AS month,
  COUNT(*)
FROM merge_requests
WHERE
  project_id = 200
  AND merged_at BETWEEN '2022-01-01 00:00:00'
  AND '2023-01-01 00:00:00'
GROUP BY year, month

쿼리는 생성된 데이터에 비해 훨씬 적은 수의 행을 처리했습니다. ORDER BY 절 (기본 키)이 쿼리 실행에 도움이 되고 있습니다: 

11 행이 설정되었습니다. 경과 시간: 0.010초.
8.19천 개의 행, 131.07 KB 처리함 (783.45천 개의 행/s., 12.54 MB/s).

Mean time to merge 쿼리 다시 쓰기

이 쿼리는 평균 병합 시간을 다음과 같이 계산합니다: duration(created_at, merged_at) / merge_request_count. 계산은 두 단계로 이루어집니다:

  1. 월별 카운트 및 월별 기간 값을 요청합니다.
  2. 카운트를 합하여 연간 카운트를 얻습니다.
  3. 기간을 합하여 연간 기간을 얻습니다.
  4. 카운트로 기간을 나눕니다.

ClickHouse에서는 한 쿼리로 평균 병합 시간을 계산할 수 있습니다: 

SELECT
  SUM(
    dateDiff('second', merged_at, created_at) / 3600 / 24
  ) / COUNT(*) AS mean_time_to_merge -- mean_time_to_merge는 일 수로 표시됩니다
FROM merge_requests
WHERE
  project_id = 200
  AND merged_at BETWEEN '2022-01-01 00:00:00'
  AND '2023-01-01 00:00:00'

필터링

위의 데이터베이스 쿼리는 기본 쿼리로 사용할 수 있습니다. 더 많은 필터를 추가할 수 있습니다. 예를 들어, 라벨 및 마일스톤에 대한 필터링: 

SELECT
  toYear(merged_at) AS year,
  toMonth(merged_at) AS month,
  COUNT(*)
FROM merge_requests
WHERE
  project_id = 200
  AND milestone_id = 15
  AND has(label_ids, 118)
  AND -- 배열에 118이 포함됩니다
  merged_at BETWEEN '2022-01-01 00:00:00'
  AND '2023-01-01 00:00:00'
GROUP BY year, month

특정 필터를 최적화하는 것은 일반적으로 데이터베이스 인덱스로 수행됩니다. 이 특정 쿼리는 8000개의 행을 읽었습니다: 

1행이 설정되었습니다. 경과 시간: 0.016초.
8.19천 개의 행, 589.99 KB 처리함 (505.38천 개의 행/s., 36.40 MB/s).

milestone_id에 대한 인덱스를 추가하기: 

ALTER TABLE merge_requests
ADD
  INDEX milestone_id_index milestone_id TYPE minmax GRANULARITY 10;
ALTER TABLE
  merge_requests MATERIALIZE INDEX milestone_id_index;

생성된 데이터에서 인덱스를 추가해도 성능이 향상되지 않았습니다.

금지된 사용자 필터

GitLab에 최근에 추가된 기능으로는 관리자가 금지한 사용자인 경우 병합 요청이 필터링됩니다. 금지된 사용자는 banned_users 데이터베이스 테이블에서 인스턴스 수준으로 추적됩니다.

아이디어 1: 금지된 사용자 ID 열거

ClickHouse 데이터베이스 스키마에 구조적 변경이 없이 사용할 수 있습니다. 프로젝트에서 금지된 사용자를 쿼리하고 쿼리 시간에 해당 값을 필터링할 수 있습니다.

금지된 사용자 가져오기 (PostgreSQL에서): 

SELECT user_id FROM banned_users

ClickHouse에서 

SELECT
  toYear(merged_at) AS year,
  toMonth(merged_at) AS month,
  COUNT(*)
FROM merge_requests
WHERE
  author_id NOT IN (1, 2, 3, 4) AND -- 금지된 사용자
  project_id = 200
  AND milestone_id = 15
  AND has(label_ids, 118) AND -- 배열에 118이 포함됩니다
  merged_at BETWEEN '2022-01-01 00:00:00'
  AND '2023-01-01 00:00:00'
GROUP BY year, month

이 접근 방식의 문제는 금지된 사용자 수가 크게 늘어날 수 있어서 쿼리가 커지고 느려질 수 있다는 것입니다.

아이디어 2: banned_users 테이블 복제

banned_users 테이블이 수백만 개의 행으로 증가하지 않는다고 가정하면 ClickHouse와 주기적으로 전체 테이블을 동기화할 수 있습니다. 이 접근 방식을 통해, 거의 일관된 banned_users 테이블을 ClickHouse 데이터베이스 쿼리에서 사용할 수 있습니다: 

SELECT
  toYear(merged_at) AS year,
  toMonth(merged_at) AS month,
  COUNT(*)
FROM merge_requests
WHERE
  author_id NOT IN (SELECT user_id FROM banned_users) AND
  project_id = 200 AND
  milestone_id = 15 AND
  has(label_ids, 118) AND -- 배열에 118이 포함됩니다
  merged_at BETWEEN '2022-01-01 00:00:00' AND '2023-01-01 00:00:00'
GROUP BY year, month

대안적으로, banned_users 테이블은 사전 로 저장될 수 있어서 쿼리 성능을 더욱 향상시킬 수 있습니다.

아이디어 3: 기능 변경

분석 계산을 위해, 특정 필터를 제외하는 것이 허용될 수 있습니다. 이 접근 방식은 차단된 사용자의 병합 요청을 포함해도 통계를 심각하게 왜곡하지 않는다고 가정합니다.