1fd44dd...master · typeable/control-logger

git.iko.soy/typeable/control-logger

on master help sign in

.gitignore+2

since splitsnapshots

unifiedsplit

@@ -1 +1,3 @@

1.stack-work

2+*~

3+*.swp

README.md+1−1

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

1# control-logger

3−Utilities for logging with DTT projects

3+Utilities for logging

control-logger.cabal+51−43

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

1−cabal-version: 2.4

1+cabal-version: 2.4

2−name: control-logger

2+name: control-logger

3−version: 0.1.0.0

3+version: 0.1.0.0

4−synopsis: Logger used by all projects

4+synopsis: Logger used by all projects

5−license-file: LICENSE

5+license-file: LICENSE

6−build-type: Simple

6+build-type: Simple

8library

9− hs-source-dirs: src

9+ hs-source-dirs: src

10− ghc-options: -Wall

10+ ghc-options: -Wall

11+

11 if !impl(ghcjs)

12 if !impl(ghcjs)

12− exposed-modules: Control.Logger

13+ exposed-modules:

14+ Control.Logger

13− Control.Logger.Katip

15+ Control.Logger.Katip

14− Control.Logger.Katip.Utils

16+ Control.Logger.Katip.Utils

15− Control.Logger.Orphans

17+ Control.Logger.Orphans

18+

16− exposed-modules: Control.Logger.Internal

19+ exposed-modules: Control.Logger.Internal

17− build-depends: base

20+ build-depends:

18− , aeson

21+ , aeson

22+ , base >=4.11

19− , bytestring

23+ , bytestring

20− , control-has

24+ , control-has

21− , control-has-katip

25+ , control-has-katip

22− , deepseq

26+ , deepseq

23− , exceptions

27+ , exceptions

24− , fast-logger

28+ , fast-logger >=2.4.11

25− , http-client

29+ , http-client

26− , lens

30+ , lens

27− , monad-logger

31+ , monad-logger

28− , mtl

32+ , mtl

29− , shakespeare

33+ , shakespeare

30− , text

34+ , text

31− , time

35+ , time

32− , unordered-containers

36+ , unordered-containers

37+

33 if !impl(ghcjs)

38 if !impl(ghcjs)

34− build-depends: katip

39+ build-depends:

40+ , katip >=0.8.8.0

35− , optparse-applicative

41+ , optparse-applicative

42+

36− default-language: Haskell2010

43+ default-language: Haskell2010

37− default-extensions: RankNTypes

44+ default-extensions:

45+ ConstraintKinds

38− DataKinds

46+ DataKinds

47+ DeriveGeneric

39− FlexibleContexts

48+ FlexibleContexts

40− FlexibleInstances

49+ FlexibleInstances

41− LambdaCase

50+ LambdaCase

42− OverloadedStrings

51+ OverloadedStrings

43− ScopedTypeVariables

52+ RankNTypes

44− DeriveGeneric

45− ConstraintKinds

46− RecordWildCards

53+ RecordWildCards

54+ ScopedTypeVariables

47− TypeSynonymInstances

55+ TypeSynonymInstances

default.nixnew file+9

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

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

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 #-}

2module Control.Logger

3 ( Logger

4 , loggerContext

5+ , scrubber

6+ , censor

7+ , censorWith

5 , logMsg

8 , logMsg

6 , logMsgWith

9 , logMsgWith

7 , logInfo

10 , logInfo

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

32 , compactCallStack

35 , compactCallStack

33 , st

36 , st

34 , ToObject(..)

37 , ToObject(..)

38+ , withScrubber

39+ , censoringWith

40+ , censoring

35 ) where

41 ) where

37import Control.Has

43import Control.Has

44+import Control.Lens hiding (censoring)

38import Control.Logger.Internal

45import Control.Logger.Internal

39−import Control.Logger.Orphans ()

46+import Control.Logger.Orphans ()

47+import Control.Monad

40import Control.Monad.Catch

48import Control.Monad.Catch

49+import Control.Monad.IO.Class

41−import qualified Data.List as List

50+import qualified Data.List as List

42−import Data.Text (Text)

51+import Data.Monoid

52+import Data.Text (Text)

43−import qualified Data.Text as Text

53+import qualified Data.Text as Text

44import Data.Time

54import Data.Time

45import GHC.Stack

55import GHC.Stack

46−import Katip (ToObject(..))

56+import Katip (ToObject (..))

47import System.Log.FastLogger

57import System.Log.FastLogger

48−import Text.Shakespeare.Text (st)

58+import Text.Shakespeare.Text (st)

50logError

60logError

51 :: (LoggingMonad r m)

61 :: (LoggingMonad r m)

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

99 -> m ()

109 -> m ()

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

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

101

111

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+

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

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

103tryLogError

157tryLogError

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

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

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

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

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

150

204

151silentLogger :: Logger

205silentLogger :: Logger

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

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

153

207

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

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

155-- stderrLogger.

209-- stderrLogger.

156flushingFastFunc

210flushingFastFunc

157 :: LogSeverity -> LoggerSet -> Logger

211 :: LogSeverity -> LoggerSet -> Logger

158flushingFastFunc minLogLevel loggerSet =

212flushingFastFunc minLogLevel loggerSet =

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

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

160 when (logLevel >= minLogLevel) $ do

214 when (logLevel >= minLogLevel) $ do

161 ts <- getCurrentTime

215 ts <- getCurrentTime

162 pushLogStr loggerSet

216 pushLogStr loggerSet

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

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

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

181fastFunc :: LoggerSet -> Logger

235fastFunc :: LoggerSet -> Logger

182fastFunc loggerSet =

236fastFunc loggerSet =

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

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

184

238

185type LogSource = Text

239type LogSource = Text

186

240

187-- | Default logger tests and same things.

241-- | Default logger tests and same things.

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

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

189defaultFastFunc loc minLogLevel loggerSet =

243defaultFastFunc loc minLogLevel loggerSet =

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

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

191 ts <- getCurrentTime

245 ts <- getCurrentTime

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

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

193

247

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

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

1{-# LANGUAGE TemplateHaskell #-}

2+{-# LANGUAGE NamedFieldPuns #-}

3+{-# LANGUAGE CPP #-}

3module Control.Logger.Internal

5module Control.Logger.Internal

4 ( Logger(..)

6 ( Logger(..)

5 , loggerContext

7 , loggerContext

6 , loggerAction

8 , loggerAction

9+ , scrubber

7 , runLogger

10 , runLogger

8 , LogSeverity(..)

11 , LogSeverity(..)

9 , LoggingMonad

12 , LoggingMonad

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

14import Control.Has

17import Control.Has

15import Control.Lens

18import Control.Lens

19+import Control.Monad.IO.Class

16import Control.DeepSeq

20import Control.DeepSeq

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

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

18import Data.Text (Text)

22import Data.Text (Text)

19−import GHC.Generics (Generic)

23+import Data.Monoid

20import GHC.Stack

24import GHC.Stack

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

30instance ToJSON LogSeverity

34instance ToJSON LogSeverity

31instance FromJSON LogSeverity

35instance FromJSON LogSeverity

33−data Logger

37+data Logger = Logger

34− = Logger

35 { _loggerContext :: Object

38 { _loggerContext :: Object

39+ , _scrubber :: Endo Text

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

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

37 } deriving Generic

41 } deriving Generic

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

41makeLenses ''Logger

47makeLenses ''Logger

43instance Semigroup Logger where

49instance 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)

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

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

46 where ctx' = ctx1 <> ctx2

53 where ctx' = ctx1 <> ctx2

48instance Monoid Logger where

55instance Monoid Logger where

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

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

51type LoggingMonad r m =

58type LoggingMonad r m =

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

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

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

70 liftIO $ runLogger logger callStack s t

77 liftIO $ runLogger logger callStack s t

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

79runLogger :: 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−22

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

5 ( logSeverityToKSeverity

6 , KatipContextTState(..)

7 , getKatipLogger

8− , ourFormatter

8+ , ourItemJson

9 , katipIndexNameString

10 ) where

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

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

15import Control.Logger.Internal

16import Data.Aeson hiding (Error)

17−import qualified Data.HashMap.Strict as HM

18import Data.Text (Text)

17import Data.Text (Text)

19import qualified Data.Text as T

18import qualified Data.Text as T

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

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

21import Katip as K hiding (logMsg)

20import Katip as K hiding (logMsg)

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

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

23import Katip.Monadic (KatipContextTState(..))

22import Katip.Monadic (KatipContextTState(..))

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

31 Error -> ErrorS

30 Error -> ErrorS

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−

52katipIndexNameString :: Text

33katipIndexNameString :: Text

53katipIndexNameString = "antorica-b2b-logs"

34katipIndexNameString = "antorica-b2b-logs"

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

75 payloadKeys _ _ = AllKeys

56 payloadKeys _ _ = AllKeys

77getKatipLogger :: KatipContextTState -> Logger

58getKatipLogger :: KatipContextTState -> Logger

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

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

79 $ \ ctx stack s msg ->

60 $ \ ctx stack s msg ->

80 let ?callStack = stack

61 let ?callStack = stack

81 in

62 in

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

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

1−{-# LANGUAGE ImplicitParams #-}

1+{-# LANGUAGE CPP #-}

3module Control.Logger.Katip.Utils

4 ( katipIndexNameString

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

6 , LogFormat(..)

7 , registerFileScribe

8 , setLoggingCtx

9− , ourFormatter

10 , getKatipLogger

9 , getKatipLogger

11 , logSeverityToKSeverity

10 , logSeverityToKSeverity

12 ) where

11 ) where

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

20import Control.Logger.Katip as L

19import Control.Logger.Katip as L

21import Data.Aeson hiding (Error)

20import Data.Aeson hiding (Error)

22import Data.Aeson.Text

21import Data.Aeson.Text

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

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

23+import qualified Data.Aeson.KeyMap as HM

24+import qualified Data.Aeson.Key as HM

25+#else

24import qualified Data.HashMap.Strict as HM

26import qualified Data.HashMap.Strict as HM

27+#endif

25import Data.Text (Text)

28import Data.Text (Text)

29+import qualified Data.Text.Lazy as T

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

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

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

28import Katip as K hiding (logMsg)

31import Katip as K hiding (logMsg)

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

30import Katip.Monadic (KatipContextTState(..))

32import Katip.Monadic (KatipContextTState(..))

31import qualified Katip.Scribes.Handle as K

33import qualified Katip.Scribes.Handle as K

32import System.IO

34import System.IO

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+

35-- | How to format logs

52-- | How to format logs

36data LogFormat

53data LogFormat

37 = LogBracket -- ^ use `bracketFormat`

54 = LogBracket -- ^ use `bracketFormat`

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

55 formatter = case format of

72 formatter = case format of

56 LogBracket -> customBracketFormat additions'

73 LogBracket -> customBracketFormat additions'

57 LogJson -> customJsonFormat gitRev additions'

74 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

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

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

61customJsonFormat

81customJsonFormat

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

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

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

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

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

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

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

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

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

86 -- 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 $

68 K.colorBySeverity withColor (_itemSeverity i) $

88 K.colorBySeverity withColor (_itemSeverity i) $

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

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

70 where

90 where

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

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

72 extend v = v

92 extend v = v

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

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

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

75customBracketFormat

96customBracketFormat

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

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

77customBracketFormat additions withColor verb i =

98customBracketFormat additions withColor verb i =

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

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

100

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

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

81-- to the output on at verbosity levels

102-- 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

83 deriving (Show)

104 deriving (Show)

105

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

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

86 payloadKeys v (LogWithAdditions additions a) =

107 payloadKeys v (LogWithAdditions additions a) =

87 case payloadKeys v a of

108 case payloadKeys v a of

88 AllKeys -> AllKeys

109 AllKeys -> AllKeys

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

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

111

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

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

92 toObject (LogWithAdditions additions a) =

113 toObject (LogWithAdditions additions a) =

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

99 -> ReaderT r m a

120 -> ReaderT r m a

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

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

101 where

122 where

102− go (Logger ctx f) =

123+ go (Logger ctx scrbber f) =

103− Logger (ctx <> ctx') f

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

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

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

10import Control.Has

11import Control.Logger.Internal

12import Control.Monad.Logger

13−import qualified Data.Text as T

13+import qualified Data.Text.Encoding as T

14import GHC.Stack

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

21 in withFrozenCallStack

22 $ logMsg

23 (mlLevelToLogSeverity level)

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

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

26locToCallStack :: Loc -> CallStack

27locToCallStack Loc {..} = fromCallSiteList