@@ -7,6 +7,7 @@
77{-# LANGUAGE FlexibleInstances #-}
88{-# LANGUAGE GADTs #-}
99{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10+{-# LANGUAGE ImplicitParams #-}
1011{-# LANGUAGE MultiParamTypeClasses #-}
1112{-# LANGUAGE OverloadedStrings #-}
1213{-# LANGUAGE RankNTypes #-}
@@ -22,53 +23,44 @@
2223module Katip.Core where
2324
2425-------------------------------------------------------------------------------
25−import Control.Applicative as A
26+import Control.Applicative as A
2627import Control.AutoUpdate
2728import Control.Concurrent
28−import qualified Control.Concurrent.Async as Async
29+import qualified Control.Concurrent.Async as Async
2930import Control.Concurrent.STM
30−import qualified Control.Concurrent.STM.TBQueue as BQ
31+import qualified Control.Concurrent.STM.TBQueue as BQ
3132import Control.Exception.Safe
32−import Control.Monad (unless, void, when)
33+import Control.Monad (unless, void)
3334import Control.Monad.Base
34−#if MIN_VERSION_base(4, 9, 0)
35−import qualified Control.Monad.Fail as MF
36−#endif
3735import Control.Monad.IO.Class
38−import Control.Monad.IO.Unlift
3936import Control.Monad.Trans.Class
4037import Control.Monad.Trans.Control
41−#if !MIN_VERSION_either(4, 5, 0)
4238import Control.Monad.Trans.Either
43−#endif
4439import Control.Monad.Trans.Except
4540import Control.Monad.Trans.Maybe
4641import 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
42+import Control.Monad.Trans.Resource (ResourceT, transResourceT)
43+import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
44+import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
45+import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
46+import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT, mapWriterT)
47+import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
48+import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
49+import Data.Aeson (FromJSON (..), ToJSON (..),
50+ object)
51+import qualified Data.Aeson as A
52+import Data.Foldable as FT
53+import qualified Data.HashMap.Strict as HM
6154import Data.List
62−import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
64−import Data.Semigroup as SG
55+import qualified Data.Map.Strict as M
56+import Data.Semigroup
6557import Data.String
6658import Data.String.Conv
67−import Data.Text (Text)
68−import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
59+import Data.Text (Text)
60+import qualified Data.Text as T
61+import qualified Data.Text.Lazy.Builder as B
7062import Data.Time
71−import GHC.Generics hiding (to)
63+import GHC.Generics hiding (to)
7264#if MIN_VERSION_base(4, 8, 0)
7365#if !MIN_VERSION_base(4, 9, 0)
7466import GHC.SrcLoc
@@ -76,7 +68,7 @@ import GHC.SrcLoc
7668import GHC.Stack
7769#endif
7870import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
71+import qualified Language.Haskell.TH.Syntax as TH
8072import Lens.Micro
8173import Lens.Micro.TH
8274import Network.HostName
@@ -103,7 +95,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
10395-- IsString/OverloadedStrings, so "foo" will result in Namespace
10496-- ["foo"].
10597newtype Namespace = Namespace { unNamespace :: [Text] }
106− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
98+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
10799
108100instance IsString Namespace where
109101 fromString s = Namespace [fromString s]
@@ -143,7 +135,7 @@ data Severity
143135-- - 'V3' implies the maximum amount of payload information.
144136-- - Anything in between is left to the discretion of the developer.
145137data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
138+ deriving (Eq, Ord, Show, Read, Generic, Enum)
147139
148140
149141-------------------------------------------------------------------------------
@@ -184,26 +176,11 @@ instance FromJSON Severity where
184176 Just x -> return x
185177 Nothing -> fail $ "Invalid Severity " ++ toS t
186178
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−
202179
203180-------------------------------------------------------------------------------
204181-- | Log message with Builder underneath; use '<>' to concat in O(1).
205182newtype LogStr = LogStr { unLogStr :: B.Builder }
206− deriving (Generic, Show, Eq)
183+ deriving (Generic, Show)
207184
208185instance IsString LogStr where
209186 fromString = LogStr . B.fromString
@@ -250,9 +227,7 @@ newtype ThreadIdText = ThreadIdText {
250227
251228
252229mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
254− where
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
230+mkThreadIdText = ThreadIdText . T.pack . show
256231
257232
258233-------------------------------------------------------------------------------
@@ -272,62 +247,31 @@ data Item a = Item {
272247 } deriving (Generic, Functor)
273248makeLenses ''Item
274249
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− ]
298250
299251instance 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 ", "
252+ show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
253+ "_itemEnv = " ++ show _itemEnv ++ ", " ++
254+ "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
255+ "_itemThread = " ++ show _itemThread ++ ", " ++
256+ "_itemHost = " ++ show _itemHost ++ ", " ++
257+ "_itemProcess = " ++ show _itemProcess ++ ", " ++
258+ "_itemPayload = " ++ show _itemPayload ++ ", " ++
259+ "_itemMessage = " ++ show _itemMessage ++ ", " ++
260+ "_itemTime = " ++ show _itemTime ++ ", " ++
261+ "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
262+ "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
263+
316264
317265newtype LocShow = LocShow Loc
318266
319267
320268instance 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 ", "
269+ show (LocShow Loc{..}) =
270+ "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
271+ "loc_package = " ++ show loc_package ++ ", " ++
272+ "loc_module = " ++ show loc_module ++ ", " ++
273+ "loc_start = " ++ show loc_start ++ ", " ++
274+ "loc_end = " ++ show loc_end ++ "}"
331275
332276
333277instance ToJSON a => ToJSON (Item a) where
@@ -540,93 +484,52 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
540484--
541485-- Scribes should always take a 'Severity' and 'Verbosity'.
542486--
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.
487+-- Severity is used to *exclude log messages* that are < the provided
488+-- Severity. For instance, if the user passes InfoS, DebugS items
489+-- should be ignored. Katip provides the 'permitItem' utility for this.
549490--
550491-- Verbosity is used to select keys from the log item's payload. Each
551492-- 'LogItem' instance describes what keys should be retained for each
552493-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
494+-- that should be permitted.
554495--
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.
496+-- There is no built-in mechanism in katip for telling a scribe that
497+-- its time to shut down. 'unregisterScribe' merely drops it from the
498+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
564499--
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)
586−
587−
500+-- 1. Pass in the resource when the scribe is created. Handle
501+-- allocation and release of the resource elsewhere. This is what the
502+-- Handle scribe does.
503+--
504+-- 2. Return a finalizing function that tells the scribe to shut
505+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns an @IO (Scribe,
506+-- IO ())@. The finalizer will flush any queued log messages and shut
507+-- down gracefully before returning. This can be hooked into your
508+-- application's shutdown routine to ensure you never miss any log
509+-- messages on shutdown.
588510data 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'
511+ liPush :: forall a. LogItem a => Item a -> IO ()
512+ , scribeFinalizer :: IO ()
513+ -- ^ Provide a *blocking* finalizer to call when your scribe is
514+ -- removed. If this is not relevant to your scribe, return () is
515+ -- fine.
601516 }
602517
603518
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.
612519instance 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)
520+ (Scribe pushA finA) <> (Scribe pushB finB) =
521+ Scribe (\item -> pushA item >> pushB item) (finA `finally` finB)
619522
620523
621524instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
525+ mempty = Scribe (const (return ())) (return ())
623526 mappend = (<>)
624527
625528
626529-------------------------------------------------------------------------------
627530data ScribeHandle = ScribeHandle {
628531 shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
532+ , shChan :: BQ.TBQueue WorkerMessage
630533 }
631534
632535
@@ -638,9 +541,8 @@ data WorkerMessage where
638541
639542-------------------------------------------------------------------------------
640543-- | 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)
544+permitItem :: Severity -> Item a -> Bool
545+permitItem sev i = _itemSeverity i >= sev
644546
645547
646548-------------------------------------------------------------------------------
@@ -665,10 +567,10 @@ makeLenses ''LogEnv
665567
666568
667569-------------------------------------------------------------------------------
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'.
570+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
571+-- the default settings as the timer. If you are concerned about
572+-- timestamp precision or event ordering in log outputs like
573+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
672574initLogEnv
673575 :: Namespace
674576 -- ^ A base namespace for this application
@@ -680,15 +582,13 @@ initLogEnv an env = LogEnv
680582 <*> getProcessID
681583 <*> pure an
682584 <*> pure env
683− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
585+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
684586 <*> pure mempty
685587
686588
687589-------------------------------------------------------------------------------
688590-- | 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.
591+-- scribe in addition to the others.
692592registerScribe
693593 :: Text
694594 -- ^ Name the scribe
@@ -697,7 +597,7 @@ registerScribe
697597 -> LogEnv
698598 -> IO LogEnv
699599registerScribe nm scribe ScribeSettings {..} le = do
700− queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
600+ queue <- atomically (BQ.newTBQueue _scribeBufferSize)
701601 worker <- spawnScribeWorker scribe queue
702602 let fin = do
703603 atomically (BQ.writeTBQueue queue PoisonPill)
@@ -712,7 +612,7 @@ registerScribe nm scribe ScribeSettings {..} le = do
712612
713613-------------------------------------------------------------------------------
714614spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
615+spawnScribeWorker (Scribe write _) queue = Async.async go
716616 where
717617 go = do
718618 newCmd <- atomically (BQ.readTBQueue queue)
@@ -729,7 +629,6 @@ spawnScribeWorker (Scribe write _ _) queue = Async.async go
729629data ScribeSettings = ScribeSettings {
730630 _scribeBufferSize :: Int
731631 }
732− deriving (Show, Eq)
733632
734633makeLenses ''ScribeSettings
735634
@@ -741,7 +640,7 @@ defaultScribeSettings = ScribeSettings 4096
741640
742641
743642-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
643+-- | Remove a scribe from the environment. This does *not* finalize
745644-- the scribe. This mainly only makes sense to use with something like
746645-- MonadReader's @local@ function to temporarily disavow a single
747646-- logger for a block of code.
@@ -754,7 +653,7 @@ unregisterScribe nm = logEnvScribes %~ M.delete nm
754653
755654
756655-------------------------------------------------------------------------------
757−-- | Unregister __all__ scribes. Note that this is __not__ for closing or
656+-- | Unregister *all* scribes. Note that this is *not* for closing or
758657-- finalizing scribes, use 'closeScribes' for that. This mainly only
759658-- makes sense to use with something like MonadReader's @local@
760659-- function to temporarily disavow any loggers for a block of code.
@@ -766,10 +665,9 @@ clearScribes = logEnvScribes .~ mempty
766665
767666-------------------------------------------------------------------------------
768667-- | 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.
668+-- its finalizer is called and it can never be written to again. Note
669+-- that this will throw any exceptions yoru finalizer will throw, and
670+-- that LogEnv is immutable, so it will not be removed in that case.
773671closeScribe
774672 :: Text
775673 -- ^ Name of the scribe
@@ -822,11 +720,9 @@ instance Katip m => Katip (ReaderT s m) where
822720 localLogEnv = mapReaderT . localLogEnv
823721
824722
825−#if !MIN_VERSION_either(4, 5, 0)
826723instance Katip m => Katip (EitherT s m) where
827724 getLogEnv = lift getLogEnv
828725 localLogEnv = mapEitherT . localLogEnv
829−#endif
830726
831727
832728instance Katip m => Katip (ExceptT s m) where
@@ -875,13 +771,10 @@ instance (Katip m) => Katip (ResourceT m) where
875771
876772
877773-------------------------------------------------------------------------------
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.
774+-- | A concrete monad you can use to run logging actions.
881775newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882776 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
884− , MonadBase b)
777+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
885778
886779
887780instance MonadIO m => Katip (KatipT m) where
@@ -902,21 +795,6 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
902795 liftBaseWith = defaultLiftBaseWith
903796 restoreM = defaultRestoreM
904797
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
920798
921799-------------------------------------------------------------------------------
922800-- | Execute 'KatipT' on a log env.
@@ -948,32 +826,21 @@ logItem
948826 -> m ()
949827logItem a ns loc sev msg = do
950828 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))
829+ liftIO $ do
830+ item <- Item
831+ <$> pure _logEnvApp
832+ <*> pure _logEnvEnv
833+ <*> pure sev
834+ <*> (mkThreadIdText <$> myThreadId)
835+ <*> pure _logEnvHost
836+ <*> pure _logEnvPid
837+ <*> pure a
838+ <*> pure msg
839+ <*> _logEnvTimer
840+ <*> pure (_logEnvApp <> ns)
841+ <*> pure loc
842+ FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> atomically (tryWriteTBQueue shChan (NewItem item))
843+
977844
978845-------------------------------------------------------------------------------
979846tryWriteTBQueue
@@ -986,7 +853,6 @@ tryWriteTBQueue q a = do
986853 unless full (writeTBQueue q a)
987854 return (not full)
988855
989−
990856-------------------------------------------------------------------------------
991857-- | Log with full context, but without any code location.
992858logF
@@ -1019,7 +885,7 @@ logException
1019885logException a ns sev action = action `catchAny` \e -> f e >> throwM e
1020886 where
1021887 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
888+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1023889
1024890
1025891-------------------------------------------------------------------------------
@@ -1073,15 +939,11 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
1073939-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1074940-- callstacks when available (GHC > 7.8).
1075941#if MIN_VERSION_base(4, 8, 0)
1076−getLoc :: HasCallStack => Maybe Loc
1077−getLoc = case getCallStack callStack of
942+getLoc :: (?loc :: CallStack) => Maybe Loc
943+getLoc = case getCallStack ?loc of
1078944 [] -> Nothing
1079− xs -> Just . toLoc . head $ filter filterKatip xs
945+ xs -> Just . toLoc . last $ xs
1080946 where
1081− filterKatip :: (String, SrcLoc) -> Bool
1082− filterKatip (_, srcloc) = not $
1083− "katip-" `isPrefixOf` srcLocPackage srcloc
1084−
1085947 toLoc :: (String, SrcLoc) -> Loc
1086948 toLoc (_, l) = Loc {
1087949 loc_filename = srcLocFile l
@@ -1112,7 +974,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1112974
1113975
1114976-------------------------------------------------------------------------------
1115−-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
977+-- | 'Loc'-tagged logging using implicit-callstacks when available.
1116978--
1117979-- This function does not require template-haskell as it
1118980-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1123,7 +985,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1123985--
1124986-- @logLoc obj mempty InfoS "Hello world"@
1125987#if MIN_VERSION_base(4, 8, 0)
1126−logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
988+logLoc :: (Applicative m, LogItem a, Katip m, ?loc :: CallStack)
1127989#else
1128990logLoc :: (Applicative m, LogItem a, Katip m)
1129991#endif