@@ -7,6 +7,7 @@
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE GADTs #-}
8{-# LANGUAGE GADTs #-}
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10+{-# LANGUAGE ImplicitParams #-}
10{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE RankNTypes #-}
13{-# LANGUAGE RankNTypes #-}
@@ -22,53 +23,39 @@
22module Katip.Core where
23module Katip.Core where
24-------------------------------------------------------------------------------
25-------------------------------------------------------------------------------
25−import Control.Applicative as A
26+import Control.Applicative as A
26import Control.AutoUpdate
27import Control.AutoUpdate
27import Control.Concurrent
28import Control.Concurrent
28−import qualified Control.Concurrent.Async as Async
29+import qualified Control.Concurrent.Async as Async
29−import Control.Concurrent.STM
30−import qualified Control.Concurrent.STM.TBQueue as BQ
30+import qualified Control.Concurrent.Chan.Unagi.Bounded as UB
31−import Control.Exception.Safe
32−import Control.Monad (unless, void, when)
31+import Control.Monad (void)
33import Control.Monad.Base
32import Control.Monad.Base
34−#if MIN_VERSION_base(4, 9, 0)
35−import qualified Control.Monad.Fail as MF
33+import Control.Monad.Catch
37import Control.Monad.IO.Class
34import Control.Monad.IO.Class
38−import Control.Monad.IO.Unlift
39import Control.Monad.Trans.Class
35import Control.Monad.Trans.Class
40import Control.Monad.Trans.Control
36import Control.Monad.Trans.Control
41−#if !MIN_VERSION_either(4, 5, 0)
42import Control.Monad.Trans.Either
37import Control.Monad.Trans.Either
44import Control.Monad.Trans.Except
38import Control.Monad.Trans.Except
45import Control.Monad.Trans.Maybe
39import Control.Monad.Trans.Maybe
46import Control.Monad.Trans.Reader
40import Control.Monad.Trans.Reader
47−import Control.Monad.Trans.Resource (MonadResource, ResourceT,
41+import Control.Monad.Trans.Resource
49−import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
42+import Control.Monad.Trans.State
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)
43+import Control.Monad.Trans.Writer
54−import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT,
56−import Data.Aeson (FromJSON (..), ToJSON (..),
44+import Data.Aeson (FromJSON (..),
57− object)
45+ ToJSON (..), object)
58−import qualified Data.Aeson as A
46+import qualified Data.Aeson as A
59−import Data.Foldable as FT
47+import Data.Foldable as FT
60−import qualified Data.HashMap.Strict as HM
48+import qualified Data.HashMap.Strict as HM
61import Data.List
49import Data.List
62−import qualified Data.Map.Strict as M
50+import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
51+import Data.Semigroup
64−import Data.Semigroup as SG
65import Data.String
52import Data.String
66import Data.String.Conv
53import Data.String.Conv
67−import Data.Text (Text)
54+import Data.Text (Text)
68−import qualified Data.Text as T
55+import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
56+import qualified Data.Text.Lazy.Builder as B
70import Data.Time
57import Data.Time
71−import GHC.Generics hiding (to)
58+import GHC.Generics hiding (to)
72#if MIN_VERSION_base(4, 8, 0)
59#if MIN_VERSION_base(4, 8, 0)
73#if !MIN_VERSION_base(4, 9, 0)
60#if !MIN_VERSION_base(4, 9, 0)
74import GHC.SrcLoc
61import GHC.SrcLoc
@@ -76,7 +63,7 @@ import GHC.SrcLoc
76import GHC.Stack
63import GHC.Stack
78import Language.Haskell.TH
65import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
66+import qualified Language.Haskell.TH.Syntax as TH
80import Lens.Micro
67import Lens.Micro
81import Lens.Micro.TH
68import Lens.Micro.TH
82import Network.HostName
69import Network.HostName
@@ -103,7 +90,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
103-- IsString/OverloadedStrings, so "foo" will result in Namespace
90-- IsString/OverloadedStrings, so "foo" will result in Namespace
104-- ["foo"].
91-- ["foo"].
105newtype Namespace = Namespace { unNamespace :: [Text] }
92newtype Namespace = Namespace { unNamespace :: [Text] }
106− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
93+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
108instance IsString Namespace where
95instance IsString Namespace where
109 fromString s = Namespace [fromString s]
96 fromString s = Namespace [fromString s]
@@ -143,7 +130,7 @@ data Severity
143-- - 'V3' implies the maximum amount of payload information.
130-- - 'V3' implies the maximum amount of payload information.
144-- - Anything in between is left to the discretion of the developer.
131-- - Anything in between is left to the discretion of the developer.
145data Verbosity = V0 | V1 | V2 | V3
132data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
133+ deriving (Eq, Ord, Show, Read, Generic, Enum)
149-------------------------------------------------------------------------------
136-------------------------------------------------------------------------------
@@ -184,26 +171,11 @@ instance FromJSON Severity where
184 Just x -> return x
171 Just x -> return x
185 Nothing -> fail $ "Invalid Severity " ++ toS t
172 Nothing -> fail $ "Invalid Severity " ++ toS t
187−instance ToJSON Verbosity where
188− toJSON s = A.String $ case s of
194−instance FromJSON Verbosity where
195− parseJSON = A.withText "Verbosity" $ \s -> case s of
200− _ -> fail $ "Invalid Verbosity " ++ toS s
203-------------------------------------------------------------------------------
175-------------------------------------------------------------------------------
204−-- | Log message with Builder underneath; use '<>' to concat in O(1).
176+-- | Log message with Builder unerneath; use '<>' to concat in O(1).
205newtype LogStr = LogStr { unLogStr :: B.Builder }
177newtype LogStr = LogStr { unLogStr :: B.Builder }
206− deriving (Generic, Show, Eq)
178+ deriving (Generic, Show)
208instance IsString LogStr where
180instance IsString LogStr where
209 fromString = LogStr . B.fromString
181 fromString = LogStr . B.fromString
@@ -225,7 +197,7 @@ instance FromJSON LogStr where
226-------------------------------------------------------------------------------
198-------------------------------------------------------------------------------
227-- | Pack any string-like thing into a 'LogStr'. This will
199-- | Pack any string-like thing into a 'LogStr'. This will
228−-- automatically work on 'String', 'ByteString', 'Text' and any of the
200+-- automatically work on 'String', 'ByteString, 'Text' and any of the
229-- lazy variants.
201-- lazy variants.
230logStr :: StringConv a Text => a -> LogStr
202logStr :: StringConv a Text => a -> LogStr
231logStr t = LogStr (B.fromText $ toS t)
203logStr t = LogStr (B.fromText $ toS t)
@@ -250,9 +222,7 @@ newtype ThreadIdText = ThreadIdText {
252mkThreadIdText :: ThreadId -> ThreadIdText
224mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
225+mkThreadIdText = ThreadIdText . T.pack . show
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
258-------------------------------------------------------------------------------
228-------------------------------------------------------------------------------
@@ -272,62 +242,31 @@ data Item a = Item {
272 } deriving (Generic, Functor)
242 } deriving (Generic, Functor)
273makeLenses ''Item
243makeLenses ''Item
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
299instance Show a => Show (Item a) where
246instance Show a => Show (Item a) where
300− showsPrec d Item{..} = showParen (d >= 11) ( showString "Item {"
247+ show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
301− . field "_itemApp" _itemApp
248+ "_itemEnv = " ++ show _itemEnv ++ ", " ++
302− . field "_itemEnv" _itemEnv
303− . field "_itemSeverity" _itemSeverity
249+ "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
304− . field "_itemThread" _itemThread
250+ "_itemThread = " ++ show _itemThread ++ ", " ++
305− . field "_itemHost" _itemHost
251+ "_itemHost = " ++ show _itemHost ++ ", " ++
306− . field "_itemProcess" _itemProcess
252+ "_itemProcess = " ++ show _itemProcess ++ ", " ++
307− . field "_itemPayload" _itemPayload
253+ "_itemPayload = " ++ show _itemPayload ++ ", " ++
308− . field "_itemMessage" _itemMessage
254+ "_itemMessage = " ++ show _itemMessage ++ ", " ++
309− . field "_itemTime" _itemTime
255+ "_itemTime = " ++ show _itemTime ++ ", " ++
310− . field "_itemNamespace" _itemNamespace
256+ "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
311− . showString "_itemLoc = " . shows (LocShow <$> _itemLoc)
257+ "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
315− field n v = showString n . showString " = " . shows v . showString ", "
317newtype LocShow = LocShow Loc
260newtype LocShow = LocShow Loc
320instance Show LocShow where
263instance Show LocShow where
321− showsPrec d (LocShow Loc{..}) = showParen (d >= 11) ( showString "Loc {"
264+ show (LocShow Loc{..}) =
322− . field "loc_filename" loc_filename
265+ "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
323− . field "loc_package" loc_package
266+ "loc_package = " ++ show loc_package ++ ", " ++
324− . field "loc_module" loc_module
267+ "loc_module = " ++ show loc_module ++ ", " ++
325− . field "loc_start" loc_start
268+ "loc_start = " ++ show loc_start ++ ", " ++
326− . showString "loc_end = " . shows loc_end
269+ "loc_end = " ++ show loc_end ++ "}"
330− field n v = showString n . showString " = " . shows v . showString ", "
333instance ToJSON a => ToJSON (Item a) where
272instance ToJSON a => ToJSON (Item a) where
@@ -540,93 +479,52 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
541-- Scribes should always take a 'Severity' and 'Verbosity'.
480-- Scribes should always take a 'Severity' and 'Verbosity'.
543−-- Severity is used to __exclude log messages__ that are lower than
482+-- Severity is used to *exclude log messages* that are < the provided
544−-- the provided Severity. For instance, if the user passes InfoS,
483+-- Severity. For instance, if the user passes InfoS, DebugS items
545−-- DebugS items should be ignored. Katip provides the 'permitItem'
484+-- should be ignored. Katip provides the 'permitItem' utility for this.
546−-- utility for this. The user or the scribe may use 'permitAND' and
547−-- 'permitOR' to further customize this filtering, even dynamically if
550-- Verbosity is used to select keys from the log item's payload. Each
486-- Verbosity is used to select keys from the log item's payload. Each
551-- 'LogItem' instance describes what keys should be retained for each
487-- 'LogItem' instance describes what keys should be retained for each
552-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
488-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
489+-- that should be permitted.
555−-- Scribes provide a finalizer IO action ('scribeFinalizer') that is
491+-- There is no built-in mechanism in katip for telling a scribe that
556−-- meant to synchronously flush any remaining writes and clean up any
492+-- its time to shut down. 'unregisterScribe' merely drops it from the
557−-- resources acquired when the scribe was created. Internally, katip
493+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
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
565−-- While katip internally buffers messages per 'ScribeSettings', it
495+-- 1. Pass in the resource when the scribe is created. Handle
566−-- sends them one at a time to the scribe. Depending on the scribe
496+-- allocation and release of the resource elsewhere. This is what the
567−-- itself, it may make sense for that scribe to keep its own internal
497+-- Handle scribe does.
568−-- buffer to batch-send logs if writing items one at a time is not
498+--
569−-- efficient. The scribe implementer must be sure that on
499+-- 2. Return a finalizing function that tells the scribe to shut
570−-- finalization, all writes are committed synchronously.
500+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns a @IO (Scribe,
571−
501+-- IO ())@. The finalizer will flush any queued log messages and shut
572−-- | Signature of a function passed to `Scribe` constructor and
502+-- down gracefully before returning. This can be hooked into your
573−-- mkScribe* functions that decides which messages to be
503+-- application's shutdown routine to ensure you never miss any log
574−-- logged. Typically filters based on 'Severity', but can be
504+-- messages on shutdown.
575−-- combined with other, custom logic with 'permitAND' and 'permitOR'
576−type PermitFunc = forall a. Item a -> IO Bool
579−-- | AND together 2 permit functions
580−permitAND :: PermitFunc -> PermitFunc -> PermitFunc
581−permitAND f1 f2 = \a -> liftA2 (&&) (f1 a) (f2 a)
583−-- | OR together 2 permit functions
584−permitOR :: PermitFunc -> PermitFunc -> PermitFunc
585−permitOR f1 f2 = \a -> liftA2 (||) (f1 a) (f2 a)
588data Scribe = Scribe {
505data Scribe = Scribe {
589− liPush :: forall a. LogItem a => Item a -> IO ()
506+ liPush :: forall a. LogItem a => Item a -> IO ()
590− -- ^ How do we write an item to the scribe's output?
591− , scribeFinalizer :: IO ()
507+ , scribeFinalizer :: IO ()
592− -- ^ Provide a __blocking__ finalizer to call when your scribe is
508+ -- ^ 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.
509+ -- removed. If this is not relevant to your scribe, return () is
595− , scribePermitItem :: PermitFunc
510+ -- fine.
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'
604−whenM :: Monad m => m Bool -> m () -> m ()
605−whenM mbool = (>>=) mbool . flip when
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
612instance Semigroup Scribe where
514instance Semigroup Scribe where
613− (Scribe pushA finA permitA) <> (Scribe pushB finB permitB) =
515+ (Scribe pushA finA) <> (Scribe pushB finB) =
614− Scribe (\item -> whenM (permitA item) (pushA item)
516+ Scribe (\item -> pushA item >> pushB item) (finA >> finB)
615− >> whenM (permitB item) (pushB item)
617− (finA `finally` finB)
618− (permitOR permitA permitB)
621instance Monoid Scribe where
519instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
520+ mempty = Scribe (const (return ())) (return ())
623 mappend = (<>)
521 mappend = (<>)
626-------------------------------------------------------------------------------
524-------------------------------------------------------------------------------
627data ScribeHandle = ScribeHandle {
525data ScribeHandle = ScribeHandle {
628 shScribe :: Scribe
526 shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
527+ , shChan :: UB.InChan WorkerMessage
@@ -638,9 +536,8 @@ data WorkerMessage where
639-------------------------------------------------------------------------------
537-------------------------------------------------------------------------------
640-- | Should this item be logged given the user's maximum severity?
538-- | 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
539+permitItem :: Severity -> Item a -> Bool
643−permitItem sev item = return (_itemSeverity item >= sev)
540+permitItem sev i = _itemSeverity i >= sev
646-------------------------------------------------------------------------------
543-------------------------------------------------------------------------------
@@ -665,10 +562,10 @@ makeLenses ''LogEnv
667-------------------------------------------------------------------------------
564-------------------------------------------------------------------------------
668−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which
565+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
669−-- updates the timer every 1ms. If you need even more timestamp
566+-- the default settings as the timer. If you are concerned about
670−-- precision at the cost of performance, consider setting
567+-- timestamp precision or event ordering in log outputs like
671−-- '_logEnvTimer' with 'getCurrentTime'.
568+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
672initLogEnv
569initLogEnv
673 :: Namespace
570 :: Namespace
674 -- ^ A base namespace for this application
571 -- ^ A base namespace for this application
@@ -680,15 +577,13 @@ initLogEnv an env = LogEnv
680 <*> getProcessID
577 <*> getProcessID
681 <*> pure an
578 <*> pure an
682 <*> pure env
579 <*> pure env
683− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
580+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
684 <*> pure mempty
581 <*> pure mempty
687-------------------------------------------------------------------------------
584-------------------------------------------------------------------------------
688-- | Add a scribe to the list. All future log calls will go to this
585-- | 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
586+-- scribe in addition to the others.
690−-- ScribeSettings to prevent slow scribes from slowing down
691−-- logging. Writes will be dropped if the buffer fills.
692registerScribe
587registerScribe
694 -- ^ Name the scribe
589 -- ^ Name the scribe
@@ -697,43 +592,41 @@ registerScribe
697 -> LogEnv
592 -> LogEnv
698 -> IO LogEnv
593 -> IO LogEnv
699registerScribe nm scribe ScribeSettings {..} le = do
594registerScribe nm scribe ScribeSettings {..} le = do
700− queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
595+ (inChan, outChan) <- UB.newChan scribeBufferSize
701− worker <- spawnScribeWorker scribe queue
596+ worker <- spawnScribeWorker scribe outChan
702 let fin = do
597 let fin = do
703− atomically (BQ.writeTBQueue queue PoisonPill)
598+ UB.writeChan inChan PoisonPill
704 -- wait for our worker to finish final write
599 -- wait for our worker to finish final write
705 void (Async.waitCatch worker)
600 void (Async.waitCatch worker)
601+ --TODO: safe exceptions
706 -- wait for scribe to finish final write
602 -- wait for scribe to finish final write
707− void (scribeFinalizer scribe)
603+ scribeFinalizer scribe
709− let sh = ScribeHandle (scribe { scribeFinalizer = fin }) queue
605+ let sh = ScribeHandle (scribe { scribeFinalizer = fin }) inChan
710 return (le & logEnvScribes %~ M.insert nm sh)
606 return (le & logEnvScribes %~ M.insert nm sh)
713-------------------------------------------------------------------------------
609-------------------------------------------------------------------------------
610+--TODO: should do some reasonable exception handling in the scribe, don't want to crash the loop
714−spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
611+spawnScribeWorker :: Scribe -> UB.OutChan WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
612+spawnScribeWorker (Scribe write _) outChan = Async.async go
718− newCmd <- atomically (BQ.readTBQueue queue)
615+ newCmd <- UB.readChan outChan
719 case newCmd of
616 case newCmd of
720 NewItem a -> do
617 NewItem a -> do
721− -- Swallow any direct exceptions from the
722− -- scribe. safe-exceptions won't catch async exceptions.
723− void (tryAny (write a))
618+ write a
725 PoisonPill -> return ()
620 PoisonPill -> return ()
728-------------------------------------------------------------------------------
623-------------------------------------------------------------------------------
729data ScribeSettings = ScribeSettings {
624data ScribeSettings = ScribeSettings {
730− _scribeBufferSize :: Int
625+ scribeBufferSize :: Int
734−makeLenses ''ScribeSettings
629+--TODO: standardize on american or british spelling of finali{z,s}er
737-- | Reasonable defaults for a scribe. Buffer
630-- | Reasonable defaults for a scribe. Buffer
738-- size of 4096.
631-- size of 4096.
739defaultScribeSettings :: ScribeSettings
632defaultScribeSettings :: ScribeSettings
@@ -741,60 +634,30 @@ defaultScribeSettings = ScribeSettings 4096
743-------------------------------------------------------------------------------
636-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
637+-- | Remove a scribe from the list. All future log calls will no
745−-- the scribe. This mainly only makes sense to use with something like
638+-- longer use this scribe. If there is a finalizer, it will be called
746−-- MonadReader's @local@ function to temporarily disavow a single
639+-- in a blocking manner.
747−-- logger for a block of code.
748unregisterScribe
640unregisterScribe
750− -- ^ Name of the scribe
753−unregisterScribe nm = logEnvScribes %~ M.delete nm
756−-------------------------------------------------------------------------------
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.
764−clearScribes = logEnvScribes .~ mempty
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.
775 -- ^ Name of the scribe
642 -- ^ Name of the scribe
776 -> LogEnv
643 -> LogEnv
777 -> IO LogEnv
644 -> IO LogEnv
778−closeScribe nm le = do
645+unregisterScribe nm le = do
779 maybe (return ()) (scribeFinalizer . shScribe) (M.lookup nm (_logEnvScribes le))
646 maybe (return ()) (scribeFinalizer . shScribe) (M.lookup nm (_logEnvScribes le))
780 return (le & logEnvScribes %~ M.delete nm)
647 return (le & logEnvScribes %~ M.delete nm)
783-------------------------------------------------------------------------------
650-------------------------------------------------------------------------------
784−-- | Call this at the end of your program. This is a blocking call
651+-- | Unregister *all* scribes. Logs will go off into space from this
785−-- that stop writing to a scribe's queue, waits for the queue to
652+-- point onward until new scribes are added. Note that you could use
786−-- empty, finalizes each scribe in the log environment and then
653+-- this with `local` if you're using a Reader based stack to
787−-- removes it. Finalizers are all run even if one of them throws, but
654+-- temporarily disable log output. See `katipNoLogging` for an
788−-- the exception will be re-thrown at the end.
655+-- example.
789−closeScribes
656+clearScribes
790 :: LogEnv
657 :: LogEnv
791 -> IO LogEnv
658 -> IO LogEnv
792−closeScribes le = do
659+clearScribes le =
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)]
660+ foldrM unregisterScribe le (M.keys (_logEnvScribes le))
796− FT.foldr finally (return ()) actions
797− return (le & logEnvScribes .~ mempty)
800-------------------------------------------------------------------------------
663-------------------------------------------------------------------------------
@@ -807,86 +670,44 @@ closeScribes le = do
807-- which keeps a namespace and merged context. You can write simple
670-- which keeps a namespace and merged context. You can write simple
808-- functions that add additional namespacing and merges additional
671-- functions that add additional namespacing and merges additional
809-- context on the fly.
672-- context on the fly.
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.
815class MonadIO m => Katip m where
673class MonadIO m => Katip m where
816 getLogEnv :: m LogEnv
674 getLogEnv :: m LogEnv
817− localLogEnv :: (LogEnv -> LogEnv) -> m a -> m a
820instance Katip m => Katip (ReaderT s m) where
677instance Katip m => Katip (ReaderT s m) where
821 getLogEnv = lift getLogEnv
678 getLogEnv = lift getLogEnv
822− localLogEnv = mapReaderT . localLogEnv
825−#if !MIN_VERSION_either(4, 5, 0)
826instance Katip m => Katip (EitherT s m) where
681instance Katip m => Katip (EitherT s m) where
827 getLogEnv = lift getLogEnv
682 getLogEnv = lift getLogEnv
828− localLogEnv = mapEitherT . localLogEnv
832instance Katip m => Katip (ExceptT s m) where
684instance Katip m => Katip (ExceptT s m) where
833 getLogEnv = lift getLogEnv
685 getLogEnv = lift getLogEnv
834− localLogEnv = mapExceptT . localLogEnv
837instance Katip m => Katip (MaybeT m) where
687instance Katip m => Katip (MaybeT m) where
838 getLogEnv = lift getLogEnv
688 getLogEnv = lift getLogEnv
839− localLogEnv = mapMaybeT . localLogEnv
842instance Katip m => Katip (StateT s m) where
691instance Katip m => Katip (StateT s m) where
843 getLogEnv = lift getLogEnv
692 getLogEnv = lift getLogEnv
844− localLogEnv = mapStateT . localLogEnv
847−instance (Katip m, Monoid w) => Katip (RWST r w s m) where
848− getLogEnv = lift getLogEnv
849− localLogEnv = mapRWST . localLogEnv
852−instance (Katip m, Monoid w) => Katip (Strict.RWST r w s m) where
853− getLogEnv = lift getLogEnv
854− localLogEnv = Strict.mapRWST . localLogEnv
857−instance Katip m => Katip (Strict.StateT s m) where
858− getLogEnv = lift getLogEnv
859− localLogEnv = Strict.mapStateT . localLogEnv
862instance (Katip m, Monoid s) => Katip (WriterT s m) where
695instance (Katip m, Monoid s) => Katip (WriterT s m) where
863 getLogEnv = lift getLogEnv
696 getLogEnv = lift getLogEnv
864− localLogEnv = mapWriterT . localLogEnv
867−instance (Katip m, Monoid s) => Katip (Strict.WriterT s m) where
868− getLogEnv = lift getLogEnv
869− localLogEnv = Strict.mapWriterT . localLogEnv
872instance (Katip m) => Katip (ResourceT m) where
698instance (Katip m) => Katip (ResourceT m) where
873 getLogEnv = lift getLogEnv
699 getLogEnv = lift getLogEnv
874− localLogEnv = transResourceT . localLogEnv
877-------------------------------------------------------------------------------
702-------------------------------------------------------------------------------
878−-- | A concrete monad you can use to run logging actions. Use this if
703+-- | A concrete monad you can use to run logging actions.
879−-- you prefer an explicit monad transformer stack and adding layers as
880−-- opposed to implementing 'Katip' for your monad.
881newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
704newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882 deriving ( Functor, Applicative, Monad, MonadIO
705 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
706+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
887instance MonadIO m => Katip (KatipT m) where
709instance MonadIO m => Katip (KatipT m) where
888 getLogEnv = KatipT ask
710 getLogEnv = KatipT ask
889− localLogEnv f (KatipT m) = KatipT $ local f m
892instance MonadTransControl KatipT where
713instance MonadTransControl KatipT where
@@ -902,21 +723,6 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
902 liftBaseWith = defaultLiftBaseWith
723 liftBaseWith = defaultLiftBaseWith
903 restoreM = defaultRestoreM
724 restoreM = defaultRestoreM
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)
910− askUnliftIO = KatipT $
911− withUnliftIO $ \u ->
912− pure (UnliftIO (unliftIO u . unKatipT))
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)
921-------------------------------------------------------------------------------
727-------------------------------------------------------------------------------
922-- | Execute 'KatipT' on a log env.
728-- | Execute 'KatipT' on a log env.
@@ -924,17 +730,6 @@ runKatipT :: LogEnv -> KatipT m a -> m a
924runKatipT le (KatipT f) = runReaderT f le
730runKatipT le (KatipT f) = runReaderT f le
927−-------------------------------------------------------------------------------
928−-- | Disable all scribes for the given monadic action, then restore
929−-- them afterwards. Works in any Katip monad.
935−katipNoLogging = localLogEnv (\le -> set logEnvScribes mempty le)
938-------------------------------------------------------------------------------
733-------------------------------------------------------------------------------
939-- | Log with everything, including a source code location. This is
734-- | Log with everything, including a source code location. This is
940-- very low level and you typically can use 'logT' in its place.
735-- very low level and you typically can use 'logT' in its place.
@@ -948,43 +743,20 @@ logItem
949logItem a ns loc sev msg = do
744logItem a ns loc sev msg = do
950 LogEnv{..} <- getLogEnv
745 LogEnv{..} <- getLogEnv
951− logKatipItem =<< liftIO
746+ liftIO $ do
952− (Item <$> pure _logEnvApp
748+ <$> pure _logEnvApp
953− <*> pure _logEnvEnv
749+ <*> pure _logEnvEnv
954− <*> pure sev
750+ <*> pure sev
955− <*> (mkThreadIdText <$> myThreadId)
751+ <*> (mkThreadIdText <$> myThreadId)
956− <*> pure _logEnvHost
752+ <*> pure _logEnvHost
957− <*> pure _logEnvPid
753+ <*> pure _logEnvPid
958− <*> pure a
754+ <*> pure a
959− <*> pure msg
755+ <*> pure msg
960− <*> _logEnvTimer
756+ <*> _logEnvTimer
961− <*> pure (_logEnvApp <> ns)
757+ <*> pure (_logEnvApp <> ns)
962− <*> pure loc)
758+ <*> pure loc
964−-- | Log already constructed 'Item'. This is the lowest level function that other log*
966−-- It can be useful when implementing centralised logging services.
968− :: (A.Applicative m, LogItem a, Katip m)
971−logKatipItem item = do
972− LogEnv{..} <- getLogEnv
974− FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> do
759+ FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> UB.tryWriteChan shChan (NewItem item)
975− whenM (scribePermitItem shScribe item) $
976− void $ atomically (tryWriteTBQueue shChan (NewItem item))
978−-------------------------------------------------------------------------------
984−tryWriteTBQueue q a = do
985− full <- isFullTBQueue q
986− unless full (writeTBQueue q a)
990-------------------------------------------------------------------------------
762-------------------------------------------------------------------------------
@@ -1016,10 +788,10 @@ logException
1016 -> Severity -- ^ Severity
788 -> Severity -- ^ Severity
1017 -> m b -- ^ Main action being run
789 -> m b -- ^ Main action being run
1019−logException a ns sev action = action `catchAny` \e -> f e >> throwM e
791+logException a ns sev action = action `catchAll` \e -> f e >> throwM e
1021 f e = logF a ns sev (msg e)
793 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
794+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1025-------------------------------------------------------------------------------
797-------------------------------------------------------------------------------
@@ -1073,15 +845,11 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
1073-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
845-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1074-- callstacks when available (GHC > 7.8).
846-- callstacks when available (GHC > 7.8).
1075#if MIN_VERSION_base(4, 8, 0)
847#if MIN_VERSION_base(4, 8, 0)
1076−getLoc :: HasCallStack => Maybe Loc
848+getLoc :: (?loc :: CallStack) => Maybe Loc
1077−getLoc = case getCallStack callStack of
849+getLoc = case getCallStack ?loc of
1078 [] -> Nothing
850 [] -> Nothing
1079− xs -> Just . toLoc . head $ filter filterKatip xs
851+ xs -> Just . toLoc . last $ xs
1081− filterKatip :: (String, SrcLoc) -> Bool
1082− filterKatip (_, srcloc) = not $
1083− "katip-" `isPrefixOf` srcLocPackage srcloc
1085 toLoc :: (String, SrcLoc) -> Loc
853 toLoc :: (String, SrcLoc) -> Loc
1086 toLoc (_, l) = Loc {
854 toLoc (_, l) = Loc {
1087 loc_filename = srcLocFile l
855 loc_filename = srcLocFile l
@@ -1112,7 +880,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1114-------------------------------------------------------------------------------
882-------------------------------------------------------------------------------
1115−-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
883+-- | 'Loc'-tagged logging using implicit-callstacks when available.
1117-- This function does not require template-haskell as it
885-- This function does not require template-haskell as it
1118-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
886-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1123,7 +891,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1124-- @logLoc obj mempty InfoS "Hello world"@
892-- @logLoc obj mempty InfoS "Hello world"@
1125#if MIN_VERSION_base(4, 8, 0)
893#if MIN_VERSION_base(4, 8, 0)
1126−logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
894+logLoc :: (Applicative m, LogItem a, Katip m, ?loc :: CallStack)
1128logLoc :: (Applicative m, LogItem a, Katip m)
896logLoc :: (Applicative m, LogItem a, Katip m)