sh.status() (método mongosh)

Definición

sh.status()

Cuando se ejecuta en un La instancia mongos imprime un informe formateado de la configuración del particionado y la información relativa a los fragmentos existentes en un clúster. El comportamiento por defecto suprime la información detallada de fragmentos si el número total de fragmentos es mayor o igual a 20.

La sh.status() el método tiene el siguiente parámetro:

Parameter	Tipo	Descripción
`verbose`	booleano	opcional. Determina el nivel de verbosidad. Si `true`, el método muestra: Detalles completos de la distribución de fragmentos a través de particiones, incluso si tienes 20 o más fragmentos, así como el número de fragmentos en cada partición. Detalles de instancias mongos activas. Si `false`, el método muestra: Detalles completos de la distribución de fragmentos en particiones sólo si tienes menos de 20 fragmentos. Si tienes 20 o más fragmentos, el método en su lugar devuelve un mensaje `too many chunks to print ...`, mostrando solo la cantidad de fragmentos en cada partición. Solo la versión y el número de instancias activas de mongos. El valor detallado por defecto es `false`.

Tip

db.printShardingStatus()

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Importante

Este comando no es compatible con los clústeres M0 y Flex. Para obtener más información, consulta Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Ejemplos de salida

La sección Versión de particionado muestra información sobre la base de datos de configuración:

--- Sharding Status ---
  sharding version: {
   "_id" : <num>,
   "minCompatibleVersion" : <num>,
   "currentVersion" : <num>,
   "clusterId" : <ObjectId>
}

La sección Particiones enumera información sobre la(s) partición(es). Para cada partición, la sección muestra el nombre, el host y las etiquetas asociadas, si hay alguna.

shards:
 { "_id" : <shard name1>, "host" : <string>, "tags" : [ <string> ... ], "state" : <num> }
 { "_id" : <shard name2>, "host" : <string>, "tags" : [ <string> ... ], "state" : <num> }
 ...

La sección Instancias activas de mongos muestra, por defecto, información sobre la versión y el número de instancias de mongos que han estado activas en los últimos 60 segundos:

active mongoses:
  <version> : <num>

Si el método se ejecuta con el parámetro verbose en verdadero, la sección Instancias activas de mongos muestra información adicional:

active mongoses:
{  "_id" : "<hostname:port>",  "advisoryHostFQDNs" : [ "<name>" ],  "mongoVersion" : <string>,  "ping" : <ISODate>,  "up" : <long>,  "waiting" : <boolean> }

El Autosplit muestra información sobre si autosplit está activado:

autosplit:
  Currently enabled: <yes|no>

La sección Balancer enumera información sobre el estado del balanceador. Esto proporciona una perspectiva sobre la operación actual del balanceador y puede ser útil para solucionar problemas en un clúster no balanceado.

balancer:
      Currently enabled:  yes
      Currently running:  yes
      Collections with active migrations:
              config.system.sessions started at Fri May 15 2020 17:38:12 GMT-0400 (EDT)
      Failed balancer rounds in last 5 attempts:  0
      Migration Results for the last 24 hours:
             416 : Success
             1 : Failed with error 'aborted', from shardA to shardB

La sección Bases de datos enumera información sobre la(s) base(s) de datos. Muestra el nombre de la base de datos y la partición primaria para cada base de datos.

databases:
 { "_id" : <dbname1>, "primary" : <string>, "version": <document> }
 { "_id" : <dbname2>, "primary" : <string>, "version": <document> }
 ...

La sección Colección particionada proporciona información sobre los detalles de particionado para las colecciones particionadas. Para cada colección particionada, la sección muestra la clave de partición, el número de fragmentos por partición(es), la distribución de fragmentos entre las particiones [1], y la información de etiquetas, si la hay, para los rangos de claves de partición.

<dbname>.<collection>
   shard key: { <shard key> : <1 or hashed> }
   unique: <boolean>
   balancing: <boolean>
   allowMigrations: <boolean>
   chunks:
      <shard name1> <number of chunks>
      <shard name2> <number of chunks>
      ...
   { <shard key>: <min range1> } -->> { <shard key> : <max range1> } on : <shard name> <last modified timestamp>
   { <shard key>: <min range2> } -->> { <shard key> : <max range2> } on : <shard name> <last modified timestamp>
   ...
   tag: <tag1>  { <shard key> : <min range1> } -->> { <shard key> : <max range1> }
   ...

Campos de salida

Versión de particionado

sh.status.sharding-version._id: El _id es un identificador para los detalles de la versión.

sh.status.sharding-version.minCompatibleVersion

La minCompatibleVersion es la versión mínima compatible del servidor de configuración.

En las versiones de MongoDB anteriores a la 6.2, este campo está incluido en la colección config.version, pero en la versión mongosh 2.0.0 y posteriores, el campo no se devuelve en la salida sh.status(). A partir de MongoDB 6.2, este campo se elimina y no se devuelve en ninguna versión de mongosh ni en ninguna otra aplicación cliente. En su lugar, para obtener información sobre la versión, consulta la compatibilidad de características entre versiones (fcv).

sh.status.sharding-version.currentVersion

El currentVersion es la versión actual del servidor de configuración.

sh.status.sharding-version.clusterId: El clusterId es la identificación del clúster.

Instancias activas `mongos`

sh.status.active-mongoses

Si verbose es false, sh.status.active-mongoses registra la versión y la cantidad de mongos instancias activas. Las instancias activas mongos son mongos instancias que han sido activadas en los últimos 60 segundos.

Si verbose es true, sh.status.active-mongoses devuelve un documento para cada instancia activa de mongos que contiene los siguientes campos:

Campo	Tipo de dato	Descripción
`_id`	String	El nombre del host y el puerto donde se ejecuta el `mongos`. El `_id` tiene el formato `<hostname>:<port>`.
`advisoryHostFQDNs`	Arreglo de cadenas	Arreglo de los nombres de dominio totalmente calificados (FQDN) de `mongos`.
`created`	fecha	Cuando se inició el `mongos`. Nuevo en la versión 5.2.
`mongoVersion`	String	Versión de MongoDB en la que se ejecuta el `mongos`.
`ping`	fecha	Las instancias `mongos` envían pings al servidor de configuración cada 30 segundos. Este campo indica la última vez que se realizó el ping.
`up`	NumberLong	Número de segundos que el `mongos` ha estado activo desde el último ping.
`waiting`	Booleano	Este campo siempre es `true` y sólo se incluye por compatibilidad con versiones anteriores.

active mongoses:
{
   "_id" : "<hostname:port>",
   "advisoryHostFQDNs" : [ "<name>" ],
   "created" : <ISODate>,
   "mongoVersion" : <string>,
   "ping" : <ISODate>,
   "up" : <long>,
   "waiting" : <boolean>
}
...

Autosplit

sh.status.autosplit: sh.status.autosplit indica si la partición automática está activada actualmente.

Nota

A partir de MongoDB 6.0.3, no se realiza la división automática de fragmentos. Esto se debe a las mejoras en la política de balanceo. Los comandos de división automática aún existen, pero no ejecutan ninguna operación.

En versiones de MongoDB anteriores a la 6.1:

El balancerStart comando y los métodos de asistente de shell mongo sh.startBalancer() y sh.setBalancerState(true) también habilitan la división automática para el clúster.
To disable auto-splitting when the balancer is enabled, you can use sh.disableAutoSplit().
El comando balancerStop y los métodos de asistente de shell mongo sh.stopBalancer() y sh.setBalancerState(false) también desactivan la división automática para el clúster.
To enable auto-splitting when the balancer is disabled, you can use sh.enableAutoSplit().

Los métodos mongo sh.enableBalancing(namespace) y sh.disableBalancing(namespace) no tienen ningún efecto en la división automática.

Automerge

sh.status.automerge: Indica si AutoMerger está habilitado.
Nota
La sección automerge solo aparece si habilitas o deshabilitas el AutoMerger de forma explícita. Por defecto, el AutoMerger está habilitado.

Fragmentos

sh.status.shards._id: El _id muestra el nombre de la partición.

sh.status.shards.host: El host muestra la ubicación del host de la partición.

sh.status.shards.tags: El tags muestra todas las etiquetas para la partición. El campo solo se muestra si la partición tiene etiquetas.

sh.status.shards.state

El state muestra:

0 si la partición no es consciente de particiones.
1 si la partición tiene conocimiento de la partición.

Balanceador

Nota

En versiones de MongoDB anteriores a la 6.1:

El balancerStart comando y los métodos de asistente de shell mongo sh.startBalancer() y sh.setBalancerState(true) también habilitan la división automática para el clúster.
To disable auto-splitting when the balancer is enabled, you can use sh.disableAutoSplit().
El comando balancerStop y los métodos de asistente de shell mongo sh.stopBalancer() y sh.setBalancerState(false) también desactivan la división automática para el clúster.
To enable auto-splitting when the balancer is disabled, you can use sh.enableAutoSplit().

Los métodos mongo sh.enableBalancing(namespace) y sh.disableBalancing(namespace) no tienen ningún efecto en la división automática.

sh.status.balancer.currently-enabled: currently-enabled indica si el balanceador está actualmente habilitado en el clúster particionado.

sh.status.balancer.currently-running: currently-running indica si el balanceador está actualmente en funcionamiento y, por tanto, equilibrando actualmente el clúster.

sh.status.balancer.collections-with-active-migrations: collections-with-active-migrations muestra los nombres de las colecciones con migraciones activas y especifica cuándo comenzó la migración. Si no hay migraciones activas, este campo no aparecerá en la salida de sh.status().

sh.status.balancer.failed-balancer-rounds-in-last-5-attempts: failed-balancer-rounds-in-last-5-attempts muestra el número de rondas del balanceador que fallaron, de entre las últimas cinco rondas intentadas. Una ronda de balanceador fallará cuando falla una migración de fragmento.

sh.status.balancer.last-reported-error: last-reported-error muestra el mensaje de error más reciente del balanceador. Si no se han producido errores, este campo no aparecerá en la salida de sh.status().

sh.status.balancer.time-of-reported-error: time-of-reported-error proporciona la fecha y hora del error más recientemente reportado.

sh.status.balancer.migration-results-for-the-last-24-hours

migration-results-for-the-last-24-hours muestra el número de migraciones en las últimas 24 horas, así como los mensajes de error de las migraciones fallidas. Si no ha habido migraciones recientes, migration-results-for-the-last-24-hours muestra No recent migrations.

migration-results-for-the-last-24-hours incluye todas las migraciones, incluidas aquellas que no son iniciadas por el balanceador.

Databases

sh.status.databases._id: El _id muestra el nombre de la base de datos.

sh.status.databases.primary: primary muestra la partición primaria de la base de datos.

sh.status.databases.version

La version muestra la información de la versión de la base de datos:

{  "uuid" : UUID("cc250b66-8638-49f7-a2e8-c6f1220b9d7a"),  "lastMod" : 1 }

donde:

uuid es el identificador de la base de datos.
lastMod es la versión de la base de datos.

Colección particionada

sh.status.databases.<collection>.shard-key: La shard-key muestra el documento de especificación de la clave de partición.

sh.status.databases.<collection>.unique: El unique muestra si MongoDB aplica la unicidad en los valores de la clave de partición (es decir, si el índice de clave de partición subyacente es único).

sh.status.databases.<collection>.balancing: Muestra si el balanceador puede equilibrar la colección. Si el equilibrador está activado y este estado devuelve true, el equilibrador incluirá esta colección en las operaciones de equilibrio. Si el estado devuelve false, esto indica que el balanceador no equilibra los datos en esta colección.

sh.status.databases.<collection>.allowMigrations: Muestra si se permiten migraciones para la colección. Cuando true, la colección permite migraciones. Cuando false, la colección no permite migraciones, evitando la migración de fragmentos para esta colección. Utiliza sh.enableMigrations() y sh.disableMigrations() para controlar esta configuración.

sh.status.databases.<collection>.chunks: El chunks lista todas las particiones y el número de fragmentos que residen en cada partición.

sh.status.databases.<collection>.chunk-details

El chunk-details lista los detalles de los fragmentos [1]:

El rango de valores de la clave de partición que definen el fragmento,
La partición donde reside el fragmento, y
La última marca de tiempo modificada para el fragmento.

sh.status.databases.<collection>.tag: La tag enumera los detalles de las etiquetas asociadas con un rango de valores de la clave de partición.

Tip

sh.balancerCollectionStatus()

[1] (1, 2) La sección de la colección particionada, por defecto, muestra la información de fragmentos si el número total de fragmentos es menor a 20. Para mostrar la información cuando tenga 20 fragmentos o más, llame a los métodos sh.status() con el parámetro verbose establecido en true, es decir, sh.status(true).

Volver

sh.startBalancer

sh.stopAutoMerger

Definición

Tip

Compatibilidad

Importante

Ejemplos de salida

Campos de salida

Versión de particionado

Instancias activas mongos

Autosplit

Nota

Automerge

Nota

Fragmentos

Balanceador

Nota

Databases

Colección particionada

Tip

Instancias activas `mongos`