@@ -3,33 +3,42 @@ module Katip.Scribes.Handle where
33-------------------------------------------------------------------------------
44import Control.Applicative as A
55import Control.Concurrent
6−import Control.Exception (bracket_, finally)
6+import Control.Exception (finally)
77import Data.Aeson
8−import Data.Text.Lazy (toStrict)
9−import Data.Text.Lazy.Encoding (decodeUtf8)
10−import qualified Data.HashMap.Strict as HM
8+import Data.Aeson.Text
9+import Data.ByteString.Builder as B
10+import Data.ByteString.Lazy as BL (hPutStr)
11+import Data.ByteString.Lazy.Char8 as BL (singleton)
1112import Data.Monoid as M
1213import Data.Scientific as S
1314import Data.Text (Text)
14−import Data.Text.Lazy.Builder
15−import Data.Text.Lazy.IO as T
15+import Data.Text.Lazy.Builder as TL
16+import Data.Text.Lazy.Encoding (encodeUtf8)
1617import System.IO
18+import qualified Data.HashMap.Strict as HM
19+
1720-------------------------------------------------------------------------------
1821import Katip.Core
1922import Katip.Format.Time (formatAsLogTime)
23+import Katip.Scribes.Handle.FileOwner
2024-------------------------------------------------------------------------------
2125
2226
2327-------------------------------------------------------------------------------
24−brackets :: Builder -> Builder
28+brackets :: TL.Builder -> TL.Builder
2529brackets m = fromText "[" M.<> m <> fromText "]"
2630
31+textBuilderToBS :: TL.Builder -> B.Builder
32+textBuilderToBS = B.lazyByteString . encodeUtf8 . toLazyText
33+
34+appendNL :: B.Builder -> B.Builder
35+appendNL b = b <> B.lazyByteString (BL.singleton '\n')
2736
2837-------------------------------------------------------------------------------
29−getKeys :: LogItem s => Verbosity -> s -> [Builder]
38+getKeys :: LogItem s => Verbosity -> s -> [TL.Builder]
3039getKeys verb a = concat (renderPair A.<$> HM.toList (payloadObject verb a))
3140 where
32− renderPair :: (Text, Value) -> [Builder]
41+ renderPair :: (Text, Value) -> [TL.Builder]
3342 renderPair (k,v) =
3443 case v of
3544 Object o -> concat [renderPair (k <> "." <> k', v') | (k', v') <- HM.toList o]
@@ -65,6 +74,19 @@ data ColorStrategy
6574mkHandleScribe :: ColorStrategy -> Handle -> PermitFunc -> Verbosity -> IO Scribe
6675mkHandleScribe = mkHandleScribeWithFormatter bracketFormat
6776
77+
78+mkFileScribeWithFormatter :: (forall a . LogItem a => ItemFormatter a)
79+ -> ColorStrategy
80+ -> FilePath
81+ -> PermitFunc
82+ -> Verbosity
83+ -> IO Scribe
84+mkFileScribeWithFormatter formatter color f permitF verb = do
85+ h <- openBinaryFile f AppendMode
86+ Scribe logger finalizer permit <- mkHandleScribeWithFormatter formatter color h permitF verb
87+ return (Scribe logger (finalizer `finally` hClose h) permit)
88+
89+
6890-- | Logs to a file handle such as stdout, stderr, or a file. Takes a custom
6991-- `ItemFormatter` that can be used to format `Item` as needed.
7092--
@@ -77,16 +99,34 @@ mkHandleScribeWithFormatter :: (forall a . LogItem a => ItemFormatter a)
7799 -> Verbosity
78100 -> IO Scribe
79101mkHandleScribeWithFormatter itemFormatter cs h permitF verb = do
80− hSetBuffering h LineBuffering
81102 colorize <- case cs of
82103 ColorIfTerminal -> hIsTerminalDevice h
83104 ColorLog b -> return b
84105 lock <- newMVar ()
85− let logger i@Item{..} = do
86− bracket_ (takeMVar lock) (putMVar lock ()) $
87− T.hPutStrLn h $ toLazyText $ itemFormatter colorize verb i
106+ let logger i@Item{..} = withMVar lock $ \() -> do
107+ BL.hPutStr h $ toLazyByteString $ itemFormatter colorize verb i
88108 return $ Scribe logger (hFlush h) permitF
89109
110+-- | Just like mkFileScribeWithFormatter but does it with FileOwner. You can
111+-- rotate your logs with commands to the FileOwner directly. This scribe will
112+-- send messages to the given FileOwner
113+mkFileOwnerScribeWithFormatter :: (forall a . LogItem a => ItemFormatter a)
114+ -> ColorStrategy
115+ -> FileOwner
116+ -> PermitFunc
117+ -> Verbosity
118+ -> IO Scribe
119+mkFileOwnerScribeWithFormatter itemFormatter cs owner permitF verb = do
120+ let
121+ colorize = case cs of
122+ ColorIfTerminal -> False
123+ -- File is never a terminal
124+ ColorLog b -> b
125+ logger item = do
126+ writeFileOwner owner $ toLazyByteString
127+ $ itemFormatter colorize verb item
128+ scribe = Scribe logger (fileOwnerControl owner CloseMsg) permitF
129+ return scribe
90130
91131-------------------------------------------------------------------------------
92132-- | A specialization of 'mkHandleScribe' that takes a 'FilePath'
@@ -95,19 +135,17 @@ mkHandleScribeWithFormatter itemFormatter cs h permitF verb = do
95135-- 'closeScribe'/'closeScribes'. Does not do log coloring. Sets handle
96136-- to 'LineBuffering' mode.
97137mkFileScribe :: FilePath -> PermitFunc -> Verbosity -> IO Scribe
98−mkFileScribe f permitF verb = do
99− h <- openFile f AppendMode
100− Scribe logger finalizer permit <- mkHandleScribe (ColorLog False) h permitF verb
101− return (Scribe logger (finalizer `finally` hClose h) permit)
138+mkFileScribe = mkFileScribeWithFormatter bracketFormat (ColorLog False)
102139
103140
104141-------------------------------------------------------------------------------
105142-- | A custom ItemFormatter for logging `Item`s. Takes a `Bool` indicating
106143-- whether to colorize the output, `Verbosity` of output, and an `Item` to
107−-- format.
144+-- format. Note that formatter is responsible for appending the newline at the
145+-- end of the string if required
108146--
109147-- See `bracketFormat` and `jsonFormat` for examples.
110−type ItemFormatter a = Bool -> Verbosity -> Item a -> Builder
148+type ItemFormatter a = Bool -> Verbosity -> Item a -> B.Builder
111149
112150
113151formatItem :: LogItem a => ItemFormatter a
@@ -121,10 +159,10 @@ formatItem = bracketFormat
121159-- > [2016-05-11 21:01:15][MyApp.confrabulation][Debug][myhost.example.com][PID 1724][ThreadId 1154][confrab_factor:42.0][main:Helpers.Logging Helpers/Logging.hs:41:9] Confrabulating widgets, with extra namespace and context
122160-- > [2016-05-11 21:01:15][MyApp][Info][myhost.example.com][PID 1724][ThreadId 1154][main:Helpers.Logging Helpers/Logging.hs:43:7] Namespace and context are back to normal
123161bracketFormat :: LogItem a => ItemFormatter a
124−bracketFormat withColor verb Item{..} =
162+bracketFormat withColor verb Item{..} = appendNL $ textBuilderToBS $
125163 brackets nowStr <>
126164 brackets (mconcat $ map fromText $ intercalateNs _itemNamespace) <>
127− brackets (fromText (renderSeverity' _itemSeverity)) <>
165+ brackets (renderSeverity' _itemSeverity) <>
128166 brackets (fromString _itemHost) <>
129167 brackets ("PID " <> fromString (show _itemProcess)) <>
130168 brackets ("ThreadId " <> fromText (getThreadIdText _itemThread)) <>
@@ -135,7 +173,7 @@ bracketFormat withColor verb Item{..} =
135173 nowStr = fromText (formatAsLogTime _itemTime)
136174 ks = map brackets $ getKeys verb _itemPayload
137175 renderSeverity' severity =
138− colorBySeverity withColor severity (renderSeverity severity)
176+ colorBySeverity withColor severity (fromText $ renderSeverity severity)
139177
140178-- | Logs items as JSON. This can be useful in circumstances where you already
141179-- have infrastructure that is expecting JSON to be logged to a standard stream
@@ -145,15 +183,15 @@ bracketFormat withColor verb Item{..} =
145183-- > {"at":"2018-10-02T21:50:30.4523848Z","env":"production","ns":["MyApp","confrabulation"],"data":{"confrab_factor":42},"app":["MyApp"],"msg":"Confrabulating widgets, with extra namespace and context","pid":"10456","loc":{"loc_col":11,"loc_pkg":"main","loc_mod":"Helpers.Logging","loc_fn":"Helpers\\Logging.hs","loc_ln":53},"host":"myhost.example.com","sev":"Debug","thread":"ThreadId 139"}
146184-- > {"at":"2018-10-02T21:50:30.4523848Z","env":"production","ns":["MyApp"],"data":{},"app":["MyApp"],"msg":"Namespace and context are back to normal","pid":"10456","loc":{"loc_col":9,"loc_pkg":"main","loc_mod":"Helpers.Logging","loc_fn":"Helpers\\Logging.hs","loc_ln":55},"host":"myhost.example.com","sev":"Info","thread":"ThreadId 139"}
147185jsonFormat :: LogItem a => ItemFormatter a
148−jsonFormat withColor verb i =
149− fromText $
186+jsonFormat withColor verb i = appendNL $
187+ textBuilderToBS $
150188 colorBySeverity withColor (_itemSeverity i) $
151− toStrict $ decodeUtf8 $ encode $ itemJson verb i
189+ encodeToTextBuilder $ itemJson verb i
152190
153191-- | Color a text message based on `Severity`. `ErrorS` and more severe errors
154192-- are colored red, `WarningS` is colored yellow, and all other messages are
155193-- rendered in the default color.
156−colorBySeverity :: Bool -> Severity -> Text -> Text
194+colorBySeverity :: Bool -> Severity -> TL.Builder -> TL.Builder
157195colorBySeverity withColor severity msg = case severity of
158196 EmergencyS -> red msg
159197 AlertS -> red msg