`mongotop`

在此页面上

概要

语法
选项
字段
更多信息
了解详情

本文档适用于 mongotop 的 100.9.0 版本。

概要

mongotop 是一个命令行工具，提供了一种方法来跟踪 MongoDB 实例 mongod读取和写入数据所花费的时间。 mongotop提供每个集合级别的统计信息。默认情况下， mongotop每秒返回一次值。

语法

mongotop 事务语法：

mongotop <options> <connection-string> <polling interval in seconds>

运行不带任何命令行选项的mongotop将通过端口27017连接到本地主机上运行的mongod实例，并且默认情况下每秒返回一次值。

mongotop

要让mongotop每30秒报告一次，请指定轮询间隔：

mongotop 30

当连接到mongod实例时，该程序首先报告连接情况，然后按配置的频率报告统计信息。

2019-04-29T15:35:27.785-0400 connected to: 127.0.0.1
             ns    total      read      write    <timestamp>
<db.collection>    81802ms     0ms    81802ms
...

命令行选项

mongotop [options] [frequency]

您可以使用各种命令行选项运行mongotop 。

例如，要将mongotop连接到远程主机mongodb0.example.com上运行的mongod实例，并每30秒报告一次：

您可以包含所需的报告频率（在本示例中为30秒）和--uri选项，以指定主机和端口：
```
mongotop 30 --uri='mongodb://mongodb0.example.com:27017' [additional options]
```
如果mongod实例需要身份验证，则可以指定用户、密码和身份验证数据库作为 URI 连接字符串的一部分：
```
mongotop 30 --uri='mongodb://user:password@mongodb0.example.com:27017/?authSource=admin' [additional options]
```
运行mongotop的用户必须具有serverStatus和top特权。
有关 URI 连接字符串的详细信息，请参阅--uri 。
或者，您可以使用--host和--port选项指定主机和端口：
```
mongotop 30 --host=mongodb0.example.com --port=27017 [additional options]
```
如果mongod实例需要身份验证，则可以指定用户-u和身份验证数据库--authenticationDatabase 。省略--password选项以使mongoexport提示输入密码。
```
mongotop 30 --host=mongodb0.example.com --port=27017 -u=user --authenticationDatabase=admin [additional options]
```
运行mongotop的用户必须具有serverStatus和top特权。

有关可用选项的更多信息，请参阅选项。

当连接到mongod实例时，该程序首先报告连接情况，然后按配置的频率报告统计信息。

2019-04-29T15:35:27.785-0400 connected to: 127.0.0.1
             ns    total      read      write    <timestamp>
<db.collection>    81802ms     0ms    81802ms
...

选项

--help: 返回有关 mongotop 的选项和使用的信息。

--verbose, -v: 增加标准输出或日志文件中返回的内部报告数量。通过包括多个 -v 选项来提高详细程度，（例如 -vvvvv。）

--quiet

在尝试限制输出量的安静模式下运行 mongotop。

该选项会抑制：

数据库命令的输出
复制活动
连接接受事件
连接关闭事件

--version: 返回 mongotop 版本号。

--config=<filename>

版本 100.3.0 中的新增内容。

指定包含以下 mongotop 选项的敏感值的 YAML 配置文件的完整路径：

--password
--uri
--sslPEMKeyPassword

除通过密码提示来指定密码之外，这是为 mongotop 指定密码的另一推荐方法。

配置文件采用以下形式：

password: <password>
uri: mongodb://mongodb0.example.com:27017
sslPEMKeyPassword: <password>

向 password: 字段指定密码并在 uri: 字段中提供包含冲突密码的连接字符串将导致错误。

请务必使用相应的文件系统权限保护此文件。

注意

如果使用指定配置文件，并且还使用--config 的--password 、--uri 或--sslPEMKeyPassword mongotop选项，则每个命令行选项都会覆盖配置文件中的相应选项。

--uri=<connectionString>

指定 MongoDB 部署的可解析URI 连接字符串，用引号引起来：

--uri="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"

从mongotop的100.0版本开始，也可以将连接字符串作为位置参数提供，而不使用--uri选项：

mongotop mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]

作为位置参数，可以在命令行上的任何位置指定连接字符串，前提是它以 mongodb:// 或 mongodb+srv:// 开头。例如：

mongotop --username joe --password secret1 mongodb://mongodb0.example.com:27017 --ssl

只能提供一个连接字符串。无论是使用--uri选项还是作为位置参数，尝试包含多个值都会导致错误。

有关连接字符串组件的信息，请参阅连接字符串 URI 格式文档。

注意

connection string中的某些组件也可以使用自己的显式命令行选项来指定，例如--username和--password 。在提供连接字符串的同时，使用显式选项并指定冲突信息将导致错误。

注意

如果在 Ubuntu 上使用mongotop18 。04 cannot unmarshal DNS，在使用带有选项的 SRV 连接字符串（采用mongodb+srv:// 形式）时，您可能会遇到--uri 错误消息。如果是这样，请改用以下选项之一：

--uri带有非 SRV 连接字符串的选项（采用mongodb:// 形式）
--host选项，用于指定要直接连接的主机

警告

在某些系统上，使用--uri选项在连接字符串中提供的密码可能会对其他用户调用的系统状态程序（例如ps可见。请考虑：

在连接字符串中省略密码，接收交互式密码提示，或者
使用--config选项指定包含密码的配置文件。

--host=<hostname><:port>, -h=<hostname><:port>

默认：localhost:27017

指定 MongoDB 部署的可解析主机名。默认情况下，mongotop 尝试连接到在本地主机端口号 27017 上运行的 MongoDB 实例。

要连接到副本集，请指定replSetName和副本集成员的种子列表，如下所示：

--host=<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>

指定副本集列表格式时， mongotop始终连接到主节点。

还可以通过仅指定该成员的主机和端口来连接至副本集的任何单个成员：

--host=<hostname1><:port>

如果您使用 IPv6 并采用 <address>:<port> 格式，则须将地址与端口的组合部分用方括号括起（即 [<address>]）。

或者，也可以直接在URI connection string中指定主机名。在提供连接字符串的同时使用--host并指定冲突信息将导致错误。

如果连接到无法访问主节点的副本集， mongotop会返回错误消息。

--port=<port>

默认值：27017

指定 MongoDB 实例侦听客户端连接的 TCP 端口。

或者，也可以直接在URI connection string中指定端口。在提供连接字符串的同时使用--port并指定冲突信息将导致错误。

--ssl

允许连接到已启用 TLS/SSL 支持的mongod或mongos 。

或者，您也可以直接在URI connection string中配置 TLS/SSL 支持。在提供连接字符串的同时使用--ssl并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--sslCAFile=<filename>

指定包含来自证书颁发机构的根证书链的 .pem 文件。使用相对或绝对路径指定 .pem 文件的文件名。

或者，也可以直接在URI connection string中指定.pem文件。在提供连接字符串的同时使用--sslCAFile并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--sslPEMKeyFile=<filename>

指定同时包含 TLS/SSL 证书和密钥的 .pem 文件。使用相对或绝对路径指定 .pem 文件的文件名。

使用--ssl选项连接到已启用CAFile且未启用allowConnectionsWithoutCertificates的mongod或mongos时，需要使用此选项。

或者，也可以直接在URI connection string中指定.pem文件。在提供连接字符串的同时使用--sslPEMKeyFile并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--sslPEMKeyPassword=<value>

指定用于解密证书密钥文件的密码（即--sslPEMKeyFile ）。仅当证书密钥文件已加密时才使用--sslPEMKeyPassword选项。在所有情况下， mongotop都会从所有日志记录和报告输出中编辑密码。

如果 PEM 文件中的私钥已加密并且您未指定--sslPEMKeyPassword选项，则mongotop将提示输入密码。请参阅TLS/SSL 证书密码。

或者，也可以直接在URI connection string中指定密码。在提供连接字符串的同时使用--sslPEMKeyPassword并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

警告

在某些系统上，使用--sslPEMKeyPassword选项直接提供的密码可能会对其他用户调用的系统状态程序（例如ps可见。请考虑改用--config选项来指定包含密码的配置文件。

--sslCRLFile=<filename>

指定包含证书吊销列表的 .pem 文件。使用相对或绝对路径指定 .pem 文件的文件名。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--sslAllowInvalidCertificates

绕过对服务器证书的验证检查并允许使用无效证书。使用allowInvalidCertificates设置时，MongoDB 将使用无效证书记录为警告。

警告

尽管可用，但请尽可能避免使用 --sslAllowInvalidCertificates 选项。如果需要使用 --sslAllowInvalidCertificates，请仅在不可能入侵的系统上使用该选项。

在不验证服务器证书的情况下连接到mongod或mongos实例存在潜在的安全风险。如果只需禁用 TLS/SSL 证书中的主机名验证，请参阅--sslAllowInvalidHostnames 。

或者，也可以直接在URI connection string中禁用证书验证。在提供连接字符串的同时使用--sslAllowInvalidCertificates并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--sslAllowInvalidHostnames

禁用 TLS/SSL 证书中的主机名验证。即使证书中的主机名与指定的主机名不匹配，也支持 mongotop 连接到 MongoDB 实例。

或者，也可以直接在URI connection string中禁用主机名验证。在提供连接字符串的同时使用--sslAllowInvalidHostnames并指定冲突信息将导致错误。

有关 TLS/SSL 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos以及客户端的 TLS/SSL 配置。

--username=<username>, -u=<username>

指定用户名，用于对使用身份验证的 MongoDB 数据库进行身份验证。与--password和--authenticationDatabase选项结合使用。

或者，也可以直接在URI connection string中指定用户名。在提供连接字符串的同时使用--username并指定冲突信息将导致错误。

如果使用连接到 MongoDB Atlas MONGODB-AWSauthentication mechanism集群，您可以在以下位置指定您的 AWS 访问密钥 ID：

这个字段，
connection string ，或
AWS_ACCESS_KEY_ID 环境变量。

有关每个凭证的示例，请参阅使用 AWS IAM 凭证连接到 MongoDB Atlas 集群。

--password=<password>, -p=<password>

指定密码，用于对使用身份验证的 MongoDB 数据库进行身份验证。与--username和--authenticationDatabase选项结合使用。

要提示用户输入密码，请传递不带的选项，或指定空字符串作为--username --password--password值，如--password "" 中。

或者，也可以直接在URI connection string中指定密码。在提供连接字符串的同时使用--password并指定冲突信息将导致错误。

如果使用连接到 MongoDB Atlas MONGODB-AWSauthentication mechanism集群，您可以在以下位置指定 AWS 秘密访问密钥：

这个字段，
connection string ，或
AWS_SECRET_ACCESS_KEY 环境变量。

有关每个凭证的示例，请参阅使用 AWS IAM 凭证连接到 MongoDB Atlas 集群。

警告

在某些系统上，使用--password选项直接提供的密码可能会对其他用户调用的系统状态程序（例如ps可见。请考虑：

省略--password选项以接收交互式密码提示，或
使用--config选项指定包含密码的配置文件。

--awsSessionToken=<AWS Session Token>

如果使用连接到 MongoDB Atlas 集群，并且除了MONGODB-AWSauthentication mechanism AWS 访问密钥 ID 和秘密访问密钥之外还使用会话令牌，则可以在以下位置指定 AWS 会话令牌：

这个字段，
将AWS_SESSION_TOKEN authMechanismProperties参数传递给connection string ，或者
AWS_SESSION_TOKEN 环境变量。

有关每个凭证的示例，请参阅使用 AWS IAM 凭证连接到 MongoDB Atlas 集群。

仅在使用MONGODB-AWS authentication mechanism时有效。

--authenticationDatabase=<dbname>

指定已在其中创建指定的身份验证数据库。对于使用--username --authenticationDatabaseAuthentication mongos 的mongod 和实例，是必需的。请参阅身份验证数据库。

如果使用GSSAPI (Kerberos)、 PLAIN (LDAP SASL) 或MONGODB-AWS authentication mechanisms ，则必须将--authenticationDatabase设置为$external 。

或者，也可以直接在URI connection string中指定身份验证数据库。在提供连接字符串的同时使用--authenticationDatabase并指定冲突信息将导致错误。

--authenticationMechanism=<name>

默认值：SCRAM-SHA-1

指定mongotop实例用于向mongod或mongos进行身份验证的身份验证机制。

在版本100中进行了更改。 1 。 0 ：从版本100.1.0开始， mongotop在连接到MongoDB Atlas集群时增加了对MONGODB-AWS身份验证机制的支持。

值	说明
SCRAM-SHA-1	RFC5802 使用 SHA-1 哈希函数的标准 Salted 挑战响应身份验证机制。
SCRAM-SHA-256	RFC7677 使用 SHA-256 哈希函数的标准 Salted 挑战响应身份验证机制。需将 featureCompatibilityVersion 设为 `4.0`。
MONGODB-X509	MongoDB TLS/SSL 证书身份验证。
`MONGODB-AWS`	使用 AWS IAM 凭证进行外部身份验证，用于连接到MongoDB Atlas集群。请参阅使用 AWS IAM 档案连接到 MongoDB Atlas 集群。 100.1.0 版本新增。
GSSAPI (Kerberos)	使用 Kerberos 的外部身份验证。此机制仅在MongoDB Enterprise 中可用。
PLAIN (LDAP SASL)	使用 LDAP 进行外部身份验证。您还可以使用`PLAIN`对数据库内用户进行身份验证。 `PLAIN`以纯文本形式传输密码。此机制仅在MongoDB Enterprise 中可用。

或者，也可以直接在URI connection string中指定身份验证机制。在提供连接字符串的同时使用--authenticationMechanism并指定冲突信息将导致错误。

--gssapiServiceName=<serviceName>

使用GSSAPI/Kerberos指定服务名称。仅当服务不使用默认名称mongodb时才需要。

此选项仅在 MongoDB Enterprise 中可用。

--gssapiHostName=<hostname>

使用GSSAPI/Kerberos指定服务的主机名。仅当计算机的主机名与 DNS 解析的主机名不匹配时才需要。

此选项仅在 MongoDB Enterprise 中可用。

--locks

切换mongotop模式以报告每个数据库锁的使用情况。此数据仅在连接到 MongoDB 2时可用。 6或更旧的实例。

--locks针对mongod3 0调用时，会返回错误。或更新的实例，不报告每个数据库的锁使用情况。

--rowcount=<int>, -n=<int>: mongotop应打印的数据行数。 “ 0表示不定”

--json: 以JSON格式返回mongotop的输出。除定时数据外， --json选项还返回轮询间隔内发生的操作次数。

<sleeptime>: 最后一个参数是mongotop在两次调用之间等待的时间长度（以秒为单位）。默认情况下， mongotop每秒返回一次数据。

字段

当连接到mongod实例时，该程序首先报告连接情况，然后按配置的频率报告统计信息。 mongotop返回以毫秒 (ms) 为单位的时间值。

2019-04-29T15:35:27.785-0400 connected to: 127.0.0.1
             ns    total      read      write    <timestamp>
<db.collection>    81802ms     0ms    81802ms
...
             ns    total      read      write    <timestamp>
<db.collection>    0ms         0ms        0ms
...

mongotop 仅报告活动的命名空间或数据库，具体取决于--locks选项。如果没有看到数据库或集合，则表明它最近没有收到任何活动。您可以在mongo Shell 中发出简单的操作来生成活动，从而影响mongotop的输出。

mongotop.ns

包含数据库命名空间，它将数据库名称和集合组合在一起。

如果使用mongotop --locks ，则ns字段不会出现在mongotop输出中。

mongotop.db

包含数据库名称。名为 . 的数据库引用的是全局锁，而不是某个特定的数据库。

除非您使用--locks选项调用mongotop ，否则该字段不会出现。

mongotop.total: 提供此mongod在此命名空间上运行所花费的总时间。

mongotop.read: 提供此mongod在此命名空间上执行读取操作所花费的时间。

mongotop.write: 提供此mongod在此命名空间上执行写入操作所花费的时间。

mongotop.<timestamp>: 为返回的数据提供时间戳。

了解详情

← mongostat 示例

mongotop 兼容性和安装 →