@@ -3,20 +3,17 @@ module Katip.Scribes.Handle where
3-------------------------------------------------------------------------------
3-------------------------------------------------------------------------------
4import Control.Applicative as A
4import Control.Applicative as A
5import Control.Concurrent
5import Control.Concurrent
6−import Control.Exception (finally)
6+import Control.Exception (bracket_, finally)
7import Data.Aeson
7import Data.Aeson
8−import Data.Aeson.Text
8+import Data.Text.Lazy (toStrict)
9−import Data.ByteString.Builder as B
9+import Data.Text.Lazy.Encoding (decodeUtf8)
10−import Data.ByteString.Lazy as BL (hPutStr)
10+import qualified Data.HashMap.Strict as HM
11−import Data.ByteString.Lazy.Char8 as BL (singleton)
12import Data.Monoid as M
11import Data.Monoid as M
13import Data.Scientific as S
12import Data.Scientific as S
14import Data.Text (Text)
13import Data.Text (Text)
15−import Data.Text.Lazy.Builder as TL
14+import Data.Text.Lazy.Builder
16−import Data.Text.Lazy.Encoding (encodeUtf8)
15+import Data.Text.Lazy.IO as T
17import System.IO
16import System.IO
18−import qualified Data.HashMap.Strict as HM
20-------------------------------------------------------------------------------
17-------------------------------------------------------------------------------
21import Katip.Core
18import Katip.Core
22import Katip.Format.Time (formatAsLogTime)
19import Katip.Format.Time (formatAsLogTime)
@@ -24,20 +21,15 @@ import Katip.Format.Time (formatAsLogTime)
26-------------------------------------------------------------------------------
23-------------------------------------------------------------------------------
27−brackets :: TL.Builder -> TL.Builder
24+brackets :: Builder -> Builder
28brackets m = fromText "[" M.<> m <> fromText "]"
25brackets m = fromText "[" M.<> m <> fromText "]"
30−textBuilderToBS :: TL.Builder -> B.Builder
31−textBuilderToBS = B.lazyByteString . encodeUtf8 . toLazyText
33−appendNL :: B.Builder -> B.Builder
34−appendNL b = b <> B.lazyByteString (BL.singleton '\n')
36-------------------------------------------------------------------------------
28-------------------------------------------------------------------------------
37−getKeys :: LogItem s => Verbosity -> s -> [TL.Builder]
29+getKeys :: LogItem s => Verbosity -> s -> [Builder]
38getKeys verb a = concat (renderPair A.<$> HM.toList (payloadObject verb a))
30getKeys verb a = concat (renderPair A.<$> HM.toList (payloadObject verb a))
40− renderPair :: (Text, Value) -> [TL.Builder]
32+ renderPair :: (Text, Value) -> [Builder]
41 renderPair (k,v) =
33 renderPair (k,v) =
43 Object o -> concat [renderPair (k <> "." <> k', v') | (k', v') <- HM.toList o]
35 Object o -> concat [renderPair (k <> "." <> k', v') | (k', v') <- HM.toList o]
@@ -73,19 +65,6 @@ data ColorStrategy
73mkHandleScribe :: ColorStrategy -> Handle -> PermitFunc -> Verbosity -> IO Scribe
65mkHandleScribe :: ColorStrategy -> Handle -> PermitFunc -> Verbosity -> IO Scribe
74mkHandleScribe = mkHandleScribeWithFormatter bracketFormat
66mkHandleScribe = mkHandleScribeWithFormatter bracketFormat
77−mkFileScribeWithFormatter :: (forall a . LogItem a => ItemFormatter a)
83−mkFileScribeWithFormatter formatter color f permitF verb = do
84− h <- openBinaryFile f AppendMode
85− Scribe logger finalizer permit <- mkHandleScribeWithFormatter formatter color h permitF verb
86− return (Scribe logger (finalizer `finally` hClose h) permit)
89-- | Logs to a file handle such as stdout, stderr, or a file. Takes a custom
68-- | Logs to a file handle such as stdout, stderr, or a file. Takes a custom
90-- `ItemFormatter` that can be used to format `Item` as needed.
69-- `ItemFormatter` that can be used to format `Item` as needed.
@@ -98,12 +77,14 @@ mkHandleScribeWithFormatter :: (forall a . LogItem a => ItemFormatter a)
98 -> Verbosity
77 -> Verbosity
99 -> IO Scribe
78 -> IO Scribe
100mkHandleScribeWithFormatter itemFormatter cs h permitF verb = do
79mkHandleScribeWithFormatter itemFormatter cs h permitF verb = do
80+ hSetBuffering h LineBuffering
101 colorize <- case cs of
81 colorize <- case cs of
102 ColorIfTerminal -> hIsTerminalDevice h
82 ColorIfTerminal -> hIsTerminalDevice h
103 ColorLog b -> return b
83 ColorLog b -> return b
104 lock <- newMVar ()
84 lock <- newMVar ()
105− let logger i@Item{..} = withMVar lock $ \() -> do
85+ let logger i@Item{..} = do
86+ bracket_ (takeMVar lock) (putMVar lock ()) $
106− BL.hPutStr h $ toLazyByteString $ itemFormatter colorize verb i
87+ T.hPutStrLn h $ toLazyText $ itemFormatter colorize verb i
107 return $ Scribe logger (hFlush h) permitF
88 return $ Scribe logger (hFlush h) permitF
@@ -114,17 +95,19 @@ mkHandleScribeWithFormatter itemFormatter cs h permitF verb = do
114-- 'closeScribe'/'closeScribes'. Does not do log coloring. Sets handle
95-- 'closeScribe'/'closeScribes'. Does not do log coloring. Sets handle
115-- to 'LineBuffering' mode.
96-- to 'LineBuffering' mode.
116mkFileScribe :: FilePath -> PermitFunc -> Verbosity -> IO Scribe
97mkFileScribe :: FilePath -> PermitFunc -> Verbosity -> IO Scribe
117−mkFileScribe = mkFileScribeWithFormatter bracketFormat (ColorLog False)
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)
120-------------------------------------------------------------------------------
104-------------------------------------------------------------------------------
121-- | A custom ItemFormatter for logging `Item`s. Takes a `Bool` indicating
105-- | A custom ItemFormatter for logging `Item`s. Takes a `Bool` indicating
122-- whether to colorize the output, `Verbosity` of output, and an `Item` to
106-- whether to colorize the output, `Verbosity` of output, and an `Item` to
123−-- format. Note that formatter is responsible for appending the newline at the
107+-- format.
124−-- end of the string if required
126-- See `bracketFormat` and `jsonFormat` for examples.
109-- See `bracketFormat` and `jsonFormat` for examples.
127−type ItemFormatter a = Bool -> Verbosity -> Item a -> B.Builder
110+type ItemFormatter a = Bool -> Verbosity -> Item a -> Builder
130formatItem :: LogItem a => ItemFormatter a
113formatItem :: LogItem a => ItemFormatter a
@@ -138,10 +121,10 @@ formatItem = bracketFormat
138-- > [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
121-- > [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
139-- > [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
122-- > [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
140bracketFormat :: LogItem a => ItemFormatter a
123bracketFormat :: LogItem a => ItemFormatter a
141−bracketFormat withColor verb Item{..} = appendNL $ textBuilderToBS $
124+bracketFormat withColor verb Item{..} =
142 brackets nowStr <>
125 brackets nowStr <>
143 brackets (mconcat $ map fromText $ intercalateNs _itemNamespace) <>
126 brackets (mconcat $ map fromText $ intercalateNs _itemNamespace) <>
144− brackets (renderSeverity' _itemSeverity) <>
127+ brackets (fromText (renderSeverity' _itemSeverity)) <>
145 brackets (fromString _itemHost) <>
128 brackets (fromString _itemHost) <>
146 brackets ("PID " <> fromString (show _itemProcess)) <>
129 brackets ("PID " <> fromString (show _itemProcess)) <>
147 brackets ("ThreadId " <> fromText (getThreadIdText _itemThread)) <>
130 brackets ("ThreadId " <> fromText (getThreadIdText _itemThread)) <>
@@ -152,7 +135,7 @@ bracketFormat withColor verb Item{..} = appendNL $ textBuilderToBS $
152 nowStr = fromText (formatAsLogTime _itemTime)
135 nowStr = fromText (formatAsLogTime _itemTime)
153 ks = map brackets $ getKeys verb _itemPayload
136 ks = map brackets $ getKeys verb _itemPayload
154 renderSeverity' severity =
137 renderSeverity' severity =
155− colorBySeverity withColor severity (fromText $ renderSeverity severity)
138+ colorBySeverity withColor severity (renderSeverity severity)
157-- | Logs items as JSON. This can be useful in circumstances where you already
140-- | Logs items as JSON. This can be useful in circumstances where you already
158-- have infrastructure that is expecting JSON to be logged to a standard stream
141-- have infrastructure that is expecting JSON to be logged to a standard stream
@@ -162,15 +145,15 @@ bracketFormat withColor verb Item{..} = appendNL $ textBuilderToBS $
162-- > {"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"}
145-- > {"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"}
163-- > {"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"}
146-- > {"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"}
164jsonFormat :: LogItem a => ItemFormatter a
147jsonFormat :: LogItem a => ItemFormatter a
165−jsonFormat withColor verb i = appendNL $
148+jsonFormat withColor verb i =
166− textBuilderToBS $
149+ fromText $
167 colorBySeverity withColor (_itemSeverity i) $
150 colorBySeverity withColor (_itemSeverity i) $
168− encodeToTextBuilder $ itemJson verb i
151+ toStrict $ decodeUtf8 $ encode $ itemJson verb i
170-- | Color a text message based on `Severity`. `ErrorS` and more severe errors
153-- | Color a text message based on `Severity`. `ErrorS` and more severe errors
171-- are colored red, `WarningS` is colored yellow, and all other messages are
154-- are colored red, `WarningS` is colored yellow, and all other messages are
172-- rendered in the default color.
155-- rendered in the default color.
173−colorBySeverity :: Bool -> Severity -> TL.Builder -> TL.Builder
156+colorBySeverity :: Bool -> Severity -> Text -> Text
174colorBySeverity withColor severity msg = case severity of
157colorBySeverity withColor severity msg = case severity of
175 EmergencyS -> red msg
158 EmergencyS -> red msg
176 AlertS -> red msg
159 AlertS -> red msg