collStats (comando de banco de dados)

Definição

collStats

Obsoleto desde a versão 6.2.

Nas versões 6.2 e posterior, utilize o estágio de aggregation de $collStats.

O comando collStats retorna uma variedade de estatísticas de armazenamento para uma determinada collection.

Dica

In mongosh, this command can also be run through the stats() helper method. Specific fields in the collStats output can be accessed using the dataSize(), estimatedDocumentCount(), isCapped(), latencyStats(), storageSize(), totalIndexSize(), and totalSize() helper methods.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

Para executar collStats, use o método db.runCommand( { <command> } ).

Compatibilidade

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Observação

Este comando é aceito em todos os clusters do MongoDB Atlas. Para obter informações sobre o suporte do Atlas a todos os comandos, consulte Comandos não suportados.

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

O comando tem a seguinte sintaxe:

db.runCommand(
   {
     collStats: <string>,
     scale: <int>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Campo	Tipo	Descrição
`collStats`	string	O nome da coleção de destino.
`scale`	int	Opcional. O fator de escala para os vários dados de tamanho (com exceção dos tamanhos que especificam a unidade de medida no nome do campo). O valor padrão é 1 para retornar dados de tamanho em bytes. Para exibir kilobytes em vez de bytes, especifique um valor `scale` 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 arredonda os valores de tamanho afetados para números inteiros.

Comportamento

Redação

Ao usar Queryable Encryption, a saída de $collStats elimina determinadas informações para collections criptografadas:

A saída omite "queryExecStats"
A saída omite "latencyStats"
A saída suprime "WiredTiger", se presente, para incluir apenas o campo url.

Tamanhos em escala

A menos que especificado de outra forma pelo nome da métrica (como "bytes currently in the cache"), os valores relacionados ao tamanho são exibidos em bytes e podem ser substituídos por scale.

O fator de escala arredonda os valores de tamanho afetados para números inteiros.

Precisão após Desligamento Inesperado

Após um desligamento impuro de um mongod usando o mecanismo de armazenamento Wired Tiger, as estatísticas de tamanho relatadas por collStats podem ser imprecisas.

A quantidade de desvio depende do número de operações de inserção, atualização ou exclusão executadas entre o último ponto de verificação e o desligamento não limpo. Os pontos de verificação geralmente ocorrem a cada 60 segundos. No entanto, mongod instâncias executadas com configurações de --syncdelay não padrão podem ter pontos de verificação mais ou menos frequentes.

Execute validate em cada collection no mongod para restaurar as estatísticas depois de um desligamento impróprio.

Após um desligamento impróprio:

validate updates the count statistic in the collStats output with the latest value.
Other statistics like the number of documents inserted or removed in the collStats output are estimates.

Índices em andamento

collStats inclui informações sobre índices que estão sendo construídos atualmente. Para obter detalhes, consulte:

collStats.nindexes
collStats.indexDetails
collStats.indexBuilds
collStats.totalIndexSize
collStats.indexSizes

Restrição de estado do membro do conjunto de réplica

Para executar em um membro do conjunto de réplicas, as operações collStats exigem que o membro esteja no estado PRIMARY ou SECONDARY. Se o membro estiver em outro estado, como STARTUP2, a operação terá erros.

Collections não existentes

If you run collStats for a non-existent collection, the command might return 0 values in the output fields instead of an error. This behavior depends on your database implementation.

For an example of this behavior, see Example.

Exemplo

Os exemplos nesta página usam dados do conjunto de dados de amostra sample_mflix. Para obter detalhes sobre como carregar esse conjunto de dados em sua implantação autogerenciada do MongoDB , consulte Carregar o conjunto de dados de amostra. Se você fez modificações nos bancos de dados de amostra, talvez seja necessário descartar e recriar os bancos de dados para executar os exemplos nesta página.

A seguinte operação executa o comando collStats na collection movies, especificando uma escala de 1024 bytes:

db.runCommand( { collStats : "movies", scale: 1024 } )

{
  ok: 1,
  capped: false,
  ns: 'sample_mflix.movies',
  size: ...,
  count: 21349,
  avgObjSize: 1598,
  storageSize: ...,
  nindexes: 2,
  totalIndexSize: ...,
  totalSize: ...,
  indexSizes: {
    _id_: ...,
    cast_text_fullplot_text_genres_text_title_text: ...
  },
  scaleFactor: 1024
}

The following operation runs the collStats command on a non-existent collection:

db.runCommand( { collStats : "nonExistentCollection" } )

{
  ns: 'sample_mflix.nonExistentCollection',
  size: 0,
  count: 0,
  numOrphanDocs: 0,
  storageSize: 0,
  totalSize: 0,
  nindexes: 0,
  totalIndexSize: 0,
  indexDetails: {},
  indexSizes: {},
  scaleFactor: 1,
  ok: 1
}

Saída

O documento a seguir fornece uma representação da saída collStats . Dependendo da configuração da sua collection e do mecanismo de armazenamento, os campos de saída podem variar.

{
  "ns" : <string>,
  "size" : <number>,
  "timeseries" : {
     "bucketsNs" : <bucketName>,
     "bucketCount" : <number>,
     "avgBucketSize" : <number>,
     "numBucketInserts" : <number>,
     "numBucketUpdates" : <number>,
     "numBucketsOpenedDueToMetadata" : <number>,
     "numBucketsClosedDueToCount" : <number>,
     "numBucketsClosedDueToSize" : <number>,
     "numBucketsClosedDueToTimeForward" : <number>,
     "numBucketsClosedDueToTimeBackward" : <number>,
     "numBucketsClosedDueToMemoryThreshold" : <number>,
     "numCommits" : <number>,
     "numWaits" : <number>,
     "numMeasurementsCommitted" : <number>,
     "avgNumMeasurementsPerCommit": <number>
  },
  "count" : <number>,
  "avgObjSize" : <number>,
  "numOrphanDocs" : <number>,      // Available starting in MongoDB 6.0
  "storageSize" : <number>,
  "freeStorageSize" : <number>,
  "capped" : <boolean>,
  "max" : <number>,
  "maxSize" :  <number>,
  "wiredTiger" : {
     "metadata" : {
        "formatVersion" : <num>
     },
     "creationString" : <string>
     "type" :  <string>,
     "uri" :  <string>,
     "LSM" : {
        "bloom filter false positives" : <number>,
        "bloom filter hits" : <number>,
        "bloom filter misses" : <number>,
        "bloom filter pages evicted from cache" : <number>,
        "bloom filter pages read into cache" : <number>,
        "bloom filters in the LSM tree" : <number>,
        "total size of bloom filters" : <number>,
        "chunks in the LSM tree" : <number>,
        "highest merge generation in the LSM tree" : <number>,
        "queries that could have benefited from a Bloom filter that did not exist" : <number>,
        "sleep for LSM checkpoint throttle" : <number>,
        "sleep for LSM merge throttle" : <number>
        "total size of bloom filters" : <number>
     },
     "block-manager" : {
         "allocations requiring file extension" : <number>,
         "blocks allocated" : <number>,
         "blocks freed" : <number>,
         "checkpoint size" : <number>,
         "file allocation unit size" : <number>,
         "file bytes available for reuse" : <number>,
         "file magic number" : <number>,
         "file major version number" : <number>,
         "file size in bytes" : <number>,
         "minor version number" : <number>
     },
     "btree" : {
         "btree checkpoint generation" : <number>,
         "column-store fixed-size leaf pages" : <number>,
         "column-store internal pages" : <number>,
         "column-store variable-size RLE encoded values" : <number>,
         "column-store variable-size deleted values" : <number>,
         "column-store variable-size leaf pages" : <number>,
         "fixed-record size" : <number>,
         "maximum internal page key size" : <number>,
         "maximum internal page size" : <number>,
         "maximum leaf page key size" : <number>,
         "maximum leaf page size" : <number>,
         "maximum leaf page value size" : <number>,
         "maximum tree depth" : <number>,
         "number of key/value pairs" : <number>,
         "overflow pages" : <number>,
         "pages rewritten by compaction" : <number>,
         "row-store empty values" : <number>,
         "row-store internal pages" : <number>,
         "row-store leaf pages" : <number>
     },
     "cache" : {
        "bytes currently in the cache" : <number>,
        "bytes dirty in the cache cumulative" : <number>,
        "bytes read into cache" : <number>,
        "bytes written from cache" : <number>,
        "checkpoint blocked page eviction" : <number>,
        "data source pages selected for eviction unable to be evicted" : <number>,
        "eviction walk passes of a file" : <number>,
        "eviction walk target pages histogram - 0-9" : <number>,
        "eviction walk target pages histogram - 10-31" : <number>,
        "eviction walk target pages histogram - 128 and higher" : <number>,
        "eviction walk target pages histogram - 32-63" : <number>,
        "eviction walk target pages histogram - 64-128" : <number>,
        "eviction walks abandoned" : <number>,
        "eviction walks gave up because they restarted their walk twice" : <number>,
        "eviction walks gave up because they saw too many pages and found no candidates" : <number>,
        "eviction walks gave up because they saw too many pages and found too few candidates" : <number>,
        "eviction walks reached end of tree" : <number>,
        "eviction walks started from root of tree" : <number>,
        "eviction walks started from saved location in tree" : <number>,
        "hazard pointer blocked page eviction" : <number>,
        "in-memory page passed criteria to be split" : <number>,
        "in-memory page splits" : <number>,
        "internal pages evicted" : <number>,
        "internal pages split during eviction" : <number>,
        "leaf pages split during eviction" : <number>,
        "modified pages evicted" : <number>,
        "overflow pages read into cache" : <number>,
        "page split during eviction deepened the tree" : <number>,
        "page written requiring cache overflow records" : <number>,
        "pages read into cache" : <number>,
        "pages read into cache after truncate" : <number>,
        "pages read into cache after truncate in prepare state" : <number>,
        "pages read into cache requiring cache overflow entries" : <number>,
        "pages requested from the cache" : <number>,
        "pages seen by eviction walk" : <number>,
        "pages written from cache" : <number>,
        "pages written requiring in-memory restoration" : <number>,
        "tracked dirty bytes in the cache" : <number>,
        "unmodified pages evicted" : <number>
     },
     "cache_walk" : {
        "Average difference between current eviction generation when the page was last considered" : <number>,
        "Average on-disk page image size seen" : <number>,
        "Average time in cache for pages that have been visited by the eviction server" : <number>,
        "Average time in cache for pages that have not been visited by the eviction server" : <number>,
        "Clean pages currently in cache" : <number>,
        "Current eviction generation" : <number>,
        "Dirty pages currently in cache" : <number>,
        "Entries in the root page" : <number>,
        "Internal pages currently in cache" : <number>,
        "Leaf pages currently in cache" : <number>,
        "Maximum difference between current eviction generation when the page was last considered" : <number>,
        "Maximum page size seen" : <number>,
        "Minimum on-disk page image size seen" : <number>,
        "Number of pages never visited by eviction server" : <number>,
        "On-disk page image sizes smaller than a single allocation unit" : <number>,
        "Pages created in memory and never written" : <number>,
        "Pages currently queued for eviction" : <number>,
        "Pages that could not be queued for eviction" : <number>,
        "Refs skipped during cache traversal" : <number>,
        "Size of the root page" : <number>,
        "Total number of pages currently in cache" : <number>
     },
     "compression" : {
        "compressed page maximum internal page size prior to compression" : <number>,
        "compressed page maximum leaf page size prior to compression " : <number>,
        "compressed pages read" : <number>,
        "compressed pages written" : <number>,
        "page written failed to compress" : <number>,
        "page written was too small to compress" : 1
     },
     "cursor" : {
        "bulk loaded cursor insert calls" : <number>,
        "cache cursors reuse count" : <number>,
        "close calls that result in cache" : <number>,
        "create calls" : <number>,
        "insert calls" : <number>,
        "insert key and value bytes" : <number>,
        "modify" : <number>,
        "modify key and value bytes affected" : <number>,
        "modify value bytes modified" : <number>,
        "next calls" : <number>,
        "open cursor count" : <number>,
        "operation restarted" : <number>,
        "prev calls" : <number>,
        "remove calls" : <number>,
        "remove key bytes removed" : <number>,
        "reserve calls" : <number>,
        "reset calls" : <number>,
        "search calls" : <number>,
        "search near calls" : <number>,
        "truncate calls" : <number>,
        "update calls" : <number>,
        "update key and value bytes" : <number>,
        "update value size change" : <num>
     },
     "reconciliation" : {
        "dictionary matches" : <number>,
        "fast-path pages deleted" : <number>,
        "internal page key bytes discarded using suffix compression" : <number>,
        "internal page multi-block writes" : <number>,
        "internal-page overflow keys" : <number>,
        "leaf page key bytes discarded using prefix compression" : <number>,
        "leaf page multi-block writes" : <number>,
        "leaf-page overflow keys" : <number>,
        "maximum blocks required for a page" : <number>,
        "overflow values written" : <number>,
        "page checksum matches" : <number>,
        "page reconciliation calls" : <number>,
        "page reconciliation calls for eviction" : <number>,
        "pages deleted" : <number>
     },
     "session" : {
        "object compaction" : <number>,
     },
     "transaction" : {
        "update conflicts" : <number>
     }
  },
  "nindexes" : <number>,
  "indexDetails" : {
     "_id_" : {
        "metadata" : {
           "formatVersion" : <number>
        },
        ...
     },
     ...
  },
  "indexBuilds" : [
     <string>,
  ],
  "totalIndexSize" : <number>,
  "totalSize" : <number>,
  "indexSizes" : {
          "_id_" : <number>,
          "<indexName>" : <number>,
          ...
  },
  "scaleFactor" : <number>
  "ok" : <number>
}

collStats.ns: O namespace da collection atual, que segue o formato [database].[collection].

collStats.size

The total uncompressed size in memory of all records in a collection. The size does not include the size of any indexes associated with the collection, which the totalIndexSize field reports.

O argumento scale afeta esse valor. A compressão de dados não afeta esse valor.

collStats.timeseries

timeseries appears when you run the collStats command on a time series collection.

Este documento contém dados para uso diagnóstico interno.

collStats.count: O número de objetos ou documentos nesta collection.

collStats.avgObjSize: O tamanho médio de um objeto na collection. O argumento scale não afeta este valor.

collStats.numOrphanDocs: O número de documentos órfãos na collection.
Novidades na versão 6.0.

collStats.storageSize

A quantidade total de armazenamento alocada a essa collection para armazenamento de documentos. O argumento scale afeta esse valor.

If collection data is compressed (which is the default for WiredTiger), the storage size reflects the compressed size and may be smaller than the value for collStats.size.

storageSize does not include index size. See totalIndexSize for index sizing.

collStats.freeStorageSize

Indisponível para o mecanismo de armazenamento in-memory

A quantidade de armazenamento disponível para reutilização. O argumento scale afeta esse valor.

O campo só estará disponível se o armazenamento estiver disponível para reutilização (ou seja, maior que zero).

collStats.nindexes

O número de índices na collection. Todas as collections têm pelo menos um índice no campo _id.

nindexes inclui índices que estão sendo criados atualmente em sua contagem.

collStats.indexDetails

Um documento que relata dados do mecanismo de armazenamento WiredTiger para cada índice da collection. Outros mecanismos de armazenamento retornarão um documento vazio.

Os campos neste documento são os nomes dos índices, enquanto os valores em si são documentos que contêm estatísticas do índice fornecidas pelo mecanismo de armazenamento. Essas estatísticas são para uso em diagnósticos internos.

indexDetails contém detalhes sobre os índices que estão sendo criados atualmente, incluindo avisos e erros.

collStats.indexBuilds: An array that contains the names of the indexes that are currently being built on the collection. Once an index build completes, the index does not appear in the indexBuilds.

collStats.totalIndexSize

Soma do espaço em disco usado por todos os índices. O argumento scale afeta esse valor.

Se um índice utilizar compressão de prefixo (que é o default for WiredTiger), o tamanho retornado refletirá o tamanho comprimido para qualquer um desses índices ao calcular o total.

totalIndexSize inclui índices atualmente sendo construídos no tamanho total.

collStats.totalSize: The sum of the storageSize and totalIndexSize. The scale argument affects this value.

collStats.indexSizes

Este campo especifica a chave e o tamanho de cada índice existente na collection. O argumento scale afeta esse valor.

Se um índice usar compactação de prefixo (que é o default for WiredTiger), o tamanho retornado refletirá o tamanho compactado.

indexSizes inclui os tamanhos dos índices que estão sendo criados atualmente.

collStats.scaleFactor

O valor scale utilizado pelo comando.

Se você tiver especificado um fator de escala não inteiro, o MongoDB usará 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.

collStats.capped: Este campo será "true" se a collection for limitada.

collStats.max: Mostra o número máximo de documentos que podem estar presentes em uma capped collection.

collStats.maxSize: Mostra o tamanho máximo de uma capped collection.

collStats.wiredTiger

wiredTiger only appears when using the WiredTiger storage engine. When using Queryable Encryption, WiredTiger data is redacted to only the url field.

Este documento contém dados relatados diretamente pelo mecanismo WiredTiger e outros dados para uso de diagnóstico interno.

collStats.inMemory

inMemory só aparece ao usar o mecanismo de armazenamento in-memory.

Este documento contém dados reportados diretamente pelo mecanismo de armazenamento e outros dados para uso diagnóstico interno.

Voltar

buildInfo

connPoolStats