588cf7c...master · typeable/control-logger

.gitignore+2

@@ -1 +1,3 @@

11.stack-work

2+*~

3+*.swp

README.md+1−1

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

11# control-logger

22

3−Utilities for logging with DTT projects

3+Utilities for logging

control-logger.cabal+51−44

@@ -1,48 +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.Scribes.Reopenable

15− Control.Logger.Katip.Utils

16− Control.Logger.Orphans

17− exposed-modules: Control.Logger.Internal

18− build-depends: base

19− , aeson

20− , bytestring

21− , control-has

22− , control-has-katip

23− , deepseq

24− , exceptions

25− , fast-logger

26− , http-client

27− , lens

28− , monad-logger

29− , mtl

30− , shakespeare

31− , text

32− , time

33− , 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+

3438 if !impl(ghcjs)

35− build-depends: katip

36− , optparse-applicative

37− default-language: Haskell2010

38− default-extensions: RankNTypes

39− DataKinds

40− FlexibleContexts

41− FlexibleInstances

42− LambdaCase

43− OverloadedStrings

44− ScopedTypeVariables

45− DeriveGeneric

46− ConstraintKinds

47− RecordWildCards

48− 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+65−11

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

1−

1+{-# LANGUAGE CPP #-}

22module Control.Logger

33 ( Logger

44 , loggerContext

5+ , scrubber

6+ , censor

7+ , censorWith

58 , logMsg

69 , logMsgWith

710 , logInfo

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

39−import Control.Logger.Orphans ()

46+import Control.Logger.Orphans ()

47+import Control.Monad

4048import Control.Monad.Catch

41−import qualified Data.List as List

42−import Data.Text (Text)

43−import qualified Data.Text as Text

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

4454import Data.Time

4555import GHC.Stack

46−import Katip (ToObject(..))

56+import Katip (ToObject (..))

4757import System.Log.FastLogger

48−import Text.Shakespeare.Text (st)

58+import Text.Shakespeare.Text (st)

4959

5060logError

5161 :: (LoggingMonad r m)

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

99109 -> m ()

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

101111

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+

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

103157tryLogError

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

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

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

150204

151205silentLogger :: Logger

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

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

153207

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

155209-- stderrLogger.

156210flushingFastFunc

157211 :: LogSeverity -> LoggerSet -> Logger

158212flushingFastFunc minLogLevel loggerSet =

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

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

160214 when (logLevel >= minLogLevel) $ do

161215 ts <- getCurrentTime

162216 pushLogStr loggerSet

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

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

181235fastFunc :: LoggerSet -> Logger

182236fastFunc loggerSet =

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

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

184238

185239type LogSource = Text

186240

187241-- | Default logger tests and same things.

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

189243defaultFastFunc loc minLogLevel loggerSet =

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

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

191245 ts <- getCurrentTime

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

193247

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

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

11{-# LANGUAGE TemplateHaskell #-}

2+{-# LANGUAGE NamedFieldPuns #-}

3+{-# LANGUAGE CPP #-}

24

35module Control.Logger.Internal

46 ( Logger(..)

57 , loggerContext

68 , loggerAction

9+ , scrubber

710 , runLogger

811 , LogSeverity(..)

912 , LoggingMonad

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

1316

1417import Control.Has

1518import Control.Lens

19+import Control.Monad.IO.Class

1620import Control.DeepSeq

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

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

1822import Data.Text (Text)

19−import GHC.Generics (Generic)

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+3−24

@@ -5,23 +5,20 @@ module Control.Logger.Katip

55 ( logSeverityToKSeverity

66 , KatipContextTState(..)

77 , getKatipLogger

8− , ourFormatter

8+ , ourItemJson

99 , katipIndexNameString

10− , reopenableFileLog

1110 ) where

1211

1312import Control.EnvT

1413import Control.Has.Katip ()

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

1615import Control.Logger.Internal

17−import Control.Logger.Katip.Scribes.Reopenable

1816import Data.Aeson hiding (Error)

19−import qualified Data.HashMap.Strict as HM

2017import Data.Text (Text)

2118import qualified Data.Text as T

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

2320import Katip as K hiding (logMsg)

24−import Katip.Core (ItemFunc(..), LocJs(..), ProcessIDJs(..))

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

2522import Katip.Monadic (KatipContextTState(..))

2623

2724

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

3330 Error -> ErrorS

3431

3532

36−-- | Adds the @rev-hash@ value to each record.

37−-- Early we copied `msg` to `msg-keyword` here but drop it

38−-- because purpose of this duplication is not clear.

39−ourFormatter

40− :: Text

41− -- ^ git revision string

42− -> Verbosity

43− -> ItemFunc Value

44−ourFormatter gitRev verb = ItemFunc $ \item -> go $ ourItemJson verb item

45− where

46− go :: Value -> Value

47− go = \case

48− Object h -> Object $ setRev h

49− x -> x -- drop exception here?

50− where

51− setRev :: HM.HashMap Text Value -> HM.HashMap Text Value

52− setRev = HM.insert "rev-hash" (toJSON gitRev)

53−

5433katipIndexNameString :: Text

5534katipIndexNameString = "antorica-b2b-logs"

5635

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

7756 payloadKeys _ _ = AllKeys

7857

7958getKatipLogger :: KatipContextTState -> Logger

80−getKatipLogger katipCtx = Logger (toObject . ltsContext $ katipCtx)

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

8160 $ \ ctx stack s msg ->

8261 let ?callStack = stack

8362 in

src/Control/Logger/Katip/Scribes/Reopenable.hsdeleted−19

@@ -1,19 +0,0 @@

1−module Control.Logger.Katip.Scribes.Reopenable where

2−

3−import Katip

4−import Katip.Scribes.Handle.FileOwner

5−

6−-- | Utility function to create scribe using the 'FileOwner'

7−-- inside. Returns new scribe and action to reopen the log

8−-- file. Reopening is performed asyncronously.

9−reopenableFileLog

10− :: FilePath

11− -> (forall a. LogItem a => ItemFormatter a)

12− -> PermitFunc

13− -> Verbosity

14− -> IO (Scribe, IO ())

15−reopenableFileLog fPath formatter permitF verbosity = do

16− owner <- newFileOwner fPath defaultFileOwnerSettings

17− s <- mkFileOwnerScribeWithFormatter formatter (ColorLog False)

18− owner permitF verbosity

19− return (s, fileOwnerControl owner ReopenMsg)

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

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

1−{-# LANGUAGE ImplicitParams #-}

1+{-# LANGUAGE CPP #-}

22

33module Control.Logger.Katip.Utils

44 ( katipIndexNameString

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

66 , LogFormat(..)

77 , registerFileScribe

88 , setLoggingCtx

9− , ourFormatter

109 , getKatipLogger

1110 , logSeverityToKSeverity

1211 ) where

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

2019import Control.Logger.Katip as L

2120import Data.Aeson hiding (Error)

2221import Data.Aeson.Text

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

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

2426import qualified Data.HashMap.Strict as HM

27+#endif

2528import Data.Text (Text)

29+import qualified Data.Text.Lazy as T

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

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

2831import Katip as K hiding (logMsg)

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

3032import Katip.Monadic (KatipContextTState(..))

3133import qualified Katip.Scribes.Handle as K

3234import System.IO

3335

3436

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+

3552-- | How to format logs

3653data LogFormat

3754 = LogBracket -- ^ use `bracketFormat`

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

5572 formatter = case format of

5673 LogBracket -> customBracketFormat additions'

5774 LogJson -> customJsonFormat gitRev additions'

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

75+ additions'

76+ = HM.fromList

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

78+ $ additions

5979

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

6181customJsonFormat

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

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

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

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

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

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

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

87+ T.Builder.fromText $

6888 K.colorBySeverity withColor (_itemSeverity i) $

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

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

7090 where

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

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

7292 extend v = v

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

7394

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

7596customBracketFormat

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

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

7798customBracketFormat additions withColor verb i =

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

79100

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

81102-- to the output on at verbosity levels

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

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

83104 deriving (Show)

84105

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

86107 payloadKeys v (LogWithAdditions additions a) =

87108 case payloadKeys v a of

88109 AllKeys -> AllKeys

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

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

90111

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

92113 toObject (LogWithAdditions additions a) =

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

99120 -> ReaderT r m a

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

101122 where

102− go (Logger ctx f) =

103− 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