@@ -7,7 +7,6 @@
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE GADTs #-}
8{-# LANGUAGE GADTs #-}
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10−{-# LANGUAGE ImplicitParams #-}
11{-# LANGUAGE MultiParamTypeClasses #-}
10{-# LANGUAGE MultiParamTypeClasses #-}
12{-# LANGUAGE OverloadedStrings #-}
11{-# LANGUAGE OverloadedStrings #-}
13{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
@@ -23,15 +22,18 @@
23module Katip.Core where
22module Katip.Core where
25-------------------------------------------------------------------------------
24-------------------------------------------------------------------------------
26−import Control.Applicative as A
25+import Control.Applicative as A
27import Control.AutoUpdate
26import Control.AutoUpdate
28import Control.Concurrent
27import Control.Concurrent
29−import qualified Control.Concurrent.Async as Async
28+import qualified Control.Concurrent.Async as Async
30import Control.Concurrent.STM
29import Control.Concurrent.STM
31−import qualified Control.Concurrent.STM.TBQueue as BQ
30+import qualified Control.Concurrent.STM.TBQueue as BQ
32import Control.Exception.Safe
31import Control.Exception.Safe
33−import Control.Monad (unless, void)
32+import Control.Monad (unless, void, when)
34import Control.Monad.Base
33import Control.Monad.Base
34+#if MIN_VERSION_base(4, 9, 0)
35+import qualified Control.Monad.Fail as MF
35import Control.Monad.IO.Class
37import Control.Monad.IO.Class
36import Control.Monad.IO.Unlift
38import Control.Monad.IO.Unlift
37import Control.Monad.Trans.Class
39import Control.Monad.Trans.Class
@@ -42,28 +44,31 @@ import Control.Monad.Trans.Either
42import Control.Monad.Trans.Except
44import Control.Monad.Trans.Except
43import Control.Monad.Trans.Maybe
45import Control.Monad.Trans.Maybe
44import Control.Monad.Trans.Reader
46import Control.Monad.Trans.Reader
45−import Control.Monad.Trans.Resource (ResourceT, transResourceT)
47+import Control.Monad.Trans.Resource (MonadResource, ResourceT,
46−import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
49+import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
47−import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
50+import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
48−import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
51+import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
49−import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT, mapWriterT)
52+import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
50−import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
53+import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
51−import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
54+import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT,
52−import Data.Aeson (FromJSON (..), ToJSON (..),
56+import Data.Aeson (FromJSON (..), ToJSON (..),
54−import qualified Data.Aeson as A
58+import qualified Data.Aeson as A
55−import Data.Foldable as FT
59+import Data.Foldable as FT
56−import qualified Data.HashMap.Strict as HM
60+import qualified Data.HashMap.Strict as HM
57import Data.List
61import Data.List
58−import qualified Data.Map.Strict as M
62+import qualified Data.Map.Strict as M
59−import Data.Semigroup
63+import Data.Maybe (fromMaybe)
64+import Data.Semigroup as SG
60import Data.String
65import Data.String
61import Data.String.Conv
66import Data.String.Conv
62−import Data.Text (Text)
67+import Data.Text (Text)
63−import qualified Data.Text as T
68+import qualified Data.Text as T
64−import qualified Data.Text.Lazy.Builder as B
69+import qualified Data.Text.Lazy.Builder as B
65import Data.Time
70import Data.Time
66−import GHC.Generics hiding (to)
71+import GHC.Generics hiding (to)
67#if MIN_VERSION_base(4, 8, 0)
72#if MIN_VERSION_base(4, 8, 0)
68#if !MIN_VERSION_base(4, 9, 0)
73#if !MIN_VERSION_base(4, 9, 0)
69import GHC.SrcLoc
74import GHC.SrcLoc
@@ -71,7 +76,7 @@ import GHC.SrcLoc
71import GHC.Stack
76import GHC.Stack
73import Language.Haskell.TH
78import Language.Haskell.TH
74−import qualified Language.Haskell.TH.Syntax as TH
79+import qualified Language.Haskell.TH.Syntax as TH
75import Lens.Micro
80import Lens.Micro
76import Lens.Micro.TH
81import Lens.Micro.TH
77import Network.HostName
82import Network.HostName
@@ -98,7 +103,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
98-- IsString/OverloadedStrings, so "foo" will result in Namespace
103-- IsString/OverloadedStrings, so "foo" will result in Namespace
99-- ["foo"].
104-- ["foo"].
100newtype Namespace = Namespace { unNamespace :: [Text] }
105newtype Namespace = Namespace { unNamespace :: [Text] }
101− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
106+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
103instance IsString Namespace where
108instance IsString Namespace where
104 fromString s = Namespace [fromString s]
109 fromString s = Namespace [fromString s]
@@ -138,7 +143,7 @@ data Severity
138-- - 'V3' implies the maximum amount of payload information.
143-- - 'V3' implies the maximum amount of payload information.
139-- - Anything in between is left to the discretion of the developer.
144-- - Anything in between is left to the discretion of the developer.
140data Verbosity = V0 | V1 | V2 | V3
145data Verbosity = V0 | V1 | V2 | V3
141− deriving (Eq, Ord, Show, Read, Generic, Enum)
146+ deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
144-------------------------------------------------------------------------------
149-------------------------------------------------------------------------------
@@ -179,6 +184,21 @@ instance FromJSON Severity where
179 Just x -> return x
184 Just x -> return x
180 Nothing -> fail $ "Invalid Severity " ++ toS t
185 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
183-------------------------------------------------------------------------------
203-------------------------------------------------------------------------------
184-- | Log message with Builder underneath; use '<>' to concat in O(1).
204-- | Log message with Builder underneath; use '<>' to concat in O(1).
@@ -230,7 +250,9 @@ newtype ThreadIdText = ThreadIdText {
232mkThreadIdText :: ThreadId -> ThreadIdText
252mkThreadIdText :: ThreadId -> ThreadIdText
233−mkThreadIdText = ThreadIdText . T.pack . show
253+mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
255+ stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
236-------------------------------------------------------------------------------
258-------------------------------------------------------------------------------
@@ -518,52 +540,93 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
519-- Scribes should always take a 'Severity' and 'Verbosity'.
541-- Scribes should always take a 'Severity' and 'Verbosity'.
521−-- Severity is used to *exclude log messages* that are < the provided
543+-- Severity is used to __exclude log messages__ that are lower than
522−-- Severity. For instance, if the user passes InfoS, DebugS items
544+-- the provided Severity. For instance, if the user passes InfoS,
523−-- should be ignored. Katip provides the 'permitItem' utility for this.
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
525-- Verbosity is used to select keys from the log item's payload. Each
550-- Verbosity is used to select keys from the log item's payload. Each
526-- 'LogItem' instance describes what keys should be retained for each
551-- 'LogItem' instance describes what keys should be retained for each
527-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
552-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
528−-- that should be permitted.
553+-- that should be written.
530−-- There is no built-in mechanism in katip for telling a scribe that
531−-- its time to shut down. 'unregisterScribe' merely drops it from the
532−-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
534−-- 1. Pass in the resource when the scribe is created. Handle
555+-- Scribes provide a finalizer IO action ('scribeFinalizer') that is
535−-- allocation and release of the resource elsewhere. This is what the
556+-- meant to synchronously flush any remaining writes and clean up any
536−-- Handle scribe does.
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
538−-- 2. Return a finalizing function that tells the scribe to shut
565+-- While katip internally buffers messages per 'ScribeSettings', it
539−-- down. @katip-elasticsearch@'s @mkEsScribe@ returns an @IO (Scribe,
566+-- sends them one at a time to the scribe. Depending on the scribe
540−-- IO ())@. The finalizer will flush any queued log messages and shut
567+-- itself, it may make sense for that scribe to keep its own internal
541−-- down gracefully before returning. This can be hooked into your
568+-- buffer to batch-send logs if writing items one at a time is not
542−-- application's shutdown routine to ensure you never miss any log
569+-- efficient. The scribe implementer must be sure that on
543−-- messages on shutdown.
570+-- finalization, all writes are committed synchronously.
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
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)
544data Scribe = Scribe {
588data Scribe = Scribe {
545− liPush :: forall a. LogItem a => Item a -> IO ()
589+ liPush :: forall a. LogItem a => Item a -> IO ()
590+ -- ^ How do we write an item to the scribe's output?
546− , scribeFinalizer :: IO ()
591+ , scribeFinalizer :: IO ()
547− -- ^ Provide a *blocking* finalizer to call when your scribe is
592+ -- ^ Provide a __blocking__ finalizer to call when your scribe is
593+ -- removed. All pending writes should be flushed synchronously. If
548− -- removed. If this is not relevant to your scribe, return () is
594+ -- this is not relevant to your scribe, return () is fine.
549− -- 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'
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
553instance Semigroup Scribe where
612instance Semigroup Scribe where
554− (Scribe pushA finA) <> (Scribe pushB finB) =
613+ (Scribe pushA finA permitA) <> (Scribe pushB finB permitB) =
614+ Scribe (\item -> whenM (permitA item) (pushA item)
615+ >> whenM (permitB item) (pushB item)
555− Scribe (\item -> pushA item >> pushB item) (finA `finally` finB)
617+ (finA `finally` finB)
618+ (permitOR permitA permitB)
558instance Monoid Scribe where
621instance Monoid Scribe where
559− mempty = Scribe (const (return ())) (return ())
622+ mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
560 mappend = (<>)
623 mappend = (<>)
563-------------------------------------------------------------------------------
626-------------------------------------------------------------------------------
564data ScribeHandle = ScribeHandle {
627data ScribeHandle = ScribeHandle {
565 shScribe :: Scribe
628 shScribe :: Scribe
566− , shChan :: BQ.TBQueue WorkerMessage
629+ , shChan :: BQ.TBQueue WorkerMessage
@@ -575,8 +638,9 @@ data WorkerMessage where
576-------------------------------------------------------------------------------
639-------------------------------------------------------------------------------
577-- | Should this item be logged given the user's maximum severity?
640-- | Should this item be logged given the user's maximum severity?
641+-- Most new scribes will use this as a base for their 'PermitFunc'
578−permitItem :: Severity -> Item a -> Bool
642+permitItem :: Monad m => Severity -> Item a -> m Bool
579−permitItem sev i = _itemSeverity i >= sev
643+permitItem sev item = return (_itemSeverity item >= sev)
582-------------------------------------------------------------------------------
646-------------------------------------------------------------------------------
@@ -601,10 +665,10 @@ makeLenses ''LogEnv
603-------------------------------------------------------------------------------
667-------------------------------------------------------------------------------
604−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
668+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which
605−-- the default settings as the timer. If you are concerned about
669+-- updates the timer every 1ms. If you need even more timestamp
606−-- timestamp precision or event ordering in log outputs like
670+-- precision at the cost of performance, consider setting
607−-- ElasticSearch, you should replace the timer with 'getCurrentTime'
671+-- '_logEnvTimer' with 'getCurrentTime'.
608initLogEnv
672initLogEnv
609 :: Namespace
673 :: Namespace
610 -- ^ A base namespace for this application
674 -- ^ A base namespace for this application
@@ -616,13 +680,15 @@ initLogEnv an env = LogEnv
616 <*> getProcessID
680 <*> getProcessID
617 <*> pure an
681 <*> pure an
618 <*> pure env
682 <*> pure env
619− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
683+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
620 <*> pure mempty
684 <*> pure mempty
623-------------------------------------------------------------------------------
687-------------------------------------------------------------------------------
624-- | Add a scribe to the list. All future log calls will go to this
688-- | Add a scribe to the list. All future log calls will go to this
625−-- scribe in addition to the others.
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.
626registerScribe
692registerScribe
628 -- ^ Name the scribe
694 -- ^ Name the scribe
@@ -631,7 +697,7 @@ registerScribe
631 -> LogEnv
697 -> LogEnv
632 -> IO LogEnv
698 -> IO LogEnv
633registerScribe nm scribe ScribeSettings {..} le = do
699registerScribe nm scribe ScribeSettings {..} le = do
634− queue <- atomically (BQ.newTBQueue _scribeBufferSize)
700+ queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
635 worker <- spawnScribeWorker scribe queue
701 worker <- spawnScribeWorker scribe queue
636 let fin = do
702 let fin = do
637 atomically (BQ.writeTBQueue queue PoisonPill)
703 atomically (BQ.writeTBQueue queue PoisonPill)
@@ -646,7 +712,7 @@ registerScribe nm scribe ScribeSettings {..} le = do
647-------------------------------------------------------------------------------
713-------------------------------------------------------------------------------
648spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
714spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
649−spawnScribeWorker (Scribe write _) queue = Async.async go
715+spawnScribeWorker (Scribe write _ _) queue = Async.async go
652 newCmd <- atomically (BQ.readTBQueue queue)
718 newCmd <- atomically (BQ.readTBQueue queue)
@@ -675,7 +741,7 @@ defaultScribeSettings = ScribeSettings 4096
677-------------------------------------------------------------------------------
743-------------------------------------------------------------------------------
678−-- | Remove a scribe from the environment. This does *not* finalize
744+-- | Remove a scribe from the environment. This does __not__ finalize
679-- the scribe. This mainly only makes sense to use with something like
745-- the scribe. This mainly only makes sense to use with something like
680-- MonadReader's @local@ function to temporarily disavow a single
746-- MonadReader's @local@ function to temporarily disavow a single
681-- logger for a block of code.
747-- logger for a block of code.
@@ -688,7 +754,7 @@ unregisterScribe nm = logEnvScribes %~ M.delete nm
690-------------------------------------------------------------------------------
756-------------------------------------------------------------------------------
691−-- | Unregister *all* scribes. Note that this is *not* for closing or
757+-- | Unregister __all__ scribes. Note that this is __not__ for closing or
692-- finalizing scribes, use 'closeScribes' for that. This mainly only
758-- finalizing scribes, use 'closeScribes' for that. This mainly only
693-- makes sense to use with something like MonadReader's @local@
759-- makes sense to use with something like MonadReader's @local@
694-- function to temporarily disavow any loggers for a block of code.
760-- function to temporarily disavow any loggers for a block of code.
@@ -700,9 +766,10 @@ clearScribes = logEnvScribes .~ mempty
701-------------------------------------------------------------------------------
767-------------------------------------------------------------------------------
702-- | Finalize a scribe. The scribe is removed from the environment,
768-- | Finalize a scribe. The scribe is removed from the environment,
703−-- its finalizer is called and it can never be written to again. Note
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
704−-- that this will throw any exceptions yoru finalizer will throw, and
771+-- exceptions yoru finalizer will throw, and that LogEnv is immutable,
705−-- that LogEnv is immutable, so it will not be removed in that case.
772+-- so it will not be removed in that case.
706closeScribe
773closeScribe
708 -- ^ Name of the scribe
775 -- ^ Name of the scribe
@@ -813,7 +880,8 @@ instance (Katip m) => Katip (ResourceT m) where
813-- opposed to implementing 'Katip' for your monad.
880-- opposed to implementing 'Katip' for your monad.
814newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
881newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
815 deriving ( Functor, Applicative, Monad, MonadIO
882 deriving ( Functor, Applicative, Monad, MonadIO
816− , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
883+ , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
819instance MonadIO m => Katip (KatipT m) where
887instance MonadIO m => Katip (KatipT m) where
@@ -835,9 +903,20 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
835 restoreM = defaultRestoreM
903 restoreM = defaultRestoreM
837instance MonadUnliftIO m => MonadUnliftIO (KatipT m) where
905instance 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)
838 askUnliftIO = KatipT $
910 askUnliftIO = KatipT $
839− withUnliftIO $ \u ->
911+ withUnliftIO $ \u ->
840− pure (UnliftIO (unliftIO u . unKatipT))
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)
842-------------------------------------------------------------------------------
921-------------------------------------------------------------------------------
843-- | Execute 'KatipT' on a log env.
922-- | Execute 'KatipT' on a log env.
@@ -869,21 +948,32 @@ logItem
870logItem a ns loc sev msg = do
949logItem a ns loc sev msg = do
871 LogEnv{..} <- getLogEnv
950 LogEnv{..} <- getLogEnv
872− liftIO $ do
951+ logKatipItem =<< liftIO
874− <$> pure _logEnvApp
952+ (Item <$> pure _logEnvApp
875− <*> pure _logEnvEnv
953+ <*> pure _logEnvEnv
876− <*> pure sev
954+ <*> pure sev
877− <*> (mkThreadIdText <$> myThreadId)
955+ <*> (mkThreadIdText <$> myThreadId)
878− <*> pure _logEnvHost
956+ <*> pure _logEnvHost
879− <*> pure _logEnvPid
957+ <*> pure _logEnvPid
880− <*> pure a
958+ <*> pure a
881− <*> pure msg
959+ <*> pure msg
882− <*> _logEnvTimer
960+ <*> _logEnvTimer
883− <*> pure (_logEnvApp <> ns)
961+ <*> pure (_logEnvApp <> ns)
884− <*> pure loc
962+ <*> 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
975+ whenM (scribePermitItem shScribe item) $
885− FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> atomically (tryWriteTBQueue shChan (NewItem item))
976+ void $ atomically (tryWriteTBQueue shChan (NewItem item))
888-------------------------------------------------------------------------------
978-------------------------------------------------------------------------------
889tryWriteTBQueue
979tryWriteTBQueue
@@ -896,6 +986,7 @@ tryWriteTBQueue q a = do
896 unless full (writeTBQueue q a)
986 unless full (writeTBQueue q a)
897 return (not full)
987 return (not full)
899-------------------------------------------------------------------------------
990-------------------------------------------------------------------------------
900-- | Log with full context, but without any code location.
991-- | Log with full context, but without any code location.
@@ -928,7 +1019,7 @@ logException
928logException a ns sev action = action `catchAny` \e -> f e >> throwM e
1019logException a ns sev action = action `catchAny` \e -> f e >> throwM e
930 f e = logF a ns sev (msg e)
1021 f e = logF a ns sev (msg e)
931− msg e = ls (T.pack "An exception has occured: ") <> showLS e
1022+ msg e = ls (T.pack "An exception has occurred: ") <> showLS e
934-------------------------------------------------------------------------------
1025-------------------------------------------------------------------------------
@@ -982,11 +1073,15 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
982-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1073-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
983-- callstacks when available (GHC > 7.8).
1074-- callstacks when available (GHC > 7.8).
984#if MIN_VERSION_base(4, 8, 0)
1075#if MIN_VERSION_base(4, 8, 0)
985−getLoc :: (?loc :: CallStack) => Maybe Loc
1076+getLoc :: HasCallStack => Maybe Loc
986−getLoc = case getCallStack ?loc of
1077+getLoc = case getCallStack callStack of
987 [] -> Nothing
1078 [] -> Nothing
988− xs -> Just . toLoc . last $ xs
1079+ xs -> Just . toLoc . head $ filter filterKatip xs
1081+ filterKatip :: (String, SrcLoc) -> Bool
1082+ filterKatip (_, srcloc) = not $
1083+ "katip-" `isPrefixOf` srcLocPackage srcloc
990 toLoc :: (String, SrcLoc) -> Loc
1085 toLoc :: (String, SrcLoc) -> Loc
991 toLoc (_, l) = Loc {
1086 toLoc (_, l) = Loc {
992 loc_filename = srcLocFile l
1087 loc_filename = srcLocFile l
@@ -1017,7 +1112,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1019-------------------------------------------------------------------------------
1114-------------------------------------------------------------------------------
1020−-- | 'Loc'-tagged logging using implicit-callstacks when available.
1115+-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
1022-- This function does not require template-haskell as it
1117-- This function does not require template-haskell as it
1023-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
1118-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1028,7 +1123,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1029-- @logLoc obj mempty InfoS "Hello world"@
1124-- @logLoc obj mempty InfoS "Hello world"@
1030#if MIN_VERSION_base(4, 8, 0)
1125#if MIN_VERSION_base(4, 8, 0)
1031−logLoc :: (Applicative m, LogItem a, Katip m, ?loc :: CallStack)
1126+logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
1033logLoc :: (Applicative m, LogItem a, Katip m)
1128logLoc :: (Applicative m, LogItem a, Katip m)