$collStats (agregação)
Nesta página
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 campoDescriçãolatencyStats
Adiciona estatísticas de latência ao documento de retorno.latencyStats.histograms
Adiciona informações de histograma de latência aos documentos incorporados emlatencyStats
setrue
.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.
Consulte o campo
count
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 campoDescriçãons
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 processomongod
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 coleção ou visualização. Consulte Documento
latencyStats
para obter detalhes sobre esse documento.Presente somente quando a opção
latencyStats: {}
é especificada.storageStats
Estatísticas relacionadas ao mecanismo de armazenamento de uma coleção. Consulte Documento
storageStats
para obter detalhes sobre esse 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 aplicado 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.
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 campourl
.
Transações
$collStats
não é permitido em transações.
latencyStats
Documento
O documento incorporado latencyStats
só existe na saída caso você especifique a opção latencyStats
.
Nome do campo | Descrição |
---|---|
reads | Estatísticas de latência para solicitações de leitura. |
writes | Estatísticas de latência para solicitações de escrita. |
commands | Estatísticas de latência para comandos de banco de dados. |
transactions | Estatísticas de latência para transações de banco de dados. |
Cada um desses campos contém um documento incorporado com os seguintes campos:
Nome do campo | Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
latency | Um número inteiro de 64 bits que informa o total de latência combinada em microssegundos. | |||||||||||||
ops | Um inteiro de 64 bits que informa o número total de operações realizadas na collection desde a inicialização. | |||||||||||||
histogram | Um array de documentos incorporados, cada um representando uma faixa de latência. Cada documento cobre o dobro da faixa do documento anterior. Para valores mais baixos entre 2048 microssegundos e aproximadamente 1 segundo, o histograma inclui meios-passos. Este campo só existe com a opção Cada documento contém os seguintes campos:
Por exemplo, se
Isso indicará que houve [1]:
|
[1] |
|
Por exemplo, se você executar $collStats
com a opção latencyStats: {}
em uma collection matrices
:
db.matrices.aggregate( [ { $collStats: { latencyStats: { histograms: true } } } ] )
Esta query retornará um resultado semelhante ao seguinte:
{ "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) } } }
storageStats
Documento
O documento incorporado storageStats
só existe na saída caso você especifique a opção storageStats
.
O conteúdo deste documento depende do mecanismo de armazenamento em uso. Consulte Saída para obter uma referência sobre este documento.
Por exemplo, se você executar o $collStats
com a opção storageStats: {}
em uma collection matrices
utilizando o Mecanismo de armazenamento WiredTiger:
db.matrices.aggregate( [ { $collStats: { storageStats: { } } } ] )
Esta query retornará um resultado semelhante ao seguinte:
{ "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" : [ "_id_1_abc_1" ], "totalIndexSize" : 260337664, "totalSize" : 613216256, "indexSizes" : { "_id_" : 9891840, "_id_1_abc_1" : 250445824 }, "scaleFactor" : 1 } }
Consulte Saída para obter uma referência sobre este documento.
Observação
Índices em andamento
O storageStats
retornado inclui informações sobre índices em construção. Para obter detalhes, consulte:
Executar $collStats
com a opção storageStats
em uma visualização resulta em um erro.
count
Campo
O campo count
só existirá na saída se você especificar a opção count
.
Por exemplo, se você executar $collStats
com a opção count: {}
em uma collection matrices
:
db.matrices.aggregate( [ { $collStats: { count: { } } } ] )
A query retorna um resultado semelhante ao seguinte:
{ "ns" : "test.matrices", "host" : "mongo.example.net:27017", "localTime" : ISODate("2017-10-06T19:43:56.599Z"), "count" : 1103869 }
Observação
A contagem é baseada nos metadados da collection, que fornecem uma contagem rápida, mas às vezes imprecisa para clusters fragmentados.
O número total de documentos na coleção também está disponível como storageStats.count
quando storageStats: {}
é especificado. Para obter mais informações, consulte o documento storageStats
.
queryExecStats
Documento
O documento incorporado queryExecStats
só existe na saída caso você especifique a opção queryExecStats
.
O campo collectionScans
contém um documento incorporado com os seguintes campos:
Nome do campo | Descrição |
---|---|
total | Um inteiro de 64 bits que informa o número total de query que executaram uma varredura de collection. O total consiste em query que usaram e não usaram um cursor persistente. |
nonTailable | Um inteiro de 64 bits que informa o número de queries que executaram uma varredura de collection que não usou um cursor tailable. |
Por exemplo, se você executar $collStats
com a opção queryExecStats: {}
em uma collection matrices
:
db.matrices.aggregate( [ { $collStats: { queryExecStats: { } } } ] )
A query retorna um resultado semelhante ao seguinte:
{ "ns": "test.matrices", "host": "mongo.example.net:27017", "localTime": ISODate("2020-06-03T14:23:29.711Z"), "queryExecStats": { "collectionScans": { "total": NumberLong(33), "nonTailable": NumberLong(31) } } }
$collStats
em collections fragmentadas
$collStats
gera um documento por fragmento quando executado em collections fragmentadas. Cada documento de saída contém um campo shard
com o nome do fragmento ao qual o documento corresponde.
Por exemplo, se você executar $collStats
em uma collection fragmentada com a opção count: {}
em uma collection denominada matrices
:
db.matrices.aggregate( [ { $collStats: { count: { } } } ] )
A query retorna um resultado semelhante ao seguinte:
{ "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 }