Skip to content

Commit 7db2b87

Browse files
authored
DOCSP-28680 Add Restart Warning for diagnosticDataCollectionDirectoryPath (#2753) (#2851)
* DOCSP-28680 Add Restart Warning for diagnosticDataCollectionDirectoryPath * copy cleanup * IF feedback * move warning message
1 parent 4fd6c2b commit 7db2b87

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

21212121
|mongos-only|
21222122

2123+
.. warning::
2124+
2125+
If :ref:`Full Time Diagnostic Data Capture (FTDC) <ftdc-stub>` is
2126+
disabled with :parameter:`diagnosticDataCollectionEnabled` or if
2127+
:setting:`systemLog.destination` is set to ``syslog``, you must restart
2128+
:binary:`~bin.mongos` after setting
2129+
``diagnosticDataCollectionDirectoryPath``.
2130+
21232131
Specify the directory for the diagnostic directory for
21242132
:binary:`~bin.mongos`. If the directory does not exist,
21252133
:binary:`~bin.mongos` creates the directory.
@@ -2133,15 +2141,11 @@ The following parameters support diagnostic data capture (FTDC):
21332141
/var/log/mongodb/mongos.log.201708015``, then the diagnostic data
21342142
directory is ``/var/log/mongodb/mongos.diagnostic.data/``.
21352143

2136-
.. important::
2137-
2138-
If the :binary:`~bin.mongos` cannot create the specified
2139-
directory, the diagnostic data capture is disabled for that
2140-
instance. This is often caused by:
2141-
2142-
- a file with the same name already exists in the path, or
2143-
2144-
- the process does not have permissions to create the directory.
2144+
If the :binary:`~bin.mongos` cannot create the specified directory, the
2145+
diagnostic data capture is disabled for that instance. :binary:`~bin.mongos`
2146+
may not be able to create the specified directory if a file with the same
2147+
name already exists in the path or if the process does not have permissions
2148+
to create the directory.
21452149

21462150
.. parameter:: diagnosticDataCollectionDirectorySizeMB
21472151

0 commit comments

Comments
 (0)