@@ -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,40 @@
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)
43+import Control.Monad.Trans.State
44+import Control.Monad.Trans.Writer
45+import Data.Aeson (FromJSON (..),
46+ ToJSON (..), object)
47+import qualified Data.Aeson as A
48+import Data.Foldable as FT
49+import qualified Data.HashMap.Strict as HM
6150import Data.List
62−import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
64−import Data.Semigroup as SG
51+import qualified Data.Map.Strict as M
52+import Data.Semigroup
6553import Data.String
6654import Data.String.Conv
67−import Data.Text (Text)
68−import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
55+import Data.Text (Text)
56+import qualified Data.Text as T
57+import qualified Data.Text.Lazy.Builder as B
7058import Data.Time
71−import GHC.Generics hiding (to)
59+import GHC.Generics hiding (to)
7260#if MIN_VERSION_base(4, 8, 0)
7361#if !MIN_VERSION_base(4, 9, 0)
7462import GHC.SrcLoc
@@ -76,7 +64,7 @@ import GHC.SrcLoc
7664import GHC.Stack
7765#endif
7866import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
67+import qualified Language.Haskell.TH.Syntax as TH
8068import Lens.Micro
8169import Lens.Micro.TH
8270import Network.HostName
@@ -103,7 +91,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
10391-- IsString/OverloadedStrings, so "foo" will result in Namespace
10492-- ["foo"].
10593newtype Namespace = Namespace { unNamespace :: [Text] }
106− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
94+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
10795
10896instance IsString Namespace where
10997 fromString s = Namespace [fromString s]
@@ -143,7 +131,7 @@ data Severity
143131-- - 'V3' implies the maximum amount of payload information.
144132-- - Anything in between is left to the discretion of the developer.
145133data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
134+ deriving (Eq, Ord, Show, Read, Generic, Enum)
147135
148136
149137-------------------------------------------------------------------------------
@@ -184,26 +172,11 @@ instance FromJSON Severity where
184172 Just x -> return x
185173 Nothing -> fail $ "Invalid Severity " ++ toS t
186174
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−
202175
203176-------------------------------------------------------------------------------
204−-- | Log message with Builder underneath; use '<>' to concat in O(1).
177+-- | Log message with Builder unerneath; use '<>' to concat in O(1).
205178newtype LogStr = LogStr { unLogStr :: B.Builder }
206− deriving (Generic, Show, Eq)
179+ deriving (Generic, Show)
207180
208181instance IsString LogStr where
209182 fromString = LogStr . B.fromString
@@ -225,7 +198,7 @@ instance FromJSON LogStr where
225198
226199-------------------------------------------------------------------------------
227200-- | Pack any string-like thing into a 'LogStr'. This will
228−-- automatically work on 'String', 'ByteString', 'Text' and any of the
201+-- automatically work on 'String', 'ByteString, 'Text' and any of the
229202-- lazy variants.
230203logStr :: StringConv a Text => a -> LogStr
231204logStr t = LogStr (B.fromText $ toS t)
@@ -250,9 +223,7 @@ newtype ThreadIdText = ThreadIdText {
250223
251224
252225mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
254− where
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
226+mkThreadIdText = ThreadIdText . T.pack . show
256227
257228
258229-------------------------------------------------------------------------------
@@ -272,62 +243,31 @@ data Item a = Item {
272243 } deriving (Generic, Functor)
273244makeLenses ''Item
274245
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− ]
298246
299247instance 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 ", "
248+ show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
249+ "_itemEnv = " ++ show _itemEnv ++ ", " ++
250+ "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
251+ "_itemThread = " ++ show _itemThread ++ ", " ++
252+ "_itemHost = " ++ show _itemHost ++ ", " ++
253+ "_itemProcess = " ++ show _itemProcess ++ ", " ++
254+ "_itemPayload = " ++ show _itemPayload ++ ", " ++
255+ "_itemMessage = " ++ show _itemMessage ++ ", " ++
256+ "_itemTime = " ++ show _itemTime ++ ", " ++
257+ "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
258+ "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
259+
316260
317261newtype LocShow = LocShow Loc
318262
319263
320264instance 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 ", "
265+ show (LocShow Loc{..}) =
266+ "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
267+ "loc_package = " ++ show loc_package ++ ", " ++
268+ "loc_module = " ++ show loc_module ++ ", " ++
269+ "loc_start = " ++ show loc_start ++ ", " ++
270+ "loc_end = " ++ show loc_end ++ "}"
331271
332272
333273instance ToJSON a => ToJSON (Item a) where
@@ -540,93 +480,52 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
540480--
541481-- Scribes should always take a 'Severity' and 'Verbosity'.
542482--
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.
483+-- Severity is used to *exclude log messages* that are < the provided
484+-- Severity. For instance, if the user passes InfoS, DebugS items
485+-- should be ignored. Katip provides the 'permitItem' utility for this.
549486--
550487-- Verbosity is used to select keys from the log item's payload. Each
551488-- 'LogItem' instance describes what keys should be retained for each
552489-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
490+-- that should be permitted.
554491--
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.
492+-- There is no built-in mechanism in katip for telling a scribe that
493+-- its time to shut down. 'unregisterScribe' merely drops it from the
494+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
564495--
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−
496+-- 1. Pass in the resource when the scribe is created. Handle
497+-- allocation and release of the resource elsewhere. This is what the
498+-- Handle scribe does.
499+--
500+-- 2. Return a finalizing function that tells the scribe to shut
501+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns a @IO (Scribe,
502+-- IO ())@. The finalizer will flush any queued log messages and shut
503+-- down gracefully before returning. This can be hooked into your
504+-- application's shutdown routine to ensure you never miss any log
505+-- messages on shutdown.
588506data 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'
507+ liPush :: forall a. LogItem a => Item a -> IO ()
508+ , scribeFinalizer :: IO ()
509+ -- ^ Provide a *blocking* finalizer to call when your scribe is
510+ -- removed. If this is not relevant to your scribe, return () is
511+ -- fine.
601512 }
602513
603514
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.
612515instance 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)
516+ (Scribe pushA finA) <> (Scribe pushB finB) =
517+ Scribe (\item -> pushA item >> pushB item) (finA `finally` finB)
619518
620519
621520instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
521+ mempty = Scribe (const (return ())) (return ())
623522 mappend = (<>)
624523
625524
626525-------------------------------------------------------------------------------
627526data ScribeHandle = ScribeHandle {
628527 shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
528+ , shChan :: BQ.TBQueue WorkerMessage
630529 }
631530
632531
@@ -638,9 +537,8 @@ data WorkerMessage where
638537
639538-------------------------------------------------------------------------------
640539-- | 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)
540+permitItem :: Severity -> Item a -> Bool
541+permitItem sev i = _itemSeverity i >= sev
644542
645543
646544-------------------------------------------------------------------------------
@@ -665,10 +563,10 @@ makeLenses ''LogEnv
665563
666564
667565-------------------------------------------------------------------------------
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'.
566+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
567+-- the default settings as the timer. If you are concerned about
568+-- timestamp precision or event ordering in log outputs like
569+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
672570initLogEnv
673571 :: Namespace
674572 -- ^ A base namespace for this application
@@ -680,15 +578,13 @@ initLogEnv an env = LogEnv
680578 <*> getProcessID
681579 <*> pure an
682580 <*> pure env
683− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
581+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
684582 <*> pure mempty
685583
686584
687585-------------------------------------------------------------------------------
688586-- | 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.
587+-- scribe in addition to the others.
692588registerScribe
693589 :: Text
694590 -- ^ Name the scribe
@@ -697,14 +593,14 @@ registerScribe
697593 -> LogEnv
698594 -> IO LogEnv
699595registerScribe nm scribe ScribeSettings {..} le = do
700− queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
596+ queue <- atomically (BQ.newTBQueue _scribeBufferSize)
701597 worker <- spawnScribeWorker scribe queue
702598 let fin = do
703599 atomically (BQ.writeTBQueue queue PoisonPill)
704600 -- wait for our worker to finish final write
705601 void (Async.waitCatch worker)
706602 -- wait for scribe to finish final write
707− void (scribeFinalizer scribe)
603+ void (tryAny (scribeFinalizer scribe))
708604
709605 let sh = ScribeHandle (scribe { scribeFinalizer = fin }) queue
710606 return (le & logEnvScribes %~ M.insert nm sh)
@@ -712,7 +608,7 @@ registerScribe nm scribe ScribeSettings {..} le = do
712608
713609-------------------------------------------------------------------------------
714610spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
611+spawnScribeWorker (Scribe write _) queue = Async.async go
716612 where
717613 go = do
718614 newCmd <- atomically (BQ.readTBQueue queue)
@@ -729,7 +625,6 @@ spawnScribeWorker (Scribe write _ _) queue = Async.async go
729625data ScribeSettings = ScribeSettings {
730626 _scribeBufferSize :: Int
731627 }
732− deriving (Show, Eq)
733628
734629makeLenses ''ScribeSettings
735630
@@ -741,7 +636,7 @@ defaultScribeSettings = ScribeSettings 4096
741636
742637
743638-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
639+-- | Remove a scribe from the environment. This does *not* finalize
745640-- the scribe. This mainly only makes sense to use with something like
746641-- MonadReader's @local@ function to temporarily disavow a single
747642-- logger for a block of code.
@@ -754,7 +649,7 @@ unregisterScribe nm = logEnvScribes %~ M.delete nm
754649
755650
756651-------------------------------------------------------------------------------
757−-- | Unregister __all__ scribes. Note that this is __not__ for closing or
652+-- | Unregister *all* scribes. Note that this is *not* for closing or
758653-- finalizing scribes, use 'closeScribes' for that. This mainly only
759654-- makes sense to use with something like MonadReader's @local@
760655-- function to temporarily disavow any loggers for a block of code.
@@ -766,10 +661,7 @@ clearScribes = logEnvScribes .~ mempty
766661
767662-------------------------------------------------------------------------------
768663-- | 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.
664+-- its finalizer is called and it can never be written to again.
773665closeScribe
774666 :: Text
775667 -- ^ Name of the scribe
@@ -784,17 +676,12 @@ closeScribe nm le = do
784676-- | Call this at the end of your program. This is a blocking call
785677-- that stop writing to a scribe's queue, waits for the queue to
786678-- 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.
679+-- removes it.
789680closeScribes
790681 :: LogEnv
791682 -> 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)
683+closeScribes le =
684+ foldrM closeScribe le (M.keys (_logEnvScribes le))
798685
799686
800687-------------------------------------------------------------------------------
@@ -807,86 +694,44 @@ closeScribes le = do
807694-- which keeps a namespace and merged context. You can write simple
808695-- functions that add additional namespacing and merges additional
809696-- 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.
815697class MonadIO m => Katip m where
816698 getLogEnv :: m LogEnv
817− localLogEnv :: (LogEnv -> LogEnv) -> m a -> m a
818699
819700
820701instance Katip m => Katip (ReaderT s m) where
821702 getLogEnv = lift getLogEnv
822− localLogEnv = mapReaderT . localLogEnv
823703
824704
825−#if !MIN_VERSION_either(4, 5, 0)
826705instance Katip m => Katip (EitherT s m) where
827706 getLogEnv = lift getLogEnv
828− localLogEnv = mapEitherT . localLogEnv
829−#endif
830−
831707
832708instance Katip m => Katip (ExceptT s m) where
833709 getLogEnv = lift getLogEnv
834− localLogEnv = mapExceptT . localLogEnv
835−
836710
837711instance Katip m => Katip (MaybeT m) where
838712 getLogEnv = lift getLogEnv
839− localLogEnv = mapMaybeT . localLogEnv
840713
841714
842715instance Katip m => Katip (StateT s m) where
843716 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
860717
861718
862719instance (Katip m, Monoid s) => Katip (WriterT s m) where
863720 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−
871721
872722instance (Katip m) => Katip (ResourceT m) where
873723 getLogEnv = lift getLogEnv
874− localLogEnv = transResourceT . localLogEnv
875724
876725
877726-------------------------------------------------------------------------------
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.
727+-- | A concrete monad you can use to run logging actions.
881728newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882729 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
884− , MonadBase b)
730+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
885731
886732
887733instance MonadIO m => Katip (KatipT m) where
888734 getLogEnv = KatipT ask
889− localLogEnv f (KatipT m) = KatipT $ local f m
890735
891736
892737instance MonadTransControl KatipT where
@@ -902,21 +747,6 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
902747 liftBaseWith = defaultLiftBaseWith
903748 restoreM = defaultRestoreM
904749
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
920750
921751-------------------------------------------------------------------------------
922752-- | Execute 'KatipT' on a log env.
@@ -924,17 +754,6 @@ runKatipT :: LogEnv -> KatipT m a -> m a
924754runKatipT le (KatipT f) = runReaderT f le
925755
926756
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−
938757-------------------------------------------------------------------------------
939758-- | Log with everything, including a source code location. This is
940759-- very low level and you typically can use 'logT' in its place.
@@ -948,32 +767,22 @@ logItem
948767 -> m ()
949768logItem a ns loc sev msg = do
950769 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))
770+ liftIO $ do
771+ item <- Item
772+ <$> pure _logEnvApp
773+ <*> pure _logEnvEnv
774+ <*> pure sev
775+ <*> (mkThreadIdText <$> myThreadId)
776+ <*> pure _logEnvHost
777+ <*> pure _logEnvPid
778+ <*> pure a
779+ <*> pure msg
780+ <*> _logEnvTimer
781+ <*> pure (_logEnvApp <> ns)
782+ <*> pure loc
783+ FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> atomically (tryWriteTBQueue shChan (NewItem item))
784+ --TODO: if we use tbqueue, write an atomic tryWriteTBQueue
785+
977786
978787-------------------------------------------------------------------------------
979788tryWriteTBQueue
@@ -986,7 +795,6 @@ tryWriteTBQueue q a = do
986795 unless full (writeTBQueue q a)
987796 return (not full)
988797
989−
990798-------------------------------------------------------------------------------
991799-- | Log with full context, but without any code location.
992800logF
@@ -1019,7 +827,7 @@ logException
1019827logException a ns sev action = action `catchAny` \e -> f e >> throwM e
1020828 where
1021829 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
830+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1023831
1024832
1025833-------------------------------------------------------------------------------
@@ -1073,15 +881,11 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
1073881-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1074882-- callstacks when available (GHC > 7.8).
1075883#if MIN_VERSION_base(4, 8, 0)
1076−getLoc :: HasCallStack => Maybe Loc
1077−getLoc = case getCallStack callStack of
884+getLoc :: (?loc :: CallStack) => Maybe Loc
885+getLoc = case getCallStack ?loc of
1078886 [] -> Nothing
1079− xs -> Just . toLoc . head $ filter filterKatip xs
887+ xs -> Just . toLoc . last $ xs
1080888 where
1081− filterKatip :: (String, SrcLoc) -> Bool
1082− filterKatip (_, srcloc) = not $
1083− "katip-" `isPrefixOf` srcLocPackage srcloc
1084−
1085889 toLoc :: (String, SrcLoc) -> Loc
1086890 toLoc (_, l) = Loc {
1087891 loc_filename = srcLocFile l
@@ -1112,7 +916,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1112916
1113917
1114918-------------------------------------------------------------------------------
1115−-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
919+-- | 'Loc'-tagged logging using implicit-callstacks when available.
1116920--
1117921-- This function does not require template-haskell as it
1118922-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1123,7 +927,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1123927--
1124928-- @logLoc obj mempty InfoS "Hello world"@
1125929#if MIN_VERSION_base(4, 8, 0)
1126−logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
930+logLoc :: (Applicative m, LogItem a, Katip m, ?loc :: CallStack)
1127931#else
1128932logLoc :: (Applicative m, LogItem a, Katip m)
1129933#endif