Skip to content

DOCS-8981: Document maxLogSizeKB parameter #3157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 15, 2017
Merged

DOCS-8981: Document maxLogSizeKB parameter #3157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ba7c7c
DOCS-8981: Document maxLogSizeKB parameter
kallimachos Dec 8, 2017
822707e
DOCS-8981 Add warning for large maxLogSizeKB values
kallimachos Dec 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/reference/command/setParameter.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ setParameter
- :parameter:`logComponentVerbosity`
- :parameter:`logLevel`
- :parameter:`logUserIds`
- :parameter:`maxLogSizeKB`
- :parameter:`quiet`
- :parameter:`traceExceptions`

Expand Down
29 changes: 27 additions & 2 deletions source/reference/parameters.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,31 @@ Logging Parameters

Disabled by default.

.. parameter:: maxLogSizeKB

.. versionadded:: 3.4

|both|

*Type*: integer

*Default*: 10

Specifies the maximum size, in kilobytes, for a log line. Lines exceeding
this limit print only the beginning and end of the line, excising the middle
portion.

For example, the following sets the maximum size to ``20`` kilobytes:

.. code-block:: sh

mongod --setParameter maxLogSizeKB=20

.. warning::

Using a large value for :parameter:`maxLogSizeKB` may adversely affect
system performance and negatively impact database operations.

.. parameter:: quiet

|both|
Expand Down Expand Up @@ -846,7 +871,7 @@ The following parameters support :term:`diagnostic data capture (FTDC)

|mongos-only|

Specify the the directory for the diagnostic directory for
Specify the directory for the diagnostic directory for
:program:`mongos`. If the directory does not exist,
:program:`mongos` creates the directory.

Expand Down Expand Up @@ -882,7 +907,7 @@ The following parameters support :term:`diagnostic data capture (FTDC)
*Default*: 200

Specifies the maximum size, in megabytes, of the ``diagnostic.data``
directory . If directory size exceeds this number, the oldest
directory. If directory size exceeds this number, the oldest
:ref:`diagnostic files in the directory
<3.2-diagnostic-data-capture>` are automatically deleted based on
the timestamp in the file name.
Expand Down