@@ -1,12 +1,11 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DefaultSignatures #-}
32{-# LANGUAGE DeriveFunctor #-}
43{-# LANGUAGE DeriveGeneric #-}
54{-# LANGUAGE ExistentialQuantification #-}
65{-# LANGUAGE FlexibleContexts #-}
76{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GADTs #-}
97{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE ImplicitParams #-}
109{-# LANGUAGE MultiParamTypeClasses #-}
1110{-# LANGUAGE OverloadedStrings #-}
1211{-# LANGUAGE RankNTypes #-}
@@ -14,86 +13,59 @@
1413{-# LANGUAGE TemplateHaskell #-}
1514{-# LANGUAGE TypeFamilies #-}
1615{-# LANGUAGE UndecidableInstances #-}
17−#if MIN_VERSION_base(4, 9, 0)
18−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
19−#endif
2016-- | This module is not meant to be imported directly and may contain
2117-- internal mechanisms that will change without notice.
2218module Katip.Core where
2319
2420-------------------------------------------------------------------------------
25−import Control.Applicative as A
21+import Control.Applicative as A
2622import Control.AutoUpdate
2723import Control.Concurrent
28−import qualified Control.Concurrent.Async as Async
29−import Control.Concurrent.STM
30−import qualified Control.Concurrent.STM.TBQueue as BQ
31−import Control.Exception.Safe
32−import Control.Monad (unless, void, when)
3324import Control.Monad.Base
34−#if MIN_VERSION_base(4, 9, 0)
35−import qualified Control.Monad.Fail as MF
36−#endif
25+import Control.Monad.Catch
3726import Control.Monad.IO.Class
38−import Control.Monad.IO.Unlift
3927import Control.Monad.Trans.Class
4028import Control.Monad.Trans.Control
41−#if !MIN_VERSION_either(4, 5, 0)
4229import Control.Monad.Trans.Either
43−#endif
4430import Control.Monad.Trans.Except
4531import Control.Monad.Trans.Maybe
4632import 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
33+import Control.Monad.Trans.Resource
34+import Control.Monad.Trans.State
35+import Control.Monad.Trans.Writer
36+import Data.Aeson (FromJSON (..), ToJSON (..),
37+ object)
38+import qualified Data.Aeson as A
39+import Data.Foldable as FT
40+import qualified Data.HashMap.Strict as HM
6141import Data.List
62−import qualified Data.Map.Strict as M
63−import Data.Maybe (fromMaybe)
64−import Data.Semigroup as SG
42+import qualified Data.Map.Strict as M
43+import Data.Semigroup
6544import Data.String
6645import Data.String.Conv
67−import Data.Text (Text)
68−import qualified Data.Text as T
69−import qualified Data.Text.Lazy.Builder as B
46+import Data.Text (Text)
47+import qualified Data.Text as T
48+import qualified Data.Text.Lazy.Builder as B
7049import Data.Time
71−import GHC.Generics hiding (to)
50+import GHC.Generics hiding (to)
7251#if MIN_VERSION_base(4, 8, 0)
73−#if !MIN_VERSION_base(4, 9, 0)
7452import GHC.SrcLoc
75−#endif
7653import GHC.Stack
7754#endif
7855import Language.Haskell.TH
79−import qualified Language.Haskell.TH.Syntax as TH
56+import qualified Language.Haskell.TH.Syntax as TH
8057import Lens.Micro
8158import Lens.Micro.TH
8259import Network.HostName
83−#if mingw32_HOST_OS
84−import Katip.Compat
85−#else
8660import System.Posix
87−#endif
88−
8961-------------------------------------------------------------------------------
9062
9163
9264readMay :: Read a => String -> Maybe a
9365readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
9466 [x] -> Just x
95− [] -> Nothing -- no parse
96− _ -> Nothing -- Ambiguous parse
67+ [] -> Nothing -- no parse
68+ _ -> Nothing -- Ambiguous parse
9769
9870
9971-------------------------------------------------------------------------------
@@ -103,7 +75,7 @@ readMay s = case [x | (x,t) <- reads s, ("","") <- lex t] of
10375-- IsString/OverloadedStrings, so "foo" will result in Namespace
10476-- ["foo"].
10577newtype Namespace = Namespace { unNamespace :: [Text] }
106− deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,SG.Semigroup,Monoid)
78+ deriving (Eq,Show,Read,Ord,Generic,ToJSON,FromJSON,Semigroup,Monoid)
10779
10880instance IsString Namespace where
10981 fromString s = Namespace [fromString s]
@@ -143,35 +115,33 @@ data Severity
143115-- - 'V3' implies the maximum amount of payload information.
144116-- - Anything in between is left to the discretion of the developer.
145117data Verbosity = V0 | V1 | V2 | V3
146− deriving (Eq, Ord, Show, Read, Generic, Enum, Bounded)
118+ deriving (Eq, Ord, Show, Read, Generic, Enum)
147119
148120
149121-------------------------------------------------------------------------------
150122renderSeverity :: Severity -> Text
151123renderSeverity s = case s of
152− DebugS -> "Debug"
153− InfoS -> "Info"
154− NoticeS -> "Notice"
155− WarningS -> "Warning"
156− ErrorS -> "Error"
157− CriticalS -> "Critical"
158− AlertS -> "Alert"
124+ DebugS -> "Debug"
125+ InfoS -> "Info"
126+ NoticeS -> "Notice"
127+ WarningS -> "Warning"
128+ ErrorS -> "Error"
129+ CriticalS -> "Critical"
130+ AlertS -> "Alert"
159131 EmergencyS -> "Emergency"
160132
161133
162134-------------------------------------------------------------------------------
163135textToSeverity :: Text -> Maybe Severity
164−textToSeverity = go . T.toLower
165− where
166− go "debug" = Just DebugS
167− go "info" = Just InfoS
168− go "notice" = Just NoticeS
169− go "warning" = Just WarningS
170− go "error" = Just ErrorS
171− go "critical" = Just CriticalS
172− go "alert" = Just AlertS
173− go "emergency" = Just EmergencyS
174− go _ = Nothing
136+textToSeverity "Debug" = Just DebugS
137+textToSeverity "Info" = Just InfoS
138+textToSeverity "Notice" = Just NoticeS
139+textToSeverity "Warning" = Just WarningS
140+textToSeverity "Error" = Just ErrorS
141+textToSeverity "Critical" = Just CriticalS
142+textToSeverity "Alert" = Just AlertS
143+textToSeverity "Emergency" = Just EmergencyS
144+textToSeverity _ = Nothing
175145
176146
177147instance ToJSON Severity where
@@ -181,29 +151,14 @@ instance FromJSON Severity where
181151 parseJSON = A.withText "Severity" parseSeverity
182152 where
183153 parseSeverity t = case textToSeverity t of
184− Just x -> return x
154+ Just x -> return x
185155 Nothing -> fail $ "Invalid Severity " ++ toS t
186156
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−
202157
203158-------------------------------------------------------------------------------
204−-- | Log message with Builder underneath; use '<>' to concat in O(1).
159+-- | Log message with Builder unerneath; use '<>' to concat in O(1).
205160newtype LogStr = LogStr { unLogStr :: B.Builder }
206− deriving (Generic, Show, Eq)
161+ deriving (Generic, Show)
207162
208163instance IsString LogStr where
209164 fromString = LogStr . B.fromString
@@ -225,7 +180,7 @@ instance FromJSON LogStr where
225180
226181-------------------------------------------------------------------------------
227182-- | Pack any string-like thing into a 'LogStr'. This will
228−-- automatically work on 'String', 'ByteString', 'Text' and any of the
183+-- automatically work on 'String', 'ByteString, 'Text' and any of the
229184-- lazy variants.
230185logStr :: StringConv a Text => a -> LogStr
231186logStr t = LogStr (B.fromText $ toS t)
@@ -238,7 +193,7 @@ ls = logStr
238193
239194
240195-------------------------------------------------------------------------------
241−-- | Convert any showable type into a 'LogStr'.
196+-- | Convert any showable type into a LogStr.
242197showLS :: Show a => a -> LogStr
243198showLS = ls . show
244199
@@ -250,9 +205,7 @@ newtype ThreadIdText = ThreadIdText {
250205
251206
252207mkThreadIdText :: ThreadId -> ThreadIdText
253−mkThreadIdText = ThreadIdText . stripPrefix' "ThreadId " . T.pack . show
254− where
255− stripPrefix' pfx t = fromMaybe t (T.stripPrefix pfx t)
208+mkThreadIdText = ThreadIdText . T.pack . show
256209
257210
258211-------------------------------------------------------------------------------
@@ -272,62 +225,31 @@ data Item a = Item {
272225 } deriving (Generic, Functor)
273226makeLenses ''Item
274227
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− ]
298228
299229instance 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 ", "
230+ show Item{..} = "Item {_itemApp = " ++ show _itemApp ++ ", " ++
231+ "_itemEnv = " ++ show _itemEnv ++ ", " ++
232+ "_itemSeverity = " ++ show _itemSeverity ++ ", " ++
233+ "_itemThread = " ++ show _itemThread ++ ", " ++
234+ "_itemHost = " ++ show _itemHost ++ ", " ++
235+ "_itemProcess = " ++ show _itemProcess ++ ", " ++
236+ "_itemPayload = " ++ show _itemPayload ++ ", " ++
237+ "_itemMessage = " ++ show _itemMessage ++ ", " ++
238+ "_itemTime = " ++ show _itemTime ++ ", " ++
239+ "_itemNamespace = " ++ show _itemNamespace ++ ", " ++
240+ "_itemLoc = " ++ show (LocShow <$> _itemLoc) ++ "}"
241+
316242
317243newtype LocShow = LocShow Loc
318244
319245
320246instance 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 ", "
247+ show (LocShow Loc{..}) =
248+ "Loc {loc_filename = " ++ show loc_filename ++ ", " ++
249+ "loc_package = " ++ show loc_package ++ ", " ++
250+ "loc_module = " ++ show loc_module ++ ", " ++
251+ "loc_start = " ++ show loc_start ++ ", " ++
252+ "loc_end = " ++ show loc_end ++ "}"
331253
332254
333255instance ToJSON a => ToJSON (Item a) where
@@ -408,7 +330,7 @@ instance FromJSON ProcessIDJs where
408330 parseJSON = A.withText "ProcessID" parseProcessID
409331 where
410332 parseProcessID t = case textToProcessID t of
411− Just p -> return $ ProcessIDJs p
333+ Just p -> return $ ProcessIDJs p
412334 Nothing -> fail $ "Invalid ProcessIDJs " ++ toS t
413335
414336
@@ -440,12 +362,11 @@ instance Monoid PayloadSelection where
440362-- a ToJSON instance like:
441363--
442364-- > instance ToObject Foo
443−class ToObject a where
365+class ToJSON a => ToObject a where
444366 toObject :: a -> A.Object
445− default toObject :: ToJSON a => a -> A.Object
446367 toObject v = case toJSON v of
447368 A.Object o -> o
448− _ -> mempty
369+ _ -> mempty
449370
450371instance ToObject ()
451372instance ToObject A.Object
@@ -497,7 +418,7 @@ instance ToObject SimpleLogPayload
497418
498419instance LogItem SimpleLogPayload where
499420 payloadKeys V0 _ = SomeKeys []
500− payloadKeys _ _ = AllKeys
421+ payloadKeys _ _ = AllKeys
501422
502423
503424instance Semigroup SimpleLogPayload where
@@ -520,7 +441,7 @@ sl a b = SimpleLogPayload [(a, AnyLogPayload b)]
520441-- automatically bubble higher verbosity levels to lower ones.
521442payloadObject :: LogItem a => Verbosity -> a -> A.Object
522443payloadObject verb a = case FT.foldMap (flip payloadKeys a) [(V0)..verb] of
523− AllKeys -> toObject a
444+ AllKeys -> toObject a
524445 SomeKeys ks -> HM.filterWithKey (\ k _ -> k `FT.elem` ks) $ toObject a
525446
526447
@@ -540,107 +461,49 @@ itemJson verb a = toJSON $ a & itemPayload %~ payloadObject verb
540461--
541462-- Scribes should always take a 'Severity' and 'Verbosity'.
542463--
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.
464+-- Severity is used to *exclude log messages* that are < the provided
465+-- Severity. For instance, if the user passes InfoS, DebugS items
466+-- should be ignored. Katip provides the 'permitItem' utility for this.
549467--
550468-- Verbosity is used to select keys from the log item's payload. Each
551469-- 'LogItem' instance describes what keys should be retained for each
552470-- Verbosity level. Use the 'payloadObject' utility for extracting the keys
553−-- that should be written.
471+-- that should be permitted.
554472--
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.
473+-- There is no built-in mechanism in katip for telling a scribe that
474+-- its time to shut down. 'unregisterScribe' merely drops it from the
475+-- 'LogEnv'. This means there are 2 ways to handle resources as a scribe:
564476--
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)
477+-- 1. Pass in the resource when the scribe is created. Handle
478+-- allocation and release of the resource elsewhere. This is what the
479+-- Handle scribe does.
480+--
481+-- 2. Return a finalizing function that tells the scribe to shut
482+-- down. @katip-elasticsearch@'s @mkEsScribe@ returns a @IO (Scribe,
483+-- IO ())@. The finalizer will flush any queued log messages and shut
484+-- down gracefully before returning. This can be hooked into your
485+-- application's shutdown routine to ensure you never miss any log
486+-- messages on shutdown.
487+data Scribe = Scribe {
488+ liPush :: forall a. LogItem a => Item a -> IO ()
489+ }
586490
587491
588−data 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'
601− }
602−
603−
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.
612492instance 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)
493+ (Scribe a) <> (Scribe b) = Scribe $ \ item -> do
494+ a item
495+ b item
619496
620497
621498instance Monoid Scribe where
622− mempty = Scribe (const (return ())) (return ()) (permitItem DebugS)
499+ mempty = Scribe $ const $ return ()
623500 mappend = (<>)
624501
625502
626−-------------------------------------------------------------------------------
627−data ScribeHandle = ScribeHandle {
628− shScribe :: Scribe
629− , shChan :: BQ.TBQueue WorkerMessage
630− }
631−
632−
633−-------------------------------------------------------------------------------
634−data WorkerMessage where
635− NewItem :: LogItem a => Item a -> WorkerMessage
636− PoisonPill :: WorkerMessage
637−
638−
639503-------------------------------------------------------------------------------
640504-- | 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)
505+permitItem :: Severity -> Item a -> Bool
506+permitItem sev i = _itemSeverity i >= sev
644507
645508
646509-------------------------------------------------------------------------------
@@ -659,16 +522,16 @@ data LogEnv = LogEnv {
659522 -- 'AutoUpdate' for high volume logs but note that this may cause
660523 -- some output forms to display logs out of order. Alternatively,
661524 -- you could just use 'getCurrentTime'.
662− , _logEnvScribes :: M.Map Text ScribeHandle
525+ , _logEnvScribes :: M.Map Text Scribe
663526 }
664527makeLenses ''LogEnv
665528
666529
667530-------------------------------------------------------------------------------
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'.
531+-- | Create a reasonable default InitLogEnv. Uses an 'AutoUdate' with
532+-- the default settings as the timer. If you are concerned about
533+-- timestamp precision or event ordering in log outputs like
534+-- ElasticSearch, you should replace the timer with 'getCurrentTime'
672535initLogEnv
673536 :: Namespace
674537 -- ^ A base namespace for this application
@@ -680,123 +543,45 @@ initLogEnv an env = LogEnv
680543 <*> getProcessID
681544 <*> pure an
682545 <*> pure env
683− <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime, updateFreq = 1000 }
546+ <*> mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentTime }
684547 <*> pure mempty
685548
686549
687550-------------------------------------------------------------------------------
688551-- | 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.
552+-- scribe in addition to the others.
692553registerScribe
693554 :: Text
694555 -- ^ Name the scribe
695556 -> Scribe
696− -> ScribeSettings
697557 -> LogEnv
698− -> IO LogEnv
699−registerScribe nm scribe ScribeSettings {..} le = do
700− queue <- atomically (BQ.newTBQueue (fromIntegral _scribeBufferSize))
701− worker <- spawnScribeWorker scribe queue
702− let fin = do
703− atomically (BQ.writeTBQueue queue PoisonPill)
704− -- wait for our worker to finish final write
705− void (Async.waitCatch worker)
706− -- wait for scribe to finish final write
707− void (scribeFinalizer scribe)
708−
709− let sh = ScribeHandle (scribe { scribeFinalizer = fin }) queue
710− return (le & logEnvScribes %~ M.insert nm sh)
711−
712−
713−-------------------------------------------------------------------------------
714−spawnScribeWorker :: Scribe -> BQ.TBQueue WorkerMessage -> IO (Async.Async ())
715−spawnScribeWorker (Scribe write _ _) queue = Async.async go
716− where
717− go = do
718− newCmd <- atomically (BQ.readTBQueue queue)
719− case newCmd of
720− NewItem a -> do
721− -- Swallow any direct exceptions from the
722− -- scribe. safe-exceptions won't catch async exceptions.
723− void (tryAny (write a))
724− go
725− PoisonPill -> return ()
726−
727−
728−-------------------------------------------------------------------------------
729−data ScribeSettings = ScribeSettings {
730− _scribeBufferSize :: Int
731− }
732− deriving (Show, Eq)
733−
734−makeLenses ''ScribeSettings
735−
736−
737−-- | Reasonable defaults for a scribe. Buffer
738−-- size of 4096.
739−defaultScribeSettings :: ScribeSettings
740−defaultScribeSettings = ScribeSettings 4096
558+ -> LogEnv
559+registerScribe nm h = logEnvScribes %~ M.insert nm h
741560
742561
743562-------------------------------------------------------------------------------
744−-- | Remove a scribe from the environment. This does __not__ finalize
745−-- the scribe. This mainly only makes sense to use with something like
746−-- MonadReader's @local@ function to temporarily disavow a single
747−-- logger for a block of code.
563+-- | Remove a scribe from the list. All future log calls will no
564+-- longer use this scribe. If the given scribe doesn't exist, its a no-op.
748565unregisterScribe
749566 :: Text
750567 -- ^ Name of the scribe
751568 -> LogEnv
752569 -> LogEnv
753−unregisterScribe nm = logEnvScribes %~ M.delete nm
570+unregisterScribe nm = logEnvScribes %~ M.delete nm
754571
755572
756573-------------------------------------------------------------------------------
757−-- | Unregister __all__ scribes. Note that this is __not__ for closing or
758−-- finalizing scribes, use 'closeScribes' for that. This mainly only
759−-- makes sense to use with something like MonadReader's @local@
760−-- function to temporarily disavow any loggers for a block of code.
574+-- | Unregister *all* scribes. Logs will go off into space from this
575+-- point onward until new scribes are added. Note that you could use
576+-- this with `local` if you're using a Reader based stack to
577+-- temporarily disable log output. See `katipNoLogging` for an
578+-- example.
761579clearScribes
762580 :: LogEnv
763581 -> LogEnv
764582clearScribes = logEnvScribes .~ mempty
765583
766584
767−-------------------------------------------------------------------------------
768−-- | 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.
773−closeScribe
774− :: Text
775− -- ^ Name of the scribe
776− -> LogEnv
777− -> IO LogEnv
778−closeScribe nm le = do
779− maybe (return ()) (scribeFinalizer . shScribe) (M.lookup nm (_logEnvScribes le))
780− return (le & logEnvScribes %~ M.delete nm)
781−
782−
783−-------------------------------------------------------------------------------
784−-- | Call this at the end of your program. This is a blocking call
785−-- that stop writing to a scribe's queue, waits for the queue to
786−-- 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.
789−closeScribes
790− :: LogEnv
791− -> 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)
798−
799−
800585-------------------------------------------------------------------------------
801586-- | Monads where katip logging actions can be performed. Katip is the
802587-- most basic logging monad. You will typically use this directly if
@@ -807,86 +592,44 @@ closeScribes le = do
807592-- which keeps a namespace and merged context. You can write simple
808593-- functions that add additional namespacing and merges additional
809594-- 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.
815595class MonadIO m => Katip m where
816596 getLogEnv :: m LogEnv
817− localLogEnv :: (LogEnv -> LogEnv) -> m a -> m a
818597
819598
820599instance Katip m => Katip (ReaderT s m) where
821600 getLogEnv = lift getLogEnv
822− localLogEnv = mapReaderT . localLogEnv
823601
824602
825−#if !MIN_VERSION_either(4, 5, 0)
826603instance Katip m => Katip (EitherT s m) where
827604 getLogEnv = lift getLogEnv
828− localLogEnv = mapEitherT . localLogEnv
829−#endif
830−
831605
832606instance Katip m => Katip (ExceptT s m) where
833607 getLogEnv = lift getLogEnv
834− localLogEnv = mapExceptT . localLogEnv
835−
836608
837609instance Katip m => Katip (MaybeT m) where
838610 getLogEnv = lift getLogEnv
839− localLogEnv = mapMaybeT . localLogEnv
840611
841612
842613instance Katip m => Katip (StateT s m) where
843614 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
860615
861616
862617instance (Katip m, Monoid s) => Katip (WriterT s m) where
863618 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−
871619
872620instance (Katip m) => Katip (ResourceT m) where
873621 getLogEnv = lift getLogEnv
874− localLogEnv = transResourceT . localLogEnv
875622
876623
877624-------------------------------------------------------------------------------
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.
625+-- | A concrete monad you can use to run logging actions.
881626newtype KatipT m a = KatipT { unKatipT :: ReaderT LogEnv m a }
882627 deriving ( Functor, Applicative, Monad, MonadIO
883− , MonadMask, MonadCatch, MonadThrow, MonadResource, MonadTrans
884− , MonadBase b)
628+ , MonadMask, MonadCatch, MonadThrow, MonadTrans, MonadBase b)
885629
886630
887631instance MonadIO m => Katip (KatipT m) where
888632 getLogEnv = KatipT ask
889− localLogEnv f (KatipT m) = KatipT $ local f m
890633
891634
892635instance MonadTransControl KatipT where
@@ -902,21 +645,6 @@ instance (MonadBaseControl b m) => MonadBaseControl b (KatipT m) where
902645 liftBaseWith = defaultLiftBaseWith
903646 restoreM = defaultRestoreM
904647
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
920648
921649-------------------------------------------------------------------------------
922650-- | Execute 'KatipT' on a log env.
@@ -924,17 +652,6 @@ runKatipT :: LogEnv -> KatipT m a -> m a
924652runKatipT le (KatipT f) = runReaderT f le
925653
926654
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−
938655-------------------------------------------------------------------------------
939656-- | Log with everything, including a source code location. This is
940657-- very low level and you typically can use 'logT' in its place.
@@ -948,43 +665,20 @@ logItem
948665 -> m ()
949666logItem a ns loc sev msg = do
950667 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))
977−
978−-------------------------------------------------------------------------------
979−tryWriteTBQueue
980− :: TBQueue a
981− -> a
982− -> STM Bool
983− -- ^ Did we write?
984−tryWriteTBQueue q a = do
985− full <- isFullTBQueue q
986− unless full (writeTBQueue q a)
987− return (not full)
668+ liftIO $ do
669+ item <- Item
670+ <$> pure _logEnvApp
671+ <*> pure _logEnvEnv
672+ <*> pure sev
673+ <*> (mkThreadIdText <$> myThreadId)
674+ <*> pure _logEnvHost
675+ <*> pure _logEnvPid
676+ <*> pure a
677+ <*> pure msg
678+ <*> _logEnvTimer
679+ <*> pure (_logEnvApp <> ns)
680+ <*> pure loc
681+ FT.forM_ (M.elems _logEnvScribes) $ \ (Scribe h) -> h item
988682
989683
990684-------------------------------------------------------------------------------
@@ -1016,10 +710,10 @@ logException
1016710 -> Severity -- ^ Severity
1017711 -> m b -- ^ Main action being run
1018712 -> m b
1019−logException a ns sev action = action `catchAny` \e -> f e >> throwM e
713+logException a ns sev action = action `catchAll` \e -> f e >> throwM e
1020714 where
1021715 f e = logF a ns sev (msg e)
1022− msg e = ls (T.pack "An exception has occurred: ") <> showLS e
716+ msg e = ls (T.pack "An exception has occured: ") <> showLS e
1023717
1024718
1025719-------------------------------------------------------------------------------
@@ -1047,14 +741,14 @@ instance TH.Lift Verbosity where
1047741
1048742
1049743instance TH.Lift Severity where
1050− lift DebugS = [| DebugS |]
1051− lift InfoS = [| InfoS |]
1052− lift NoticeS = [| NoticeS |]
1053− lift WarningS = [| WarningS |]
1054− lift ErrorS = [| ErrorS |]
744+ lift DebugS = [| DebugS |]
745+ lift InfoS = [| InfoS |]
746+ lift NoticeS = [| NoticeS |]
747+ lift WarningS = [| WarningS |]
748+ lift ErrorS = [| ErrorS |]
1055749 lift CriticalS = [| CriticalS |]
1056− lift AlertS = [| AlertS |]
1057− lift EmergencyS = [| EmergencyS |]
750+ lift AlertS = [| AlertS |]
751+ lift EmergencyS = [| EmergencyS |]
1058752
1059753
1060754-- | Lift a location into an Exp.
@@ -1073,15 +767,11 @@ liftLoc (Loc a b c (d1, d2) (e1, e2)) = [|Loc
1073767-- fill the 'Maybe Loc' gap in 'logF' of this module, and relies on implicit
1074768-- callstacks when available (GHC > 7.8).
1075769#if MIN_VERSION_base(4, 8, 0)
1076−getLoc :: HasCallStack => Maybe Loc
1077−getLoc = case getCallStack callStack of
770+getLoc :: (?loc :: CallStack) => Maybe Loc
771+getLoc = case getCallStack ?loc of
1078772 [] -> Nothing
1079− xs -> Just . toLoc . head $ filter filterKatip xs
773+ xs -> Just . toLoc . last $ xs
1080774 where
1081− filterKatip :: (String, SrcLoc) -> Bool
1082− filterKatip (_, srcloc) = not $
1083− "katip-" `isPrefixOf` srcLocPackage srcloc
1084−
1085775 toLoc :: (String, SrcLoc) -> Loc
1086776 toLoc (_, l) = Loc {
1087777 loc_filename = srcLocFile l
@@ -1112,7 +802,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1112802
1113803
1114804-------------------------------------------------------------------------------
1115−-- | 'Loc'-tagged logging using 'GHC.Stack' when available.
805+-- | 'Loc'-tagged logging using implicit-callstacks when available.
1116806--
1117807-- This function does not require template-haskell as it
1118808-- automatically uses <https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-Stack.html#v:getCallStack implicit-callstacks>
@@ -1122,11 +812,7 @@ logT = [| \ a ns sev msg -> logItem a ns (Just $(getLocTH)) sev msg |]
1122812-- `logT` for maximum compatibility.
1123813--
1124814-- @logLoc obj mempty InfoS "Hello world"@
1125−#if MIN_VERSION_base(4, 8, 0)
1126−logLoc :: (Applicative m, LogItem a, Katip m, HasCallStack)
1127−#else
1128815logLoc :: (Applicative m, LogItem a, Katip m)
1129−#endif
1130816 => a
1131817 -> Namespace
1132818 -> Severity