$collStats (etapa de agregación)

Definición

$collStats

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

La etapa $collStats tiene la siguiente forma de prototipo:

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

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

Nombre de campo	Descripción
latencyStats	Añade Estadísticas de latencia al documento de retorno.
latencyStats.histograms	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. Especifique el factor de escala (p. ej., storageStats: { scale: <number> }) para utilizarlo en los datos de distintos tamaños. Por ejemplo, para mostrar kilobytes en lugar de bytes, especifique 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 de la colección al documento de devolución. El recuento se basa en los metadatos de la colección, que proporcionan un recuento rápido pero a veces inexacto para los clústeres fragmentados. Ver campo de conteo
queryExecStats	Agrega estadísticas de ejecución de consultas al documento de retorno.

Para una colección en un conjunto de réplicas o una colección no fragmentada en un clúster, $collStats genera un solo documento. Para una colección fragmentada, $collStats genera un documento por fragmento. 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.
host	El nombre de host y el puerto del proceso mongod que produjo el documento de salida.
localTime	La hora actual en el servidor MongoDB, expresada en milisegundos UTC desde la época UNIX.
latencyStats	Estadísticas relacionadas con la latencia de las solicitudes de una colección o vista. Consulte el documento "Estadísticas de latencia" para obtener más información. Sólo está presente cuando se especifica la opción latencyStats: {}.
storageStats	Estadísticas relacionadas con el motor de almacenamiento de una colección. Consulte el documento "storageStats" para obtener más información. Los distintos tamaños de datos se escalan según el factor especificado (con excepción de aquellos tamaños que especifican la unidad de medida en el nombre del campo). Sólo está presente cuando se especifica la opción storageStats. Devuelve un error si se aplica a una vista.
count	Número total de documentos de la colección. Estos datos también están disponibles en storageStats.count. El recuento se basa en los metadatos de la colección, que proporcionan un recuento rápido pero a veces inexacto para los clústeres fragmentados. 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 está presente cuando queryExecStats: {} se especifica la opción. Devuelve un error si se aplica a una vista.

Comportamiento

$collStats debe ser la primera etapa de una secuencia de agregación, de lo contrario la secuencia devuelve un error.

Salida

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

Ejemplos

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" : Long(16),
             "count" : Long(3) },
           { "micros" : Long(32),
             "count" : Long(1) },
           { "micros" : Long(128),
             "count" : Long(1) } ],
         "latency" : Long(264),
         "ops" : Long(5) },
     "writes" :
       { "histogram" : [
           { "micros" : Long(32),
             "count" : Long(1) },
           { "micros" : Long(64),
             "count" : Long(3) },
           { "micros" : Long(24576),
             "count" : Long(1) } ],
         "latency" : Long(27659),
         "ops" : Long(5) },
     "commands" :
       { "histogram" : [
           {
               "micros" : Long(196608),
               "count" : Long(1)
           }
         ],
         "latency" : Long(0),
         "ops" : Long(0) },
     "transactions" : {
         "histogram" : [ ],
         "latency" : Long(0),
         "ops" : Long(0)
     }
   }
}

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

{
  localTime : 2020-03-06T01:44:57.437Z,
  storageStats: {
  size: 608500363,
  count: 1104369,
  avgObjectSize: 550,
  storageSize: 4096,
  freeStorageSize: 2490380,
  capped: false,
  wiredTiger : {
      ...
   },
   nindexes : 2,
   indexDetails : {
     ...
   },
   indexBuilds: [
     _id_1_abc_1
   ],
   totalIndexSize: 260337664,
   indexSizes: {
   _id_ : 9891840,
   _id_1_abc_1 : 250445824
   },
   totalSize: 613216256,
   scaleFactor : 1
 },
 host : 'mongo.example.net:27017',
 ns : 'test.matrices'
}

db.weather.aggregate( [ { $collStats: { storageStats: { } } } ] ).toArray()[0].storageStats.timeseries

{
   bucketsNs: 'test.system.buckets.weather',
   bucketCount: 12,
   avgBucketSize: 300,
   numActiveBuckets: 1,
   numBucketInserts: 12,
   numBucketUpdates: 0,
   numBucketsOpenedDueToMetadata: 1,
   numBucketsClosedDueToCount: 0,
   numBucketsClosedDueToSchemaChange: 0,
   numBucketsClosedDueToSize: 0,
   numBucketsClosedDueToTimeForward: 11,
   numBucketsClosedDueToMemoryThreshold: 0,
   numCommits: 12,
   numMeasurementsGroupCommitted: 0,
   numWaits: 0,
   numMeasurementsCommitted: 12,
   avgNumMeasurementsPerCommit: 1,
   numBucketsClosedDueToReopening: 0,
   numBucketsArchivedDueToMemoryThreshold: 0,
   numBucketsArchivedDueToTimeBackward: 0,
   numBucketsReopened: 0,
   numBucketsKeptOpenDueToLargeMeasurements: 0,
   numBucketsClosedDueToCachePressure: 0,
   numBucketsFrozen: 0,
   numCompressedBucketsConvertedToUnsorted: 0,
   numBucketsFetched: 0,
   numBucketsQueried: 0,
   numBucketFetchesFailed: 0,
   numBucketQueriesFailed: 1,
   numBucketReopeningsFailed: 0,
   numDuplicateBucketsReopened: 0
}

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": Long(33),
         "nonTailable": Long(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
}

const pipeline = [
  {
    $collStats: {
      latencyStats: {histograms: true}
    }
  }
];
const cursor = collection.aggregate(pipeline);  
return cursor;

const pipeline = [{ $collStats: { storageStats: {} } }]; 
const cursor = collection.aggregate(pipeline);
return cursor;

const pipeline = [{ $collStats: { storageStats: {} } }];
const cursor = collection.aggregate(pipeline);
const timeSeriesStats = resultsTimeSeries[0].storageStats.timeseries;  
return timeSeriesStats;

const pipeline = [{ $collStats: { count: {} } }]; 
const cursor =  collection.aggregate(pipeline);
return cursor;

const pipeline = [{ $collStats: { queryExecStats: {} } }]; 
const cursor =  collection.aggregate(pipeline);
return cursor;