master..f21ebc9 · typeable/control-logger

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+8−58

@@ -2,9 +2,6 @@

22module Control.Logger

33 ( Logger

44 , loggerContext

5− , scrubber

6− , censor

7− , censorWith

85 , logMsg

96 , logMsgWith

107 , logInfo

@@ -35,20 +32,13 @@ 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

4639import Control.Logger.Orphans ()

47−import Control.Monad

4840import Control.Monad.Catch

49−import Control.Monad.IO.Class

5041import qualified Data.List as List

51−import Data.Monoid

5242import Data.Text (Text)

5343import qualified Data.Text as Text

5444import Data.Time

@@ -56,6 +46,10 @@ import GHC.Stack

5646import Katip (ToObject (..))

5747import System.Log.FastLogger

5848import Text.Shakespeare.Text (st)

49+#if MIN_VERSION_base(4,18,0)

50+import Control.Monad

51+#else

52+#endif

5953

6054logError

6155 :: (LoggingMonad r m)

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

109103 -> m ()

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

111105

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−

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

157107tryLogError

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

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

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

204154

205155silentLogger :: Logger

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

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

207157

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

209159-- stderrLogger.

210160flushingFastFunc

211161 :: LogSeverity -> LoggerSet -> Logger

212162flushingFastFunc minLogLevel loggerSet =

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

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

214164 when (logLevel >= minLogLevel) $ do

215165 ts <- getCurrentTime

216166 pushLogStr loggerSet

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

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

235185fastFunc :: LoggerSet -> Logger

236186fastFunc loggerSet =

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

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

238188

239189type LogSource = Text

240190

241191-- | Default logger tests and same things.

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

243193defaultFastFunc loc minLogLevel loggerSet =

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

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

245195 ts <- getCurrentTime

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

247197

src/Control/Logger/Internal.hs+7−28

@@ -1,12 +1,10 @@

11{-# LANGUAGE TemplateHaskell #-}

2−{-# LANGUAGE NamedFieldPuns #-}

32{-# LANGUAGE CPP #-}

43

54module Control.Logger.Internal

65 ( Logger(..)

76 , loggerContext

87 , loggerAction

9− , scrubber

108 , runLogger

119 , LogSeverity(..)

1210 , LoggingMonad

@@ -16,11 +14,9 @@ module Control.Logger.Internal

1614

1715import Control.Has

1816import Control.Lens

19−import Control.Monad.IO.Class

2017import Control.DeepSeq

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

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

2219import Data.Text (Text)

23−import Data.Monoid

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+1−1

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

5656 payloadKeys _ _ = AllKeys

5757

5858getKatipLogger :: KatipContextTState -> Logger

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

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

6060 $ \ ctx stack s msg ->

6161 let ?callStack = stack

6262 in

src/Control/Logger/Katip/Utils.hs+3−2

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

1+{-# LANGUAGE ImplicitParams #-}

12{-# LANGUAGE CPP #-}

23

34module Control.Logger.Katip.Utils

@@ -120,5 +121,5 @@ setLoggingCtx

120121 -> ReaderT r m a

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

122123 where

123− go (Logger ctx scrbber f) =

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

124+ go (Logger ctx f) =

125+ 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