> This page location: /docs.md > /docs/tools-and-connectors.md > /docs/database-tools.md

> For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

# `mongotop`

MongoDB Command Line Database Tool binaries are not supported or tested for use with non-genuine MongoDB deployments. While the tools may work on these deployments, compatibility is not guaranteed.

This documentation is for version `100.20.1` of `mongotop`.

## Synopsis

`mongotop` is a command-line tool that provides a method to track the amount of time a MongoDB instance [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) spends reading and writing data. `mongotop` provides statistics on a per-collection level. By default, `mongotop` returns values every second.

## Security Considerations

Do not pass connection options such as `--uri` or `--host` from an untrusted source to `mongotop`. Untrusted connection information can expose information from the host that runs the tool or direct the tool to an attacker-controlled cluster.

## Syntax

`mongotop` syntax:

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

Running `mongotop` without any command-line options will connect to the [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance running on localhost over port `27017`, and will return values every second by default.

```sh
mongotop
```

To have `mongotop` report every 30 seconds, specify the polling interval:

```sh
mongotop 30
```

When connected to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance, the program reports first on the connection and then reports on the statistics at the configured frequency.

```sh
2019-04-29T15:35:27.785-0400 connected to: 127.0.0.1

             ns    total      read      write    <timestamp>
<db.collection>    81802ms     0ms    81802ms
...
```

### Command Line Options

```sh
mongotop [options] [frequency]
```

You can run `mongotop` with various [command-line options.](https://www.mongodb.com/docs/database-tools/mongotop.md#std-label-mongotop-options)

For example, to connect `mongotop` to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance running on a remote host `mongodb0.example.com` and report every 30 seconds:

- You can include the desired frequency of reporting (in this example, 30 seconds) and the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option to specify the host and port:

  ```sh
  mongotop 30 --uri='mongodb://mongodb0.example.com:27017' [additional options]
  ```

  If the [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance requires authentication, you can specify the user, password, and authentication database as part of the URI connection string:

  ```sh
  mongotop 30 --uri='mongodb://user:password@mongodb0.example.com:27017/?authSource=admin' [additional options]
  ```

  The user running `mongotop` must have the [`serverStatus`](https://www.mongodb.com/docs/manual/reference/privilege-actions.md#mongodb-authaction-serverStatus) and [`top`](https://www.mongodb.com/docs/manual/reference/privilege-actions.md#mongodb-authaction-top) privileges.

  For more information on the URI connection string, see [`--uri`.](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri)

- Alternatively, you can use the [`--host`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--host) and [`--port`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--port) options to specify the host and port:

  ```sh
  mongotop 30 --host=mongodb0.example.com --port=27017 [additional options]
  ```

  If the [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance requires authentication, you can specify the user [`-u`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username), and the authentication database [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase). Omit the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) option to have [`mongoexport`](https://www.mongodb.com/docs/database-tools/mongoexport.md#mongodb-binary-bin.mongoexport) prompt for the password.

  ```sh
  mongotop 30 --host=mongodb0.example.com --port=27017 -u=user --authenticationDatabase=admin [additional options]
  ```

  The user running `mongotop` must have the [`serverStatus`](https://www.mongodb.com/docs/manual/reference/privilege-actions.md#mongodb-authaction-serverStatus) and [`top`](https://www.mongodb.com/docs/manual/reference/privilege-actions.md#mongodb-authaction-top) privileges.

For more information on the options available, see [Options.](https://www.mongodb.com/docs/database-tools/mongotop.md#std-label-mongotop-options)

When connected to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance, the program reports first on the connection and then reports on the statistics at the configured frequency.

```sh
2019-04-29T15:35:27.785-0400 connected to: 127.0.0.1

             ns    total      read      write    <timestamp>
<db.collection>    81802ms     0ms    81802ms
...
```

## Options

Returns information on the options and use of `mongotop`.

Increases the amount of internal reporting returned on standard output or in log files. Increase the verbosity with the `-v` form by including the option multiple times, (e.g. `-vvvvv`.)

Runs `mongotop` in a quiet mode that attempts to limit the amount of output.

This option suppresses:

- output from [database commands](https://www.mongodb.com/docs/manual/reference/glossary.md#std-term-database-command)

- replication activity

- connection accepted events

- connection closed events

Returns the `mongotop` release number.

**New in version 100.3.0**

Specifies the full path to a YAML configuration file that contains sensitive values for the following `mongotop` options:

- [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password)

- [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri)

- [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword)

This is the recommended way to specify a password to `mongotop`, aside from specifying it through a password prompt. You can use any combination of the arguments in the file.

The configuration file takes the following form:

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

If you specify the `password` option without specifying `uri`, you can specify the other components of the connection string by using `mongotop` command line options, such as [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) and [`--host`.](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--host)

Be sure to secure this file with appropriate filesystem permissions.

**Important:**

When using the `--config` option, keep the following limitations and behaviors in mind:

- If you provide the `password` field and provide a connection string in the `uri` field with a conflicting password, `mongorestore` throws an error.

- If you specify a configuration file with `--config` and also use the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password), [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri), or [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword) `mongotop` command line options, the command line option overrides the corresponding configuration file option.

Specifies the resolvable [URI connection string](https://www.mongodb.com/docs/manual/reference/connection-string/) of the MongoDB deployment, enclosed in quotes:

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

Starting with version `100.0` of `mongotop`, the connection string may alternatively be provided as a positional parameter, without using the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option:

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

As a positional parameter, the connection string may be specified at any point on the command line, as long as it begins with either `mongodb://` or `mongodb+srv://`. For example:

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

Only one connection string can be provided. Attempting to include more than one, whether using the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option or as a positional argument, will result in an error.

For information on the components of the connection string, see the [Connection String URI Format](https://www.mongodb.com/docs/manual/reference/connection-string/) documentation.

**Note:**

Some components in the [`connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) may alternatively be specified using their own explicit command-line options, such as [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) and [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password). Providing a connection string while also using an explicit option and specifying conflicting information will result in an error.

**Note:**

If using `mongotop` on Ubuntu 18.04, you may experience a `cannot unmarshal DNS` error message when using [SRV connection strings](https://www.mongodb.com/docs/manual/reference/connection-string-formats.md#std-label-connections-dns-seedlist) (in the form `mongodb+srv://`) with the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option. If so, use one of the following options instead:

- the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option with a [non-SRV connection string](https://www.mongodb.com/docs/manual/reference/connection-string-formats.md#std-label-connections-standard-connection-string-format) (in the form `mongodb://`)

- the [`--host`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--host) option to specify the host to connect to directly

**Warning:**

On some systems, a password provided in a connection string with the [`--uri`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri) option may be visible to system status programs such as `ps` that may be invoked by other users. Consider instead:

- omitting the password in the connection string to receive an interactive password prompt, or

- using the [`--config`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--config) option to specify a configuration file containing the password.

*Default*: localhost:27017

Specifies the resolvable hostname of the MongoDB deployment. By default, `mongotop` attempts to connect to a MongoDB instance running on the localhost on port number `27017`.

To connect to a replica set, specify the [`replSetName`](https://www.mongodb.com/docs/manual/reference/configuration-options.md#mongodb-setting-replication.replSetName) and a seed list of set members, as in the following:

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

When specifying the replica set list format, `mongotop` always connects to the [primary.](https://www.mongodb.com/docs/manual/reference/glossary.md#std-term-primary)

You can also connect to any single member of the replica set by specifying the host and port of only that member:

```none
--host=<hostname1><:port>
```

If you use IPv6 and use the `<address>:<port>` format, you must enclose the portion of an address and port combination in brackets (e.g. `[<address>]`).

Alternatively, you can also specify the hostname directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--host`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--host) and specifying conflicting information will result in an error.

If connected to a replica set where the [primary](https://www.mongodb.com/docs/manual/reference/glossary.md#std-term-primary) is not reachable, `mongotop` returns an error message.

*Default*: 27017

Specifies the TCP port on which the MongoDB instance listens for client connections.

Alternatively, you can also specify the port directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--port`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--port) and specifying conflicting information will result in an error.

Enables connection to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) or [`mongos`](https://www.mongodb.com/docs/manual/reference/program/mongos.md#mongodb-binary-bin.mongos) that has TLS/SSL support enabled.

Alternatively, you can also configure TLS/SSL support directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--ssl`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--ssl) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Specifies the `.pem` file that contains the root certificate chain from the Certificate Authority. Specify the file name of the `.pem` file using relative or absolute paths.

Alternatively, you can also specify the `.pem` file directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--sslCAFile`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslCAFile) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Specifies the `.pem` file that contains both the TLS/SSL certificate and key. Specify the file name of the `.pem` file using relative or absolute paths.

This option is required when using the [`--ssl`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--ssl) option to connect to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) or [`mongos`](https://www.mongodb.com/docs/manual/reference/program/mongos.md#mongodb-binary-bin.mongos) that has [`CAFile`](https://www.mongodb.com/docs/manual/reference/configuration-options.md#mongodb-setting-net.tls.CAFile) enabled *without* [`allowConnectionsWithoutCertificates`.](https://www.mongodb.com/docs/manual/reference/configuration-options.md#mongodb-setting-net.tls.allowConnectionsWithoutCertificates)

Alternatively, you can also specify the `.pem` file directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--sslPEMKeyFile`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyFile) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Specifies the password to de-crypt the certificate-key file (i.e. [`--sslPEMKeyFile`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyFile)). Use the [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword) option only if the certificate-key file is encrypted. In all cases, the `mongotop` will redact the password from all logging and reporting output.

If the private key in the PEM file is encrypted and you do not specify the [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword) option, the `mongotop` will prompt for a passphrase. See [TLS/SSL Certificate Passphrase.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl.md#std-label-ssl-certificate-password)

Alternatively, you can also specify the password directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

**Warning:**

On some systems, a password provided directly using the [`--sslPEMKeyPassword`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslPEMKeyPassword) option may be visible to system status programs such as `ps` that may be invoked by other users. Consider using the [`--config`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--config) option to specify a configuration file containing the password instead.

Specifies the `.pem` file that contains the Certificate Revocation List. Specify the file name of the `.pem` file using relative or absolute paths.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the [`allowInvalidCertificates`](https://www.mongodb.com/docs/manual/reference/configuration-options.md#mongodb-setting-net.tls.allowInvalidCertificates) setting, MongoDB logs as a warning the use of the invalid certificate.

**Warning:**

Although available, avoid using the `--sslAllowInvalidCertificates` option if possible. If the use of `--sslAllowInvalidCertificates` is necessary, only use the option on systems where intrusion is not possible.

Connecting to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) or [`mongos`](https://www.mongodb.com/docs/manual/reference/program/mongos.md#mongodb-binary-bin.mongos) instance without validating server certificates is a potential security risk. If you only need to disable the validation of the hostname in the TLS/SSL certificates, see `--sslAllowInvalidHostnames`.

Alternatively, you can also disable certificate validation directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--sslAllowInvalidCertificates`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslAllowInvalidCertificates) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Disables the validation of the hostnames in TLS/SSL certificates. Allows `mongotop` to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname.

Alternatively, you can also disable hostname validation directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--sslAllowInvalidHostnames`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--sslAllowInvalidHostnames) and specifying conflicting information will result in an error.

For more information about TLS/SSL and MongoDB, see [Configure mongod and mongos for TLS/SSL](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) and [TLS/SSL Configuration for Clients.](https://www.mongodb.com/docs/manual/tutorial/configure-ssl-clients/)

Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) and [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase) options.

Alternatively, you can also specify the username directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) and specifying conflicting information will result in an error.

If connecting to a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster using the `MONGODB-AWS` [`authentication mechanism`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism), you can specify your AWS access key ID in:

- this field,

- the [`connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri), or

- the `AWS_ACCESS_KEY_ID` environment variable.

See [Connect to a MongoDB Atlas Cluster using AWS IAM Credentials](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-examples.md#std-label-mongotop-example-connect-using-aws-iam) for an example of each.

Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) and [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase) options.

To prompt the user for the password, pass the [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) option without [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) or specify an empty string as the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) value, as in `--password ""` .

Alternatively, you can also specify the password directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) and specifying conflicting information will result in an error.

If connecting to a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster using the `MONGODB-AWS` [`authentication mechanism`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism), you can specify your AWS secret access key in:

- this field,

- the [`connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri), or

- the `AWS_SECRET_ACCESS_KEY` environment variable.

See [Connect to a MongoDB Atlas Cluster using AWS IAM Credentials](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-examples.md#std-label-mongotop-example-connect-using-aws-iam) for an example of each.

**Warning:**

On some systems, a password provided directly using the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) option may be visible to system status programs such as `ps` that may be invoked by other users. Consider instead:

- omitting the [`--password`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--password) option to receive an interactive password prompt, or

- using the [`--config`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--config) option to specify a configuration file containing the password.

If connecting to a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster using the `MONGODB-AWS` [`authentication mechanism`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism), and using session tokens in addition to your AWS access key ID and secret access key, you can specify your AWS session token in:

- this field,

- the `AWS_SESSION_TOKEN` [`authMechanismProperties`](https://www.mongodb.com/docs/manual/reference/connection-string-options.md#mongodb-urioption-urioption.authMechanismProperties) parameter to the [`connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri), or

- the `AWS_SESSION_TOKEN` environment variable.

See [Connect to a MongoDB Atlas Cluster using AWS IAM Credentials](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-examples.md#std-label-mongotop-example-connect-using-aws-iam) for an example of each.

Only valid when using the `MONGODB-AWS` [`authentication mechanism`.](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism)

Specifies the authentication database where the specified [`--username`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--username) has been created. [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase) is required for [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) and [`mongos`](https://www.mongodb.com/docs/manual/reference/program/mongos.md#mongodb-binary-bin.mongos) instances that use [Authentication on Self-Managed Deployments](https://www.mongodb.com/docs/manual/core/authentication.md#std-label-authentication). See [Authentication Database.](https://www.mongodb.com/docs/manual/core/security-users.md#std-label-user-authentication-database)

If you use the [GSSAPI](https://www.mongodb.com/docs/manual/core/authentication.md#std-label-security-auth-kerberos) (Kerberos), [PLAIN](https://www.mongodb.com/docs/manual/core/authentication.md#std-label-security-auth-ldap) (LDAP SASL), or `MONGODB-AWS` [`authentication mechanisms`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism), you must set [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase) to `$external`.

Alternatively, you can also specify the authentication database directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--authenticationDatabase`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationDatabase) and specifying conflicting information will result in an error.

*Default*: SCRAM-SHA-1

Specifies the authentication mechanism the `mongotop` instance uses to authenticate to the [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) or [`mongos`.](https://www.mongodb.com/docs/manual/reference/program/mongos.md#mongodb-binary-bin.mongos)

**Changed in version 100.1.0**

Starting in version `100.1.0`, `mongotop` adds support for the `MONGODB-AWS` authentication mechanism when connecting to a [MongoDB Atlas](https://www.mongodb.com/docs/atlas/) cluster.

| Value | Description |
| --- | --- |
| [SCRAM-SHA-1](https://www.mongodb.com/docs/manual/core/security-scram.md#std-label-authentication-scram-sha-1) | [RFC 5802](https://tools.ietf.org/html/rfc5802) standard Salted Challenge Response Authentication Mechanism using the SHA-1 hash function. |
| [SCRAM-SHA-256](https://www.mongodb.com/docs/manual/core/security-scram.md#std-label-authentication-scram-sha-256) | [RFC 7677](https://tools.ietf.org/html/rfc7677) standard Salted Challenge Response Authentication Mechanism using the SHA-256 hash function. Requires featureCompatibilityVersion set to `4.0`. |
| [MONGODB-X.509](https://www.mongodb.com/docs/manual/core/security-x.509.md#std-label-security-auth-x509) | MongoDB TLS/SSL certificate authentication. |
| `MONGODB-AWS` | External authentication using AWS IAM credentials for use in connecting to a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster. See [Connect to a MongoDB Atlas Cluster using AWS IAM Credentials](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-examples.md#std-label-mongotop-example-connect-using-aws-iam). **New in version 100.1.0** |
| [GSSAPI](https://www.mongodb.com/docs/manual/core/authentication.md#std-label-security-auth-kerberos) (Kerberos) | External authentication using Kerberos. This mechanism is available only in [MongoDB Enterprise.](http://www.mongodb.com/products/mongodb-enterprise-advanced) |
| [PLAIN](https://www.mongodb.com/docs/manual/core/authentication.md#std-label-security-auth-ldap) (LDAP SASL) | External authentication using LDAP. You can also use `PLAIN` for authenticating in-database users. `PLAIN` transmits passwords in plain text. This mechanism is available only in [MongoDB Enterprise.](http://www.mongodb.com/products/mongodb-enterprise-advanced) |

Alternatively, you can also specify the authentication mechanism directly in the [`URI connection string`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--uri). Providing a connection string while also using [`--authenticationMechanism`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--authenticationMechanism) and specifying conflicting information will result in an error.

Specify the name of the service using [GSSAPI/Kerberos](https://www.mongodb.com/docs/manual/core/kerberos/). Only required if the service does not use the default name of `mongodb`.

This option is available only in MongoDB Enterprise.

Specify the hostname of a service using [GSSAPI/Kerberos](https://www.mongodb.com/docs/manual/core/kerberos/). *Only* required if the hostname of a machine does not match the hostname resolved by DNS.

This option is available only in MongoDB Enterprise.

Toggles the mode of `mongotop` to report on use of per-database [locks](https://www.mongodb.com/docs/manual/reference/command/serverStatus.md#std-label-locks). This data is only available when connected to a MongoDB 2.6 or older instance.

[`--locks`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--locks) returns an error when called against a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) 3.0 or newer instance that does not report per-database lock usage.

Number of lines of data that `mongotop` should print. "0 for indefinite"

Returns output for `mongotop` in [JSON](https://www.mongodb.com/docs/manual/reference/glossary.md#std-term-JSON) format. In addition to timing data, the `--json` option also returns a count of the number of operations which took place during the polling interval.

The final argument is the length of time, in seconds, that `mongotop` waits in between calls. By default `mongotop` returns data every second.

## Fields

When connected to a [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) instance, the program reports first on the connection and then reports on the statistics at the configured frequency. `mongotop` returns time values specified in milliseconds (ms.)

```sh
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` only reports active namespaces or databases, depending on the [`--locks`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--locks) option. If you don't see a database or collection, it has received no recent activity. You can issue a simple operation in the [`mongo`](https://www.mongodb.com/docs/manual/reference/mongo.md#mongodb-binary-bin.mongo) shell to generate activity to affect the output of `mongotop`.

Contains the database namespace, which combines the database name and collection.

If you use the [`mongotop --locks`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--locks), the [`ns`](https://www.mongodb.com/docs/database-tools/mongotop.md#mongodb-data-mongotop.ns) field does not appear in the `mongotop` output.

Contains the name of the database. The database named `.` refers to the global lock, rather than a specific database.

This field does not appear unless you have invoked `mongotop` with the [`--locks`](https://www.mongodb.com/docs/database-tools/mongotop.md#std-option-mongotop.--locks) option.

Provides the total amount of time that this [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) spent operating on this namespace.

Provides the amount of time that this [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) spent performing read operations on this namespace.

Provides the amount of time that this [`mongod`](https://www.mongodb.com/docs/manual/reference/program/mongod.md#mongodb-binary-bin.mongod) spent performing write operations on this namespace.

Provides a time stamp for the returned data.

## Additional Information

For more information about monitoring MongoDB, see [Monitoring for MongoDB.](https://www.mongodb.com/docs/manual/administration/monitoring/)

For additional background on various other MongoDB status outputs see:

- [serverStatus](https://www.mongodb.com/docs/manual/reference/command/serverStatus/)

- [replSetGetStatus](https://www.mongodb.com/docs/manual/reference/command/replSetGetStatus/)

- [dbStats](https://www.mongodb.com/docs/manual/reference/command/dbStats/)

- [collStats](https://www.mongodb.com/docs/manual/reference/command/collStats/)

For an additional utility that provides MongoDB metrics see [mongostat.](https://www.mongodb.com/docs/database-tools/mongostat.md)

## Learn More

- [mongotop Compatibility and Installation](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-compatibility-and-installation.md#std-label-mongotop-compatibility-and-installation)

- [mongotop Behavior](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-behavior.md#std-label-mongotop-behavior-access-usage)

- [mongotop Examples](https://www.mongodb.com/docs/database-tools/mongotop/mongotop-examples.md#std-label-mongotop-examples)
