Definição
$indexStatsRetorna estatísticas sobre o uso de cada índice para a coleção. Se estiver executando com controle de acesso, autentique como um usuário com pelo menos o papel
clusterMonitor.O estágio
$indexStatsrecebe um documento vazio e tem a seguinte sintaxe:{ $indexStats: { } }Para cada índice, o documento de devolução inclui os seguintes campos:
Campo de SaídaDescriçãonameNome do Índice.
Especificação da chave de índice.
Consulte também: especificações.
O nome de host e porta do processo do
mongod.Métricas de uso do índice para o hospedar associado, incluindo:
ops: o número de operações de usuário que utilizaram o índice. Este valor exclui operações internas, como exclusão por índices TTL ou operações de divisão e migração de partes. Essa exclusão também abrange o acesso ao índice da replicação, como a aplicação de oplog e a construção de índice durante a sincronização inicial.since: o momento a partir do qual o MongoDB coletou as estatísticas
AVISO: o campo
accessesreporta métricas de uso de índice apenas para o nó onde a query é executada. Para estatísticas de uso de índices mais abrangentes, execute$indexStatsem cada nó do cluster.O nome do fragmento associado ao host
Disponível apenas para um cluster fragmentado.
O documento de especificação completo do índice, que inclui a chave do índice e as propriedades do índice.
A opção de índice
hiddensó será incluída se o valor fortrue.Indica se o índice está sendo construído no momento.
Disponível apenas se
true.
Comportamento
Campo de Acessos
As estatísticas relatadas pelo campo acessos se aplicam apenas ao nó onde a query está sendo executada e incluem apenas o acesso ao índice acionado por solicitações do usuário. O campo accesses exclui as seguintes operações internas:
Exclusão por índices TTL
Operações de divisão e migração de partes
Acesso ao índice a partir da replicação, como a aplicação de oplog e a construção de índice durante a sincronização inicial
Restrições
$indexStatsdeve ser o primeiro estágio em um pipeline de agregação.$indexStatsnão é permitido em transações.
Considerações sobre redefinição de estatísticas de índice
Exemplos
O exemplo a seguir usa a coleção movies do conjunto de dados de amostra sample_mflix. Para obter detalhes sobre como carregar esse conjunto de dados em sua implantação, consulte Carregar o conjunto de dados de amostra.
Crie os seguintes índices na coleção movies:
db.movies.createIndex( { year: 1, title: 1 } )db.movies.createIndex( { rated: 1, year: 1 } )db.movies.createIndex( { metacritic: 1 }, { partialFilterExpression: { rated: "R" } })Execute algumas consultas em relação à coleção:
db.movies.find( { rated: "R" } )db.movies.find( { year: 1994 } ).sort( { title: 1 } )db.movies.find( { metacritic: { $gt: 90 } } )A seguinte operação de agregação retorna um documento que contém estatísticas de uso para cada índice na coleção movies:
db.movies.aggregate( [ { $indexStats: { } } ] )[ { name: 'year_1_title_1', key: { year: 1, title: 1 }, host: ..., accesses: ..., spec: { v: 2, key: { year: 1, title: 1 }, name: 'year_1_title_1' } }, { name: 'rated_1_year_1', key: { rated: 1, year: 1 }, host: ..., accesses: ..., spec: { v: 2, key: { rated: 1, year: 1 }, name: 'rated_1_year_1' } }, { name: 'metacritic_1', key: { metacritic: 1 }, host: ..., accesses: ..., spec: { v: 2, key: { metacritic: 1 }, name: 'metacritic_1', partialFilterExpression: { rated: 'R' } } }, { name: '_id_', key: { _id: 1 }, host: ..., accesses: ..., spec: { v: 2, key: { _id: 1 }, name: '_id_' } }, { name: 'cast_text_fullplot_text_genres_text_title_text', key: { _fts: 'text', _ftsx: 1 }, host: ..., accesses: ..., spec: ... }]Para usar o driver Node.js do MongoDB para adicionar um estágio $indexStats a um pipeline de agregação , use o operador $indexStats em um objeto de pipeline.
O exemplo a seguir cria um estágio de pipeline que retorna um documento que contém estatísticas de uso para cada índice da coleção. Em seguida, o exemplo executa o agregação pipeline:
const pipeline = [{ $indexStats: {} }];
const cursor = collection.aggregate(pipeline);return cursor;