@@ -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,44 +22,53 @@
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
38+import Control.Monad.IO.Unlift
36import Control.Monad.Trans.Class
39import Control.Monad.Trans.Class
37import Control.Monad.Trans.Control
40import Control.Monad.Trans.Control
41+#if !MIN_VERSION_either(4, 5, 0)
38import Control.Monad.Trans.Either
42import Control.Monad.Trans.Either
39import Control.Monad.Trans.Except
44import Control.Monad.Trans.Except
40import Control.Monad.Trans.Maybe
45import Control.Monad.Trans.Maybe
41import Control.Monad.Trans.Reader
46import Control.Monad.Trans.Reader
42−import Control.Monad.Trans.Resource (ResourceT)
47+import Control.Monad.Trans.Resource (MonadResource, ResourceT,
43−import Control.Monad.Trans.State.Lazy (StateT)
49+import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
44−import qualified Control.Monad.Trans.State.Strict as Strict (StateT)
50+import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
45−import Control.Monad.Trans.Writer.Lazy (WriterT)
51+import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
46−import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT)
52+import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
47−import Control.Monad.Trans.RWS.Lazy (RWST)
53+import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
48−import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST)
54+import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT,
49−import Data.Aeson (FromJSON (..), ToJSON (..),
56+import Data.Aeson (FromJSON (..), ToJSON (..),
51−import qualified Data.Aeson as A
58+import qualified Data.Aeson as A
52−import Data.Foldable as FT
59+import Data.Foldable as FT
53−import qualified Data.HashMap.Strict as HM
60+import qualified Data.HashMap.Strict as HM
54import Data.List
61import Data.List
55−import qualified Data.Map.Strict as M
62+import qualified Data.Map.Strict as M
56−import Data.Semigroup
63+import Data.Maybe (fromMaybe)
64+import Data.Semigroup as SG
57import Data.String
65import Data.String
58import Data.String.Conv
66import Data.String.Conv
59−import Data.Text (Text)
67+import Data.Text (Text)
60−import qualified Data.Text as T
68+import qualified Data.Text as T
61−import qualified Data.Text.Lazy.Builder as B
69+import qualified Data.Text.Lazy.Builder as B
62import Data.Time
70import Data.Time
63−import GHC.Generics hiding (to)
71+import GHC.Generics hiding (to)
64#if MIN_VERSION_base(4, 8, 0)
72#if MIN_VERSION_base(4, 8, 0)
65#if !MIN_VERSION_base(4, 9, 0)
73#if !MIN_VERSION_base(4, 9, 0)
66import GHC.SrcLoc
74import GHC.SrcLoc
@@ -68,7 +76,7 @@ import GHC.SrcLoc
68import GHC.Stack
76import GHC.Stack
70import Language.Haskell.TH
78import Language.Haskell.TH
71−import qualified Language.Haskell.TH.Syntax as TH
79+import qualified Language.Haskell.TH.Syntax as TH
72import Lens.Micro
80import Lens.Micro
73import Lens.Micro.TH
81import Lens.Micro.TH
74import Network.HostName
82import Network.HostName
@@ -95,7 +103,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
95-- IsString/OverloadedStrings, so "foo" will result in Namespace
103-- IsString/OverloadedStrings, so "foo" will result in Namespace
96-- ["foo"].
104-- ["foo"].
97newtype Namespace = Namespace { unNamespace :: [Text] }
105newtype Namespace = Namespace { unNamespace :: [Text] }
98− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
106+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
100instance IsString Namespace where
108instance IsString Namespace where
101 fromString s = Namespace [fromString s]
109 fromString s = Namespace [fromString s]
@@ -135,7 +143,7 @@ data Severity
135-- - 'V3' implies the maximum amount of payload information.
143-- - 'V3' implies the maximum amount of payload information.
136-- - Anything in between is left to the discretion of the developer.
144-- - Anything in between is left to the discretion of the developer.
137data Verbosity = V0 | V1 | V2 | V3
145data Verbosity = V0 | V1 | V2 | V3
138− deriving (Eq, Ord, Show, Read, Generic, Enum)
146+ deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
141-------------------------------------------------------------------------------
149-------------------------------------------------------------------------------
@@ -176,11 +184,26 @@ instance FromJSON Severity where
176 Just x -> return x
184 Just x -> return x
177 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
180-------------------------------------------------------------------------------
203-------------------------------------------------------------------------------
181-- | Log message with Builder underneath; use '<>' to concat in O(1).
204-- | Log message with Builder underneath; use '<>' to concat in O(1).
182newtype LogStr = LogStr { unLogStr :: B.Builder }
205newtype LogStr = LogStr { unLogStr :: B.Builder }
183− deriving (Generic, Show)
206+ deriving (Generic, Show, Eq)
185instance IsString LogStr where
208instance IsString LogStr where
186 fromString = LogStr . B.fromString
209 fromString = LogStr . B.fromString
@@ -227,7 +250,9 @@ newtype ThreadIdText = ThreadIdText {
229mkThreadIdText :: ThreadId -> ThreadIdText
252mkThreadIdText :: ThreadId -> ThreadIdText
230−mkThreadIdText = ThreadIdText . T.pack . show
253+mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
255+ stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
233-------------------------------------------------------------------------------
258-------------------------------------------------------------------------------
@@ -247,31 +272,62 @@ data Item a = Item {
247 } deriving (Generic, Functor)
272 } deriving (Generic, Functor)
248makeLenses ''Item
273makeLenses ''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
251instance Show a => Show (Item a) where
299instance Show a => Show (Item a) where
252− show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
300+ showsPrec d Item{..} = showParen (d >= 11) ( showString "Item {"
253− "_itemEnv = " ++ show _itemEnv ++ ", " ++
301+ . field "_itemApp" _itemApp
302+ . field "_itemEnv" _itemEnv
254− "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
303+ . field "_itemSeverity" _itemSeverity
255− "_itemThread = " ++ show _itemThread ++ ", " ++
304+ . field "_itemThread" _itemThread
256− "_itemHost = " ++ show _itemHost ++ ", " ++
305+ . field "_itemHost" _itemHost
257− "_itemProcess = " ++ show _itemProcess ++ ", " ++
306+ . field "_itemProcess" _itemProcess
258− "_itemPayload = " ++ show _itemPayload ++ ", " ++
307+ . field "_itemPayload" _itemPayload
259− "_itemMessage = " ++ show _itemMessage ++ ", " ++
308+ . field "_itemMessage" _itemMessage
260− "_itemTime = " ++ show _itemTime ++ ", " ++
309+ . field "_itemTime" _itemTime
261− "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
310+ . field "_itemNamespace" _itemNamespace
262− "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
311+ . showString "_itemLoc = " . shows (LocShow <$> _itemLoc)
315+ field n v = showString n . showString " = " . shows v . showString ", "
265newtype LocShow = LocShow Loc
317newtype LocShow = LocShow Loc
268instance Show LocShow where
320instance Show LocShow where
269− show (LocShow Loc{..}) =
321+ showsPrec d (LocShow Loc{..}) = showParen (d >= 11) ( showString "Loc {"
270− "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
322+ . field "loc_filename" loc_filename
271− "loc_package = " ++ show loc_package ++ ", " ++
323+ . field "loc_package" loc_package
272− "loc_module = " ++ show loc_module ++ ", " ++
324+ . field "loc_module" loc_module
273− "loc_start = " ++ show loc_start ++ ", " ++
325+ . field "loc_start" loc_start
274− "loc_end = " ++ show loc_end ++ "}"
326+ . showString "loc_end = " . shows loc_end
330+ field n v = showString n . showString " = " . shows v . showString ", "
277instance ToJSON a => ToJSON (Item a) where
333instance ToJSON a => ToJSON (Item a) where
@@ -484,52 +540,93 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
485-- Scribes should always take a 'Severity' and 'Verbosity'.
541-- Scribes should always take a 'Severity' and 'Verbosity'.
487−-- Severity is used to *exclude log messages* that are < the provided
543+-- Severity is used to __exclude log messages__ that are lower than
488−-- Severity. For instance, if the user passes InfoS, DebugS items
544+-- the provided Severity. For instance, if the user passes InfoS,
489−-- 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
491-- 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
492-- 'LogItem' instance describes what keys should be retained for each
551-- 'LogItem' instance describes what keys should be retained for each
493-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
552-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
494−-- that should be permitted.
553+-- that should be 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:
500−-- 1. Pass in the resource when the scribe is created. Handle
555+-- Scribes provide a finalizer IO action ('scribeFinalizer') that is
501−-- allocation and release of the resource elsewhere. This is what the
556+-- meant to synchronously flush any remaining writes and clean up any
502−-- 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
504−-- 2. Return a finalizing function that tells the scribe to shut
565+-- While katip internally buffers messages per 'ScribeSettings', it
505−-- down. @katip-elasticsearch@'s @mkEsScribe@ returns an @IO (Scribe,
566+-- sends them one at a time to the scribe. Depending on the scribe
506−-- 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
507−-- 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
508−-- application's shutdown routine to ensure you never miss any log
569+-- efficient. The scribe implementer must be sure that on
509−-- 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)
510data Scribe = Scribe {
588data Scribe = Scribe {
511− 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?
512− , scribeFinalizer :: IO ()
591+ , scribeFinalizer :: IO ()
513− -- ^ 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
514− -- removed. If this is not relevant to your scribe, return () is
594+ -- this is not relevant to your scribe, return () is fine.
515− -- 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
519instance Semigroup Scribe where
612instance Semigroup Scribe where
520− (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)
521− Scribe (\item -> pushA item >> pushB item) (finA `finally` finB)
617+ (finA `finally` finB)
618+ (permitOR permitA permitB)
524instance Monoid Scribe where
621instance Monoid Scribe where
525− mempty = Scribe (const (return ())) (return ())
622+ mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
526 mappend = (<>)
623 mappend = (<>)
529-------------------------------------------------------------------------------
626-------------------------------------------------------------------------------
530data ScribeHandle = ScribeHandle {
627data ScribeHandle = ScribeHandle {
531 shScribe :: Scribe
628 shScribe :: Scribe
532− , shChan :: BQ.TBQueue WorkerMessage
629+ , shChan :: BQ.TBQueue WorkerMessage
@@ -541,8 +638,9 @@ data WorkerMessage where
542-------------------------------------------------------------------------------
639-------------------------------------------------------------------------------
543-- | 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'
544−permitItem :: Severity -> Item a -> Bool
642+permitItem :: Monad m => Severity -> Item a -> m Bool
545−permitItem sev i = _itemSeverity i >= sev
643+permitItem sev item = return (_itemSeverity item >= sev)
548-------------------------------------------------------------------------------
646-------------------------------------------------------------------------------
@@ -567,10 +665,10 @@ makeLenses ''LogEnv
569-------------------------------------------------------------------------------
667-------------------------------------------------------------------------------
570−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
668+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which
571−-- the default settings as the timer. If you are concerned about
669+-- updates the timer every 1ms. If you need even more timestamp
572−-- timestamp precision or event ordering in log outputs like
670+-- precision at the cost of performance, consider setting
573−-- ElasticSearch, you should replace the timer with 'getCurrentTime'
671+-- '_logEnvTimer' with 'getCurrentTime'.
574initLogEnv
672initLogEnv
575 :: Namespace
673 :: Namespace
576 -- ^ A base namespace for this application
674 -- ^ A base namespace for this application
@@ -582,13 +680,15 @@ initLogEnv an env = LogEnv
582 <*> getProcessID
680 <*> getProcessID
583 <*> pure an
681 <*> pure an
584 <*> pure env
682 <*> pure env
585− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
683+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
586 <*> pure mempty
684 <*> pure mempty
589-------------------------------------------------------------------------------
687-------------------------------------------------------------------------------
590-- | 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
591−-- 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.
592registerScribe
692registerScribe
594 -- ^ Name the scribe
694 -- ^ Name the scribe
@@ -597,7 +697,7 @@ registerScribe
597 -> LogEnv
697 -> LogEnv
598 -> IO LogEnv
698 -> IO LogEnv
599registerScribe nm scribe ScribeSettings {..} le = do
699registerScribe nm scribe ScribeSettings {..} le = do
600− queue <- atomically (BQ.newTBQueue _scribeBufferSize)
700+ queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
601 worker <- spawnScribeWorker scribe queue
701 worker <- spawnScribeWorker scribe queue
602 let fin = do
702 let fin = do
603 atomically (BQ.writeTBQueue queue PoisonPill)
703 atomically (BQ.writeTBQueue queue PoisonPill)
@@ -612,7 +712,7 @@ registerScribe nm scribe ScribeSettings {..} le = do
613-------------------------------------------------------------------------------
713-------------------------------------------------------------------------------
614spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
714spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
615−spawnScribeWorker (Scribe write _) queue = Async.async go
715+spawnScribeWorker (Scribe write _ _) queue = Async.async go
618 newCmd <- atomically (BQ.readTBQueue queue)
718 newCmd <- atomically (BQ.readTBQueue queue)
@@ -629,6 +729,7 @@ spawnScribeWorker (Scribe write _) queue = Async.async go
629data ScribeSettings = ScribeSettings {
729data ScribeSettings = ScribeSettings {
630 _scribeBufferSize :: Int
730 _scribeBufferSize :: Int
633makeLenses ''ScribeSettings
734makeLenses ''ScribeSettings
@@ -640,7 +741,7 @@ defaultScribeSettings = ScribeSettings 4096
642-------------------------------------------------------------------------------
743-------------------------------------------------------------------------------
643−-- | Remove a scribe from the environment. This does *not* finalize
744+-- | Remove a scribe from the environment. This does __not__ finalize
644-- 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
645-- MonadReader's @local@ function to temporarily disavow a single
746-- MonadReader's @local@ function to temporarily disavow a single
646-- logger for a block of code.
747-- logger for a block of code.
@@ -653,7 +754,7 @@ unregisterScribe nm = logEnvScribes %~ M.delete nm
655-------------------------------------------------------------------------------
756-------------------------------------------------------------------------------
656−-- | Unregister *all* scribes. Note that this is *not* for closing or
757+-- | Unregister __all__ scribes. Note that this is __not__ for closing or
657-- finalizing scribes, use 'closeScribes' for that. This mainly only
758-- finalizing scribes, use 'closeScribes' for that. This mainly only
658-- makes sense to use with something like MonadReader's @local@
759-- makes sense to use with something like MonadReader's @local@
659-- function to temporarily disavow any loggers for a block of code.
760-- function to temporarily disavow any loggers for a block of code.
@@ -665,9 +766,10 @@ clearScribes = logEnvScribes .~ mempty
666-------------------------------------------------------------------------------
767-------------------------------------------------------------------------------
667-- | Finalize a scribe. The scribe is removed from the environment,
768-- | Finalize a scribe. The scribe is removed from the environment,
668−-- 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
669−-- that this will throw any exceptions yoru finalizer will throw, and
771+-- exceptions yoru finalizer will throw, and that LogEnv is immutable,
670−-- that LogEnv is immutable, so it will not be removed in that case.
772+-- so it will not be removed in that case.
671closeScribe
773closeScribe
673 -- ^ Name of the scribe
775 -- ^ Name of the scribe
@@ -705,54 +807,86 @@ closeScribes le = do
705-- which keeps a namespace and merged context. You can write simple
807-- which keeps a namespace and merged context. You can write simple
706-- functions that add additional namespacing and merges additional
808-- functions that add additional namespacing and merges additional
707-- context on the fly.
809-- 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.
708class MonadIO m => Katip m where
815class MonadIO m => Katip m where
709 getLogEnv :: m LogEnv
816 getLogEnv :: m LogEnv
817+ localLogEnv :: (LogEnv -> LogEnv) -> m a -> m a
712instance Katip m => Katip (ReaderT s m) where
820instance Katip m => Katip (ReaderT s m) where
713 getLogEnv = lift getLogEnv
821 getLogEnv = lift getLogEnv
822+ localLogEnv = mapReaderT . localLogEnv
825+#if !MIN_VERSION_either(4, 5, 0)
716instance Katip m => Katip (EitherT s m) where
826instance Katip m => Katip (EitherT s m) where
717 getLogEnv = lift getLogEnv
827 getLogEnv = lift getLogEnv
828+ localLogEnv = mapEitherT . localLogEnv
719instance Katip m => Katip (ExceptT s m) where
832instance Katip m => Katip (ExceptT s m) where
720 getLogEnv = lift getLogEnv
833 getLogEnv = lift getLogEnv
834+ localLogEnv = mapExceptT . localLogEnv
722instance Katip m => Katip (MaybeT m) where
837instance Katip m => Katip (MaybeT m) where
723 getLogEnv = lift getLogEnv
838 getLogEnv = lift getLogEnv
839+ localLogEnv = mapMaybeT . localLogEnv
725instance Katip m => Katip (StateT s m) where
842instance Katip m => Katip (StateT s m) where
726 getLogEnv = lift getLogEnv
843 getLogEnv = lift getLogEnv
844+ localLogEnv = mapStateT . localLogEnv
728instance (Katip m, Monoid w) => Katip (RWST r w s m) where
847instance (Katip m, Monoid w) => Katip (RWST r w s m) where
729 getLogEnv = lift getLogEnv
848 getLogEnv = lift getLogEnv
849+ localLogEnv = mapRWST . localLogEnv
731instance (Katip m, Monoid w) => Katip (Strict.RWST r w s m) where
852instance (Katip m, Monoid w) => Katip (Strict.RWST r w s m) where
732 getLogEnv = lift getLogEnv
853 getLogEnv = lift getLogEnv
854+ localLogEnv = Strict.mapRWST . localLogEnv
734instance Katip m => Katip (Strict.StateT s m) where
857instance Katip m => Katip (Strict.StateT s m) where
735 getLogEnv = lift getLogEnv
858 getLogEnv = lift getLogEnv
859+ localLogEnv = Strict.mapStateT . localLogEnv
737instance (Katip m, Monoid s) => Katip (WriterT s m) where
862instance (Katip m, Monoid s) => Katip (WriterT s m) where
738 getLogEnv = lift getLogEnv
863 getLogEnv = lift getLogEnv
864+ localLogEnv = mapWriterT . localLogEnv
740instance (Katip m, Monoid s) => Katip (Strict.WriterT s m) where
867instance (Katip m, Monoid s) => Katip (Strict.WriterT s m) where
741 getLogEnv = lift getLogEnv
868 getLogEnv = lift getLogEnv
869+ localLogEnv = Strict.mapWriterT . localLogEnv
743instance (Katip m) => Katip (ResourceT m) where
872instance (Katip m) => Katip (ResourceT m) where
744 getLogEnv = lift getLogEnv
873 getLogEnv = lift getLogEnv
874+ localLogEnv = transResourceT . localLogEnv
747-------------------------------------------------------------------------------
877-------------------------------------------------------------------------------
748−-- | A concrete monad you can use to run logging actions.
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.
749newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
881newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
750 deriving ( Functor, Applicative, Monad, MonadIO
882 deriving ( Functor, Applicative, Monad, MonadIO
751− , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
883+ , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
754instance MonadIO m => Katip (KatipT m) where
887instance MonadIO m => Katip (KatipT m) where
755 getLogEnv = KatipT ask
888 getLogEnv = KatipT ask
889+ localLogEnv f (KatipT m) = KatipT $ local f m
758instance MonadTransControl KatipT where
892instance MonadTransControl KatipT where
@@ -768,6 +902,21 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
768 liftBaseWith = defaultLiftBaseWith
902 liftBaseWith = defaultLiftBaseWith
769 restoreM = defaultRestoreM
903 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)
772-------------------------------------------------------------------------------
921-------------------------------------------------------------------------------
773-- | Execute 'KatipT' on a log env.
922-- | Execute 'KatipT' on a log env.
@@ -775,6 +924,17 @@ runKatipT :: LogEnv -> KatipT m a -> m a
775runKatipT le (KatipT f) = runReaderT f le
924runKatipT 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)
778-------------------------------------------------------------------------------
938-------------------------------------------------------------------------------
779-- | Log with everything, including a source code location. This is
939-- | Log with everything, including a source code location. This is
780-- very low level and you typically can use 'logT' in its place.
940-- very low level and you typically can use 'logT' in its place.
@@ -788,21 +948,32 @@ logItem
789logItem a ns loc sev msg = do
949logItem a ns loc sev msg = do
790 LogEnv{..} <- getLogEnv
950 LogEnv{..} <- getLogEnv
791− liftIO $ do
951+ logKatipItem =<< liftIO
793− <$> pure _logEnvApp
952+ (Item <$> pure _logEnvApp
794− <*> pure _logEnvEnv
953+ <*> pure _logEnvEnv
795− <*> pure sev
954+ <*> pure sev
796− <*> (mkThreadIdText <$> myThreadId)
955+ <*> (mkThreadIdText <$> myThreadId)
797− <*> pure _logEnvHost
956+ <*> pure _logEnvHost
798− <*> pure _logEnvPid
957+ <*> pure _logEnvPid
799− <*> pure a
958+ <*> pure a
800− <*> pure msg
959+ <*> pure msg
801− <*> _logEnvTimer
960+ <*> _logEnvTimer
802− <*> pure (_logEnvApp <> ns)
961+ <*> pure (_logEnvApp <> ns)
803− <*> 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) $
804− FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> atomically (tryWriteTBQueue shChan (NewItem item))
976+ void $ atomically (tryWriteTBQueue shChan (NewItem item))
807-------------------------------------------------------------------------------
978-------------------------------------------------------------------------------
808tryWriteTBQueue
979tryWriteTBQueue
@@ -815,6 +986,7 @@ tryWriteTBQueue q a = do
815 unless full (writeTBQueue q a)
986 unless full (writeTBQueue q a)
816 return (not full)
987 return (not full)
818-------------------------------------------------------------------------------
990-------------------------------------------------------------------------------
819-- | Log with full context, but without any code location.
991-- | Log with full context, but without any code location.
@@ -847,7 +1019,7 @@ logException
847logException a ns sev action = action `catchAny` \e -> f e >> throwM e
1019logException a ns sev action = action `catchAny` \e -> f e >> throwM e
849 f e = logF a ns sev (msg e)
1021 f e = logF a ns sev (msg e)
850− msg e = ls (T.pack "An exception has occured: ") <> showLS e
1022+ msg e = ls (T.pack "An exception has occurred: ") <> showLS e
853-------------------------------------------------------------------------------
1025-------------------------------------------------------------------------------
@@ -901,11 +1073,15 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
901-- 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
902-- callstacks when available (GHC > 7.8).
1074-- callstacks when available (GHC > 7.8).
903#if MIN_VERSION_base(4, 8, 0)
1075#if MIN_VERSION_base(4, 8, 0)
904−getLoc :: (?loc :: CallStack) => Maybe Loc
1076+getLoc :: HasCallStack => Maybe Loc
905−getLoc = case getCallStack ?loc of
1077+getLoc = case getCallStack callStack of
906 [] -> Nothing
1078 [] -> Nothing
907− 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
909 toLoc :: (String, SrcLoc) -> Loc
1085 toLoc :: (String, SrcLoc) -> Loc
910 toLoc (_, l) = Loc {
1086 toLoc (_, l) = Loc {
911 loc_filename = srcLocFile l
1087 loc_filename = srcLocFile l
@@ -936,7 +1112,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
938-------------------------------------------------------------------------------
1114-------------------------------------------------------------------------------
939−-- | 'Loc'-tagged logging using implicit-callstacks when available.
1115+-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
941-- This function does not require template-haskell as it
1117-- This function does not require template-haskell as it
942-- 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>
@@ -947,7 +1123,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
948-- @logLoc obj mempty InfoS "Hello world"@
1124-- @logLoc obj mempty InfoS "Hello world"@
949#if MIN_VERSION_base(4, 8, 0)
1125#if MIN_VERSION_base(4, 8, 0)
950−logLoc :: (Applicative m, LogItem a, Katip m, ?loc :: CallStack)
1126+logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
952logLoc :: (Applicative m, LogItem a, Katip m)
1128logLoc :: (Applicative m, LogItem a, Katip m)