ETag 캐싱을 활용한 폴링

GitLab에서 Redis 기반 ETag 캐싱을 활용해 데이터베이스 부하 없이 효율적으로 변경 사항을 폴링하는 방법을 설명합니다.

변경 사항을 폴링(서버에 새로운 변경이 있는지 반복적으로 질의)하면 GitLab 인스턴스에 높은 부하가 발생합니다. 일반적으로 최소 몇 개의 SQL 쿼리를 실행해야 하기 때문입니다. 이로 인해 GitLab.com과 같은 대규모 GitLab 인스턴스의 스케일링이 매우 어려워지므로, 데이터베이스를 직접 조회하는 폴링이 필요한 새 기능 추가는 허용하지 않습니다. 대신 Redis를 활용한 ETag 캐싱 폴링 메커니즘을 사용해야 합니다. 사용 방법 # 폴링할 엔드포인트의 경로를 Gitlab::EtagCaching::Router 에 추가합니다. Gitlab::PollingInterval.set_header 를 사용해 응답에 폴링 간격 헤더를 설정합니다. Gitlab::EtagCaching::Store 를 사용해 엔드포인트 경로에 대한 캐시 무효화를 구현합니다. 리소스가 변경될 때마다 해당 리소스에 의존하는 경로의 ETag를 무효화해야 합니다. 메커니즘이 올바르게 동작하는지 확인합니다: 요청이 상태 코드 304를 반환해야 합니다. log/development.log 에 SQL 쿼리가 기록되지 않아야 합니다. ETag 캐싱 폴링 동작 방식 # 캐시 미스(Cache Miss): %%{init: { "fontFamily": "GitLab Sans" }}%% sequenceDiagram accTitle: How polling with ETag caching works accDescr: Diagram showing how polling with ETag caching works with a cache miss Client->>+Rails: GET /projects/5/pipelines Rails->>+EtagCaching: GET /projects/5/pipelines EtagCaching->>+Redis: read(key = 'GET ') rect rgba(0, 0, 0, 0) Redis->>+EtagCaching: cache MISS end EtagCaching->>+Redis: write('') EtagCaching->>+Rails: GET /projects/5/pipelines Rails->>+Client: JSON response with ETag 캐시 히트(Cache Hit): %%{init: { "fontFamily": "GitLab Sans" }}%% sequenceDiagram accTitle: How polling with ETag caching works accDescr: Diagram showing how polling with ETag caching works with a cache hit Client->>+Rails: GET /projects/5/pipelines Rails->>+EtagCaching: GET /projects/5/pipelines EtagCaching->>+Redis: read(key = 'GET ') rect rgba(0, 0, 0, 0) Redis->>+EtagCaching: cache HIT end EtagCa