Skip to content

Commit c473dda

Browse files
authored
DOCSP-28680 Add Restart Warning for diagnosticDataCollectionDirectoryPath (#2753) (#2852)
* DOCSP-28680 Add Restart Warning for diagnosticDataCollectionDirectoryPath * copy cleanup * IF feedback * move warning message
1 parent 10828e5 commit c473dda

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

source/reference/parameters.txt

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2068,6 +2068,14 @@ The following parameters support diagnostic data capture (FTDC):
20682068

20692069
|mongos-only|
20702070

2071+
.. warning::
2072+
2073+
If :ref:`Full Time Diagnostic Data Capture (FTDC) <ftdc-stub>` is
2074+
disabled with :parameter:`diagnosticDataCollectionEnabled` or if
2075+
:setting:`systemLog.destination` is set to ``syslog``, you must restart
2076+
:binary:`~bin.mongos` after setting
2077+
``diagnosticDataCollectionDirectoryPath``.
2078+
20712079
Specify the directory for the diagnostic directory for
20722080
:binary:`~bin.mongos`. If the directory does not exist,
20732081
:binary:`~bin.mongos` creates the directory.
@@ -2081,15 +2089,11 @@ The following parameters support diagnostic data capture (FTDC):
20812089
/var/log/mongodb/mongos.log.201708015``, then the diagnostic data
20822090
directory is ``/var/log/mongodb/mongos.diagnostic.data/``.
20832091

2084-
.. important::
2085-
2086-
If the :binary:`~bin.mongos` cannot create the specified
2087-
directory, the diagnostic data capture is disabled for that
2088-
instance. This is often caused by:
2089-
2090-
- a file with the same name already exists in the path, or
2091-
2092-
- the process does not have permissions to create the directory.
2092+
If the :binary:`~bin.mongos` cannot create the specified directory, the
2093+
diagnostic data capture is disabled for that instance. :binary:`~bin.mongos`
2094+
may not be able to create the specified directory if a file with the same
2095+
name already exists in the path or if the process does not have permissions
2096+
to create the directory.
20932097

20942098
.. parameter:: diagnosticDataCollectionDirectorySizeMB
20952099

0 commit comments

Comments
 (0)