f21ebc9...master · typeable/control-logger

control-logger.cabal+51−43

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

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

9+ hs-source-dirs: src

10+ ghc-options: -Wall

11+

1112 if !impl(ghcjs)

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

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+

3338 if !impl(ghcjs)

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

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

default.nixnew file+9

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

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

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

22module Control.Logger

33 ( Logger

44 , loggerContext

5+ , scrubber

6+ , censor

7+ , censorWith

58 , logMsg

69 , logMsgWith

710 , logInfo

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

3235 , compactCallStack

3336 , st

3437 , ToObject(..)

38+ , withScrubber

39+ , censoringWith

40+ , censoring

3541 ) where

3642

3743import Control.Has

44+import Control.Lens hiding (censoring)

3845import Control.Logger.Internal

3946import Control.Logger.Orphans ()

47+import Control.Monad

4048import Control.Monad.Catch

49+import Control.Monad.IO.Class

4150import qualified Data.List as List

51+import Data.Monoid

4252import Data.Text (Text)

4353import qualified Data.Text as Text

4454import Data.Time

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

4656import Katip (ToObject (..))

4757import System.Log.FastLogger

4858import Text.Shakespeare.Text (st)

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

50−import Control.Monad

51−#else

52−#endif

5359

5460logError

5561 :: (LoggingMonad r m)

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

103109 -> m ()

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

105111

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+

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

107157tryLogError

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

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

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

154204

155205silentLogger :: Logger

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

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

157207

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

159209-- stderrLogger.

160210flushingFastFunc

161211 :: LogSeverity -> LoggerSet -> Logger

162212flushingFastFunc minLogLevel loggerSet =

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

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

164214 when (logLevel >= minLogLevel) $ do

165215 ts <- getCurrentTime

166216 pushLogStr loggerSet

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

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

185235fastFunc :: LoggerSet -> Logger

186236fastFunc loggerSet =

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

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

188238

189239type LogSource = Text

190240

191241-- | Default logger tests and same things.

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

193243defaultFastFunc loc minLogLevel loggerSet =

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

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

195245 ts <- getCurrentTime

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

197247

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

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

11{-# LANGUAGE TemplateHaskell #-}

2+{-# LANGUAGE NamedFieldPuns #-}

23{-# LANGUAGE CPP #-}

34

45module Control.Logger.Internal

56 ( Logger(..)

67 , loggerContext

78 , loggerAction

9+ , scrubber

810 , runLogger

911 , LogSeverity(..)

1012 , LoggingMonad

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

1416

1517import Control.Has

1618import Control.Lens

19+import Control.Monad.IO.Class

1720import Control.DeepSeq

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

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

1922import Data.Text (Text)

23+import Data.Monoid

2024import GHC.Stack

2125

2226

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

3034instance ToJSON LogSeverity

3135instance FromJSON LogSeverity

3236

33−data Logger

34− = Logger

37+data Logger = Logger

3538 { _loggerContext :: Object

39+ , _scrubber :: Endo Text

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

3741 } deriving Generic

3842

39−instance NFData Logger

43+instance NFData Logger where

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

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

4046

4147makeLenses ''Logger

4248

4349instance Semigroup Logger where

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

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

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

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

4653 where ctx' = ctx1 <> ctx2

4754

4855instance Monoid Logger where

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

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

5057

5158type LoggingMonad r m =

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

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

7077 liftIO $ runLogger logger callStack s t

7178

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

73−runLogger (Logger ctx logger) = logger ctx

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

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)

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

6060 $ \ ctx stack s msg ->

6161 let ?callStack = stack

6262 in

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

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

1−{-# LANGUAGE ImplicitParams #-}

21{-# LANGUAGE CPP #-}

32

43module Control.Logger.Katip.Utils

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

121120 -> ReaderT r m a

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

123122 where

124− go (Logger ctx f) =

125− Logger (ctx <> ctx') f

123+ go (Logger ctx scrbber f) =

124+ Logger (ctx <> ctx') scrbber 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 as T

13+import qualified Data.Text.Encoding 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.pack . show . toLogStr $ msg)

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

2525

2626locToCallStack :: Loc -> CallStack

2727locToCallStack Loc {..} = fromCallSiteList