mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-30 09:06:21 +01:00
922 lines
22 KiB
Groff
922 lines
22 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "MONGOTOP" "1" "Aug 16, 2019" "4.2" "mongodb-manual"
|
|
.SH NAME
|
|
mongotop \- MongoDB Activity Monitor
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SS On this page
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fI\%Description\fP
|
|
.IP \(bu 2
|
|
\fI\%Syntax\fP
|
|
.IP \(bu 2
|
|
\fI\%Required Access\fP
|
|
.IP \(bu 2
|
|
\fI\%Behavior\fP
|
|
.IP \(bu 2
|
|
\fI\%Options\fP
|
|
.IP \(bu 2
|
|
\fI\%Fields\fP
|
|
.IP \(bu 2
|
|
\fI\%Examples\fP
|
|
.IP \(bu 2
|
|
\fI\%Additional Information\fP
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.IP "macOS Sierra and Go 1.6 Incompatibility"
|
|
.sp
|
|
Users running on macOS Sierra require the 3.2.10 or newer version
|
|
of mongotop\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fI\%mongotop\fP provides a method to track the amount of time a
|
|
MongoDB instance \fBmongod\fP spends reading and writing data.
|
|
\fI\%mongotop\fP provides statistics on a per\-collection level.
|
|
By default, \fI\%mongotop\fP returns values every second.
|
|
.sp
|
|
Run \fI\%mongotop\fP from the system command line, not the \fBmongo\fP shell.
|
|
.SH SYNTAX
|
|
.SS Default
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop [frequency]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
You can run \fI\%mongotop\fP without any command\-line options to
|
|
connect to the \fBmongod\fP instance running on the localhost
|
|
port \fB27017\fP\&. By default, \fI\%mongotop\fP returns values
|
|
every second.
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To have \fI\%mongotop\fP report every 30 seconds, specify the
|
|
time:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 30
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
When connected to a \fBmongod\fP instance, the program reports
|
|
first on the connection and then reports on the statistics at the
|
|
configured frequency.
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
2019\-04\-29T15:35:27.785\-0400 connected to: 127.0.0.1
|
|
|
|
ns total read write <timestamp>
|
|
<db.collection> 81802ms 0ms 81802ms
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SS Command Line Options
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop [options] [frequency]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
You can run \fI\%mongotop\fP with various \fI\%command\-line
|
|
options\fP\&.
|
|
.sp
|
|
For example, to connect \fI\%mongotop\fP to a
|
|
\fBmongod\fP instance running on a remote host
|
|
\fBmongodb0.example.com\fP and report every 30 seconds:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
You can include the desired frequency of reporting (in this
|
|
example, 30 seconds) and the \fI\%\-\-uri\fP
|
|
option to specify the host and port:
|
|
.INDENT 2.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 30 \-\-uri mongodb://mongodb0.example.com:27017 [additional options]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
If the \fBmongod\fP instance requires authentication, you
|
|
can specify the user, password, and authentication database as part
|
|
of the URI connection string:
|
|
.INDENT 2.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 30 \-\-uri mongodb://user:password@mongodb0.example.com:27017/?authSource=admin [additional options]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
The user running \fI\%mongotop\fP must have the
|
|
\fBserverStatus\fP and \fBtop\fP privileges.
|
|
.sp
|
|
For more information on the URI connection string, see
|
|
\fI\%\-\-uri\fP\&.
|
|
.IP \(bu 2
|
|
Alternatively, you can use the \fI\%\-\-host\fP
|
|
and \fI\%\-\-port\fP options to specify the host
|
|
and port:
|
|
.INDENT 2.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 30 \-\-host mongodb0.example.com \-\-port 27017 [additional options]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
If the \fBmongod\fP instance requires authentication, you
|
|
can specify the user \fI\%\-u\fP, password
|
|
\fI\%\-p\fP, and the authentication database
|
|
\fI\%\-\-authenticationDatabase\fP\&.
|
|
.INDENT 2.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 30 \-\-host mongodb0.example.com \-\-port 27017 \-u user \-p password \-\-authenticationDatabase admin [additional options]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
The user running \fI\%mongotop\fP must have the
|
|
\fBserverStatus\fP and \fBtop\fP privileges.
|
|
.UNINDENT
|
|
.sp
|
|
For more information on the options available, see
|
|
\fI\%Options\fP\&.
|
|
.sp
|
|
When connected to a \fBmongod\fP instance, the program reports
|
|
first on the connection and then reports on the statistics at the
|
|
configured frequency.
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
2019\-04\-29T15:35:27.785\-0400 connected to: 127.0.0.1
|
|
|
|
ns total read write <timestamp>
|
|
<db.collection> 81802ms 0ms 81802ms
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH REQUIRED ACCESS
|
|
.sp
|
|
In order to connect to a \fBmongod\fP that enforces
|
|
authorization, the connecting user must have the
|
|
\fBserverStatus\fP and \fBtop\fP privileges.
|
|
.sp
|
|
The built\-in role \fBclusterMonitor\fP provides these privileges.
|
|
.SH BEHAVIOR
|
|
.SS FIPS
|
|
.sp
|
|
Starting in version 4.2, MongoDB removes the \fB\-\-sslFIPSMode\fP
|
|
option for mongotop\&. mongotop
|
|
will use FIPS compliant connections to
|
|
\fBmongod\fP/\fBmongos\fP if the
|
|
\fBmongod\fP/\fBmongos\fP instances are
|
|
configured to use FIPS mode\&.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-help
|
|
Returns information on the options and use of \fBmongotop\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-verbose, \-v
|
|
Increases the amount of internal reporting returned on standard output
|
|
or in log files. Increase the verbosity with the \fB\-v\fP form by
|
|
including the option multiple times, (e.g. \fB\-vvvvv\fP\&.)
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-quiet
|
|
Runs \fBmongotop\fP in a quiet mode that attempts to limit the amount
|
|
of output.
|
|
.sp
|
|
This option suppresses:
|
|
.INDENT 7.0
|
|
.IP \(bu 2
|
|
output from database commands
|
|
.IP \(bu 2
|
|
replication activity
|
|
.IP \(bu 2
|
|
connection accepted events
|
|
.IP \(bu 2
|
|
connection closed events
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-version
|
|
Returns the \fBmongotop\fP release number.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-uri <connectionString>
|
|
New in version 3.4.6.
|
|
|
|
.sp
|
|
Specify a resolvable URI
|
|
connection string (enclose in quotes) to connect to the MongoDB deployment.
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
\-\-uri "mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
For information on the components of the connection string, see
|
|
the Connection String URI Format documentation.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
For TLS/SSL options, use the command\-line options instead of the
|
|
URI options for TLS/SSL (Available starting in
|
|
4.2)\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBIMPORTANT:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
The following command\-line options cannot be used in conjunction
|
|
with \fI\%\-\-uri\fP option:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fI\%\-\-host\fP
|
|
.IP \(bu 2
|
|
\fI\%\-\-port\fP
|
|
.IP \(bu 2
|
|
\fI\%\-\-username\fP
|
|
.IP \(bu 2
|
|
\fI\%\-\-password\fP (if the
|
|
URI connection string also includes the password)
|
|
.IP \(bu 2
|
|
\fI\%\-\-authenticationDatabase\fP
|
|
.IP \(bu 2
|
|
\fI\%\-\-authenticationMechanism\fP
|
|
.UNINDENT
|
|
.sp
|
|
Instead, specify these options as part of your \fI\%\-\-uri\fP
|
|
connection string.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-host <hostname><:port>, \-h <hostname><:port>
|
|
\fIDefault\fP: localhost:27017
|
|
.sp
|
|
Specifies a resolvable hostname for the \fBmongod\fP to which to
|
|
connect. By default, the \fBmongotop\fP attempts to connect to a MongoDB
|
|
instance running on the localhost on port number \fB27017\fP\&.
|
|
.sp
|
|
To connect to a replica set, specify the
|
|
\fBreplSetName\fP and a seed list of set members, as in
|
|
the following:
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
\-\-host <replSetName>/<hostname1><:port>,<hostname2><:port>,<...>
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
When specifying the replica set list format, \fBmongotop\fP always connects to
|
|
the primary\&.
|
|
.sp
|
|
You can also connect to any single member of the replica set by specifying
|
|
the host and port of only that member:
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
\-\-host <hostname1><:port>
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must
|
|
enclose the portion of an address and port combination in
|
|
brackets (e.g. \fB[<address>]\fP).
|
|
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-host\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
If connected to a replica set where the primary is not
|
|
reachable, \fBmongotop\fP returns an error message.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-port <port>
|
|
\fIDefault\fP: 27017
|
|
.sp
|
|
Specifies the TCP port on which the MongoDB instance listens for
|
|
client connections.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-port\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-ipv6
|
|
\fIRemoved in version 3.0.\fP
|
|
.sp
|
|
Enables IPv6 support and allows \fBmongotop\fP to connect to the
|
|
MongoDB instance using an IPv6 network. Prior to MongoDB 3.0, you
|
|
had to specify \fI\%\-\-ipv6\fP to use IPv6. In MongoDB 3.0 and later, IPv6
|
|
is always enabled.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-ssl
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Enables connection to a \fBmongod\fP or \fBmongos\fP that has
|
|
TLS/SSL support enabled.
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslCAFile <filename>
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specifies the \fB\&.pem\fP file that contains the root certificate chain
|
|
from the Certificate Authority. Specify the file name of the
|
|
\fB\&.pem\fP file using relative or absolute paths.
|
|
.sp
|
|
Starting in version 3.4, if \fB\-\-tlsCAFile\fP/\fBnet.tls.CAFile\fP (or
|
|
their aliases \fB\-\-sslCAFile\fP/\fBnet.ssl.CAFile\fP) is not specified
|
|
and you are not using x.509 authentication, the system\-wide CA
|
|
certificate store will be used when connecting to an TLS/SSL\-enabled
|
|
server.
|
|
.sp
|
|
To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP
|
|
must be specified unless using \fB\-\-tlsCertificateSelector\fP or
|
|
\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases,
|
|
\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using
|
|
\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&.
|
|
.sp
|
|
\fBWARNING:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
\fBVersion 3.2 and earlier:\fP For TLS/SSL connections (\fB\-\-ssl\fP) to
|
|
\fBmongod\fP and \fBmongos\fP, if the \fBmongotop\fP runs without the
|
|
\fI\%\-\-sslCAFile\fP, \fBmongotop\fP will not attempt
|
|
to validate the server certificates. This creates a vulnerability
|
|
to expired \fBmongod\fP and \fBmongos\fP certificates as
|
|
well as to foreign processes posing as valid \fBmongod\fP or
|
|
\fBmongos\fP instances. Ensure that you \fIalways\fP specify the
|
|
CA file to validate the server certificates in cases where
|
|
intrusion is a possibility.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslPEMKeyFile <filename>
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specifies the \fB\&.pem\fP file that contains both the TLS/SSL certificate
|
|
and key. Specify the file name of the \fB\&.pem\fP file using relative
|
|
or absolute paths.
|
|
.sp
|
|
This option is required when using the \fI\%\-\-ssl\fP option to connect
|
|
to a \fBmongod\fP or \fBmongos\fP that has
|
|
\fBCAFile\fP enabled \fIwithout\fP
|
|
\fBallowConnectionsWithoutCertificates\fP\&.
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslPEMKeyPassword <value>
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specifies the password to de\-crypt the certificate\-key file (i.e.
|
|
\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the
|
|
certificate\-key file is encrypted. In all cases, the \fBmongotop\fP will
|
|
redact the password from all logging and reporting output.
|
|
.sp
|
|
If the private key in the PEM file is encrypted and you do not specify
|
|
the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongotop\fP will prompt for a passphrase. See
|
|
ssl\-certificate\-password\&.
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslCRLFile <filename>
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specifies the \fB\&.pem\fP file that contains the Certificate Revocation
|
|
List. Specify the file name of the \fB\&.pem\fP file using relative or
|
|
absolute paths.
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslAllowInvalidCertificates
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Bypasses the validation checks for server certificates and allows
|
|
the use of invalid certificates. When using the
|
|
\fBallowInvalidCertificates\fP setting, MongoDB logs as a
|
|
warning the use of the invalid certificate.
|
|
.sp
|
|
Starting in MongoDB 4.0, if you specify
|
|
\fB\-\-sslAllowInvalidCertificates\fP or
|
|
\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the
|
|
alias \fB\-\-tlsAllowInvalidateCertificates\fP or
|
|
\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509
|
|
authentication, an invalid certificate is only sufficient to
|
|
establish a TLS/SSL connection but is \fIinsufficient\fP for
|
|
authentication.
|
|
.sp
|
|
# We created a separate blurb for tls in the ssl\-clients page.
|
|
.sp
|
|
\fBWARNING:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
Although available, avoid using the
|
|
\fB\-\-sslAllowInvalidCertificates\fP option if possible. If the use of
|
|
\fB\-\-sslAllowInvalidCertificates\fP is necessary, only use the option
|
|
on systems where intrusion is not possible.
|
|
.sp
|
|
If the \fBmongo\fP shell (and other
|
|
mongodb\-tools\-support\-ssl) runs with the
|
|
\fB\-\-sslAllowInvalidCertificates\fP option, the
|
|
\fBmongo\fP shell (and other
|
|
mongodb\-tools\-support\-ssl) will not attempt to validate
|
|
the server certificates. This creates a vulnerability to expired
|
|
\fBmongod\fP and \fBmongos\fP certificates as
|
|
well as to foreign processes posing as valid
|
|
\fBmongod\fP or \fBmongos\fP instances. If you
|
|
only need to disable the validation of the hostname in the
|
|
TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-sslAllowInvalidHostnames
|
|
New in version 3.0.
|
|
|
|
.sp
|
|
Disables the validation of the hostnames in TLS/SSL certificates. Allows
|
|
\fBmongotop\fP to connect to MongoDB instances even if the hostname in their
|
|
certificates do not match the specified hostname.
|
|
.sp
|
|
For more information about TLS/SSL and MongoDB, see
|
|
/tutorial/configure\-ssl and
|
|
/tutorial/configure\-ssl\-clients .
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-username <username>, \-u <username>
|
|
Specifies a username with which to authenticate to a MongoDB database
|
|
that uses authentication. Use in conjunction with the \fI\%\-\-password\fP and
|
|
\fI\%\-\-authenticationDatabase\fP options.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-username\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-password <password>, \-p <password>
|
|
Specifies a password with which to authenticate to a MongoDB database
|
|
that uses authentication. Use in conjunction with the \fI\%\-\-username\fP and
|
|
\fI\%\-\-authenticationDatabase\fP options.
|
|
.sp
|
|
Changed in version 3.0.2: To prompt the user
|
|
for the password, pass the \fI\%\-\-username\fP option without
|
|
\fI\%\-\-password\fP or specify an empty string as the \fI\%\-\-password\fP value,
|
|
as in \fB\-\-password ""\fP .
|
|
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-password\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-authenticationDatabase <dbname>
|
|
Specifies the authentication database where the specified \fI\%\-\-username\fP has been created.
|
|
See user\-authentication\-database\&.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-authenticationDatabase\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Changed in version 3.0.0: \fI\%\-\-authenticationDatabase\fP is required for \fBmongod\fP
|
|
and \fBmongos\fP instances that use authentication\&.
|
|
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-authenticationMechanism <name>
|
|
\fIDefault\fP: SCRAM\-SHA\-1
|
|
.sp
|
|
Specifies the authentication mechanism the \fBmongotop\fP instance uses to
|
|
authenticate to the \fBmongod\fP or \fBmongos\fP\&.
|
|
.sp
|
|
Changed in version 4.0: MongoDB removes support for the deprecated MongoDB
|
|
Challenge\-Response (\fBMONGODB\-CR\fP) authentication mechanism.
|
|
.sp
|
|
MongoDB adds support for SCRAM mechanism using the SHA\-256 hash
|
|
function (\fBSCRAM\-SHA\-256\fP).
|
|
|
|
.TS
|
|
center;
|
|
|l|l|.
|
|
_
|
|
T{
|
|
Value
|
|
T} T{
|
|
Description
|
|
T}
|
|
_
|
|
T{
|
|
SCRAM\-SHA\-1
|
|
T} T{
|
|
\fI\%RFC 5802\fP standard
|
|
Salted Challenge Response Authentication Mechanism using the SHA\-1
|
|
hash function.
|
|
T}
|
|
_
|
|
T{
|
|
SCRAM\-SHA\-256
|
|
T} T{
|
|
\fI\%RFC 7677\fP standard
|
|
Salted Challenge Response Authentication Mechanism using the SHA\-256
|
|
hash function.
|
|
.sp
|
|
Requires featureCompatibilityVersion set to \fB4.0\fP\&.
|
|
.sp
|
|
New in version 4.0.
|
|
T}
|
|
_
|
|
T{
|
|
MONGODB\-X509
|
|
T} T{
|
|
MongoDB TLS/SSL certificate authentication.
|
|
T}
|
|
_
|
|
T{
|
|
GSSAPI (Kerberos)
|
|
T} T{
|
|
External authentication using Kerberos. This mechanism is
|
|
available only in \fI\%MongoDB Enterprise\fP\&.
|
|
T}
|
|
_
|
|
T{
|
|
PLAIN (LDAP SASL)
|
|
T} T{
|
|
External authentication using LDAP. You can also use \fBPLAIN\fP
|
|
for authenticating in\-database users. \fBPLAIN\fP transmits
|
|
passwords in plain text. This mechanism is available only in
|
|
\fI\%MongoDB Enterprise\fP\&.
|
|
T}
|
|
_
|
|
.TE
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
You cannot specify both \fI\%\-\-authenticationMechanism\fP and \fI\%\-\-uri\fP\&.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-gssapiServiceName
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specify the name of the service using GSSAPI/Kerberos\&. Only required if the service does not use the
|
|
default name of \fBmongodb\fP\&.
|
|
.sp
|
|
This option is available only in MongoDB Enterprise.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-gssapiHostName
|
|
New in version 2.6.
|
|
|
|
.sp
|
|
Specify the hostname of a service using GSSAPI/Kerberos\&. \fIOnly\fP required if the hostname of a machine does
|
|
not match the hostname resolved by DNS.
|
|
.sp
|
|
This option is available only in MongoDB Enterprise.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-locks
|
|
Toggles the mode of \fI\%mongotop\fP to report on use of per\-database
|
|
locks\&. This data is only available when connected to a
|
|
MongoDB 2.6 or older instance.
|
|
.sp
|
|
\fI\%\-\-locks\fP returns an error when called against a \fBmongod\fP 3.0 or
|
|
newer instance that does not report per\-database lock usage.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-rowcount int, \-n int
|
|
Number of lines of data that \fBmongotop\fP should print. "0 for indefinite"
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-json
|
|
New in version 3.0.0.
|
|
|
|
.sp
|
|
Returns output for \fBmongotop\fP in JSON format.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B <sleeptime>
|
|
The final argument is the length of time, in seconds, that
|
|
\fBmongotop\fP waits in between calls. By default \fBmongotop\fP returns
|
|
data every second.
|
|
.UNINDENT
|
|
.SH FIELDS
|
|
.sp
|
|
When connected to a \fBmongod\fP instance, the program reports
|
|
first on the connection and then reports on the statistics at the
|
|
configured frequency. \fI\%mongotop\fP returns time values
|
|
specified in milliseconds (ms.)
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
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
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fI\%mongotop\fP only reports active namespaces or databases,
|
|
depending on the \fI\%\-\-locks\fP option. If you don\(aqt see a database
|
|
or collection, it has received no recent activity. You can issue a
|
|
simple operation in the \fBmongo\fP shell to generate activity to
|
|
affect the output of \fI\%mongotop\fP\&.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.ns
|
|
Contains the database namespace, which combines the database name
|
|
and collection.
|
|
.sp
|
|
If you use the \fI\%mongotop \-\-locks\fP, the \fI\%ns\fP
|
|
field does not appear in the \fI\%mongotop\fP output.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.db
|
|
Contains the name of the database. The database named \fB\&.\fP refers
|
|
to the global lock, rather than a specific database.
|
|
.sp
|
|
This field does not appear unless you have invoked
|
|
\fI\%mongotop\fP with the \fI\%\-\-locks\fP option.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.total
|
|
Provides the total amount of time that this \fBmongod\fP spent
|
|
operating on this namespace.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.read
|
|
Provides the amount of time that this \fBmongod\fP spent
|
|
performing read operations on this namespace.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.write
|
|
Provides the amount of time that this \fBmongod\fP spent
|
|
performing write operations on this namespace.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongotop.<timestamp>
|
|
Provides a time stamp for the returned data.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.sp
|
|
By default \fI\%mongotop\fP connects to the MongoDB instance
|
|
running on the localhost port \fB27017\fP\&. However, \fI\%mongotop\fP can optionally
|
|
connect to remote \fBmongod\fP
|
|
instances. See the \fI\%mongotop options\fP for more
|
|
information.
|
|
.sp
|
|
To force \fI\%mongotop\fP to return less frequently specify a number, in
|
|
seconds at the end of the command. In this example, \fI\%mongotop\fP will
|
|
return every 15 seconds.
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 15
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
This command produces the following output:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
2019\-04\-29T15:35:27.785\-0400 connected to: 127.0.0.1
|
|
|
|
|
|
ns total read write 2019\-04\-29T15:35:57\-04:00
|
|
admin.system.roles 0ms 0ms 0ms
|
|
admin.system.users 0ms 0ms 0ms
|
|
admin.system.version 0ms 0ms 0ms
|
|
config.system.sessions 0ms 0ms 0ms
|
|
local.startup_log 0ms 0ms 0ms
|
|
local.system.replset 0ms 0ms 0ms
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To return a \fI\%mongotop\fP report every 5 minutes, use the
|
|
following command:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongotop 300
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH ADDITIONAL INFORMATION
|
|
.sp
|
|
For more information about monitoring MongoDB, see
|
|
/administration/monitoring\&.
|
|
.sp
|
|
For additional background on various other MongoDB status outputs see:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
/reference/command/serverStatus
|
|
.IP \(bu 2
|
|
/reference/command/replSetGetStatus
|
|
.IP \(bu 2
|
|
/reference/command/dbStats
|
|
.IP \(bu 2
|
|
/reference/command/collStats
|
|
.UNINDENT
|
|
.sp
|
|
For an additional utility that provides MongoDB metrics
|
|
see mongostat\&.
|
|
.SH AUTHOR
|
|
MongoDB Documentation Project
|
|
.SH COPYRIGHT
|
|
2008-2019
|
|
.\" Generated by docutils manpage writer.
|
|
.
|