/ /

`progress`

Descrição

Retorna um status atualizado do processo de sincronização ou um erro.

Solicitar

GET /api/v1/progress

Resposta

O endpoint progress retorna um status atualizado ou um erro.

Resposta bem-sucedida

O objeto de resposta contém 2 campos de nível superior, success e progress.

O campo success contém o status do comando progress. O valor é true se o comando for bem-sucedido e false se o comando falhar.

Se mongosync obter com êxito o status do processo de sincronização, todos os campos de resposta serão agrupados no objeto progress de nível superior com os seguintes campos:

Campo

Tipo

Descrição

state

string

O estado atual de mongosync. Para obter informações sobre os possíveis estados, consulte Descrições de estado.

canCommit

booleano

Se true, indica que uma solicitação de confirmação foi bem-sucedida. Isso também significa que:

A sincronização inicial foi concluída e está aplicando eventos de alteração.
O verificador incorporado está em um estado apropriado para confirmação.
O atraso para mongosync e o verificador incorporado é de 30 segundos ou menos.

Se você definir buildIndexes como "afterDataCopy" ou "excludeHashedAfterCopy" ao chamar start, {canCommit: true} também indicará que as compilações de índice estão concluídas.

Alterado na versão 1.21:

canCommit é false quando mongosync ou o verificador incorporado relata mais de 30 segundos de atraso.

canWrite

booleano

Se true, indica que as gravações são permitidas no cluster de destino. Não grave no cluster de destino enquanto canWrite estiver false.

A validação do índice continua até que o commit seja concluído.

indexBuilding

objeto

Mostra o progresso em tempo real das construções de índice no cluster de destino se você definir buildIndexes como afterDataCopy ou excludeHashedAfterCopy ao chamar start. Este objeto é exibido somente durante a fase Alterar Aplicativo de Evento.

IMPORTANTE: como mongosync cria primeiro índices para as maiores coleções, a porcentagem de índices construídos pode não corresponder linearmente à porcentagem de tempo decorrido.

indexBuilding.indexesBuilt

inteiro

O número de índices que mongosync terminou de construir.

indexBuilding.totalIndexesToBuild

inteiro

O número total de índices que mongosync precisa construir, incluindo aqueles que acabou de construir.

indexBuilding.collectionsFinished

inteiro

O número de collections para as quais mongosync concluiu as compilações de índice.

indexBuilding.collectionsTotal

inteiro

O número total de collections para as quais o mongosync precisa construir índices, incluindo aquelas que foram concluídas.

info

string

Fornece informações adicionais sobre o progresso da sincronização. Os possíveis valores de info incluem:

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

ceaStage

string

Estágio da fase do Aplicativo de Evento de Alteração (CEA). Só aparece quando mongosync está em CEA. Este campo pode ser um dos seguintes valores:

"collection copy drain": mongosync ainda está em processo de drenagem dos evento de alteração que se acumularam durante a cópia da coleção.
"steady state": mongosync concluiu a drenagem do backlog de cópia da coleção e está processando eventos de alteração do fluxo de alterações mais próximo do tempo real.

Use this field to interpret synchronization lag. For more information, see Change Event Application Stages.

Novidades na versão 1.22.

lag

objeto

Relata o atraso de sincronização dividido por componente. O objeto lag é null quando mongosync está no estado IDLE ou PAUSED.

Novidades na versão 1.21.

lag.overallLagSeconds

inteiro

Diferença de tempo em segundos entre o carimbo de data/hora do último evento que mongosync aplicou ao cluster de destino e o último carimbo de data/hora no cluster de origem. Igual a lagTimeSeconds em todos os estados.

Novidades na versão 1.21.

lag.crudLagSeconds

inteiro

Componente CRUD do atraso de sincronização em segundos. Este campo é null quando mongosync ainda não definiu o carimbo de data/hora de origem para operações CRUD.

Novidades na versão 1.21.

lag.ddlLagSeconds

inteiro

Componente DDL do atraso de sincronização em segundos. Este campo é null quando o aplicador DDL está desabilitado (por exemplo, quando a versão do servidor de origem é anterior a 6.0) ou quando nenhum evento DDL foi aplicado ainda.

Novidades na versão 1.21.

lagTimeSeconds

inteiro

Descontinuado no Mongosync 1.21. Use lag.overallLagSeconds em vez disso. Este campo pode ser removido em uma versão futura.

Diferença de tempo, em segundos, entre o último carimbo de data/hora do evento que mongosync aplicou ao cluster de destino e o último carimbo de data/hora no cluster de origem para essa instância de mongosync.

mongosync executa gravações periódicas no-op no cluster de origem, o que pode impedir que o valor do campo lagTimeSeconds chegue a zero até que mongosync confirme a migração.

Devido às constantes no-ops no cluster de origem, a diferença de tempo geralmente é de alguns segundos acima de zero, mesmo que não haja gravações reais no cluster de origem. A diferença de tempo se torna zero quando mongosync confirma a migração.

A partir da versão 1.9, o /progress também relata o atraso do verificador. Consulte verification.source.lagTimeSeconds e verification.destination.lagTimeSeconds nesta tabela.

totalEventsApplied

inteiro

O número aproximado de eventos de alteração que esta instância de mongosync aplicou ao cluster de destino.

Esse valor pode não ser uma representação precisa do número total de eventos porque não é persistente e omite determinados eventos da contagem.

collectionCopy

objeto

Estima a quantidade total de dados que estão sendo copiados de collection e a quantidade que já foi copiada para o cluster de destino

collectionCopy .estimatedTotalBytes

inteiro

Número total estimado de bytes a serem copiados globalmente por todas as instâncias mongosync durante a cópia inicial da collection.

mongosync calcula esse valor antes do início da cópia da coleção. Durante a cópia da coleção, esse valor só muda se estimatedCopiedBytes o exceder, caso em que mongosync aumenta estimatedTotalBytes para ser igual a estimatedCopiedBytes. Depois que a cópia da coleção for concluída, estimatedTotalBytes será igual a estimatedCopiedBytes. Este valor é uma estimativa de melhor esforço.

collectionCopy .estimatedCopiedBytes

inteiro

Número estimado de bytes copiados para o cluster de destino por essa instância mongosync durante a cópia inicial de coleções.

Para calcular o progresso total estimado como uma porcentagem:

Adicione o valor estimatedCopiedBytes para cada instância mongosync.
Divida o resultado por estimatedTotalBytes.
Multiplique o resultado por 100.

Ambos os valores são estimativas de melhor esforço e podem não refletir com precisão o progresso real da migração.

destination. pingLatencyMs

inteiro

Fornece a última latência de ping conhecida, em milissegundos, do mongosync para o cluster de destino. Este campo é atualizado a cada 30 segundos enquanto a replicação ainda está em andamento e relatado na resposta. Se a latência for inferior a 1 milésimos de segundo ou mongosync ainda não tiver executado o ping , esse campo estará ausente. Este campo tem um valor de -1 se a última tentativa de ping falhou.

Novidades na versão 1.17.

directionMapping

objeto

Descreve a direção de mapeamento para a sincronização, ou seja, os clusters de origem e destino.

directionMapping .Source

string

cluster de origem. Retornado no formulário <cluster name>: <host>:<port>.

directionMapping .Destination

string

Cluster de destino. Retornado no formulário <cluster name>: <host>:<port>.

estimatedOplogTimeRemaining

string

Mostra uma estimativa do tempo de oplog disponível no cluster de origem. Os valores possíveis incluem uma duração (por exemplo, "12 hours", "4 hours" ou "45 minutes") e casos especiais como "more than 72 hours", "less than 15 minutes" e "not checked yet".

mongosync calcula estimatedOplogTimeRemaining como a janela de tempo entre a entrada de oplog mais antiga disponível no cluster de origem e a entrada de oplog mais antiga que mongosync ainda precisa concluir com êxito. mongosync atualiza esse valor a cada cinco minutos.

IMPORTANTE: se você aumentar o tamanho do oplog no cluster de origem, estimatedOplogTimeRemaining poderá não aumentar imediatamente. À medida que o mongosync processa o oplog de origem, a oplog window disponível normalmente aumenta.

mongosync reporta estimatedOplogTimeRemaining somente enquanto verifica o tempo de oplog. mongosync inclui esse campo somente quando está no estado RUNNING e somente antes de o ponto de extremidade /progress retornar canWrite=true.

Novidades na versão 1.19.

estimatedSecondsToCEACatchup

inteiro

Tempo estimado em segundos restantes na fase de aplicação de eventos de alteração (CEA), com base em quanto lag.overallLagSeconds diminui em um intervalo recente.

/progress não relata estimatedSecondsToCEACatchup se mongosync não estiver em CAE ou se lag.overallLagSeconds aumentou ou ficou igual durante o intervalo mais recente. Nesse caso, aguarde 30 minutos e tente novamente.

Novidades na versão 1.14.

mongosyncID

string

string identificador para a instância mongosync .

Novidades na versão 1.3.

coordinatorID

string

string identificador para a instância do coordenador.

Quando o mongosync é coordenado por outra instância, este campo mostra a string do identificador para a instância do coordenador.
Quando mongosync é um coordenador ou executa sozinho, este campo retorna o mesmo valor que seu campo mongosyncID .
Quando mongosync inicia, este campo retorna null até que mongosync identifique o coordenador.

Novidades na versão 1.3.

source. pingLatencyMs

inteiro

Fornece a última latência de ping conhecida, em milissegundos, do mongosync para o cluster de origem. Este campo é atualizado a cada 30 segundos enquanto a replicação ainda está em andamento e relatado na resposta. Se a latência for inferior a 1 milésimos de segundo ou mongosync ainda não tiver executado o ping , esse campo estará ausente. Este campo tem um valor de -1 se a última tentativa de ping falhou.

Novidades na versão 1.17.

verification

documento

Fornece informações sobre a fase e o progresso das verificações de verificação realizadas pelo verificador incorporado.

Novidades na versão 1.9.

verification.source

documento

Fornece informações sobre a fase e o progresso das verificações de verificação em execução no cluster de origem.

Novidades na versão 1.9.

verification.source. estimatedDocumentCount

inteiro

Número estimado de documentos no cluster de origem.

Novidades na versão 1.9.

verification.source. hashedDocumentCount

inteiro

Número de documentos hash pelo verificador no cluster de origem.

Novidades na versão 1.9.

verification.source. lagTimeSeconds

inteiro

Tempo em segundos após a última verificação ser realizada no cluster de origem.

Novidades na versão 1.9.

verification.source. phase

string

Fase atual do processo de verificação no cluster de origem. Pode ser um dos três valores:

"not started": O verificador não iniciou nenhuma varredura de coleção inicial para este cluster.
"initial hashing": o verificador está fazendo sua verificação inicial para pelo menos uma coleção no cluster.
"stream hashing": o verificador concluiu sua verificação inicial para o cluster e agora está seguindo seu fluxo de alterações.

Se o verificador precisar reanalisar uma coleção, ele poderá voltar para a fase "initial hashing" mesmo que o ponto de extremidade tenha relatado anteriormente a fase "stream hashing".

A partir de mongosync 1.22, o verificador relata "not started" até que mongosync atinja a fase de Aplicativo de Evento de Alteração.

verification.source. scannedCollectionCount

inteiro

Número de collections verificadas pelo verificador embarcado no cluster de origem.

Novidades na versão 1.9.

verification.source. totalCollectionCount

inteiro

Número de collections no cluster de origem a serem incluídas nas verificações de verificação.

verification.destination

documento

Fornece informações sobre a fase e o progresso das verificações em execução no cluster de destino.

Novidades na versão 1.9.

verification.destination. estimatedDocumentCount

inteiro

Número estimado de documentos no cluster de destino.

Novidades na versão 1.9.

verification.destination. hashedDocumentCount

inteiro

Número de documentos hash pelo verificador no cluster de destino.

Novidades na versão 1.9.

verification.destination. lagTimeSeconds

inteiro

Tempo em segundos desde a última verificação realizada no cluster de destino.

Novidades na versão 1.9.

verification.destination. phase

string

Fase atual do processo de verificação no cluster de destino. Pode ser um dos três valores:

"not started": O verificador não iniciou nenhuma varredura de coleção inicial para este cluster.
"initial hashing": o verificador está fazendo sua verificação inicial para pelo menos uma coleção no cluster.
"stream hashing": o verificador concluiu sua verificação inicial para o cluster e agora está seguindo seu fluxo de alterações.

Se o verificador precisar reanalisar uma coleção, ele poderá voltar para a fase "initial hashing" mesmo que o ponto de extremidade tenha relatado anteriormente a fase "stream hashing".

A partir de mongosync 1.22, o verificador relata "not started" até que mongosync atinja a fase de Aplicativo de Evento de Alteração.

verification.destination. scannedCollectionCount

inteiro

Número de collections verificadas pelo verificador embarcado no cluster de destino.

Novidades na versão 1.9.

verification.destination. totalCollectionCount

inteiro

Número de collections no cluster de destino a serem incluídas nas verificações de verificação.

Novidades na versão 1.9.

warnings

array de strings

Mensagens de aviso que mongosync detecta. Se mongosync não detectar avisos, ele omitirá este campo.

Se o tempo restante estimado do oplog for muito baixo, o mongosync adicionará um aviso que descreve o problema e links para a documentação. Por exemplo:

"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/pt-br/docs/cluster-to-cluster-sync/current/reference/oplog-sizing/."
]

Para obter mais detalhes, consulte Dimensionamento do oplog.

Se mongosync bloquear gravações de usuários no cluster de origem, mongosync adicionará um aviso ao campo warnings. Para saber mais, consulte Bloqueio de escrita.

Novidades na versão 1.19.

Resposta de erro

Se mongosync encontrar um erro, o endpoint progress retornará os seguintes campos:

Campo	Tipo	Descrição
`success`	booleano	Status do comando `progress` . O valor é `true` se o comando for bem-sucedido e `false` se o comando falhar.
`error`	string	Tipo de erro.
`errorDescription`	string	Descrição detalhada do erro.

Comportamento

Quando mongosync está no estado IDLE , todos os campos de saída, exceto state e canCommit , são null.
Quando mongosync está no estado PAUSED , o objeto lag é null e o campo obsoleto lagTimeSeconds é null.
Quando mongosync está no estado INITIALIZING, mongosync rejeita /start solicitações. Após a conclusão da inicialização, mongosync retorna IDLE e aceita /start solicitações.

Se o mongosync for retomado ou reiniciado após uma falha, após a conclusão da inicialização, a resposta /progress retornará o state antes da falha.
O endpoint não é atualizado automaticamente. Para obter o status atualizado, chame o endpoint progress novamente.
Chamadas para /progress antes mongosync chegar à fase de cópia da coleção retornam 0 para estimatedCopiedBytes e 1 para estimatedTotalBytes.
Durante a cópia da coleção, estimatedTotalBytes só muda se estimatedCopiedBytes exceder. Nesse caso, mongosync aumenta estimatedTotalBytes para igualar estimatedCopiedBytes.
No final da cópia da coleção, estimatedTotalBytes é igual a estimatedCopiedBytes. mongosync usa o total de bytes copiados como a fonte da verdade. Ambos os valores são estimativas de melhor esforço.

Estágios do aplicativo de eventos de alteração

Novidades na versão 1.22.

O campo ceaStage informa o quanto o mongosync progrediu na fase de Change Evento Aplicativo (CEA). ceaStage pode ajudá-lo a interpretar o atraso de mongosync.

Durante "collection copy drain", mongosync aplica eventos de alteração acumulados durante cópia da coleção. Como a cópia da coleção pode já ter copiado um documento cuja inserção permanece na fila no backlog, reproduzir essa inserção pode produzir um erro de chave duplicada esperado. Lidar com esses erros pode reduzir temporariamente a taxa de transferência do CEA, portanto, o lag pode aumentar durante esta fase sem indicar um problema.

Quando ceaStage é "steady state", mongosync processa apenas gravações de origem que ocorrem após a conclusão da cópia da coleção. Se a taxa de transferência de mongosync exceder a taxa de gravar de origem, o atraso deve diminuir.

Aviso

Se o atraso continuar a aumentar enquanto ceaStage for "steady state", mongosync não está acompanhando o cluster de origem. A menos que a taxa de gravar de origem diminua ou a taxa de transferência do CEA aumente, mongosync não consegue acompanhar e concluir a migração. Nesse caso, você pode seguir um destes procedimentos:

Aumente o valor de --loadLevel, se o uso da CPU permitir.
Dimensionar o cluster de destino para adicionar mais capacidade de CPU.
Reduza a taxa de gravar do cluster de origem, se possível.

Proteção de endpoint

mongosync não protege o endpoint progress . No entanto, por padrão, a API é vinculada apenas ao host local e não aceita chamadas de outras fontes. Além disso, a chamada progress não expõe credenciais de conexão ou dados de usuário.

Exemplo

O exemplo a seguir retorna o status do processo de sincronização.

Solicitar

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

Resposta

{
   "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
}

Voltar

iniciar

pausa