Skip to content

Commit fc39563

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

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
@@ -2150,6 +2150,14 @@ The following parameters support diagnostic data capture (FTDC):
21502150

21512151
|mongos-only|
21522152

2153+
.. warning::
2154+
2155+
If :ref:`Full Time Diagnostic Data Capture (FTDC) <ftdc-stub>` is
2156+
disabled with :parameter:`diagnosticDataCollectionEnabled` or if
2157+
:setting:`systemLog.destination` is set to ``syslog``, you must restart
2158+
:binary:`~bin.mongos` after setting
2159+
``diagnosticDataCollectionDirectoryPath``.
2160+
21532161
Specify the directory for the diagnostic directory for
21542162
:binary:`~bin.mongos`. If the directory does not exist,
21552163
:binary:`~bin.mongos` creates the directory.
@@ -2163,15 +2171,11 @@ The following parameters support diagnostic data capture (FTDC):
21632171
/var/log/mongodb/mongos.log.201708015``, then the diagnostic data
21642172
directory is ``/var/log/mongodb/mongos.diagnostic.data/``.
21652173

2166-
.. important::
2167-
2168-
If the :binary:`~bin.mongos` cannot create the specified
2169-
directory, the diagnostic data capture is disabled for that
2170-
instance. This is often caused by:
2171-
2172-
- a file with the same name already exists in the path, or
2173-
2174-
- the process does not have permissions to create the directory.
2174+
If the :binary:`~bin.mongos` cannot create the specified directory, the
2175+
diagnostic data capture is disabled for that instance. :binary:`~bin.mongos`
2176+
may not be able to create the specified directory if a file with the same
2177+
name already exists in the path or if the process does not have permissions
2178+
to create the directory.
21752179

21762180
.. parameter:: diagnosticDataCollectionDirectorySizeMB
21772181

0 commit comments

Comments
 (0)