$collStats (estágio de agregação )

Definição

$collStats

Retorna estatísticas sobre uma coleção ou visualização.

O estágio $collStats tem o seguinte formato de protótipo:

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

O estágio $collStats aceita um documento de argumento com os seguintes campos opcionais:

Nome do campo	Descrição
latencyStats	Adiciona estatísticas de latência ao documento de retorno.
latencyStats.histograms	Adiciona informações de histograma de latência aos documentos incorporados em latencyStats se true.
storageStats	Adiciona estatísticas de armazenamento ao documento de retorno. Especifique um documento vazio (ou seja, storageStats: {}) para usar o fator de escala padrão de 1 para os vários dados de tamanho. O fator de escala de 1 exibe os tamanhos retornados em bytes. Especifique o fator de escala (ou seja, storageStats: { scale: <number> }) para utilizar o fator de escala especificado para os vários dados de tamanho. Por exemplo, para exibir kilobytes em vez de bytes, especifique um valor de escala de 1024. Se você especificar um fator de escala não inteiro, o MongoDB utilizará a parte inteira do fator especificado. Por exemplo, se você especificar um fator de escala de 1023.999, MongoDB utilizará 1023 como o fator de escala. O fator de escala não afeta os tamanhos que especificam a unidade de medida no nome do campo, como "bytes currently in the cache".
count	Adiciona o número total de documentos na collection ao documento de retorno. A contagem é baseada nos metadados da collection, que fornecem uma contagem rápida, mas às vezes imprecisa para clusters fragmentados. Ver campo de contagem
queryExecStats	Adiciona estatísticas de execução da consulta ao documento de retorno .

Para uma collection em um conjunto de réplicas ou uma collection não fragmentada em um cluster, $collStats gera um único documento. Para uma collection fragmentada, $collStats gera um documento por shard. O documento de saída inclui os seguintes campos:

Nome do campo	Descrição
ns	O namespace da collection ou visualização solicitada.
shard	O nome do shard ao qual o documento de saída corresponde. Somente está presente quando $collStats executa em um cluster fragmentado. As collections fragmentadas e não fragmentadas produzirão este campo.
host	O nome do host e a porta do processo mongod que produziu o documento de saída.
localTime	A hora atual no servidor MongoDB, expressa em milissegundos UTC desde a época UNIX.
latencyStats	Estatísticas relacionadas à latência de solicitação de uma collection ou visualização. Consulte o Documento latencyStats para obter detalhes sobre este documento. Presente somente quando a opção latencyStats: {} é especificada.
storageStats	Estatísticas relacionadas ao mecanismo de armazenamento de uma collection. Consulte o documento storageStats para obter detalhes sobre este documento. Os dados de vários tamanhos são dimensionados pelo fator especificado (com exceção dos tamanhos que especificam a unidade de medida no nome do campo). Presente somente quando a opção storageStats é especificada. Retorna um erro se aplicada a uma visualização.
count	O número total de documentos na collection. Estes dados também estão disponíveis em storageStats.count. A contagem é baseada nos metadados da collection, que fornecem uma contagem rápida, mas às vezes imprecisa para clusters fragmentados. Presente somente quando a opção count: {} é especificada.Retorna um erro se aplicada a uma visualização.
queryExecStats	Estatísticas relacionadas à execução da query para a collection. Presente somente quando a opção queryExecStats: {} é especificada.Retorna um erro se aplicada a uma visualização.

Comportamento

$collStats deve ser o primeiro estágio de um aggregation pipeline, senão o pipeline retorna um erro.

Saída

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) }
]

Exemplos

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: { } } } ] )

{
 "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.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;