on master help sign in
Clarify docs on logStdout and logStdoutDev (fixes #515)
commitfda63985d6460d5fe0b44ed57c4d75b4826b2656 authorMichael Snoyman <michael@snoyman.com> dateMon 29 Feb 2016, 10:15 (11 years ago) parentf02c90c
3 files changed+9−3
wai-extra/ChangeLog.md+4 wai-extra/Network/Wai/Middleware/RequestLogger.hs+4−2 wai-extra/wai-extra.cabal+1−1
wai-extra/ChangeLog.md+4
@@ -1,3 +1,7 @@
1+## 3.0.14.1
2+
3+* Doc update for logStdout and logStdoutDev [#515](https://github.com/yesodweb/wai/issues/515)
4+
15## 3.0.14
26
37* Middleware to force domain names. [#506](https://github.com/yesodweb/wai/issues/506) [#507](https://github.com/yesodweb/wai/pull/507)
wai-extra/Network/Wai/Middleware/RequestLogger.hs+4−2
@@ -140,14 +140,16 @@ customMiddlewareWithDetails cb getdate formatter app req sendResponse = do
140140 return rspRcv
141141
142142-- | Production request logger middleware.
143+--
144+-- This uses the 'Apache' logging format, and takes IP addresses for clients from
145+-- the socket (see 'IPAddrSource' for more information). It logs to 'stdout'.
143146{-# NOINLINE logStdout #-}
144147logStdout :: Middleware
145148logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
146149
147150-- | Development request logger middleware.
148151--
149−-- Flushes 'stdout' on each request, which would be inefficient in production use.
150−-- Use "logStdout" in production.
152+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
151153{-# NOINLINE logStdoutDev #-}
152154logStdoutDev :: Middleware
153155logStdoutDev = unsafePerformIO $ mkRequestLogger def
wai-extra/wai-extra.cabal+1−1
@@ -1,5 +1,5 @@
11Name: wai-extra
2−Version: 3.0.14
2+Version: 3.0.14.1
33Synopsis: Provides some basic WAI handlers and middleware.
44description:
55 Provides basic WAI handler and middleware functionality: