700 lines
18 KiB
Groff
700 lines
18 KiB
Groff
.\" Man page generated from reStructuredText.
|
||
.
|
||
.TH "MONGOTOP" "1" "Jun 21, 2018" "4.0" "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\%Synopsis\fP
|
||
.IP \(bu 2
|
||
\fI\%Required Access\fP
|
||
.IP \(bu 2
|
||
\fI\%Options\fP
|
||
.IP \(bu 2
|
||
\fI\%Fields\fP
|
||
.IP \(bu 2
|
||
\fI\%Use\fP
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
.IP "Mac OSX Sierra and Go 1.6 Incompatibility"
|
||
.sp
|
||
Users running on Mac OSX Sierra require the 3.2.10 or newer version
|
||
of mongotop\&.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH SYNOPSIS
|
||
.sp
|
||
\fI\%mongotop\fP provides a method to track the amount of time a
|
||
MongoDB instance 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.
|
||
.sp
|
||
\fBSEE ALSO:\fP
|
||
.INDENT 0.0
|
||
.INDENT 3.5
|
||
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\&.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH REQUIRED ACCESS
|
||
.sp
|
||
In order to connect to a \fBmongod\fP that enforces authorization
|
||
with the \fB\-\-auth\fP option, you must use the
|
||
\fI\%\-\-username\fP and \fI\%\-\-password\fP options, and the connecting user must
|
||
have the \fBserverStatus\fP and \fBtop\fP privileges.
|
||
.sp
|
||
The most appropriate built\-in role that has these privileges is
|
||
\fBclusterMonitor\fP\&.
|
||
.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 for the \fBmongod\fP to which to
|
||
connect.
|
||
.sp
|
||
The following is the standard
|
||
URI connection scheme:
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
.sp
|
||
.nf
|
||
.ft C
|
||
mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
For detailed explanations of the components of this string, refer to
|
||
the
|
||
Connection String URI Format
|
||
documentation.
|
||
.sp
|
||
\fBIMPORTANT:\fP
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
The following \fI\%mongotop\fP options are incompatible with the
|
||
\fB\-\-uri\fP option. Instead, specify these options as part of your
|
||
\fB\-\-uri\fP connection string when applicable:
|
||
.INDENT 0.0
|
||
.IP \(bu 2
|
||
\fB\-\-host\fP
|
||
.IP \(bu 2
|
||
\fB\-\-port\fP
|
||
.IP \(bu 2
|
||
\fB\-\-db\fP
|
||
.IP \(bu 2
|
||
\fB\-\-username\fP
|
||
.IP \(bu 2
|
||
\fB\-\-password\fP (when specifying the password as part of the
|
||
URI connection string)
|
||
.IP \(bu 2
|
||
\fB\-\-authenticationDatabase\fP
|
||
.IP \(bu 2
|
||
\fB\-\-authenticationMechanism\fP
|
||
.UNINDENT
|
||
.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
|
||
<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
You can always connect directly to a single MongoDB instance by
|
||
specifying the host and port number directly.
|
||
.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
|
||
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.
|
||
.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\-\-sslCAFile\fP or \fBssl.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
|
||
If using x.509 authentication, \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP
|
||
must be specified.
|
||
.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 \fBssl.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
|
||
\fBWARNING:\fP
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
For TLS/SSL connections to \fBmongod\fP and
|
||
\fBmongos\fP, avoid using
|
||
\fB\-\-sslAllowInvalidCertificates\fP if possible and only use
|
||
\fB\-\-sslAllowInvalidCertificates\fP 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.
|
||
.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 \-\-sslFIPSMode
|
||
New in version 2.6.
|
||
|
||
.sp
|
||
Directs the \fBmongotop\fP to use the FIPS mode of the installed OpenSSL
|
||
library. Your system must have a FIPS compliant OpenSSL library to use
|
||
the \fI\%\-\-sslFIPSMode\fP option.
|
||
.sp
|
||
\fBNOTE:\fP
|
||
.INDENT 7.0
|
||
.INDENT 3.5
|
||
FIPS\-compatible TLS/SSL is
|
||
available only in \fI\%MongoDB Enterprise\fP\&. See
|
||
/tutorial/configure\-fips for more information.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.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 \fB\-\-password\fP and
|
||
\fB\-\-authenticationDatabase\fP options.
|
||
.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 \fB\-\-username\fP and
|
||
\fB\-\-authenticationDatabase\fP options.
|
||
.sp
|
||
Changed in version 3.0.0: If you do not specify an argument for \fI\%\-\-password\fP, \fBmongotop\fP returns
|
||
an error.
|
||
|
||
.sp
|
||
Changed in version 3.0.2: If you wish \fBmongotop\fP 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 .
|
||
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-\-authenticationDatabase <dbname>
|
||
Specifies the database in which the user is created.
|
||
See user\-authentication\-database\&.
|
||
.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
|
||
.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
|
||
\fI\%mongotop\fP returns time values specified in milliseconds
|
||
(ms.)
|
||
.sp
|
||
\fI\%mongotop\fP only reports active namespaces or databases,
|
||
depending on the \fI\%\-\-locks\fP option. If you don’t 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 USE
|
||
.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
|
||
ns total read write 2014\-12\-19T15:32:01\-05:00
|
||
admin.system.roles 0ms 0ms 0ms
|
||
admin.system.version 0ms 0ms 0ms
|
||
local.me 0ms 0ms 0ms
|
||
local.oplog.rs 0ms 0ms 0ms
|
||
local.replset.minvalid 0ms 0ms 0ms
|
||
local.startup_log 0ms 0ms 0ms
|
||
local.system.indexes 0ms 0ms 0ms
|
||
local.system.namespaces 0ms 0ms 0ms
|
||
local.system.replset 0ms 0ms 0ms
|
||
|
||
ns total read write 2014\-12\-19T15:32:16\-05:00
|
||
admin.system.roles 0ms 0ms 0ms
|
||
admin.system.version 0ms 0ms 0ms
|
||
local.me 0ms 0ms 0ms
|
||
local.oplog.rs 0ms 0ms 0ms
|
||
local.replset.minvalid 0ms 0ms 0ms
|
||
local.startup_log 0ms 0ms 0ms
|
||
local.system.indexes 0ms 0ms 0ms
|
||
local.system.namespaces 0ms 0ms 0ms
|
||
local.system.replset 0ms 0ms 0ms
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.sp
|
||
The output varies depending on your MongoDB setup. For example,
|
||
\fBlocal.system.indexes\fP and \fBlocal.system.namespaces\fP only appear
|
||
for \fBmongod\fP instances using the MMAPv1
|
||
storage engine.
|
||
.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 AUTHOR
|
||
MongoDB Documentation Project
|
||
.SH COPYRIGHT
|
||
2008-2018
|
||
.\" Generated by docutils manpage writer.
|
||
.
|