master..592cccb · typeable/control-logger

.gitignore−2

@@ -1,3 +1 @@

11.stack-work

2−*~

3−*.swp

README.md+1−1

@@ -1,3 +1,3 @@

11# control-logger

22

3−Utilities for logging

3+Utilities for logging with DTT projects

control-logger.cabal+43−51

@@ -1,55 +1,47 @@

1−cabal-version: 2.4

2−name: control-logger

3−version: 0.1.0.0

4−synopsis: Logger used by all projects

5−license-file: LICENSE

6−build-type: Simple

1+cabal-version: 2.4

2+name: control-logger

3+version: 0.1.0.0

4+synopsis: Logger used by all projects

5+license-file: LICENSE

6+build-type: Simple

77

88library

9− hs-source-dirs: src

10− ghc-options: -Wall

11−

9+ hs-source-dirs: src

10+ ghc-options: -Wall

1211 if !impl(ghcjs)

13− exposed-modules:

14− Control.Logger

15− Control.Logger.Katip

16− Control.Logger.Katip.Utils

17− Control.Logger.Orphans

18−

19− exposed-modules: Control.Logger.Internal

20− build-depends:

21− , aeson

22− , base >=4.11

23− , bytestring

24− , control-has

25− , control-has-katip

26− , deepseq

27− , exceptions

28− , fast-logger >=2.4.11

29− , http-client

30− , lens

31− , monad-logger

32− , mtl

33− , shakespeare

34− , text

35− , time

36− , unordered-containers

37−

12+ exposed-modules: Control.Logger

13+ Control.Logger.Katip

14+ Control.Logger.Katip.Utils

15+ Control.Logger.Orphans

16+ exposed-modules: Control.Logger.Internal

17+ build-depends: base

18+ , aeson

19+ , bytestring

20+ , control-has

21+ , control-has-katip

22+ , deepseq

23+ , exceptions

24+ , fast-logger

25+ , http-client

26+ , lens

27+ , monad-logger

28+ , mtl

29+ , shakespeare

30+ , text

31+ , time

32+ , unordered-containers

3833 if !impl(ghcjs)

39− build-depends:

40− , katip >=0.8.8.0

41− , optparse-applicative

42−

43− default-language: Haskell2010

44− default-extensions:

45− ConstraintKinds

46− DataKinds

47− DeriveGeneric

48− FlexibleContexts

49− FlexibleInstances

50− LambdaCase

51− OverloadedStrings

52− RankNTypes

53− RecordWildCards

54− ScopedTypeVariables

55− TypeSynonymInstances

34+ build-depends: katip

35+ , optparse-applicative

36+ default-language: Haskell2010

37+ default-extensions: RankNTypes

38+ DataKinds

39+ FlexibleContexts

40+ FlexibleInstances

41+ LambdaCase

42+ OverloadedStrings

43+ ScopedTypeVariables

44+ DeriveGeneric

45+ ConstraintKinds

46+ RecordWildCards

47+ TypeSynonymInstances

default.nixdeleted−9

@@ -1,9 +0,0 @@

1−{ pkgs ? import <nixpkgs> {} }:

2−

3−pkgs.mkShell {

4− buildInputs = [

5− pkgs.ghc

6− pkgs.haskellPackages.cabal-install

7− pkgs.zlib

8− ];

9−}

src/Control/Logger.hs+11−65

@@ -1,10 +1,7 @@

1−{-# LANGUAGE CPP #-}

1+

22module Control.Logger

33 ( Logger

44 , loggerContext

5− , scrubber

6− , censor

7− , censorWith

85 , logMsg

96 , logMsgWith

107 , logInfo

@@ -35,27 +32,20 @@ module Control.Logger

3532 , compactCallStack

3633 , st

3734 , ToObject(..)

38− , withScrubber

39− , censoringWith

40− , censoring

4135 ) where

4236

4337import Control.Has

44−import Control.Lens hiding (censoring)

4538import Control.Logger.Internal

46−import Control.Logger.Orphans ()

47−import Control.Monad

39+import Control.Logger.Orphans ()

4840import Control.Monad.Catch

49−import Control.Monad.IO.Class

50−import qualified Data.List as List

51−import Data.Monoid

52−import Data.Text (Text)

53−import qualified Data.Text as Text

41+import qualified Data.List as List

42+import Data.Text (Text)

43+import qualified Data.Text as Text

5444import Data.Time

5545import GHC.Stack

56−import Katip (ToObject (..))

46+import Katip (ToObject(..))

5747import System.Log.FastLogger

58−import Text.Shakespeare.Text (st)

48+import Text.Shakespeare.Text (st)

5949

6050logError

6151 :: (LoggingMonad r m)

@@ -109,50 +99,6 @@ logErrorWith

10999 -> m ()

110100logErrorWith logger msg = withFrozenCallStack (logMsgWith logger Error msg)

111101

112−safeReplace :: Text -> Text -> Text -> Text

113−safeReplace what with where_

114− | Text.null what = where_

115− | otherwise = Text.replace what with where_

116−

117−-- | Add a some text to scrubber

118−censorWith :: Text -> Text -> Logger -> Logger

119−censorWith replacement needle l =

120− l & scrubber <>~ Endo (safeReplace needle replacement)

121−

122−-- | Censor with "***"

123−censor :: Text -> Logger -> Logger

124−censor = censorWith "***"

125−

126−-- | Run an action with adjusted scrubber

127−withScrubber

128− :: forall r m a. (Has Logger r, MonadReader r m)

129− => (Endo Text -> Endo Text)

130− -> m a

131− -> m a

132−withScrubber scrubF = local expandScrubber

133− where

134− expandScrubber :: r -> r

135− expandScrubber = over part (over scrubber scrubF)

136−

137−-- | Run an action while censoring additional text from logs

138−censoringWith

139− :: (Has Logger r, MonadReader r m)

140− => Text

141− -> Text

142− -> m a

143− -> m a

144−censoringWith replacement txt = withScrubber (<> censored)

145− where

146− censored = Endo (safeReplace txt replacement)

147−

148−-- | Run an action while censoring additional text from logs

149−censoring

150− :: (Has Logger r, MonadReader r m)

151− => Text

152− -> m a

153− -> m a

154−censoring = censoringWith "***"

155−

156102-- | Log exceptions occured in computation and just ignore them.

157103tryLogError

158104 :: (MonadIO m, MonadCatch m, Has Logger r, MonadReader r m)

@@ -203,14 +149,14 @@ fileLogger :: MonadIO m => FilePath -> m Logger

203149fileLogger fp = fastFunc <$> liftIO (newFileLoggerSet defaultBufSize fp)

204150

205151silentLogger :: Logger

206−silentLogger = Logger mempty mempty (\_ _ _ _ -> return ())

152+silentLogger = Logger mempty (\_ _ _ _ -> return ())

207153

208154-- | Logger which flushes buffer after each message. This is useful with

209155-- stderrLogger.

210156flushingFastFunc

211157 :: LogSeverity -> LoggerSet -> Logger

212158flushingFastFunc minLogLevel loggerSet =

213− Logger mempty mempty $ \_ stack logLevel msg ->

159+ Logger mempty $ \_ stack logLevel msg ->

214160 when (logLevel >= minLogLevel) $ do

215161 ts <- getCurrentTime

216162 pushLogStr loggerSet

@@ -234,14 +180,14 @@ flushingStderrLogger =

234180-- | Make our outdated 'Logger' of fast-logger's 'LoggerSet'

235181fastFunc :: LoggerSet -> Logger

236182fastFunc loggerSet =

237− Logger mempty mempty $ \_ _ _ msg -> pushLogStr loggerSet $ toLogStr msg

183+ Logger mempty $ \_ _ _ msg -> pushLogStr loggerSet $ toLogStr msg

238184

239185type LogSource = Text

240186

241187-- | Default logger tests and same things.

242188defaultFastFunc :: LogSource -> LogSeverity -> LoggerSet -> Logger

243189defaultFastFunc loc minLogLevel loggerSet =

244− Logger mempty mempty $ \_ stack s msg -> when (s >= minLogLevel) $ do

190+ Logger mempty $ \_ stack s msg -> when (s >= minLogLevel) $ do

245191 ts <- getCurrentTime

246192 pushLogStr loggerSet $ formatLogStr ts stack loc s (toLogStr msg)

247193

src/Control/Logger/Internal.hs+8−29

@@ -1,12 +1,9 @@

11{-# LANGUAGE TemplateHaskell #-}

2−{-# LANGUAGE NamedFieldPuns #-}

3−{-# LANGUAGE CPP #-}

42

53module Control.Logger.Internal

64 ( Logger(..)

75 , loggerContext

86 , loggerAction

9− , scrubber

107 , runLogger

118 , LogSeverity(..)

129 , LoggingMonad

@@ -16,11 +13,10 @@ module Control.Logger.Internal

1613

1714import Control.Has

1815import Control.Lens

19−import Control.Monad.IO.Class

2016import Control.DeepSeq

21−import Data.Aeson (ToJSON, FromJSON, Object, Value(..))

17+import Data.Aeson (ToJSON, FromJSON, Object)

2218import Data.Text (Text)

23−import Data.Monoid

19+import GHC.Generics (Generic)

2420import GHC.Stack

2521

2622

@@ -34,26 +30,23 @@ data LogSeverity

3430instance ToJSON LogSeverity

3531instance FromJSON LogSeverity

3632

37−data Logger = Logger

33+data Logger

34+ = Logger

3835 { _loggerContext :: Object

39− , _scrubber :: Endo Text

4036 , _loggerAction :: Object -> CallStack -> LogSeverity -> Text -> IO ()

4137 } deriving Generic

4238

43−instance NFData Logger where

44− rnf Logger{_loggerContext, _scrubber, _loggerAction} =

45− rnf _loggerContext `deepseq` rwhnf (appEndo _scrubber) `deepseq` rwhnf _loggerAction

39+instance NFData Logger

4640

4741makeLenses ''Logger

4842

4943instance Semigroup Logger where

50− (Logger ctx1 s1 l1) <> (Logger ctx2 s2 l2)

51− = Logger ctx' (s1 <> s2)

44+ (Logger ctx1 l1) <> (Logger ctx2 l2) = Logger ctx'

5245 $ \ctx stack s t -> l1 ctx stack s t >> l2 ctx stack s t

5346 where ctx' = ctx1 <> ctx2

5447

5548instance Monoid Logger where

56− mempty = Logger mempty mempty $ \_ _ _ _ -> pure ()

49+ mempty = Logger mempty $ \_ _ _ _ -> pure ()

5750

5851type LoggingMonad r m =

5952 (MonadReader r m, Has Logger r, MonadIO m, HasCallStack)

@@ -77,18 +70,4 @@ logMsgWith logger s t =

7770 liftIO $ runLogger logger callStack s t

7871

7972runLogger :: Logger -> CallStack -> LogSeverity -> Text -> IO ()

80−runLogger (Logger ctx theScrubber logger) cs ls txt

81− = logger (scrubContext theScrubber ctx) cs ls (appEndo theScrubber txt)

82−

83−

84−scrubContext :: Endo Text -> Object -> Object

85−scrubContext theScrubber = fmap doScrub

86− where

87− doScrub :: Value -> Value

88− doScrub = \case

89− Object object -> Object (fmap doScrub object)

90− Array array -> Array (fmap doScrub array)

91− String string -> String (appEndo theScrubber string)

92− n@Number{} -> n

93− b@Bool{} -> b

94− n@Null -> n

73+runLogger (Logger ctx logger) = logger ctx

src/Control/Logger/Katip.hs+22−3

@@ -5,7 +5,7 @@ module Control.Logger.Katip

55 ( logSeverityToKSeverity

66 , KatipContextTState(..)

77 , getKatipLogger

8− , ourItemJson

8+ , ourFormatter

99 , katipIndexNameString

1010 ) where

1111

@@ -14,11 +14,12 @@ import Control.Has.Katip ()

1414import Control.Lens hiding ((.=))

1515import Control.Logger.Internal

1616import Data.Aeson hiding (Error)

17+import qualified Data.HashMap.Strict as HM

1718import Data.Text (Text)

1819import qualified Data.Text as T

1920import qualified Data.Text.Lazy.Builder as T.Builder

2021import Katip as K hiding (logMsg)

21−import Katip.Core (LocJs(..), ProcessIDJs(..))

22+import Katip.Core (ItemFunc(..), LocJs(..), ProcessIDJs(..))

2223import Katip.Monadic (KatipContextTState(..))

2324

2425

@@ -30,6 +31,24 @@ logSeverityToKSeverity = \case

3031 Error -> ErrorS

3132

3233

34+-- | Adds the @rev-hash@ value to each record.

35+-- Early we copied `msg` to `msg-keyword` here but drop it

36+-- because purpose of this duplication is not clear.

37+ourFormatter

38+ :: Text

39+ -- ^ git revision string

40+ -> Verbosity

41+ -> ItemFunc Value

42+ourFormatter gitRev verb = ItemFunc $ \item -> go $ ourItemJson verb item

43+ where

44+ go :: Value -> Value

45+ go = \case

46+ Object h -> Object $ setRev h

47+ x -> x -- drop exception here?

48+ where

49+ setRev :: HM.HashMap Text Value -> HM.HashMap Text Value

50+ setRev = HM.insert "rev-hash" (toJSON gitRev)

51+

3352katipIndexNameString :: Text

3453katipIndexNameString = "antorica-b2b-logs"

3554

@@ -56,7 +75,7 @@ instance LogItem Object where

5675 payloadKeys _ _ = AllKeys

5776

5877getKatipLogger :: KatipContextTState -> Logger

59−getKatipLogger katipCtx = Logger (toObject . ltsContext $ katipCtx) mempty

78+getKatipLogger katipCtx = Logger (toObject . ltsContext $ katipCtx)

6079 $ \ ctx stack s msg ->

6180 let ?callStack = stack

6281 in

src/Control/Logger/Katip/Utils.hs+15−36

@@ -1,4 +1,4 @@

1−{-# LANGUAGE CPP #-}

1+{-# LANGUAGE ImplicitParams #-}

22

33module Control.Logger.Katip.Utils

44 ( katipIndexNameString

@@ -6,6 +6,7 @@ module Control.Logger.Katip.Utils

66 , LogFormat(..)

77 , registerFileScribe

88 , setLoggingCtx

9+ , ourFormatter

910 , getKatipLogger

1011 , logSeverityToKSeverity

1112 ) where

@@ -19,36 +20,18 @@ import Control.Logger.Internal as L

1920import Control.Logger.Katip as L

2021import Data.Aeson hiding (Error)

2122import Data.Aeson.Text

22−#if MIN_VERSION_aeson(2,0,0)

23−import qualified Data.Aeson.KeyMap as HM

24−import qualified Data.Aeson.Key as HM

25−#else

23+import qualified Data.ByteString.Builder as B.Builder

2624import qualified Data.HashMap.Strict as HM

27−#endif

2825import Data.Text (Text)

29−import qualified Data.Text.Lazy as T

3026import qualified Data.Text.Lazy.Builder as T.Builder

27+import qualified Data.Text.Lazy.Encoding as T.Lazy

3128import Katip as K hiding (logMsg)

29+import Katip.Core (ItemFunc(..))

3230import Katip.Monadic (KatipContextTState(..))

3331import qualified Katip.Scribes.Handle as K

3432import System.IO

3533

3634

37−#if MIN_VERSION_aeson(2,0,0)

38−type KeyMap v = HM.KeyMap v

39−textToKey :: Text -> Key

40−textToKey = HM.fromText

41−keyToText :: Key -> Text

42−keyToText = HM.toText

43−#else

44−type KeyMap v = HM.HashMap Text v

45−type Key = Text

46−textToKey :: Text -> Key

47−textToKey = id

48−keyToText :: Key -> Text

49−keyToText = id

50−#endif

51−

5235-- | How to format logs

5336data LogFormat

5437 = LogBracket -- ^ use `bracketFormat`

@@ -72,42 +55,38 @@ registerFileScribe gitRev verbosity format filePath permitF additions logenv =

7255 formatter = case format of

7356 LogBracket -> customBracketFormat additions'

7457 LogJson -> customJsonFormat gitRev additions'

75− additions'

76− = HM.fromList

77− . map (\(k, v) -> (textToKey k, String v))

78− $ additions

58+ additions' = HM.fromList . map (fmap String) $ additions

7959

8060-- | JSON formatter that adds the specified fields to the output

8161customJsonFormat

82− :: forall a. LogItem a => Text -> KeyMap Value -> ItemFormatter a

62+ :: forall a. LogItem a => Text -> HM.HashMap Text Value -> ItemFormatter a

8363customJsonFormat gitRev additions withColor verb i = (mappend "\n") $

8464 -- Here we reimplement the standard formater because we want the

8565 -- additional key/value pairs to be added at the top level.

8666 -- So we can't use the LogWithAdditions like we do for bracket format

87− T.Builder.fromText $

67+ B.Builder.lazyByteString . T.Lazy.encodeUtf8 . T.Builder.toLazyText $

8868 K.colorBySeverity withColor (_itemSeverity i) $

89− (T.toStrict . encodeToLazyText) (extend $ ourItemJson verb i)

69+ encodeToTextBuilder (extend $ applyItemFunc (ourFormatter gitRev verb) i)

9070 where

91− extend (Object o) = Object $ HM.union additions' o

71+ extend (Object o) = Object $ HM.union additions o

9272 extend v = v

93− additions' = HM.insert "rev-hash" (toJSON gitRev) additions

9473

9574-- | Bracket formatter that adds the specified fields to the output

9675customBracketFormat

97− :: forall a. LogItem a => KeyMap Value -> ItemFormatter a

76+ :: forall a. LogItem a => HM.HashMap Text Value -> ItemFormatter a

9877customBracketFormat additions withColor verb i =

9978 bracketFormat withColor verb (LogWithAdditions additions <$> i)

10079

10180-- | Log item payload that adds the specified additional key/value pairs

10281-- to the output on at verbosity levels

103−data LogWithAdditions a = LogWithAdditions (KeyMap Value) a

82+data LogWithAdditions a = LogWithAdditions (HM.HashMap Text Value) a

10483 deriving (Show)

10584

10685instance LogItem a => LogItem (LogWithAdditions a) where

10786 payloadKeys v (LogWithAdditions additions a) =

10887 case payloadKeys v a of

10988 AllKeys -> AllKeys

110− SomeKeys keys -> SomeKeys (map keyToText (HM.keys additions) ++ keys)

89+ SomeKeys keys -> SomeKeys (HM.keys additions ++ keys)

11190

11291instance ToObject a => ToObject (LogWithAdditions a) where

11392 toObject (LogWithAdditions additions a) =

@@ -120,5 +99,5 @@ setLoggingCtx

12099 -> ReaderT r m a

121100setLoggingCtx ctx' = local (part %~ go)

122101 where

123− go (Logger ctx scrbber f) =

124− Logger (ctx <> ctx') scrbber f

102+ go (Logger ctx f) =

103+ Logger (ctx <> ctx') f

src/Control/Logger/Orphans.hs+2−2

@@ -10,7 +10,7 @@ import Control.EnvT

1010import Control.Has

1111import Control.Logger.Internal

1212import Control.Monad.Logger

13−import qualified Data.Text.Encoding as T

13+import qualified Data.Text as T

1414import GHC.Stack

1515

1616

@@ -21,7 +21,7 @@ instance (Has Logger r, MonadIO m)

2121 in withFrozenCallStack

2222 $ logMsg

2323 (mlLevelToLogSeverity level)

24− (T.decodeUtf8Lenient . fromLogStr . toLogStr $ msg)

24+ (T.pack . show . toLogStr $ msg)

2525

2626locToCallStack :: Loc -> CallStack

2727locToCallStack Loc {..} = fromCallSiteList