Prettify library.

Author: qnikst

Readme

@@ -0,0 +1,17 @@
+# Cheops-logger
+
+Logger library for structured logging. This library is a light extension of the
+[co-log-concurrent](https://hackage.haskell.org/packages/co-log-concurrent) package.
+That allows to have asynchronous structured logs writing.
+
+
+## Installation
+
+## Tutorial
+
+### Adding package
+
+### Initialization
+
+### Context 
+

Readme.markdown

@@ -63,6 +63,7 @@ library
     Cheops.Logger
     Cheops.Logger.Internal.Structured
     Cheops.Logger.Internal.Writer
+    Cheops.Logger.Internal.Metric
   default-extensions:
     BlockArguments
     DerivingStrategies

cheops-logger.cabal

@@ -0,0 +1,20 @@
+{-# LANGUAGE ImplicitParams #-}
+{-# LANGUAGE OverloadedStrings #-}
+module Main
+  where
+
+import Cheops.Logger
+import Data.Function
+
+main :: IO ()
+main = do
+    withLogger config $ \ initial_logger -> do
+      let ?logger = initial_logger
+      logDebug ?logger "Hello!"
+      logInfo ?logger "World!"
+      let ?logger = ?logger
+                  & addContext (sl "host" ("127.0.0.1"::String))
+                  & addNamespace "www"
+      logErr ?logger "Alert!"
+  where
+    config = LoggerConfig defCapacity Nothing

examples/Main

@@ -56,15 +56,14 @@ module Cheops.Logger
   -- $setup
   ) where
 
+import Cheops.Logger.Internal.Metric
 import Cheops.Logger.Internal.Structured
 import Cheops.Logger.Internal.Writer
 import Colog.Concurrent
 import Colog.Concurrent.Internal
 import Colog.Core hiding (Severity, Info)
 import Control.Concurrent
 import Data.Aeson
-import Prometheus
-import Prometheus.Metric.WindowGauge as Window
 import System.IO
 import qualified Data.Sequence as Seq
 import qualified Data.Text as T
@@ -105,11 +104,11 @@ withLogger LoggerConfig{..} f
   | otherwise =
       withBackgroundLogger
        loggerConfigMessagesInFlight
-       (LogAction $ \x -> feed x >> incCounter metric_written_total >> Window.decGauge metric_in_flight)
+       (LogAction $ flushLog . feed)
        (hFlush stdout)
        $ \(LogAction log_action) ->
          f $ LoggerEnv
-              (LogAction $ \x -> incCounter metric_submitted_total >> log_action x >> Window.incGauge metric_in_flight)
+              (LogAction $ submitLog . log_action)
               Seq.Empty
   where
     LogAction feed = feedHandle stdout
@@ -211,18 +210,3 @@ logEmergency x = logSay x EmergencyS
 -- These metrics could tell if configuration is good and if the package is health. For example if
 -- @ghc_logger_max_in_flight@ is close to default limit then you may want to extend buffer size, give more CPU
 -- units to the application, or improve internal structures in the package.
-
--- | Metrics.
-metric_submitted_total :: Counter
-metric_submitted_total = unsafeRegister $
-  counter $ Info "ghc_logger_submitted_total" "Total amount of submitted messages"
-
--- | Metrics.
-metric_written_total :: Counter
-metric_written_total = unsafeRegister $
-  counter $ Info "ghc_logger_written_total" "Total amount of written messages"
-
--- | Metrics.
-metric_in_flight :: WinGauge
-metric_in_flight = unsafeRegister $
-  Window.gauge $ Info "ghc_logger_max_in_flight" "Maximum number of in flight messages"

examples/Main.hi

@@ -0,0 +1,38 @@
+-- | 
+-- Metrics support.
+module Cheops.Logger.Internal.Metric
+  ( submitLog
+  , flushLog
+  ) where
+
+import Prometheus
+import Prometheus.Metric.WindowGauge as Window
+
+-- | Write metrics when message is submitted.
+submitLog :: IO () -> IO ()
+submitLog f = do
+  incCounter metric_submitted_total
+  f
+  Window.incGauge metric_in_flight
+
+-- | Write metrics when message is flushed.
+flushLog :: IO () -> IO ()
+flushLog f = do
+  f
+  incCounter metric_written_total
+  Window.decGauge metric_in_flight
+
+-- | Metrics.
+metric_submitted_total :: Counter
+metric_submitted_total = unsafeRegister $
+  counter $ Info "ghc_logger_submitted_total" "Total amount of submitted messages"
+
+-- | Metrics.
+metric_written_total :: Counter
+metric_written_total = unsafeRegister $
+  counter $ Info "ghc_logger_written_total" "Total amount of written messages"
+
+-- | Metrics.
+metric_in_flight :: WinGauge
+metric_in_flight = unsafeRegister $
+  Window.gauge $ Info "ghc_logger_max_in_flight" "Maximum number of in flight messages"

examples/Main.hs

@@ -67,8 +67,7 @@ data Message = Message
   }
 
 
-
--- | Katip compatibility.
+-- | Efficient message builder.
 newtype LogStr = LogStr TLB.Builder
   deriving newtype IsString
   deriving newtype Semigroup
@@ -106,6 +105,7 @@ newtype PushContext = PushContext (Seq Structured -> Seq Structured)
 -- @sl "foo" 123@
 --
 -- Will add @"foo":123@ key pair to the current list of the attributes.
+-- Submitted value is stored with json encoding.
 sl :: ToJSON a => T.Text -> a -> PushContext
 sl label msg = PushContext \x ->
   x |> Attr label (toEncoding msg)