on master help sign in
Clarify docs on logStdout and logStdoutDev (fixes #515)
fda6398Michael Snoyman
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+
1## 3.0.14
5## 3.0.14
2
6
3* Middleware to force domain names. [#506](https://github.com/yesodweb/wai/issues/506) [#507](https://github.com/yesodweb/wai/pull/507)
7* 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
140 return rspRcv
140 return rspRcv
141
141
142-- | Production request logger middleware.
142-- | 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'.
143{-# NOINLINE logStdout #-}
146{-# NOINLINE logStdout #-}
144logStdout :: Middleware
147logStdout :: Middleware
145logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
148logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
146
149
147-- | Development request logger middleware.
150-- | Development request logger middleware.
148--
151--
149−-- Flushes 'stdout' on each request, which would be inefficient in production use.
152+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
150−-- Use "logStdout" in production.
151{-# NOINLINE logStdoutDev #-}
153{-# NOINLINE logStdoutDev #-}
152logStdoutDev :: Middleware
154logStdoutDev :: Middleware
153logStdoutDev = unsafePerformIO $ mkRequestLogger def
155logStdoutDev = unsafePerformIO $ mkRequestLogger def
wai-extra/wai-extra.cabal+1−1
@@ -1,5 +1,5 @@
1Name: wai-extra
1Name: wai-extra
2−Version: 3.0.14
2+Version: 3.0.14.1
3Synopsis: Provides some basic WAI handlers and middleware.
3Synopsis: Provides some basic WAI handlers and middleware.
4description:
4description:
5 Provides basic WAI handler and middleware functionality:
5 Provides basic WAI handler and middleware functionality: