db.setProfilingLevel() (mongosh method方法)

Definition定义

db.setProfilingLevel(level, options)

Changed in version 5.0.在版本5.0中的更改。

For a mongod instance, the method enables, disables, or configures the Database Profiler. 对于mongod实例，该方法启用、禁用或配置数据库探查器。The profiler captures and records data on the performance of write operations, cursors, and database commands on a running mongod instance. If the profiler is disabled, the method configures how slow operations are logged to the diagnostic log.分析器捕获并记录正在运行的mongod实例上写操作、游标和数据库命令的性能数据。如果禁用分析器，该方法将配置如何将慢速操作记录到诊断日志中。

Note

Changes made to the profiling level with db.setProfilingLevel() do not persist. 使用db.setProfilingLevel()对分析级别所做的更改不会持久。When the server restarts, it reverts to 0 (the default), or the value set by either the operationProfiling.mode setting or the --profile command-line option.当服务器重新启动时，它将恢复为0（默认值），或由operationProfiling.mode设置或--profile命令行选项设置的值。

If the database profiler level is 1 or 2 (specifically, the database profiler is enabled), the slowms and sampleRate affect the behavior of both the profiler and the diagnostic log.如果数据库分析器级别为1或2（具体来说，数据库分析器已启用），则slowms和sampleRate会影响分析器和诊断日志的行为。

If the database profiler level is 0 (specifically, database profiler is disabled), the slowms and sampleRate, affect only the diagnostic log.如果数据库分析器级别为0（具体来说，数据库分析器已禁用），则slowms和sampleRate仅影响诊断日志。

With mongos instances, the method sets the slowms, sampleRate and filter configuration settings, which configure how operations get written to the diagnostic log. 对于mongos实例，该方法设置slowms、sampleRate和filter配置设置，这些设置配置了如何将操作写入诊断日志。You cannot enable the Database Profiler on a mongos instance because mongos does not have any collections that the profiler can write to. 您无法在mongos实例上启用数据库分析器，因为mongos没有分析器可以写入的任何集合。The profile level must be 0 for a mongos instance.mongos实例的profile级别必须为0。

You can specify a filter on both mongod and mongos instances to control which operations are logged by the profiler. 您可以在mongod和mongos实例上指定一个筛选器，以控制分析器记录哪些操作。When you specify a filter for the profiler, the slowms, and sampleRate options are not used for profiling and slow-query log lines.为分析器指定filter时，slowms和sampleRate选项不用于分析和慢速查询日志行。

db.setProfilingLevel() provides a wrapper around the profile command.为profile命令提供包装。

Starting in MongoDB 5.0, changes made to the database profiler level, slowms, sampleRate, or filter using the profile command or db.setProfilingLevel() wrapper method are recorded in the log file.从MongoDB 5.0开始，使用profile命令或db.setProfilingLevel()包装器方法对数据库分析器level、slowms、sampleRate或filter所做的更改将记录在日志文件中。

Compatibility兼容性

This method is available in deployments hosted in the following environments:此方法在以下环境中托管的部署中可用：

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud：云中MongoDB部署的完全托管服务

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB：MongoDB的基于订阅的自我管理版本
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB：MongoDB的源代码可用、免费使用和自我管理版本

Syntax语法

The db.setProfilingLevel() method has the following form:db.setProfilingLevel()方法具有以下形式：

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

Parameters参数

Returns值

The method returns a document that contains the previous values of the settings.该方法返回一个包含先前设置值的文档。

{
   "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")
      }
   }
}

Where:其中

• was is the previous level setting.
• slowms is the previous slowms setting.
• sampleRate is the previous sampleRate setting.
• filter is the previous filter setting.
• note is a string explaining the behavior of filter. 是一个解释filter行为的字符串。This field only appears in the output when filter is also present.只有当filter也存在时，此字段才会出现在输出中。

To view the current profiling level, see db.getProfilingStatus().要查看当前的分析级别，请参阅db.getProfilingStatus()。

Behavior行为

Examples示例

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