$collStats (agregación)

Definición

$collStats

Novedad en la versión 3.4.

Devuelve estadísticas sobre una colección o vista.

La etapa $collStats tiene el siguiente formato de prototipo:

{
  $collStats:
    {
      latencyStats: { histograms: <boolean> },
      storageStats: { scale: <number> },
      count: {},
      queryExecStats: {}
    }
}

La etapa $collStats acepta un documento de argumentos con los siguientes campos opcionales:

Nombre de campo	Descripción
latencyStats	Agregar estadísticas de latencia al documento de retorno.
latencyStats.histograms	Se agrega información del histograma de latencia a los documentos incrustados en latencyStats si true.
storageStats	Agrega estadísticas de almacenamiento al documento de devolución. Especifica un documento vacío (es decir, storageStats: {}) para usar el factor de escala por defecto de 1 para los diversos datos de tamaño. Un factor de escala de 1 muestra los tamaños devueltos en bytes. Especifica el factor de escala (es decir, storageStats: { scale: <number> }) para utilizar el factor de escala especificado para los diversos datos de tamaño. Por ejemplo, para mostrar kilobytes en lugar de bytes, especifica un valor de escala de 1024. Si se especifica un factor de escala no entero, MongoDB utiliza la parte entera del factor especificado. Por ejemplo, si se especifica un factor de escala de 1023.999, MongoDB utiliza 1023 como factor de escala. El factor de escala no afecta a aquellos tamaños que especifican la unidad de medida en el nombre del campo, como "bytes currently in the cache".
count	Agrega el número total de documentos en la colección al documento de retorno. El recuento se basa en los metadatos de la colección, que proporcionan un recuento rápido pero a veces impreciso para los clústeres shardados. See count campo Novedad en la versión 3.6.
queryExecStats	Agrega estadísticas de ejecución de query al documento de retorno.

Para una colección en un set de réplicas o una colección no particionada en un clúster, $collStats genera un único documento. Para una colección particionada, $collStats produce un documento por partición. El documento de salida incluye los siguientes campos:

Nombre de campo	Descripción
ns	El namespace de la colección o vista solicitada.
shard	El nombre de la partición al que corresponde el documento de salida. Solo aparece cuando $collStats se ejecuta en un clúster particionado. Tanto las colecciones particionadas como las no particionadas producirán este campo. Novedad en la versión 3.6.
host	El hostname y puerto del proceso mongod que produjo el documento de salida. Novedad en la versión 3.6.
localTime	La hora actual en el servidor de MongoDB, expresada en milisegundos UTC desde la Unix epoch.
latencyStats	Estadísticas relacionadas con la latencia de solicitudes para una colección o vista. Consulta latencyStats Documento para obtener detalles sobre este documento. Solo está presente cuando se especifica la opción latencyStats: {}.
storageStats	Estadísticas relacionadas con el motor de almacenamiento de una colección. Consulta el storageStats Documento para obtener detalles sobre este documento. Los datos de diversos tamaños se escalan por el factor especificado (con excepción de aquellos tamaños que especifican la unidad de medida en el nombre del campo). Solo está presente cuando se especifica la opción storageStats. Devuelve un error si se aplica a un vista.
count	El número total de documentos en la colección. Esta información también está disponible en storageStats.count. El recuento se basa en los metadatos de la colección, que proporcionan un recuento rápido pero a veces impreciso para los clústeres shardados. Solo presente cuando se especifica la opción count: {}. Devuelve un error si se aplica a una vista.
queryExecStats	Estadísticas relacionadas con la ejecución de consultas para la colección. Solo presente cuando se especifica la opción queryExecStats: {}. Devuelve un error si se aplica a una vista.

Comportamiento

$collStats debe ser la primera etapa en un pipeline de agregación, de lo contrario el pipeline devuelve un error.

histogram: [
  { micros: NumberLong(0), count: NumberLong(10) },
  { micros: NumberLong(2), count: NumberLong(1) },
  { micros: NumberLong(4096), count: NumberLong(1) },
  { micros: NumberLong(16384), count: NumberLong(1000) },
  { micros: NumberLong(49152), count: NumberLong(100) }
]

db.matrices.aggregate( [ { $collStats: { latencyStats: { histograms: true } } } ] )

{ "ns" : "test.matrices",
  "host" : "mongo.example.net:27017",
  "localTime" : ISODate("2017-10-06T19:43:56.599Z"),
  "latencyStats" :
    { "reads" :
        { "histogram" : [
            { "micros" : NumberLong(16),
              "count" : NumberLong(3) },
            { "micros" : NumberLong(32),
              "count" : NumberLong(1) },
            { "micros" : NumberLong(128),
              "count" : NumberLong(1) } ],
          "latency" : NumberLong(264),
          "ops" : NumberLong(5) },
      "writes" :
        { "histogram" : [
            { "micros" : NumberLong(32),
              "count" : NumberLong(1) },
            { "micros" : NumberLong(64),
              "count" : NumberLong(3) },
            { "micros" : NumberLong(24576),
              "count" : NumberLong(1) } ],
          "latency" : NumberLong(27659),
          "ops" : NumberLong(5) },
      "commands" :
        { "histogram" : [
            {
               "micros" : NumberLong(196608),
               "count" : NumberLong(1)
            }
          ],
          "latency" : NumberLong(0),
          "ops" : NumberLong(0) },
      "transactions" : {
         "histogram" : [ ],
         "latency" : NumberLong(0),
         "ops" : NumberLong(0)
      }
    }
}

db.matrices.aggregate( [ { $collStats: { storageStats: { } } } ] )

{
  "ns" : "test.matrices",
  "host" : "mongo.example.net:27017",
  "localTime" : ISODate("2020-03-06T01:44:57.437Z"),
  "storageStats" : {
    "size" : 608500363,
    "count" : 1104369,
    "avgObjSize" : 550,
    "storageSize" : 352878592,
    "freeStorageSize" : 2490380,
    "capped" : false,
    "wiredTiger" : {
      ...
    },
    "nindexes" : 2,
    "indexDetails" : {
      ...
    },
    "indexBuilds" : [    // Starting in MongoDB 4.2
       "_id_1_abc_1"
    ],
    "totalIndexSize" : 260337664,
    "totalSize" : 613216256,
    "indexSizes" : {
      "_id_" : 9891840,
      "_id_1_abc_1" : 250445824
    },
    "scaleFactor" : 1    // Starting in MongoDB 4.2
  }
}

db.matrices.aggregate( [ { $collStats: { count: { } } } ] )

{
  "ns" : "test.matrices",
  "host" : "mongo.example.net:27017",
  "localTime" : ISODate("2017-10-06T19:43:56.599Z"),
  "count" : 1103869
}

db.matrices.aggregate( [ { $collStats: { queryExecStats: { } } } ] )

{
  "ns": "test.matrices",
  "host": "mongo.example.net:27017",
  "localTime": ISODate("2020-06-03T14:23:29.711Z"),
  "queryExecStats": {
      "collectionScans": {
          "total": NumberLong(33),
          "nonTailable": NumberLong(31)
      }
  }
}

db.matrices.aggregate( [ { $collStats: { count: { } } } ] )

{
  "ns" : "test.matrices",
  "shard" : "s1",
  "host" : "s1-mongo1.example.net:27017",
  "localTime" : ISODate("2017-10-06T15:14:21.258Z"),
  "count" : 661705
}
{
  "ns" : "test.matrices",
  "shard" : "s2",
  "host" : "s2-mongo1.example.net:27017",
  "localTime" : ISODate("2017-10-06T15:14:21.258Z"),
  "count" : 442164
}