From bd0aad18b94685077cdf1963c7a6f77a1417ef49 Mon Sep 17 00:00:00 2001 From: Brian Moss Date: Thu, 22 Feb 2018 13:45:13 +1000 Subject: [PATCH] DOCS-11343 Add warning about incorrect syslog timestamps --- source/includes/options-conf.yaml | 8 ++++++++ source/includes/options-mongod.yaml | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/source/includes/options-conf.yaml b/source/includes/options-conf.yaml index 8d4913af1b6..d728bff48c8 100644 --- a/source/includes/options-conf.yaml +++ b/source/includes/options-conf.yaml @@ -295,6 +295,14 @@ description: | If you do not specify :setting:`systemLog.destination`, MongoDB sends all log output to standard output. + + .. warning:: + + The ``syslog`` daemon generates timestamps when it logs a message, not + when MongoDB issues the message. This can lead to misleading timestamps + for log entries, especially when the system is under heavy load. We + recommend using the ``file`` option for production systems to ensure + accurate timestamps. --- program: conf name: systemLog.timeStampFormat diff --git a/source/includes/options-mongod.yaml b/source/includes/options-mongod.yaml index 91ee2856bdb..57b03cef3c8 100644 --- a/source/includes/options-mongod.yaml +++ b/source/includes/options-mongod.yaml @@ -305,6 +305,14 @@ description: | than to standard output or to a log file. , as with :option:`--logpath`. The {{role}} option is not supported on Windows. + + .. warning:: + + The ``syslog`` daemon generates timestamps when it logs a message, not + when MongoDB issues the message. This can lead to misleading timestamps + for log entries, especially when the system is under heavy load. We + recommend using the :option:`--logpath` option for production systems to + ensure accurate timestamps. optional: true --- program: mongod