Files
clean-architecture-backend-…/docs/mongodb/advanced/sharding.md
T
DongHyeonka 8d69e599a3 refactor(repo)!: 들여온 플랫폼을 src/platforms 아래로 묶는다
문제: src/ 최상위에 계층 폴더와 들여온 제품 폴더(messaging, grpc,
grpc-advanced)와 optional 빌드 폴더(optional-platforms)가 같은 높이로
놓여, 무엇이 이 애플리케이션의 계층인지 폴더만으로 안 보인다.
src/config/에는 빌드 전체 설정과 기능 하나가 주인인 데이터(jpa,
messaging, mongodb)가 섞여 있다.

고른 방법(소유자 결정 2026-11-07, 설계 가-1):
- git mv로 src/platforms/{messaging,grpc,grpc-advanced,optional-build}.
  registry source_path 28행만 바꾸고 Gradle 경로(:messaging:*, :grpc:*)는
  그대로다. optional 빌드의 이름(optional-platforms)도 그대로다.
- optional 빌드가 한 단계 깊어져, build-logic이 "optional 빌드의 부모 =
  주 빌드"로 가정한 네 곳(registry settings, ArchitecturePlugin, 테스트
  이미지 catalog, checkstyle·spotbugs 설정)을 MainBuild(위로 올라가며
  registry·설정 파일을 찾음)로 바꾼다.
- settings.gradle·build.gradle의 상대 경로, workflow의 -p 값과 경로,
  buf 작업 폴더를 고친다. buf breaking은 이동 전 baseline에서도 옛
  경로로 비교해 이동 PR에서 건너뛰지 않는다.
- config/jpa, config/messaging, config/mongodb의 데이터를 주인 leaf의
  release/로 옮기고 읽는 빌드 줄·테스트·스크립트·문서를 고친다.
- 루트 CLAUDE.md 5절에 최상위 폴더 지도를 한 줄로 적는다.
버린 대안: Gradle 루트를 저장소 루트로(가-3, CI 재편 때 다시 봄),
application-* 묶기(가-2, 파생 서비스 충돌이 큼).

위험·한계: Gradle 문서의 "이름 = 위치" 권고와 한 단계 어긋난다
(:messaging:x가 platforms/messaging/x). 옮긴 폴더를 고쳐 쓰던 파생
서비스는 이름 바뀜 충돌이 날 수 있다(B-52). docs/capability-status.md
「제거된 코드」 표와 docs/work/evidence.md의 옛 경로는 이력이라 두었다.

검증(desktop, 트리 2b3354a4, ~/t1-layout-logs/):
- ./gradlew :ci :verifyDependencyLocks --warning-mode=fail --continue
  첫 실행 rc=1: MessagingAuthorityContractTest가 src/messaging을 찾아 실패
  → 경로를 고침. 두 번째 rc=1: messaging-policy
  MessagingAdmissionControllerTest.aWaitingCallerIsAdmittedOnceAPermitIsReturned
  (2초 대기 경쟁, 부하 7.3에서 한 번 실패, 코드 변경 없는 leaf) → --rerun
  3회 모두 통과. 세 번째 rc=0
- -p platforms/optional-build ci rc=0, 두 빌드의 verifyStrictLaneStages
  --dry-run rc=0, -p build-logic check rc=0
- :app-bootstrap:documentContractTest
  :adapter:outbound:persistence-mongo:mongoDocumentContractTest rc=0
- ./gradlew projects(주 빌드)와 optional 빌드 projects의 프로젝트 목록이
  이동 전 트리와 같다(Gradle 경로 불변)
- check-work-docs.py, 상대 링크 검사 rc=0

Refs: design-docs repo-structure/README.md 3.1, repo-structure/01-backend-layout.md 6.1
BREAKING CHANGE: src/messaging·src/grpc·src/grpc-advanced·src/optional-platforms가 src/platforms/ 아래로, src/config/{jpa,messaging,mongodb}가 주인 leaf의 release/로 옮겨졌다. optional 빌드는 -p platforms/optional-build로 부른다. docs/upgrade/2026-11-maturity-review.md B-52.
2026-11-07 13:04:54 +09:00

4.5 KiB

Advanced — Sharding

Capability: MongoCapability.SHARDING Enablement: library API, no configuration property. The service's own adapter constructs the entry point with a MongoAdvancedCapabilityGuard built from MongoAdvancedCapabilityFlags that enables the capability; construction is refused otherwise. Status: Advanced. Reshard orchestration remains Experimental.

Requirements

Topology A real sharded cluster. A replica set cannot exercise routing.
Server MongoDB 7.0 or 8.0.
Privilege MongoPrincipalRole.SHARD_ADMIN for the admin plane; the application role is unchanged.
Gate Not promoted. No mongoShardedTest lane is registered, and a sharded cluster is not an environment this repository stands up. Listed under experimental_contracts in src/adapter/outbound/persistence-mongo/release/release-contracts.json; promoting it needs the lane, its required class, and protected-environment evidence to exist first.

Shard key

ShardKeyDescriptor declares the key as an ordered list of ShardKeyPart plus a ShardStrategy:

Strategy Distributes Cost
RANGE by value ranges Range queries stay targeted; a monotonic key (a timestamp, an ObjectId) sends every insert to one shard.
HASHED by hash of the key Inserts spread evenly; every range query becomes scatter-gather.

There is no strategy that is good at both, which is why the choice is a declaration rather than a default.

Routing classification

ShardAwareQueryValidator classifies each query before execution:

MongoRoutingClassification Meaning
TARGETED The full shard key is present. One shard answers.
PREFIX_TARGETED A prefix of a compound key is present. A subset of shards answers.
SCATTER_GATHER No shard-key predicate. Every shard answers.
REJECTED Scatter-gather where the profile forbids it.

A scatter-gather query is not an error — some queries legitimately need every shard — but it must be declared. Undeclared scatter-gather raises MongoShardRoutingException. The reason is that scatter-gather passes every test on a single-shard development cluster and only degrades once the cluster grows, at which point the query is already in production and the fix is a schema change.

Unsupported combinations

  • Unique index on a field that is not a prefix of the shard key. MongoDB cannot enforce it across shards, and it fails at index creation, not at query time.
  • Transactions that touch documents on multiple shards remain supported but cost a cross-shard two-phase commit. Prefer a shard key that keeps a transaction's documents co-located.
  • CSFLE on a sharded collection: see encryption.md for the combinations that are refused.

Admin plane

MongoShardingAdminGateway (D4, SHARD_ADMIN credential) covers shard-collection, refine-shard-key and reshard.

ShardKeyAnalyzer produces a ShardKeyReadinessReport before sharding a collection: cardinality, frequency skew and monotonicity. A key with low cardinality creates jumbo chunks that cannot be split; a monotonic key creates a hot shard. Both are visible in the report and invisible in a functional test.

ReshardApproval is required for a reshard — a named approver and a stated window. Resharding rewrites the collection: it duplicates the data during the operation and saturates IO. It is not a runtime operation and the type refuses to pretend otherwise.

Failure recovery

Symptom Cause Action
MongoShardRoutingException Undeclared scatter-gather Add the shard key to the predicate, or declare the query as scatter-gather in its profile after review.
Jumbo chunks Low-cardinality shard key Refine the shard key (adds a suffix, non-destructive) before considering a reshard.
One hot shard Monotonic range key Refine with a high-cardinality prefix, or reshard to hashed if range queries are not needed.
Balancer never converges Chunk migration blocked by long-running operations Check for long transactions and cursors; the balancer waits on them.

Promotion evidence

Per ADR-MONGO-ADV-001: actual sharded-cluster evidence, security review of the SHARD_ADMIN role, a migration path for an existing unsharded collection, failure cases (undeclared scatter-gather refused, jumbo chunk detected), and this document as the runbook. Reshard orchestration stays Experimental until operational scale evidence exists.