Skip to content

Commit 08e67a1

Browse files
author
Sam Kleinman
committed
DOCS-277 additional clarification to getLog command reference
1 parent b1a730c commit 08e67a1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

source/reference/commands.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1811,17 +1811,17 @@ Diagnostics
18111811

18121812
Replace ``<log>`` with one of the following values:
18131813

1814-
- ``global`` - to generate the most recent log events from the
1815-
database. This is equivalent to running the ``tail`` command on
1816-
the :program:`mongod` log in the system shell.
1814+
- ``global`` - returns the combined output of all recent log
1815+
entries.
18171816

1818-
- ``rs`` - if the :program:`mongod` is part of a :term:`replica set`,
1819-
:dbcommand:`getLog` will generate the most recent log events
1820-
that relate to replication processes.
1817+
- ``rs`` - if the :program:`mongod` is part of a :term:`replica
1818+
set`, :dbcommand:`getLog` will return recent notices related to
1819+
replica set activity.
18211820

1822-
- ``startupWarnings`` - to generate logs that *may* contain
1821+
- ``startupWarnings`` - will return logs that *may* contain
18231822
errors or warnings from MongoDB's log from when the current
1824-
process started.
1823+
process started. If :program:`mongod` started without warnings,
1824+
this filter may return an empty array.
18251825

18261826
You may also specify an asterisk (e.g. ``*``) as the ``<log>``
18271827
value to return a list of available log filters. The following
@@ -1834,8 +1834,8 @@ Diagnostics
18341834
{ "names" : [ "global", "rs", "startupWarnings" ], "ok" : 1 }
18351835

18361836
:dbcommand:`getLog` returns events from a RAM cache of the
1837-
:program:`mongod` events, and *does not* read log data from the log
1838-
file.
1837+
:program:`mongod` events and *does not* read log data from the log
1838+
:file.
18391839

18401840
.. dbcommand:: listDatabases
18411841

0 commit comments

Comments
 (0)