@@ -22,18 +22,15 @@
22module Katip.Core where
22module Katip.Core where
24-------------------------------------------------------------------------------
24-------------------------------------------------------------------------------
25−import Control.Applicative as A
25+import Control.Applicative as A
26import Control.AutoUpdate
26import Control.AutoUpdate
27import Control.Concurrent
27import Control.Concurrent
28−import qualified Control.Concurrent.Async as Async
28+import qualified Control.Concurrent.Async as Async
29import Control.Concurrent.STM
29import Control.Concurrent.STM
30−import qualified Control.Concurrent.STM.TBQueue as BQ
30+import qualified Control.Concurrent.STM.TBQueue as BQ
31import Control.Exception.Safe
31import Control.Exception.Safe
32−import Control.Monad (unless, void, when)
32+import Control.Monad (unless, void)
33import Control.Monad.Base
33import Control.Monad.Base
34−#if MIN_VERSION_base(4, 9, 0)
35−import qualified Control.Monad.Fail as MF
37import Control.Monad.IO.Class
34import Control.Monad.IO.Class
38import Control.Monad.IO.Unlift
35import Control.Monad.IO.Unlift
39import Control.Monad.Trans.Class
36import Control.Monad.Trans.Class
@@ -44,31 +41,28 @@ import Control.Monad.Trans.Either
44import Control.Monad.Trans.Except
41import Control.Monad.Trans.Except
45import Control.Monad.Trans.Maybe
42import Control.Monad.Trans.Maybe
46import Control.Monad.Trans.Reader
43import Control.Monad.Trans.Reader
47−import Control.Monad.Trans.Resource (MonadResource, ResourceT,
44+import Control.Monad.Trans.Resource (ResourceT, transResourceT)
49−import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
45+import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
50−import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
46+import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
51−import Control.Monad.Trans.State.Lazy (StateT, mapStateT)
47+import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
52−import qualified Control.Monad.Trans.State.Strict as Strict (StateT, mapStateT)
48+import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT, mapWriterT)
53−import Control.Monad.Trans.Writer.Lazy (WriterT, mapWriterT)
49+import Control.Monad.Trans.RWS.Lazy (RWST, mapRWST)
54−import qualified Control.Monad.Trans.Writer.Strict as Strict (WriterT,
50+import qualified Control.Monad.Trans.RWS.Strict as Strict (RWST, mapRWST)
56−import Data.Aeson (FromJSON (..), ToJSON (..),
51+import Data.Aeson (FromJSON (..), ToJSON (..),
58−import qualified Data.Aeson as A
53+import qualified Data.Aeson as A
59−import Data.Foldable as FT
54+import Data.Foldable as FT
60−import qualified Data.HashMap.Strict as HM
55+import qualified Data.HashMap.Strict as HM
61import Data.List
56import Data.List
62−import qualified Data.Map.Strict as M
57+import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
64−import Data.Semigroup as SG
58+import Data.Semigroup as SG
65import Data.String
59import Data.String
66import Data.String.Conv
60import Data.String.Conv
67−import Data.Text (Text)
61+import Data.Text (Text)
68−import qualified Data.Text as T
62+import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
63+import qualified Data.Text.Lazy.Builder as B
70import Data.Time
64import Data.Time
71−import GHC.Generics hiding (to)
65+import GHC.Generics hiding (to)
72#if MIN_VERSION_base(4, 8, 0)
66#if MIN_VERSION_base(4, 8, 0)
73#if !MIN_VERSION_base(4, 9, 0)
67#if !MIN_VERSION_base(4, 9, 0)
74import GHC.SrcLoc
68import GHC.SrcLoc
@@ -76,7 +70,7 @@ import GHC.SrcLoc
76import GHC.Stack
70import GHC.Stack
78import Language.Haskell.TH
72import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
73+import qualified Language.Haskell.TH.Syntax as TH
80import Lens.Micro
74import Lens.Micro
81import Lens.Micro.TH
75import Lens.Micro.TH
82import Network.HostName
76import Network.HostName
@@ -143,7 +137,7 @@ data Severity
143-- - 'V3' implies the maximum amount of payload information.
137-- - 'V3' implies the maximum amount of payload information.
144-- - Anything in between is left to the discretion of the developer.
138-- - Anything in between is left to the discretion of the developer.
145data Verbosity = V0 | V1 | V2 | V3
139data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
140+ deriving (Eq, Ord, Show, Read, Generic, Enum)
149-------------------------------------------------------------------------------
143-------------------------------------------------------------------------------
@@ -250,9 +244,7 @@ newtype ThreadIdText = ThreadIdText {
252mkThreadIdText :: ThreadId -> ThreadIdText
246mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
247+mkThreadIdText = ThreadIdText . T.pack . show
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
258-------------------------------------------------------------------------------
250-------------------------------------------------------------------------------
@@ -540,93 +532,52 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
541-- Scribes should always take a 'Severity' and 'Verbosity'.
533-- Scribes should always take a 'Severity' and 'Verbosity'.
543−-- Severity is used to __exclude log messages__ that are lower than
535+-- Severity is used to *exclude log messages* that are < the provided
544−-- the provided Severity. For instance, if the user passes InfoS,
536+-- Severity. For instance, if the user passes InfoS, DebugS items
545−-- DebugS items should be ignored. Katip provides the 'permitItem'
537+-- should be ignored. Katip provides the 'permitItem' utility for this.
546−-- utility for this. The user or the scribe may use 'permitAND' and
547−-- 'permitOR' to further customize this filtering, even dynamically if
550-- Verbosity is used to select keys from the log item's payload. Each
539-- Verbosity is used to select keys from the log item's payload. Each
551-- 'LogItem' instance describes what keys should be retained for each
540-- 'LogItem' instance describes what keys should be retained for each
552-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
541-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
542+-- that should be permitted.
555−-- Scribes provide a finalizer IO action ('scribeFinalizer') that is
544+-- There is no built-in mechanism in katip for telling a scribe that
556−-- meant to synchronously flush any remaining writes and clean up any
545+-- its time to shut down. 'unregisterScribe' merely drops it from the
557−-- resources acquired when the scribe was created. Internally, katip
546+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
558−-- keeps a buffer for each scribe's writes. When 'closeScribe' or
559−-- 'closeScribes' is called, that buffer stops accepting new log
560−-- messages and after the last item in its buffer is sent to 'liPush',
561−-- calls the finalizer. Thus, when the finalizer returns, katip can
562−-- assume that all resources are cleaned up and all log messages are
565−-- While katip internally buffers messages per 'ScribeSettings', it
548+-- 1. Pass in the resource when the scribe is created. Handle
566−-- sends them one at a time to the scribe. Depending on the scribe
549+-- allocation and release of the resource elsewhere. This is what the
567−-- itself, it may make sense for that scribe to keep its own internal
550+-- Handle scribe does.
568−-- buffer to batch-send logs if writing items one at a time is not
551+--
569−-- efficient. The scribe implementer must be sure that on
552+-- 2. Return a finalizing function that tells the scribe to shut
570−-- finalization, all writes are committed synchronously.
553+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns an @IO (Scribe,
571−
554+-- IO ())@. The finalizer will flush any queued log messages and shut
572−-- | Signature of a function passed to `Scribe` constructor and
555+-- down gracefully before returning. This can be hooked into your
573−-- mkScribe* functions that decides which messages to be
556+-- application's shutdown routine to ensure you never miss any log
574−-- logged. Typically filters based on 'Severity', but can be
557+-- messages on shutdown.
575−-- combined with other, custom logic with 'permitAND' and 'permitOR'
576−type PermitFunc = forall a. Item a -> IO Bool
579−-- | AND together 2 permit functions
580−permitAND :: PermitFunc -> PermitFunc -> PermitFunc
581−permitAND f1 f2 = \a -> liftA2 (&&) (f1 a) (f2 a)
583−-- | OR together 2 permit functions
584−permitOR :: PermitFunc -> PermitFunc -> PermitFunc
585−permitOR f1 f2 = \a -> liftA2 (||) (f1 a) (f2 a)
588data Scribe = Scribe {
558data Scribe = Scribe {
589− liPush :: forall a. LogItem a => Item a -> IO ()
559+ liPush :: forall a. LogItem a => Item a -> IO ()
590− -- ^ How do we write an item to the scribe's output?
591− , scribeFinalizer :: IO ()
560+ , scribeFinalizer :: IO ()
592− -- ^ Provide a __blocking__ finalizer to call when your scribe is
561+ -- ^ 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.
562+ -- removed. If this is not relevant to your scribe, return () is
595− , scribePermitItem :: PermitFunc
563+ -- fine.
596− -- ^ Provide a filtering function to allow the item to be logged,
597− -- or not. It can check Severity or some string in item's
598− -- body. The initial value of this is usually created from
599− -- 'permitItem'. Scribes and users can customize this by ANDing
600− -- or ORing onto the default with 'permitAND' or 'permitOR'
604−whenM :: Monad m => m Bool -> m () -> m ()
605−whenM mbool = (>>=) mbool . flip when
608−-- | Combine two scribes. Publishes to the left scribe if the left
609−-- would permit the item and to the right scribe if the right would
610−-- permit the item. Finalizers are called in sequence from left to
612instance Semigroup Scribe where
567instance Semigroup Scribe where
613− (Scribe pushA finA permitA) <> (Scribe pushB finB permitB) =
568+ (Scribe pushA finA) <> (Scribe pushB finB) =
614− Scribe (\item -> whenM (permitA item) (pushA item)
615− >> whenM (permitB item) (pushB item)
617− (finA `finally` finB)
569+ Scribe (\item -> pushA item >> pushB item) (finA `finally` finB)
618− (permitOR permitA permitB)
621instance Monoid Scribe where
572instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
573+ mempty = Scribe (const (return ())) (return ())
623 mappend = (<>)
574 mappend = (<>)
626-------------------------------------------------------------------------------
577-------------------------------------------------------------------------------
627data ScribeHandle = ScribeHandle {
578data ScribeHandle = ScribeHandle {
628 shScribe :: Scribe
579 shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
580+ , shChan :: BQ.TBQueue WorkerMessage
@@ -638,9 +589,8 @@ data WorkerMessage where
639-------------------------------------------------------------------------------
590-------------------------------------------------------------------------------
640-- | Should this item be logged given the user's maximum severity?
591-- | 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
592+permitItem :: Severity -> Item a -> Bool
643−permitItem sev item = return (_itemSeverity item >= sev)
593+permitItem sev i = _itemSeverity i >= sev
646-------------------------------------------------------------------------------
596-------------------------------------------------------------------------------
@@ -665,7 +615,7 @@ makeLenses ''LogEnv
667-------------------------------------------------------------------------------
617-------------------------------------------------------------------------------
668−-- | Create a reasonable default InitLogEnv. Uses an 'AutoUpdate' which
618+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' which
669-- updates the timer every 1ms. If you need even more timestamp
619-- updates the timer every 1ms. If you need even more timestamp
670-- precision at the cost of performance, consider setting
620-- precision at the cost of performance, consider setting
671-- '_logEnvTimer' with 'getCurrentTime'.
621-- '_logEnvTimer' with 'getCurrentTime'.
@@ -686,9 +636,7 @@ initLogEnv an env = LogEnv
687-------------------------------------------------------------------------------
637-------------------------------------------------------------------------------
688-- | Add a scribe to the list. All future log calls will go to this
638-- | 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
639+-- scribe in addition to the others.
690−-- ScribeSettings to prevent slow scribes from slowing down
691−-- logging. Writes will be dropped if the buffer fills.
692registerScribe
640registerScribe
694 -- ^ Name the scribe
642 -- ^ Name the scribe
@@ -712,7 +660,7 @@ registerScribe nm scribe ScribeSettings {..} le = do
713-------------------------------------------------------------------------------
661-------------------------------------------------------------------------------
714spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
662spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
663+spawnScribeWorker (Scribe write _) queue = Async.async go
718 newCmd <- atomically (BQ.readTBQueue queue)
666 newCmd <- atomically (BQ.readTBQueue queue)
@@ -741,7 +689,7 @@ defaultScribeSettings = ScribeSettings 4096
743-------------------------------------------------------------------------------
691-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
692+-- | Remove a scribe from the environment. This does *not* finalize
745-- the scribe. This mainly only makes sense to use with something like
693-- the scribe. This mainly only makes sense to use with something like
746-- MonadReader's @local@ function to temporarily disavow a single
694-- MonadReader's @local@ function to temporarily disavow a single
747-- logger for a block of code.
695-- logger for a block of code.
@@ -754,7 +702,7 @@ unregisterScribe nm = logEnvScribes %~ M.delete nm
756-------------------------------------------------------------------------------
704-------------------------------------------------------------------------------
757−-- | Unregister __all__ scribes. Note that this is __not__ for closing or
705+-- | Unregister *all* scribes. Note that this is *not* for closing or
758-- finalizing scribes, use 'closeScribes' for that. This mainly only
706-- finalizing scribes, use 'closeScribes' for that. This mainly only
759-- makes sense to use with something like MonadReader's @local@
707-- makes sense to use with something like MonadReader's @local@
760-- function to temporarily disavow any loggers for a block of code.
708-- function to temporarily disavow any loggers for a block of code.
@@ -766,10 +714,9 @@ clearScribes = logEnvScribes .~ mempty
767-------------------------------------------------------------------------------
715-------------------------------------------------------------------------------
768-- | Finalize a scribe. The scribe is removed from the environment,
716-- | Finalize a scribe. The scribe is removed from the environment,
769−-- its finalizer is called so that it can never be written to again
717+-- its finalizer is called and it can never be written to again. Note
770−-- and all pending writes are flushed. Note that this will throw any
771−-- exceptions yoru finalizer will throw, and that LogEnv is immutable,
718+-- that this will throw any exceptions yoru finalizer will throw, and
772−-- so it will not be removed in that case.
719+-- that LogEnv is immutable, so it will not be removed in that case.
773closeScribe
720closeScribe
775 -- ^ Name of the scribe
722 -- ^ Name of the scribe
@@ -880,8 +827,7 @@ instance (Katip m) => Katip (ResourceT m) where
880-- opposed to implementing 'Katip' for your monad.
827-- opposed to implementing 'Katip' for your monad.
881newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
828newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882 deriving ( Functor, Applicative, Monad, MonadIO
829 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
830+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
887instance MonadIO m => Katip (KatipT m) where
833instance MonadIO m => Katip (KatipT m) where
@@ -903,20 +849,9 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
903 restoreM = defaultRestoreM
849 restoreM = defaultRestoreM
905instance MonadUnliftIO m => MonadUnliftIO (KatipT m) where
851instance 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 $
852 askUnliftIO = KatipT $
911− withUnliftIO $ \u ->
853+ withUnliftIO $ \u ->
912− pure (UnliftIO (unliftIO u . unKatipT))
854+ pure (UnliftIO (unliftIO u . unKatipT))
915−#if MIN_VERSION_base(4, 9, 0)
916−instance MF.MonadFail m => MF.MonadFail (KatipT m) where
917− fail msg = lift (MF.fail msg)
921-------------------------------------------------------------------------------
856-------------------------------------------------------------------------------
922-- | Execute 'KatipT' on a log env.
857-- | Execute 'KatipT' on a log env.
@@ -948,32 +883,21 @@ logItem
949logItem a ns loc sev msg = do
884logItem a ns loc sev msg = do
950 LogEnv{..} <- getLogEnv
885 LogEnv{..} <- getLogEnv
951− logKatipItem =<< liftIO
886+ liftIO $ do
952− (Item <$> pure _logEnvApp
888+ <$> pure _logEnvApp
953− <*> pure _logEnvEnv
889+ <*> pure _logEnvEnv
954− <*> pure sev
890+ <*> pure sev
955− <*> (mkThreadIdText <$> myThreadId)
891+ <*> (mkThreadIdText <$> myThreadId)
956− <*> pure _logEnvHost
892+ <*> pure _logEnvHost
957− <*> pure _logEnvPid
893+ <*> pure _logEnvPid
958− <*> pure a
894+ <*> pure a
959− <*> pure msg
895+ <*> pure msg
960− <*> _logEnvTimer
896+ <*> _logEnvTimer
961− <*> pure (_logEnvApp <> ns)
897+ <*> pure (_logEnvApp <> ns)
962− <*> pure loc)
898+ <*> 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) $
976− void $ atomically (tryWriteTBQueue shChan (NewItem item))
899+ FT.forM_ (M.elems _logEnvScribes) $ \ ScribeHandle {..} -> atomically (tryWriteTBQueue shChan (NewItem item))
978-------------------------------------------------------------------------------
902-------------------------------------------------------------------------------
979tryWriteTBQueue
903tryWriteTBQueue
@@ -986,7 +910,6 @@ tryWriteTBQueue q a = do
986 unless full (writeTBQueue q a)
910 unless full (writeTBQueue q a)
987 return (not full)
911 return (not full)
990-------------------------------------------------------------------------------
913-------------------------------------------------------------------------------
991-- | Log with full context, but without any code location.
914-- | Log with full context, but without any code location.
@@ -1019,7 +942,7 @@ logException
1019logException a ns sev action = action `catchAny` \e -> f e >> throwM e
942logException a ns sev action = action `catchAny` \e -> f e >> throwM e
1021 f e = logF a ns sev (msg e)
944 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
945+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1025-------------------------------------------------------------------------------
948-------------------------------------------------------------------------------