/ /

`progress`

Descripción

Devuelve el estado actualizado del proceso de sincronización o un error.

Solicitud

GET /api/v1/progress

Respuesta

El endpoint progress devuelve un estado actualizado o un error.

Respuesta exitosa

El objeto de respuesta contiene 2 campos de nivel superior, success y progress.

El campo success contiene el estado del comando progress. El valor es true si el comando se ejecuta correctamente y false si falla.

Si mongosync obtiene exitosamente el estado del proceso de sincronización, todos los campos de respuesta se envuelven en el objeto de nivel superior progress con los siguientes campos:

Campo	Tipo	Descripción
`state`	string	El estado actual de `mongosync`. Para obtener información sobre los estados posibles, consulta Descripciones de estado.
`canCommit`	booleano	Si `true`, indica que una solicitud de confirmación tendrá éxito. Esto también significa que: La sincronización inicial se ha completado y está aplicando eventos de cambio. El verificador empotrado está en un estado apropiado para la confirmación. Si estableces buildIndexes en `"afterDataCopy"` o `"excludeHashedAfterCopy"` al llamar a `start`, `{canCommit: true}` también indica que la creación de índices está completa.
`canWrite`	booleano	Si `true`, indica que se permite la escritura en el clúster de destino. No escribas en el clúster de destino mientras `canWrite` es `false`. La validación del índice continúa hasta que se complete el commit.
`info`	string	Proporciona información adicional sobre el progreso de la sincronización. Los posibles valores `info` incluyen: `"collection copy"` `"change event application"` `"waiting for commit to complete"` `"commit completed"`
`lagTimeSeconds`	entero	Diferencia de tiempo en segundos entre la marca de tiempo del último evento que `mongosync` aplicó al clúster de destino y la última marca de tiempo en el clúster de origen para esta instancia de `mongosync`. `mongosync` realiza guardados periódicos sin acción en el clúster de origen, lo que puede evitar que el valor del campo `lagTimeSeconds` llegue a cero hasta que `mongosync` termine la migración. Debido a constantes operaciones nulas en el clúster de origen, la diferencia de tiempo suele ser de unos segundos sobre cero, incluso si no hay guardados reales en el clúster de origen. La diferencia de tiempo se vuelve cero cuando `mongosync` realiza la migración. Con la introducción del verificador embebido en la versión 1.9, hay tres campos distintos de `lagTimeSeconds` cada vez que se habilita la verificación embebida: `lagTimeSeconds` para `mongosync` `lagTimeSeconds` para el clúster de origen para el verificador `lagTimeSeconds` para el clúster de destino para el verificador Cuando la verificación incorporada está deshabilitada, `lagTimeSeconds` solo se aplica a `mongosync`.
`totalEventsApplied`	entero	La cantidad aproximada de eventos de cambio que esta instancia de `mongosync` ha aplicado al clúster de destino. Este valor puede no representar con precisión el número total de eventos porque no se conserva y omite ciertos eventos del recuento.
`collectionCopy`	Objeto	Estima la cantidad total de datos que se están copiando de las colecciones y la cantidad que ya se ha copiado al clúster de destino
`collectionCopy` `.estimatedTotalBytes`	entero	Número total estimado de bytes que se copiarán globalmente por todas las instancias `mongosync` durante la copia inicial de colecciones. `mongosync` aproxima el número total estimado de bytes antes de la migración y no actualiza este valor durante el proceso de sincronización. Este valor no refleja los cambios realizados en el clúster de origen durante la sincronización y no es un indicador preciso del progreso de la migración.
`collectionCopy` `.estimatedCopiedBytes`	entero	Número estimado de bytes que han sido copiados al clúster de destino por esta instancia de `mongosync` durante la copia inicial de colecciones. Para calcular el progreso estimado total como un porcentaje, suma el valor del campo `estimatedCopiedBytes` para cada instancia `mongosync` y divide el resultado por el valor del campo `estimatedTotalBytes`. Luego, multiplica el resultado por 100. El valor de `estimatedCopiedBytes` podría ser mayor que el de `estimatedTotalBytes` debido a operaciones reintentadas. Comparar `estimatedTotalBytes` y `estimatedCopiedBytes` no es un indicador preciso del progreso de la migración.
`destination.` `pingLatencyMs`	entero	Proporciona la última latencia de ping conocida, en milisegundos, desde `mongosync` hasta el clúster de destino. Este campo se actualiza cada 30 segundos mientras la replicación está en curso y se informa en la respuesta. Si la latencia es inferior a `1` milisegundos o `mongosync` aún no ha realizado el ping, este campo no está disponible. Este campo tiene un valor de `-1` si el último intento de ping falló. Novedad en la versión 1.17.
`directionMapping`	Objeto	Describe la dirección de mapeo para la sincronización, es decir, los clústeres de origen y destino.
`directionMapping` `.Source`	string	Clúster de origen. Se devuelve en el formato `<cluster name>: <host>:<port>`.
`directionMapping` `.Destination`	string	Clúster de destino. Devuelto en la forma `<cluster name>: <host>:<port>`.
`estimatedSecondsToCEACatchup`	entero	Tiempo estimado restante, en segundos, en la fase de Solicitud de aplicación de cambio (CEA), basándose en cuánto se ha reducido `lagTimeSeconds` en un intervalo reciente. `/progress` No se informa `estimatedSecondsToCEACatchup` si `mongosync` no está en CEA o si `lagTimeSeconds` ha aumentado o se ha mantenido igual durante el intervalo más reciente. En este caso, espere 30 minutos y vuelva a intentarlo. Nuevo en la versión 1.14.
`mongosyncID`	string	string de identificación de la instancia `mongosync`. Nueva en la versión 1.3.
`coordinatorID`	string	string de identificador para la instancia del coordinador. Cuando `mongosync` es coordinado por otra instancia, este campo muestra el string identificador de la instancia coordinadora. Cuando `mongosync` es un coordinador o funciona solo, este campo devuelve el mismo valor que su campo `mongosyncID`. Cuando se inicia `mongosync`, este campo devuelve `null` hasta que `mongosync` identifica al coordinador. Nueva en la versión 1.3.
`source.` `pingLatencyMs`	entero	Proporciona la última latencia de ping conocida, en milisegundos, desde `mongosync` hasta el clúster de origen. Este campo se actualiza cada 30 segundos mientras la replicación está en curso y se informa en la respuesta. Si la latencia es inferior a `1` milisegundos o `mongosync` aún no ha realizado el ping, este campo no está disponible. Este campo tiene un valor de `-1` si el último intento de ping falló. Novedad en la versión 1.17.
`verification`	Documento	Proporciona información sobre la fase y el progreso de las comprobaciones de verificación realizadas por el verificador integrado. Nuevo en la versión 1.9.
`verification.source`	Documento	Proporciona información sobre la fase y el progreso de las comprobaciones de verificación que se ejecutan en el clúster de origen. Nuevo en la versión 1.9.
`verification.source.` `estimatedDocumentCount`	entero	Número estimado de documentos en el clúster de origen. Nuevo en la versión 1.9.
`verification.source.` `hashedDocumentCount`	entero	Número de documentos encriptados por el verificador en el clúster de origen. Nuevo en la versión 1.9.
`verification.source.` `lagTimeSeconds`	entero	Tiempo en segundos transcurrido desde que se realizó la última verificación en el clúster de origen. Nuevo en la versión 1.9.
`verification.source.` `phase`	string	Fase actual del proceso de verificación en el cluster de origen. Esto puede ser uno de tres valores: `"not started"`: El verificador no ha iniciado ningún escaneo de colección inicial para este clúster. `"initial hashing"`: El verificador está realizando su escaneo inicial para al menos una colección en el clúster. `"stream hashing"`:El verificador ha finalizado su escaneo inicial para el clúster y ahora está siguiendo su flujo de cambios. Si el verificador necesita volver a escanear una colección, puede volver a la fase `"initial hashing"` incluso si el punto final informó previamente la fase `"stream hashing"`. Nuevo en la versión 1.9.
`verification.source.` `scannedCollectionCount`	entero	Número de colecciones escaneadas por el verificador integrado en el clúster de origen. Nuevo en la versión 1.9.
`verification.source.` `totalCollectionCount`	entero	Número de colecciones en el clúster de origen para incluir en las comprobaciones de verificación.
`verification.destination`	Documento	Proporciona información sobre la fase y el progreso de las comprobaciones de verificación que se ejecutan en el clúster de destino. Nuevo en la versión 1.9.
`verification.destination.` `estimatedDocumentCount`	entero	Número estimado de documentos en el clúster de destino. Nuevo en la versión 1.9.
`verification.destination.` `hashedDocumentCount`	entero	Cantidad de documentos encriptados por el verificador en el clúster de destino. Nuevo en la versión 1.9.
`verification.destination.` `lagTimeSeconds`	entero	Tiempo en segundos desde la última comprobación de verificación realizada en el clúster de destino. Nuevo en la versión 1.9.
`verification.destination.` `phase`	string	Fase actual del proceso de verificación en el clúster de destino. Esto puede ser uno de tres valores: `"not started"`: El verificador no ha iniciado ningún escaneo de colección inicial para este clúster. `"initial hashing"`: El verificador está realizando su escaneo inicial para al menos una colección en el clúster. `"stream hashing"`:El verificador ha finalizado su escaneo inicial para el clúster y ahora está siguiendo su flujo de cambios. Si el verificador necesita volver a escanear una colección, puede volver a la fase `"initial hashing"` incluso si el punto final informó previamente la fase `"stream hashing"`. Nuevo en la versión 1.9.
`verification.destination.` `scannedCollectionCount`	entero	Número de escaneos de colección por el verificador incorporado en el clúster de destino. Nuevo en la versión 1.9.
`verification.destination.` `totalCollectionCount`	entero	Número de colecciones en el clúster de destino para incluir en las comprobaciones de verificación. Nuevo en la versión 1.9.

Respuesta de error

Si mongosync encuentra un error, el punto final progress devuelve los siguientes campos:

Campo	Tipo	Descripción
`success`	booleano	El estado del comando `progress`. El valor es `true` si el comando se ejecuta correctamente y `false` si el comando falla.
`error`	string	Tipo de error.
`errorDescription`	string	Descripción detallada del error.

Comportamiento

Cuando mongosync está en el estado IDLE, todos los campos de salida, excepto state y canCommit, están null.
Cuando mongosync está en el estado PAUSED, el campo lagTimeSeconds es null.
El endpoint no se actualiza automáticamente. Para obtener el estado actualizado, llama nuevamente al endpoint progress.
Las llamadas a /progress antes de que mongosync llegue a la fase de copia de colección devuelven 0 para estimatedCopiedBytes y 1 para estimatedTotalBytes.
estimatedTotalBytes puede cambiar durante la fase de copia de colección si se insertan o borran documentos en el clúster de origen.
estimatedCopiedBytes nunca es mayor que estimatedTotalBytes. El progreso alcanza el 100% al final de la fase de copia de la colección (estimatedCopiedBytes = estimatedTotalBytes).

Protección de endpoints

mongosync no protege el punto de conexión progress. Sin embargo, por defecto, la API se vincula únicamente a localhost y no acepta llamadas de otras fuentes. Además, la llamada progress no expone credenciales de conexión ni datos de usuario.

Ejemplo

El siguiente ejemplo devuelve el estado del proceso de sincronización.

Solicitud

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

Respuesta

{
   "progress":
      {
         "state":"RUNNING",
         "canCommit":true,
         "canWrite":false,
         "info":"change event application",
         "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
}

Volver

Inicio

pausa