@@ -1,12 +1,11 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DefaultSignatures #-}
32{-# LANGUAGE DeriveFunctor #-}
43{-# LANGUAGE DeriveGeneric #-}
54{-# LANGUAGE ExistentialQuantification #-}
65{-# LANGUAGE FlexibleContexts #-}
76{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GADTs #-}
97{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE ImplicitParams #-}
109{-# LANGUAGE MultiParamTypeClasses #-}
1110{-# LANGUAGE OverloadedStrings #-}
1211{-# LANGUAGE RankNTypes #-}
@@ -22,53 +21,36 @@
2221module Katip.Core where
2322
2423-------------------------------------------------------------------------------
25−import Control.Applicative as A
24+import Control.Applicative as A
2625import Control.AutoUpdate
2726import Control.Concurrent
28−import qualified Control.Concurrent.Async as Async
29−import Control.Concurrent.STM
30−import qualified Control.Concurrent.STM.TBQueue as BQ
31−import Control.Exception.Safe
32−import Control.Monad (unless, void, when)
3327import Control.Monad.Base
34−#if MIN_VERSION_base(4, 9, 0)
35−import qualified Control.Monad.Fail as MF
36−#endif
28+import Control.Monad.Catch
3729import Control.Monad.IO.Class
38−import Control.Monad.IO.Unlift
3930import Control.Monad.Trans.Class
4031import Control.Monad.Trans.Control
41−#if !MIN_VERSION_either(4, 5, 0)
4232import Control.Monad.Trans.Either
43−#endif
4433import Control.Monad.Trans.Except
4534import Control.Monad.Trans.Maybe
4635import Control.Monad.Trans.Reader
47−import Control.Monad.Trans.Resource (MonadResource, ResourceT,
48− transResourceT)
49−import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
50−import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
51−import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
52−import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
53−import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
54−import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT,
55− mapWriterT)
56−import Data.Aeson (FromJSON (..), ToJSON (..),
57− object)
58−import qualified Data.Aeson as A
59−import Data.Foldable as FT
60−import qualified Data.HashMap.Strict as HM
36+import Control.Monad.Trans.Resource
37+import Control.Monad.Trans.State
38+import Control.Monad.Trans.Writer
39+import Data.Aeson (FromJSON (..), ToJSON (..),
40+ object)
41+import qualified Data.Aeson as A
42+import Data.Foldable as FT
43+import qualified Data.HashMap.Strict as HM
6144import Data.List
62−import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
64−import Data.Semigroup as SG
45+import qualified Data.Map.Strict as M
46+import Data.Semigroup
6547import Data.String
6648import Data.String.Conv
67−import Data.Text (Text)
68−import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
49+import Data.Text (Text)
50+import qualified Data.Text as T
51+import qualified Data.Text.Lazy.Builder as B
7052import Data.Time
71−import GHC.Generics hiding (to)
53+import GHC.Generics hiding (to)
7254#if MIN_VERSION_base(4, 8, 0)
7355#if !MIN_VERSION_base(4, 9, 0)
7456import GHC.SrcLoc
@@ -76,24 +58,19 @@ import GHC.SrcLoc
7658import GHC.Stack
7759#endif
7860import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
61+import qualified Language.Haskell.TH.Syntax as TH
8062import Lens.Micro
8163import Lens.Micro.TH
8264import Network.HostName
83−#if mingw32_HOST_OS
84−import Katip.Compat
85−#else
8665import System.Posix
87−#endif
88−
8966-------------------------------------------------------------------------------
9067
9168
9269readMay :: Read a => String -> Maybe a
9370readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
9471 [x] -> Just x
95− [] -> Nothing -- no parse
96− _ -> Nothing -- Ambiguous parse
72+ [] -> Nothing -- no parse
73+ _ -> Nothing -- Ambiguous parse
9774
9875
9976-------------------------------------------------------------------------------
@@ -103,7 +80,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
10380-- IsString/OverloadedStrings, so "foo" will result in Namespace
10481-- ["foo"].
10582newtype Namespace = Namespace { unNamespace :: [Text] }
106− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
83+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
10784
10885instance IsString Namespace where
10986 fromString s = Namespace [fromString s]
@@ -143,35 +120,33 @@ data Severity
143120-- - 'V3' implies the maximum amount of payload information.
144121-- - Anything in between is left to the discretion of the developer.
145122data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
123+ deriving (Eq, Ord, Show, Read, Generic, Enum)
147124
148125
149126-------------------------------------------------------------------------------
150127renderSeverity :: Severity -> Text
151128renderSeverity s = case s of
152− DebugS -> "Debug"
153− InfoS -> "Info"
154− NoticeS -> "Notice"
155− WarningS -> "Warning"
156− ErrorS -> "Error"
157− CriticalS -> "Critical"
158− AlertS -> "Alert"
129+ DebugS -> "Debug"
130+ InfoS -> "Info"
131+ NoticeS -> "Notice"
132+ WarningS -> "Warning"
133+ ErrorS -> "Error"
134+ CriticalS -> "Critical"
135+ AlertS -> "Alert"
159136 EmergencyS -> "Emergency"
160137
161138
162139-------------------------------------------------------------------------------
163140textToSeverity :: Text -> Maybe Severity
164−textToSeverity = go . T.toLower
165− where
166− go "debug" = Just DebugS
167− go "info" = Just InfoS
168− go "notice" = Just NoticeS
169− go "warning" = Just WarningS
170− go "error" = Just ErrorS
171− go "critical" = Just CriticalS
172− go "alert" = Just AlertS
173− go "emergency" = Just EmergencyS
174− go _ = Nothing
141+textToSeverity "Debug" = Just DebugS
142+textToSeverity "Info" = Just InfoS
143+textToSeverity "Notice" = Just NoticeS
144+textToSeverity "Warning" = Just WarningS
145+textToSeverity "Error" = Just ErrorS
146+textToSeverity "Critical" = Just CriticalS
147+textToSeverity "Alert" = Just AlertS
148+textToSeverity "Emergency" = Just EmergencyS
149+textToSeverity _ = Nothing
175150
176151
177152instance ToJSON Severity where
@@ -181,29 +156,14 @@ instance FromJSON Severity where
181156 parseJSON = A.withText "Severity" parseSeverity
182157 where
183158 parseSeverity t = case textToSeverity t of
184− Just x -> return x
159+ Just x -> return x
185160 Nothing -> fail $ "Invalid Severity " ++ toS t
186161
187−instance ToJSON Verbosity where
188− toJSON s = A.String $ case s of
189− V0 -> "V0"
190− V1 -> "V1"
191− V2 -> "V2"
192− V3 -> "V3"
193−
194−instance FromJSON Verbosity where
195− parseJSON = A.withText "Verbosity" $ \s -> case s of
196− "V0" -> return V0
197− "V1" -> return V1
198− "V2" -> return V2
199− "V3" -> return V3
200− _ -> fail $ "Invalid Verbosity " ++ toS s
201−
202162
203163-------------------------------------------------------------------------------
204−-- | Log message with Builder underneath; use '<>' to concat in O(1).
164+-- | Log message with Builder unerneath; use '<>' to concat in O(1).
205165newtype LogStr = LogStr { unLogStr :: B.Builder }
206− deriving (Generic, Show, Eq)
166+ deriving (Generic, Show)
207167
208168instance IsString LogStr where
209169 fromString = LogStr . B.fromString
@@ -225,7 +185,7 @@ instance FromJSON LogStr where
225185
226186-------------------------------------------------------------------------------
227187-- | Pack any string-like thing into a 'LogStr'. This will
228−-- automatically work on 'String', 'ByteString', 'Text' and any of the
188+-- automatically work on 'String', 'ByteString, 'Text' and any of the
229189-- lazy variants.
230190logStr :: StringConv a Text => a -> LogStr
231191logStr t = LogStr (B.fromText $ toS t)
@@ -238,7 +198,7 @@ ls = logStr
238198
239199
240200-------------------------------------------------------------------------------
241−-- | Convert any showable type into a 'LogStr'.
201+-- | Convert any showable type into a LogStr.
242202showLS :: Show a => a -> LogStr
243203showLS = ls . show
244204
@@ -250,9 +210,7 @@ newtype ThreadIdText = ThreadIdText {
250210
251211
252212mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
254− where
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
213+mkThreadIdText = ThreadIdText . T.pack . show
256214
257215
258216-------------------------------------------------------------------------------
@@ -272,62 +230,31 @@ data Item a = Item {
272230 } deriving (Generic, Functor)
273231makeLenses ''Item
274232
275−-- Manual instance because 'Loc' has no 'Eq' and 'Show' instances in old
276−-- versions of template-haskell (< 2.10)
277−instance Eq a => Eq (Item a) where
278− a == b = FT.and [ _itemApp a == _itemApp b
279− , _itemEnv a == _itemEnv b
280− , _itemSeverity a == _itemSeverity b
281− , _itemThread a == _itemThread b
282− , _itemHost a == _itemHost b
283− , _itemProcess a == _itemProcess b
284− , _itemPayload a == _itemPayload b
285− , _itemMessage a == _itemMessage b
286− , _itemTime a == _itemTime b
287− , _itemNamespace a == _itemNamespace b
288− , case (_itemLoc a, _itemLoc b) of
289− (Nothing, Nothing) -> True
290− (Just l1, Just l2) -> FT.and [ loc_filename l1 == loc_filename l2
291− , loc_package l1 == loc_package l2
292− , loc_module l1 == loc_module l2
293− , loc_start l1 == loc_start l2
294− , loc_end l1 == loc_end l2
295− ]
296− _ -> False
297− ]
298233
299234instance Show a => Show (Item a) where
300− showsPrec d Item{..} = showParen (d >= 11) ( showString "Item {"
301− . field "_itemApp" _itemApp
302− . field "_itemEnv" _itemEnv
303− . field "_itemSeverity" _itemSeverity
304− . field "_itemThread" _itemThread
305− . field "_itemHost" _itemHost
306− . field "_itemProcess" _itemProcess
307− . field "_itemPayload" _itemPayload
308− . field "_itemMessage" _itemMessage
309− . field "_itemTime" _itemTime
310− . field "_itemNamespace" _itemNamespace
311− . showString "_itemLoc = " . shows (LocShow <$> _itemLoc)
312− . showChar '}'
313− )
314− where
315− field n v = showString n . showString " = " . shows v . showString ", "
235+ show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
236+ "_itemEnv = " ++ show _itemEnv ++ ", " ++
237+ "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
238+ "_itemThread = " ++ show _itemThread ++ ", " ++
239+ "_itemHost = " ++ show _itemHost ++ ", " ++
240+ "_itemProcess = " ++ show _itemProcess ++ ", " ++
241+ "_itemPayload = " ++ show _itemPayload ++ ", " ++
242+ "_itemMessage = " ++ show _itemMessage ++ ", " ++
243+ "_itemTime = " ++ show _itemTime ++ ", " ++
244+ "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
245+ "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
246+
316247
317248newtype LocShow = LocShow Loc
318249
319250
320251instance Show LocShow where
321− showsPrec d (LocShow Loc{..}) = showParen (d >= 11) ( showString "Loc {"
322− . field "loc_filename" loc_filename
323− . field "loc_package" loc_package
324− . field "loc_module" loc_module
325− . field "loc_start" loc_start
326− . showString "loc_end = " . shows loc_end
327− . showChar '}'
328− )
329− where
330− field n v = showString n . showString " = " . shows v . showString ", "
252+ show (LocShow Loc{..}) =
253+ "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
254+ "loc_package = " ++ show loc_package ++ ", " ++
255+ "loc_module = " ++ show loc_module ++ ", " ++
256+ "loc_start = " ++ show loc_start ++ ", " ++
257+ "loc_end = " ++ show loc_end ++ "}"
331258
332259
333260instance ToJSON a => ToJSON (Item a) where
@@ -408,7 +335,7 @@ instance FromJSON ProcessIDJs where
408335 parseJSON = A.withText "ProcessID" parseProcessID
409336 where
410337 parseProcessID t = case textToProcessID t of
411− Just p -> return $ ProcessIDJs p
338+ Just p -> return $ ProcessIDJs p
412339 Nothing -> fail $ "Invalid ProcessIDJs " ++ toS t
413340
414341
@@ -440,12 +367,11 @@ instance Monoid PayloadSelection where
440367-- a ToJSON instance like:
441368--
442369-- > instance ToObject Foo
443−class ToObject a where
370+class ToJSON a => ToObject a where
444371 toObject :: a -> A.Object
445− default toObject :: ToJSON a => a -> A.Object
446372 toObject v = case toJSON v of
447373 A.Object o -> o
448− _ -> mempty
374+ _ -> mempty
449375
450376instance ToObject ()
451377instance ToObject A.Object
@@ -497,7 +423,7 @@ instance ToObject SimpleLogPayload
497423
498424instance LogItem SimpleLogPayload where
499425 payloadKeys V0 _ = SomeKeys []
500− payloadKeys _ _ = AllKeys
426+ payloadKeys _ _ = AllKeys
501427
502428
503429instance Semigroup SimpleLogPayload where
@@ -520,7 +446,7 @@ sl a b = SimpleLogPayload [(a, AnyLogPayload b)]
520446-- automatically bubble higher verbosity levels to lower ones.
521447payloadObject :: LogItem a => Verbosity -> a -> A.Object
522448payloadObject verb a = case FT.foldMap (flip payloadKeys a) [(V0)..verb] of
523− AllKeys -> toObject a
449+ AllKeys -> toObject a
524450 SomeKeys ks -> HM.filterWithKey (\ k _ -> k `FT.elem` ks) $ toObject a
525451
526452
@@ -540,107 +466,49 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
540466--
541467-- Scribes should always take a 'Severity' and 'Verbosity'.
542468--
543−-- Severity is used to __exclude log messages__ that are lower than
544−-- the provided Severity. For instance, if the user passes InfoS,
545−-- DebugS items should be ignored. Katip provides the 'permitItem'
546−-- utility for this. The user or the scribe may use 'permitAND' and
547−-- 'permitOR' to further customize this filtering, even dynamically if
548−-- they wish to.
469+-- Severity is used to *exclude log messages* that are < the provided
470+-- Severity. For instance, if the user passes InfoS, DebugS items
471+-- should be ignored. Katip provides the 'permitItem' utility for this.
549472--
550473-- Verbosity is used to select keys from the log item's payload. Each
551474-- 'LogItem' instance describes what keys should be retained for each
552475-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
476+-- that should be permitted.
554477--
555−-- Scribes provide a finalizer IO action ('scribeFinalizer') that is
556−-- meant to synchronously flush any remaining writes and clean up any
557−-- resources acquired when the scribe was created. Internally, katip
558−-- keeps a buffer for each scribe's writes. When 'closeScribe' or
559−-- 'closeScribes' is called, that buffer stops accepting new log
560−-- messages and after the last item in its buffer is sent to 'liPush',
561−-- calls the finalizer. Thus, when the finalizer returns, katip can
562−-- assume that all resources are cleaned up and all log messages are
563−-- durably written.
478+-- There is no built-in mechanism in katip for telling a scribe that
479+-- its time to shut down. 'unregisterScribe' merely drops it from the
480+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
564481--
565−-- While katip internally buffers messages per 'ScribeSettings', it
566−-- sends them one at a time to the scribe. Depending on the scribe
567−-- itself, it may make sense for that scribe to keep its own internal
568−-- buffer to batch-send logs if writing items one at a time is not
569−-- efficient. The scribe implementer must be sure that on
570−-- finalization, all writes are committed synchronously.
571−
572−-- | Signature of a function passed to `Scribe` constructor and
573−-- mkScribe* functions that decides which messages to be
574−-- logged. Typically filters based on 'Severity', but can be
575−-- combined with other, custom logic with 'permitAND' and 'permitOR'
576−type PermitFunc = forall a. Item a -> IO Bool
577−
578−
579−-- | AND together 2 permit functions
580−permitAND :: PermitFunc -> PermitFunc -> PermitFunc
581−permitAND f1 f2 = \a -> liftA2 (&&) (f1 a) (f2 a)
582−
583−-- | OR together 2 permit functions
584−permitOR :: PermitFunc -> PermitFunc -> PermitFunc
585−permitOR f1 f2 = \a -> liftA2 (||) (f1 a) (f2 a)
482+-- 1. Pass in the resource when the scribe is created. Handle
483+-- allocation and release of the resource elsewhere. This is what the
484+-- Handle scribe does.
485+--
486+-- 2. Return a finalizing function that tells the scribe to shut
487+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns a @IO (Scribe,
488+-- IO ())@. The finalizer will flush any queued log messages and shut
489+-- down gracefully before returning. This can be hooked into your
490+-- application's shutdown routine to ensure you never miss any log
491+-- messages on shutdown.
492+data Scribe = Scribe {
493+ liPush :: forall a. LogItem a => Item a -> IO ()
494+ }
586495
587496
588−data Scribe = Scribe {
589− liPush :: forall a. LogItem a => Item a -> IO ()
590− -- ^ How do we write an item to the scribe's output?
591− , scribeFinalizer :: IO ()
592− -- ^ Provide a __blocking__ finalizer to call when your scribe is
593− -- removed. All pending writes should be flushed synchronously. If
594− -- this is not relevant to your scribe, return () is fine.
595− , scribePermitItem :: PermitFunc
596− -- ^ Provide a filtering function to allow the item to be logged,
597− -- or not. It can check Severity or some string in item's
598− -- body. The initial value of this is usually created from
599− -- 'permitItem'. Scribes and users can customize this by ANDing
600− -- or ORing onto the default with 'permitAND' or 'permitOR'
601− }
602−
603−
604−whenM :: Monad m => m Bool -> m () -> m ()
605−whenM mbool = (>>=) mbool . flip when
606−
607−
608−-- | Combine two scribes. Publishes to the left scribe if the left
609−-- would permit the item and to the right scribe if the right would
610−-- permit the item. Finalizers are called in sequence from left to
611−-- right.
612497instance Semigroup Scribe where
613− (Scribe pushA finA permitA) <> (Scribe pushB finB permitB) =
614− Scribe (\item -> whenM (permitA item) (pushA item)
615− >> whenM (permitB item) (pushB item)
616− )
617− (finA `finally` finB)
618− (permitOR permitA permitB)
498+ (Scribe a) <> (Scribe b) = Scribe $ \ item -> do
499+ a item
500+ b item
619501
620502
621503instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
504+ mempty = Scribe $ const $ return ()
623505 mappend = (<>)
624506
625507
626−-------------------------------------------------------------------------------
627−data ScribeHandle = ScribeHandle {
628− shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
630− }
631−
632−
633−-------------------------------------------------------------------------------
634−data WorkerMessage where
635− NewItem :: LogItem a => Item a -> WorkerMessage
636− PoisonPill :: WorkerMessage
637−
638−
639508-------------------------------------------------------------------------------
640509-- | Should this item be logged given the user's maximum severity?
641−-- Most new scribes will use this as a base for their 'PermitFunc'
642−permitItem :: Monad m => Severity -> Item a -> m Bool
643−permitItem sev item = return (_itemSeverity item >= sev)
510+permitItem :: Severity -> Item a -> Bool
511+permitItem sev i = _itemSeverity i >= sev
644512
645513
646514-------------------------------------------------------------------------------
@@ -659,16 +527,16 @@ data LogEnv = LogEnv {
659527 -- 'AutoUpdate' for high volume logs but note that this may cause
660528 -- some output forms to display logs out of order. Alternatively,
661529 -- you could just use 'getCurrentTime'.
662− , _logEnvScribes :: M.Map Text ScribeHandle
530+ , _logEnvScribes :: M.Map Text Scribe
663531 }
664532makeLenses ''LogEnv
665533
666534
667535-------------------------------------------------------------------------------
668−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which
669−-- updates the timer every 1ms. If you need even more timestamp
670−-- precision at the cost of performance, consider setting
671−-- '_logEnvTimer' with 'getCurrentTime'.
536+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
537+-- the default settings as the timer. If you are concerned about
538+-- timestamp precision or event ordering in log outputs like
539+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
672540initLogEnv
673541 :: Namespace
674542 -- ^ A base namespace for this application
@@ -680,123 +548,45 @@ initLogEnv an env = LogEnv
680548 <*> getProcessID
681549 <*> pure an
682550 <*> pure env
683− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
551+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
684552 <*> pure mempty
685553
686554
687555-------------------------------------------------------------------------------
688556-- | Add a scribe to the list. All future log calls will go to this
689−-- scribe in addition to the others. Writes will be buffered per the
690−-- ScribeSettings to prevent slow scribes from slowing down
691−-- logging. Writes will be dropped if the buffer fills.
557+-- scribe in addition to the others.
692558registerScribe
693559 :: Text
694560 -- ^ Name the scribe
695561 -> Scribe
696− -> ScribeSettings
697562 -> LogEnv
698− -> IO LogEnv
699−registerScribe nm scribe ScribeSettings {..} le = do
700− queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
701− worker <- spawnScribeWorker scribe queue
702− let fin = do
703− atomically (BQ.writeTBQueue queue PoisonPill)
704− -- wait for our worker to finish final write
705− void (Async.waitCatch worker)
706− -- wait for scribe to finish final write
707− void (scribeFinalizer scribe)
708−
709− let sh = ScribeHandle (scribe { scribeFinalizer = fin }) queue
710− return (le & logEnvScribes %~ M.insert nm sh)
711−
712−
713−-------------------------------------------------------------------------------
714−spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
716− where
717− go = do
718− newCmd <- atomically (BQ.readTBQueue queue)
719− case newCmd of
720− NewItem a -> do
721− -- Swallow any direct exceptions from the
722− -- scribe. safe-exceptions won't catch async exceptions.
723− void (tryAny (write a))
724− go
725− PoisonPill -> return ()
726−
727−
728−-------------------------------------------------------------------------------
729−data ScribeSettings = ScribeSettings {
730− _scribeBufferSize :: Int
731− }
732− deriving (Show, Eq)
733−
734−makeLenses ''ScribeSettings
735−
736−
737−-- | Reasonable defaults for a scribe. Buffer
738−-- size of 4096.
739−defaultScribeSettings :: ScribeSettings
740−defaultScribeSettings = ScribeSettings 4096
563+ -> LogEnv
564+registerScribe nm h = logEnvScribes %~ M.insert nm h
741565
742566
743567-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
745−-- the scribe. This mainly only makes sense to use with something like
746−-- MonadReader's @local@ function to temporarily disavow a single
747−-- logger for a block of code.
568+-- | Remove a scribe from the list. All future log calls will no
569+-- longer use this scribe. If the given scribe doesn't exist, its a no-op.
748570unregisterScribe
749571 :: Text
750572 -- ^ Name of the scribe
751573 -> LogEnv
752574 -> LogEnv
753−unregisterScribe nm = logEnvScribes %~ M.delete nm
575+unregisterScribe nm = logEnvScribes %~ M.delete nm
754576
755577
756578-------------------------------------------------------------------------------
757−-- | Unregister __all__ scribes. Note that this is __not__ for closing or
758−-- finalizing scribes, use 'closeScribes' for that. This mainly only
759−-- makes sense to use with something like MonadReader's @local@
760−-- function to temporarily disavow any loggers for a block of code.
579+-- | Unregister *all* scribes. Logs will go off into space from this
580+-- point onward until new scribes are added. Note that you could use
581+-- this with `local` if you're using a Reader based stack to
582+-- temporarily disable log output. See `katipNoLogging` for an
583+-- example.
761584clearScribes
762585 :: LogEnv
763586 -> LogEnv
764587clearScribes = logEnvScribes .~ mempty
765588
766589
767−-------------------------------------------------------------------------------
768−-- | Finalize a scribe. The scribe is removed from the environment,
769−-- its finalizer is called so that it can never be written to again
770−-- and all pending writes are flushed. Note that this will throw any
771−-- exceptions yoru finalizer will throw, and that LogEnv is immutable,
772−-- so it will not be removed in that case.
773−closeScribe
774− :: Text
775− -- ^ Name of the scribe
776− -> LogEnv
777− -> IO LogEnv
778−closeScribe nm le = do
779− maybe (return ()) (scribeFinalizer . shScribe) (M.lookup nm (_logEnvScribes le))
780− return (le & logEnvScribes %~ M.delete nm)
781−
782−
783−-------------------------------------------------------------------------------
784−-- | Call this at the end of your program. This is a blocking call
785−-- that stop writing to a scribe's queue, waits for the queue to
786−-- empty, finalizes each scribe in the log environment and then
787−-- removes it. Finalizers are all run even if one of them throws, but
788−-- the exception will be re-thrown at the end.
789−closeScribes
790− :: LogEnv
791− -> IO LogEnv
792−closeScribes le = do
793− -- We want to run every finalizer here so we'll not save
794− -- intermediate logenvs and just clear scribes at the end.
795− let actions = [void (closeScribe k le) | k <- M.keys (_logEnvScribes le)]
796− FT.foldr finally (return ()) actions
797− return (le & logEnvScribes .~ mempty)
798−
799−
800590-------------------------------------------------------------------------------
801591-- | Monads where katip logging actions can be performed. Katip is the
802592-- most basic logging monad. You will typically use this directly if
@@ -807,86 +597,44 @@ closeScribes le = do
807597-- which keeps a namespace and merged context. You can write simple
808598-- functions that add additional namespacing and merges additional
809599-- context on the fly.
810−--
811−-- 'localLogEnv' was added to allow for lexically-scoped modifications
812−-- of the log env that are reverted when the supplied monad
813−-- completes. 'katipNoLogging', for example, uses this to temporarily
814−-- pause log outputs.
815600class MonadIO m => Katip m where
816601 getLogEnv :: m LogEnv
817− localLogEnv :: (LogEnv -> LogEnv) -> m a -> m a
818602
819603
820604instance Katip m => Katip (ReaderT s m) where
821605 getLogEnv = lift getLogEnv
822− localLogEnv = mapReaderT . localLogEnv
823606
824607
825−#if !MIN_VERSION_either(4, 5, 0)
826608instance Katip m => Katip (EitherT s m) where
827609 getLogEnv = lift getLogEnv
828− localLogEnv = mapEitherT . localLogEnv
829−#endif
830−
831610
832611instance Katip m => Katip (ExceptT s m) where
833612 getLogEnv = lift getLogEnv
834− localLogEnv = mapExceptT . localLogEnv
835−
836613
837614instance Katip m => Katip (MaybeT m) where
838615 getLogEnv = lift getLogEnv
839− localLogEnv = mapMaybeT . localLogEnv
840616
841617
842618instance Katip m => Katip (StateT s m) where
843619 getLogEnv = lift getLogEnv
844− localLogEnv = mapStateT . localLogEnv
845−
846−
847−instance (Katip m, Monoid w) => Katip (RWST r w s m) where
848− getLogEnv = lift getLogEnv
849− localLogEnv = mapRWST . localLogEnv
850−
851−
852−instance (Katip m, Monoid w) => Katip (Strict.RWST r w s m) where
853− getLogEnv = lift getLogEnv
854− localLogEnv = Strict.mapRWST . localLogEnv
855−
856−
857−instance Katip m => Katip (Strict.StateT s m) where
858− getLogEnv = lift getLogEnv
859− localLogEnv = Strict.mapStateT . localLogEnv
860620
861621
862622instance (Katip m, Monoid s) => Katip (WriterT s m) where
863623 getLogEnv = lift getLogEnv
864− localLogEnv = mapWriterT . localLogEnv
865−
866−
867−instance (Katip m, Monoid s) => Katip (Strict.WriterT s m) where
868− getLogEnv = lift getLogEnv
869− localLogEnv = Strict.mapWriterT . localLogEnv
870−
871624
872625instance (Katip m) => Katip (ResourceT m) where
873626 getLogEnv = lift getLogEnv
874− localLogEnv = transResourceT . localLogEnv
875627
876628
877629-------------------------------------------------------------------------------
878−-- | A concrete monad you can use to run logging actions. Use this if
879−-- you prefer an explicit monad transformer stack and adding layers as
880−-- opposed to implementing 'Katip' for your monad.
630+-- | A concrete monad you can use to run logging actions.
881631newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882632 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
884− , MonadBase b)
633+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
885634
886635
887636instance MonadIO m => Katip (KatipT m) where
888637 getLogEnv = KatipT ask
889− localLogEnv f (KatipT m) = KatipT $ local f m
890638
891639
892640instance MonadTransControl KatipT where
@@ -902,21 +650,6 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
902650 liftBaseWith = defaultLiftBaseWith
903651 restoreM = defaultRestoreM
904652
905−instance MonadUnliftIO m => MonadUnliftIO (KatipT m) where
906−#if MIN_VERSION_unliftio_core(0, 2, 0)
907− withRunInIO inner = KatipT $ ReaderT $ \le -> withRunInIO $ \run ->
908− inner (run . runKatipT le)
909−#else
910− askUnliftIO = KatipT $
911− withUnliftIO $ \u ->
912− pure (UnliftIO (unliftIO u . unKatipT))
913−#endif
914−
915−#if MIN_VERSION_base(4, 9, 0)
916−instance MF.MonadFail m => MF.MonadFail (KatipT m) where
917− fail msg = lift (MF.fail msg)
918− {-# INLINE fail #-}
919−#endif
920653
921654-------------------------------------------------------------------------------
922655-- | Execute 'KatipT' on a log env.
@@ -924,17 +657,6 @@ runKatipT :: LogEnv -> KatipT m a -> m a
924657runKatipT le (KatipT f) = runReaderT f le
925658
926659
927−-------------------------------------------------------------------------------
928−-- | Disable all scribes for the given monadic action, then restore
929−-- them afterwards. Works in any Katip monad.
930−katipNoLogging
931− :: ( Katip m
932− )
933− => m a
934− -> m a
935−katipNoLogging = localLogEnv (\le -> set logEnvScribes mempty le)
936−
937−
938660-------------------------------------------------------------------------------
939661-- | Log with everything, including a source code location. This is
940662-- very low level and you typically can use 'logT' in its place.
@@ -948,43 +670,20 @@ logItem
948670 -> m ()
949671logItem a ns loc sev msg = do
950672 LogEnv{..} <- getLogEnv
951− logKatipItem =<< liftIO
952− (Item <$> pure _logEnvApp
953− <*> pure _logEnvEnv
954− <*> pure sev
955− <*> (mkThreadIdText <$> myThreadId)
956− <*> pure _logEnvHost
957− <*> pure _logEnvPid
958− <*> pure a
959− <*> pure msg
960− <*> _logEnvTimer
961− <*> pure (_logEnvApp <> ns)
962− <*> pure loc)
963−
964−-- | Log already constructed 'Item'. This is the lowest level function that other log*
965−-- functions use.
966−-- It can be useful when implementing centralised logging services.
967−logKatipItem
968− :: (A.Applicative m, LogItem a, Katip m)
969− => Item a
970− -> m ()
971−logKatipItem item = do
972− LogEnv{..} <- getLogEnv
973− liftIO $
974− FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> do
975− whenM (scribePermitItem shScribe item) $
976− void $ atomically (tryWriteTBQueue shChan (NewItem item))
977−
978−-------------------------------------------------------------------------------
979−tryWriteTBQueue
980− :: TBQueue a
981− -> a
982− -> STM Bool
983− -- ^ Did we write?
984−tryWriteTBQueue q a = do
985− full <- isFullTBQueue q
986− unless full (writeTBQueue q a)
987− return (not full)
673+ liftIO $ do
674+ item <- Item
675+ <$> pure _logEnvApp
676+ <*> pure _logEnvEnv
677+ <*> pure sev
678+ <*> (mkThreadIdText <$> myThreadId)
679+ <*> pure _logEnvHost
680+ <*> pure _logEnvPid
681+ <*> pure a
682+ <*> pure msg
683+ <*> _logEnvTimer
684+ <*> pure (_logEnvApp <> ns)
685+ <*> pure loc
686+ FT.forM_ (M.elems _logEnvScribes) $ \ (Scribe h) -> h item
988687
989688
990689-------------------------------------------------------------------------------
@@ -1016,10 +715,10 @@ logException
1016715 -> Severity -- ^ Severity
1017716 -> m b -- ^ Main action being run
1018717 -> m b
1019−logException a ns sev action = action `catchAny` \e -> f e >> throwM e
718+logException a ns sev action = action `catchAll` \e -> f e >> throwM e
1020719 where
1021720 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
721+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1023722
1024723
1025724-------------------------------------------------------------------------------
@@ -1047,14 +746,14 @@ instance TH.Lift Verbosity where
1047746
1048747
1049748instance TH.Lift Severity where
1050− lift DebugS = [| DebugS |]
1051− lift InfoS = [| InfoS |]
1052− lift NoticeS = [| NoticeS |]
1053− lift WarningS = [| WarningS |]
1054− lift ErrorS = [| ErrorS |]
749+ lift DebugS = [| DebugS |]
750+ lift InfoS = [| InfoS |]
751+ lift NoticeS = [| NoticeS |]
752+ lift WarningS = [| WarningS |]
753+ lift ErrorS = [| ErrorS |]
1055754 lift CriticalS = [| CriticalS |]
1056− lift AlertS = [| AlertS |]
1057− lift EmergencyS = [| EmergencyS |]
755+ lift AlertS = [| AlertS |]
756+ lift EmergencyS = [| EmergencyS |]
1058757
1059758
1060759-- | Lift a location into an Exp.
@@ -1073,15 +772,11 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
1073772-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1074773-- callstacks when available (GHC > 7.8).
1075774#if MIN_VERSION_base(4, 8, 0)
1076−getLoc :: HasCallStack => Maybe Loc
1077−getLoc = case getCallStack callStack of
775+getLoc :: (?loc :: CallStack) => Maybe Loc
776+getLoc = case getCallStack ?loc of
1078777 [] -> Nothing
1079− xs -> Just . toLoc . head $ filter filterKatip xs
778+ xs -> Just . toLoc . last $ xs
1080779 where
1081− filterKatip :: (String, SrcLoc) -> Bool
1082− filterKatip (_, srcloc) = not $
1083− "katip-" `isPrefixOf` srcLocPackage srcloc
1084−
1085780 toLoc :: (String, SrcLoc) -> Loc
1086781 toLoc (_, l) = Loc {
1087782 loc_filename = srcLocFile l
@@ -1112,7 +807,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1112807
1113808
1114809-------------------------------------------------------------------------------
1115−-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
810+-- | 'Loc'-tagged logging using implicit-callstacks when available.
1116811--
1117812-- This function does not require template-haskell as it
1118813-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1122,11 +817,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1122817-- `logT` for maximum compatibility.
1123818--
1124819-- @logLoc obj mempty InfoS "Hello world"@
1125−#if MIN_VERSION_base(4, 8, 0)
1126−logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
1127−#else
1128820logLoc :: (Applicative m, LogItem a, Katip m)
1129−#endif
1130821 => a
1131822 -> Namespace
1132823 -> Severity