/ /

`progress`

설명

동기화 프로세스의 업데이트된 상태나 오류를 반환합니다.

요청

GET /api/v1/progress

응답

progress 엔드포인트가 업데이트된 상태 또는 오류를 반환합니다.

성공적인 응답

응답 객체에는 2 최상위 필드인 success 및 progress 가 포함되어 있습니다.

success 필드 progress 명령의 상태가 포함됩니다. 명령이 성공하면 값은 true 이고 명령이 실패하면 false 입니다.

mongosync 가 동기화 프로세스의 상태를 성공적으로 가져오면 모든 응답 필드가 다음 필드와 함께 최상위 progress 객체에 래핑됩니다.

필드

유형

설명

state

문자열

mongosync 의 현재 상태입니다. 가능한 상태에 대한 자세한 내용은 상태 설명을 참조하세요.

canCommit

부울

true인 경우 커밋 요청이 성공함을 나타냅니다. 이는 다음을 의미하기도 합니다.

초기 동기화 가 완료되었으며 변경 이벤트를 적용 중입니다.
내장된 검증자가 커밋 에 적합한 상태 입니다.
mongosync 와 내장된 검증기의 지연은 30 초 이하입니다.

start를 호출할 때 buildIndexes 를 "afterDataCopy" 또는 "excludeHashedAfterCopy" 로 설정하다 {canCommit: true} 도 인덱스 빌드가 완료되었음을 나타냅니다.

1.21 버전에서 변경됨:

canCommit mongosync 또는 내장된 검증기가 30 초 이상의 지연을 보고하는 경우 false 입니다.

canWrite

부울

true 인 경우 대상 cluster에서 쓰기가 허용됨을 나타냅니다. canWrite 이(가) false 인 동안에는 대상 cluster에 쓰지 않도록 합니다.

커밋 이 완료될 때까지 인덱스 유효성 검사가 계속됩니다.

indexBuilding

객체

start 호출 시 buildIndexes 를 afterDataCopy 또는 excludeHashedAfterCopy 로 설정하다 경우 대상 클러스터 에서 인덱스 생성의 진행 상황을 실시간 표시합니다. 이 객체는 변경 이벤트 애플리케이션 단계에서만 표시됩니다.

중요: mongosync 는 가장 큰 컬렉션에 대한 인덱스를 먼저 생성하기 때문에 생성된 인덱스의 비율이 경과된 시간의 비율과 선형적으로 일치하지 않을 수 있습니다.

indexBuilding.indexesBuilt

integer

mongosync 에서 빌드를 완료한 인덱스 수입니다.

indexBuilding.totalIndexesToBuild

integer

mongosync 가 빌드 해야 하는 인덱스의 총 개수이며, 빌드가 완료된 인덱스도 포함됩니다.

indexBuilding.collectionsFinished

integer

mongosync 이(가) 인덱스 생성을 완료한 컬렉션의 수입니다.

indexBuilding.collectionsTotal

integer

완료된 컬렉션을 포함하여 mongosync 에서 인덱스 생성을 해야 하는 컬렉션의 총 개수입니다.

info

문자열

동기화 진행 상황에 대한 추가 정보를 제공합니다. 가능한 info 값은 다음과 같습니다.

"collection copy"
"change event application"
"waiting for commit to complete"
"commit completed"

ceaStage

문자열

변경 이벤트 적용(CEA) 단계의 단계입니다. mongosync가 CEA에 있을 때만 나타납니다. 이 필드 다음 값 중 하나일 수 있습니다.

"collection copy drain": mongosync이(가) 컬렉션 복사 중에 누적된 변경 이벤트를 여전히 배출 있습니다.
"steady state": mongosync이(가) 컬렉션 복사 백로그 배출 완료하고 변경 스트림 의 변경 이벤트를 실시간에 더 가깝게 처리 있습니다.

이 필드 사용하여 동기화 지연을 해석합니다. 자세한 내용은 변경 이벤트 적용 단계를 참조하세요.

버전 1.22에 추가 되었습니다.

lag

객체

동기화 지연을 구성 요소별로 분류하여 보고합니다. mongosync 가 IDLE 또는 PAUSED 상태일 때 lag 객체가 null 입니다.

버전 1.21에 추가 되었습니다.

lag.overallLagSeconds

integer

mongosync 이(가) 대상 클러스터에 적용한 최신 이벤트 타임스탬프와 소스 클러스터의 최신 타임스탬프 사이의 시간 차이(초)입니다. 모든 상태에서 lagTimeSeconds 이(가) 됩니다.

버전 1.21에 추가 되었습니다.

lag.crudLagSeconds

integer

초 단위의 동기화 지연의 CRUD 구성 요소입니다. 이 필드는 mongosync 이 CRUD 작업의 소스 타임스탬프를 아직 설정하지 않은 경우 null 입니다.

버전 1.21에 추가 되었습니다.

lag.ddlLagSeconds

integer

초 단위의 동기화 지연의 DDL 컴포넌트입니다. DDL 적용기가 비활성화되거나(예: 소스 서버 버전이 6.0보다 이전인 경우) 또는 아직 DDL 이벤트가 적용되지 않은 경우 이 필드는 null 입니다.

버전 1.21에 추가 되었습니다.

lagTimeSeconds

integer

Mongosync 에서 더 이상 사용되지 1.21 lag.overallLagSeconds 않습니다. 대신 를 사용합니다. 이 필드 향후 버전에서 제거될 수 있습니다.

mongosync 이(가) 대상 클러스터 에 적용한 최신 이벤트 타임스탬프와 이 mongosync 인스턴스 에 대한 소스 클러스터 의 최신 타임스탬프 사이의 시간 차이(초)입니다.

mongosync 소스 클러스터에서 주기적으로 no-op 쓰기를 수행하여 이 마이그레이션을 lagTimeSeconds mongosync 커밋할 때까지 필드의 값이 0에 도달하는 것을 방지할 수 있습니다.

소스 클러스터의 지속적인 no-ops로 인해 소스 클러스터에 실제 쓰기가 없더라도 시간 차이가 0보다 몇 초 이상 커지는 경우가 많습니다. mongosync 이(가) 마이그레이션을 커밋하면 시간 차이가 0이 됩니다.

버전 1.9부터 /progress 는 유효성 검사기 지연도 보고합니다. 이 표에서 verification.source.lagTimeSeconds 과 verification.destination.lagTimeSeconds 를 참조하세요.

totalEventsApplied

integer

이 mongosync 인스턴스 가 대상 클러스터 에 적용한 대략적인 변경 이벤트 수입니다.

이 값은 지속되지 않고 계산에서 특정 이벤트를 생략하기 때문에 총 이벤트 수를 정확하게 나타내지 않을 수 있습니다.

collectionCopy

객체

컬렉션에서 복사되는 데이터의 총량과 대상 클러스터로 이미 복사된 데이터의 양을 추정합니다.

collectionCopy .estimatedTotalBytes

integer

초기 collection의 복사 중에 모든 mongosync 인스턴스가 전역적으로 복사할 예상 총 바이트 수입니다.

mongosync 컬렉션 복사가 시작되기 전에 이 값을 계산합니다. 컬렉션 복사 중에는 estimatedCopiedBytes 이 이 값을 초과하는 경우에만 이 값이 변경되며, 이 경우 mongosync 은 estimatedTotalBytes 를 estimatedCopiedBytes과 같게 만들기 위해 증가시킵니다. 컬렉션 복사가 완료되면 estimatedTotalBytes 는 estimatedCopiedBytes와 같습니다. 이 값은 최선의 노력 추정치입니다.

collectionCopy .estimatedCopiedBytes

integer

컬렉션의 초기 복사 중에 이 mongosync 인스턴스가 대상 클러스터로 복사한 예상 바이트 수입니다.

총 예상 진행률을 백분율로 계산하려면 다음과 같이 합니다.

각 mongosync 인스턴스에 estimatedCopiedBytes 값을 추가합니다.
결과를 estimatedTotalBytes로 나누십시오.
결과에 100을(를) 곱합니다.

두 값 모두 최선 노력 추정치이며 실제 마이그레이션 진행 상황을 정확하게 반영하지 못할 수 있습니다.

destination. pingLatencyMs

integer

mongosync 부터 대상 클러스터 까지 마지막으로 알려진 핑 지연 시간 (밀리초)을 제공합니다. 이 필드 복제 아직 진행 중인 동안 30 초마다 새로 고쳐지고 응답에 보고됩니다. 지연 시간 1 밀리초 미만이거나 mongosync 이(가) 아직 핑 수행하지 않은 경우 이 필드 표시되지 않습니다. 마지막 핑 시도가 실패한 경우 이 필드 값은 -1 입니다.

버전 1.17에 추가 되었습니다.

directionMapping

객체

동기화에 대한 매핑 방향, 즉 소스 cluster 및 대상 cluster를 설명합니다.

directionMapping .Source

문자열

소스 클러스터. <cluster name>: <host>:<port> 형식으로 반환됩니다.

directionMapping .Destination

문자열

대상 cluster. <cluster name>: <host>:<port> 형식으로 반환됩니다.

estimatedOplogTimeRemaining

문자열

소스 클러스터 에서 사용할 수 있는 oplog 시간의 추정치를 표시합니다. 가능한 값에는 기간( 예시: "12 hours", "4 hours" 또는 "45 minutes") 및 특수한 경우(예: "more than 72 hours", "less than 15 minutes", "not checked yet")가 포함됩니다.

mongosync 소스 클러스터 에서 사용 가능한 가장 오래된 oplog 항목과 mongosync 이(가) 아직 성공적으로 완료해야 하는 가장 오래된 oplog 항목 사이의 시간 창 으로 estimatedOplogTimeRemaining 를 계산합니다. mongosync 는 5분마다 이 값을 업데이트합니다.

중요: 소스 클러스터에서 oplog 크기를 늘리면 estimatedOplogTimeRemaining 이 즉시 증가하지 않을 수 있습니다. mongosync 가 소스 oplog 처리하면 일반적으로 사용 가능한 oplog window 증가합니다.

mongosync oplog 시간을 확인하는 동안에만 estimatedOplogTimeRemaining 을(를) 보고합니다. mongosync 는 RUNNING 상태 에 있고 /progress 엔드포인트가 canWrite=true를 반환하기 전에만 이 필드 포함합니다.

버전 1.19에 추가 되었습니다.

estimatedSecondsToCEACatchup

integer

최근 간격 동안 이(가)lagTimeSeconds 감소한 정도를 기준으로 이벤트 적용 변경(CEA) 단계에 남은 예상 시간(초)입니다.

/progress mongosync 이 CEA에 속하지 않거나 가장 최근 간격 동안 lagTimeSeconds 가 증가하거나 동일하게 유지된 경우 estimatedSecondsToCEACatchup 를 보고하지 않습니다. 이 경우 30 분 동안 기다렸다가 다시 시도하세요.

버전 1.14에 추가 되었습니다.

mongosyncID

문자열

mongosync 인스턴스의 식별자 string 입니다.

버전 1.3에 추가 되었습니다.

coordinatorID

문자열

코디네이터 인스턴스의 식별자 string 입니다.

다른 인스턴스에 의해 mongosync 이(가) 조정되는 경우 이 필드에는 코디네이터 인스턴스의 식별자 문자열이 표시됩니다.
mongosync 가 코디네이터이거나 단독으로 실행되는 경우 이 필드는 mongosyncID 필드와 동일한 값을 반환합니다.
mongosync 이(가) 시작되면 mongosync 이(가) 코디네이터를 식별할 때까지 이 필드가 null 을(를) 반환합니다.

버전 1.3에 추가 되었습니다.

source. pingLatencyMs

integer

mongosync 부터 소스 클러스터 까지 마지막으로 알려진 핑 지연 시간 (밀리초)을 제공합니다. 이 필드 복제 아직 진행 중인 동안 30 초마다 새로 고쳐지고 응답에 보고됩니다. 지연 시간 1 밀리초 미만이거나 mongosync 이(가) 아직 핑 수행하지 않은 경우 이 필드 표시되지 않습니다. 마지막 핑 시도가 실패한 경우 이 필드 값은 -1 입니다.

버전 1.17에 추가 되었습니다.

verification

문서

내장된 검증자가 수행하는 검증 검사의 단계 및 진행 상황에 대한 정보를 제공합니다.

버전 1.9에 추가 되었습니다.

verification.source

문서

소스 클러스터 에서 실행 확인 검사의 단계 및 진행 상황에 대한 정보를 제공합니다.

버전 1.9에 추가 되었습니다.

verification.source. estimatedDocumentCount

integer

소스 클러스터 의 예상 문서 수입니다.

버전 1.9에 추가 되었습니다.

verification.source. hashedDocumentCount

integer

소스 클러스터 에서 검증자가 해시 문서 수입니다.

버전 1.9에 추가 되었습니다.

verification.source. lagTimeSeconds

integer

소스 클러스터 에서 마지막 확인 확인이 수행된 후의 시간(초)입니다.

버전 1.9에 추가 되었습니다.

verification.source. phase

문자열

소스 클러스터 에 대한 확인 프로세스 의 현재 단계입니다. 이 값은 다음 세 가지 값 중 하나일 수 있습니다.

"not started": 검증자가 이 클러스터 에 대한 초기 컬렉션 스캔을 시작하지 않았습니다.
"initial hashing": 검증자가 클러스터 에 있는 하나 이상의 컬렉션 에 대해 초기 스캔을 수행하고 있습니다.
"stream hashing": 검증자가 클러스터 에 대한 초기 스캔을 완료했으며 이제 변경 스트림 따르고 있습니다.

검증자가 컬렉션 다시 스캔해야 하는 경우 엔드포인트가 이전에 "stream hashing" 단계를 보고했더라도 검증자는 "initial hashing" 단계로 돌아갈 수 있습니다.

mongosync 1.22부터 시작하여, 검증자는 mongosync가 변경 이벤트 적용 단계에 도달할 때까지 "not started"을 보고합니다.

verification.source. scannedCollectionCount

integer

소스 클러스터 의 내장된 검증자가 스캔한 컬렉션의 수입니다.

버전 1.9에 추가 되었습니다.

verification.source. totalCollectionCount

integer

확인 검사에 포함할 소스 클러스터 의 컬렉션 수입니다.

verification.destination

문서

대상 클러스터 에서 실행 확인 검사의 단계 및 진행 상황에 대한 정보를 제공합니다.

버전 1.9에 추가 되었습니다.

verification.destination. estimatedDocumentCount

integer

대상 클러스터 의 예상 문서 수입니다.

버전 1.9에 추가 되었습니다.

verification.destination. hashedDocumentCount

integer

대상 클러스터 에서 검증자가 해시 문서 수입니다.

버전 1.9에 추가 되었습니다.

verification.destination. lagTimeSeconds

integer

대상 클러스터 에서 마지막으로 확인 검사를 수행한 이후 경과된 시간(초)입니다.

버전 1.9에 추가 되었습니다.

verification.destination. phase

문자열

대상 클러스터 에 대한 확인 프로세스 의 현재 단계입니다. 이 값은 다음 세 가지 값 중 하나일 수 있습니다.

"not started": 검증자가 이 클러스터 에 대한 초기 컬렉션 스캔을 시작하지 않았습니다.
"initial hashing": 검증자가 클러스터 에 있는 하나 이상의 컬렉션 에 대해 초기 스캔을 수행하고 있습니다.
"stream hashing": 검증자가 클러스터 에 대한 초기 스캔을 완료했으며 이제 변경 스트림 따르고 있습니다.

mongosync 1.22부터 시작하여, 검증자는 mongosync가 변경 이벤트 적용 단계에 도달할 때까지 "not started"을 보고합니다.

verification.destination. scannedCollectionCount

integer

대상 클러스터 에서 내장된 검증자가 스캔한 컬렉션의 수입니다.

버전 1.9에 추가 되었습니다.

verification.destination. totalCollectionCount

integer

확인 검사에 포함할 대상 클러스터 의 컬렉션 수입니다.

버전 1.9에 추가 되었습니다.

warnings

문자열 배열

mongosync 에서 감지한 경고 메시지입니다. mongosync 가 경고를 감지하지 못하면 이 필드 생략합니다.

남은 oplog 예상 시간이 매우 짧은 경우 mongosync 에서 문제를 설명하는 경고와 문서 링크를 추가합니다. 예시 들면 다음과 같습니다.

"warnings": [
  "The amount of available oplog on the source cluster is too small for mongosync to complete successfully.
  For more details, see https://www.mongodb.com/ko-kr/docs/cluster-to-cluster-sync/current/reference/oplog-sizing/."
]

자세한 내용은 oplog 크기 조정을 참조하세요.

mongosync 가 소스 클러스터 에 대한 사용자 쓰기 (write) 를 차단 하면 mongosync warnings 필드 에 경고 를 추가 합니다 . 자세한 학습 은 쓰기 (write) 차단을 참조하세요.

버전 1.19에 추가 되었습니다.

오류 응답

mongosync 에 오류가 발생하면 progress 엔드포인트는 다음 필드를 반환합니다.

필드	유형	설명
`success`	부울	`progress` 명령의 상태입니다. 명령이 성공하면 값은 `true` 이고 명령이 실패하면 `false` 입니다.
`error`	문자열	오류 유형입니다.
`errorDescription`	문자열	오류에 대한 자세한 설명입니다.

행동

mongosync 가 IDLE 상태인 경우 state 및 canCommit 를 제외한 모든 출력 필드는 null 입니다.
mongosync 가 PAUSED 상태인 경우 lag 객체는 null 이고 더 이상 사용되지 않는 lagTimeSeconds 필드는 null 입니다.
mongosync 이(가) INITIALIZING 상태 이면 mongosync 은(는) /start 요청을 거부합니다. 초기화가 완료되면 mongosync 가 IDLE 를 반환하고 /start 요청을 수락합니다.

충돌 후 mongosync 가 재개되거나 다시 시작되는 경우 초기화가 완료되면 /progress 응답은 충돌 전의 state 를 반환합니다.
엔드포인트가 자동 새로 고침되지 않습니다. 업데이트된 상태를 가져오려면 progress 엔드포인트를 다시 호출합니다.
가 컬렉션 복사 단계에 도달하기 /progress 전에 mongosync 0 estimatedCopiedBytes 1 estimatedTotalBytes를 호출하면, 에 대해 를 반환합니다.
컬렉션 복사 중, estimatedCopiedBytes 이 estimatedTotalBytes 를 초과하는 경우에만 이 변경됩니다. 이러한 경우, mongosync 가 estimatedTotalBytes 을 estimatedCopiedBytes와 같게 높입니다.
컬렉션 복사 마지막에서 estimatedTotalBytes 은 estimatedCopiedBytes과 같습니다. mongosync 는 복사된 총 바이트를 정보의 소스로 사용합니다. 두 값 모두 최선의 노력 추정치입니다.

변경 이벤트 적용 단계

버전 1.22에 추가 되었습니다.

ceaStage 필드 mongosync가 CEA(Change Event Application) 단계를 통해 얼마나 진행되었는지 보고합니다. ceaStage는 mongosync 지연을 해석하는 데 도움이 될 수 있습니다.

"collection copy drain" 동안 mongosync는 컬렉션 복사 중에 축적된 변경 이벤트를 적용합니다. 컬렉션 복사본이 백로그에서 삽입이 대기열에 남아 있는 문서 이미 복사했을 수 있으므로 해당 삽입을 재생하면 예상되는 중복 키 오류가 발생할 수 있습니다. 이러한 오류를 처리하면 CEA 처리량 일시적으로 줄어들 수 있으므로 이 단계에서는 문제를 나타내지 않고 지연 시간이 증가할 수 있습니다.

ceaStage가 "steady state"인 경우, mongosync는 컬렉션 복사가 완료된 후에 발생하는 소스 쓰기만 처리합니다. mongosync 처리량 소스 쓰기 (write) 속도를 초과하면 지연이 감소해야 합니다.

경고

ceaStage가 "steady state"인 동안 지연이 계속 증가하면 mongosync가 소스 클러스터 따라잡지 못하는 것입니다. 소스 쓰기 (write) 속도가 감소하거나 CEA 처리량 증가하지 않는 한, mongosync는 마이그레이션 따라잡을 수 없습니다. 이 경우 다음 중 하나를 수행할 수 있습니다.

CPU 사용량이 허용하는 경우 --loadLevel 값을 늘립니다.
대상 클러스터 크기를 조정하여 CPU 용량 추가합니다.
가능하면 소스 클러스터의 쓰기 (write) 속도를 낮추세요.

엔드포인트 보호

mongosync progress 엔드포인트를 보호하지 않습니다. 그러나 기본적으로 API는 로컬 호스트에만 바인딩되며 다른 소스의 호출은 허용하지 않습니다. 또한 progress 호출은 연결 자격 증명이나 사용자 데이터를 노출하지 않습니다.

예시

다음 예에서는 동기화 프로세스의 상태를 반환합니다.

요청

curl localhost:27182/api/v1/progress -XGET

응답

{
   "progress":
      {
         "state":"RUNNING",
         "canCommit":true,
         "canWrite":false,
         "info":"change event application",
         "ceaStage":"steady state",
         "lag": {
            "overallLagSeconds": 0,
            "crudLagSeconds": 0,
            "ddlLagSeconds": null
         },
         "lagTimeSeconds":0,
         "collectionCopy":
            {
               "estimatedTotalBytes":694,
               "estimatedCopiedBytes":694
            },
         "directionMapping":
            {
               "Source":"cluster0: localhost:27017",
               "Destination":"cluster1: localhost:27018"
            },
         "source":
            {
               "pingLatencyMs":250
            },
         "destination":
            {
               "pingLatencyMs":-1
            },
         "verification":
            {
               "source":
                  {
                     "estimatedDocumentCount": 42,
                     "hashedDocumentCount": 42,
                     "lagTimeSeconds": 2,
                     "totalCollectionCount": 42,
                     "scannedCollectionCount": 10,
                     "phase": "stream hashing"
                  },
               "destination": {
                     "estimatedDocumentCount": 42,
                     "hashedDocumentCount": 42,
                     "lagTimeSeconds": 2,
                     "totalCollectionCount": 42,
                     "scannedCollectionCount": 10,
                     "phase": "stream hashing"
               }
            }
      },
   "success": true
}

돌아가기

시작하기

일시 중지