@@ -428,12 +428,19 @@ data LogEnv = LogEnv {
428428 , _logEnvNs :: Namespace
429429 , _logEnvEnv :: Environment
430430 , _logEnvTimer :: IO UTCTime
431+ -- ^ Action to fetch the timestamp. You can use something like
432+ -- 'AutoUpdate' for high volume logs but note that this may cause
433+ -- some output forms to display logs out of order.
431434 , _logEnvScribes :: M.Map Text Scribe
432435 }
433436makeLenses ''LogEnv
434437
435438
436439-------------------------------------------------------------------------------
440+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
441+-- the default settings as the timer. If you are concerned about
442+-- timestamp precision or event ordering in log outputs like
443+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
437444initLogEnv
438445 :: Namespace
439446 -- ^ A base namespace for this application