db.setProfilingLevel() (método mongosh)

Definição

db.setProfilingLevel(level, options)

Alterado na versão 5.0.

Para uma instância mongod, o método habilita, desabilita ou configura o Profiler de banco de dados. O profiler capta e registra dados sobre o desempenho de operações de gravação, cursores e comandos de banco de dados em uma instância mongod em execução. Se o profiler estiver desabilitado, o método configurará como as operações lentas serão registradas no log de diagnóstico.

Observação

As alterações feitas no nível de profiling com db.setProfilingLevel() não persistem. Quando o servidor é reiniciado, ele reverte para 0 (o padrão) ou o valor definido pela configuração operationProfiling.mode ou pela opção de linha de comando --profile.

Se o nível do analisador de banco de dados for 1 ou 2 (especificamente, o analisador de banco de dados estiver habilitado), os slowms, sampleRate afetarão o comportamento do analisador e do diagnostic log.

Se o nível do profiler de banco de dados for 0 (especificamente, o profiler de banco de dados estiver desabilitado), os slowms e sampleRate afetarão somente o log de diagnóstico.

Com instâncias mongos , o método define os ajustes de configuração slowms, sampleRate e filter, que definem como as operações são gravadas no registro de diagnóstico. Não é possível ativar o profiler de banco de dados em uma instância mongos porque mongos não possui nenhuma coleção nas quais o profiler possa gravar. O nível profile deve ser 0 para uma instância mongos .

Você pode especificar um filtro nas instâncias mongod e mongos para controlar quais operações são registradas pelo profiler. Quando você especifica um filter para o profiler, as opções slowms e sampleRate não são usadas para perfilar e linhas de log de query lenta.

db.setProfilingLevel() fornece um encapsulador em torno do comando profile.

A partir do MongoDB 5.0, as alterações feitas no profiler de banco de dados level, slowms, sampleRate ou filter usando o comando profile ou o método encapsulador db.setProfilingLevel() são registradas no log file.

Compatibilidade

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

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

• 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 método db.setProfilingLevel() tem o seguinte formato:

db.setProfilingLevel(<level>, <options>)

Parâmetros

Devoluções

O método retorna um documento que contém os valores anteriores das configurações.

{
   "was" : 2,
   "slowms" : 100,
   "sampleRate" : 1,
   "filter" : {
      "$and" : [
         {
            "op" : {
               "$eq" : "query"
            }
         },
         {
            "millis" : {
               "$gt" : 20000
            }
         }
      ]
   },
   "note" : "When a filter expression is set, slowms and sampleRate are not used for profiling and slow-query log lines.",
   "ok" : 1
}

{
   "was" : 0,
   "slowms" : 100,
   "sampleRate" : 1,
   "filter" : {
      "$and" : [
         {
            "op" : {
               "$eq" : "query"
            }
         },
         {
            "millis" : {
               "$gte" : 2000
            }
         }
      ]
   },
   "note" : "When a filter expression is set, slowms and sampleRate are not used for profiling and slow-query log lines.",
   "ok" : 1,
   "$clusterTime" : {
      "clusterTime" : Timestamp(1572991238, 1),
      "signature" : {
         "hash" : BinData(0,"hg6GnlrVhV9MAhwWdeHmHQ4T4qU="),
         "keyId" : Long("6755945537557495811")
      }
   },
   "operationTime" : Timestamp(1572991238, 1)
}

{
   "was" : 0,
   "slowms" : 100,
   "sampleRate" : 1,
   "filter" : {
      "$and" : [
         {
            "op" : {
               "$eq" : "query"
            }
         },
         {
            "millis" : {
               "$gte" : 2000
            }
         }
      ]
   },
   "note" : "When a filter expression is set, slowms and sampleRate are not used for profiling and slow-query log lines.",
   "ok" : 1,
   "operationTime" : Timestamp(1572991499, 2),
   "$clusterTime" : {
      "clusterTime" : Timestamp(1572991499, 2),
      "signature" : {
         "hash" : BinData(0,"nhCquIxUw7thlrBudXe3PnsnvP0="),
         "keyId" : Long("6755946491040235540")
      }
   }
}

Onde:

• was é a configuração deanterior de nível.

• slowms é a configuração de anterior de slowms.

• sampleRate é a configuração anterior de sampleRate.

• filter é a configuração anterior de filtro.

• note é uma string explicando o comportamento de filter. Este campo aparece somente no resultado quando filter também está presente.

Para visualizar o nível do profiling atual, consulte db.getProfilingStatus().

Comportamento

Exemplos

db.setProfilingLevel(1, { slowms: 20, sampleRate: 0.42 })

db.setProfilingLevel(0, { slowms: 20, sampleRate: 0.42 })

db.setProfilingLevel( 1, { filter: { op: "query", millis: { $gt: 2000 } } } )

db.setProfilingLevel( 1, { filter: "unset" } )