Merge pull request #1 from cheopslab/backpack

Try to use backpack.

Author: qnikst

.github/workflows/haskell.yml

@@ -16,7 +16,7 @@ jobs:
     - uses: actions/setup-haskell@v1
       with:
         ghc-version: '8.10.2'
-        cabal-version: '3.0'
+        cabal-version: '3.2'
 
     - name: Cache
       uses: actions/cache@v1
@@ -33,7 +33,7 @@ jobs:
     - name: Install dependencies
       run: |
         cabal update
-        cabal build --only-dependencies --enable-tests --enable-benchmarks
+        cabal build --only-dependencies --enable-tests --enable-benchmarks cheops-logger
     - name: Build
       run: cabal build --enable-tests --enable-benchmarks all
     - name: Run tests

cheops-logger.cabal

@@ -58,12 +58,40 @@ category:            System
 build-type:          Simple
 extra-source-files:  ChangeLog.md
 
+
+library metrics-prometheus
+  default-language: Haskell2010
+  visibility: public
+  exposed-modules:
+     Cheops.Logger.Internal.Metric.Prometheus
+  reexported-modules:
+     Cheops.Logger.Internal.Metric.Prometheus as Cheops.Logger.Internal.Metrics
+  hs-source-dirs: src
+  default-extensions:
+    OverloadedStrings
+  build-depends:
+      base >= 4.11 && <5
+    , prometheus-client ^>= 1.0
+    , prometheus-client-extra ^>=0.1
+    , text ^>=1.2
+
+library metrics-noop
+  visibility: public
+  exposed-modules:
+     Cheops.Logger.Internal.Metric.Noop
+  reexported-modules:
+     Cheops.Logger.Internal.Metric.Noop as Cheops.Logger.Internal.Metrics
+  hs-source-dirs: src
+  default-language: Haskell2010
+  build-depends:
+    base >= 4.11 && <5
+  
+
 library
   exposed-modules:
     Cheops.Logger
     Cheops.Logger.Internal.Structured
     Cheops.Logger.Internal.Writer
-    Cheops.Logger.Internal.Metric
   default-extensions:
     BlockArguments
     DerivingStrategies
@@ -79,17 +107,27 @@ library
     MagicHash
     FlexibleContexts
     LambdaCase
-  build-depends:       base >=4.11 && <5
-                      , aeson ^>= 1.5
-                      , bytestring ^>=0.10
-                      , text ^>=1.2
-                      , containers ^>=0.6
-                      , co-log-core ^>=0.2
-                      , co-log-concurrent ^>=0.5
-                      , prometheus-client ^>= 1.0
-                      , prometheus-client-extra ^>=0.1
-                      , string-conv ^>=0.1
-                      , stm ^>=2.5
-  hs-source-dirs:      src
+  build-depends:
+      base >=4.11 && <5
+    , aeson ^>= 1.5
+    , bytestring ^>=0.10
+    , text ^>=1.2
+    , containers ^>=0.6
+    , co-log-core ^>=0.2
+    , co-log-concurrent ^>=0.5
+    , string-conv ^>=0.1
+    , stm ^>=2.5
+  signatures: Cheops.Logger.Internal.Metrics
   ghc-options: -Wall -Werror
+  hs-source-dirs:      src
   default-language:    Haskell2010
+
+
+executable Example
+  hs-source-dirs: examples
+  main-is: Main.hs
+  build-depends:
+    base >=4.11 && <5,
+    cheops-logger,
+    cheops-logger:metrics-prometheus
+  default-language: Haskell2010

examples/Main

@@ -12,7 +12,8 @@
 -- @
 -- run :: LoggerConfig -> IO ()
 -- run config = do
---   'withLogger' config $ \logger -> do
+--   'withLogger' config $ \initial_logger -> do
+--     let ?logger = initial_logger
 --     'logSay' ?logger message1"
 --     'logDebug' ?logger "message2"
 --     let ?logger  = 'addContext' ('sl' "host" "127.0.0.1")
@@ -56,7 +57,7 @@ module Cheops.Logger
   -- $setup
   ) where
 
-import Cheops.Logger.Internal.Metric
+import Cheops.Logger.Internal.Metrics (flushLog, submitLog)
 import Cheops.Logger.Internal.Structured
 import Cheops.Logger.Internal.Writer
 import Colog.Concurrent

examples/Main.hi

@@ -0,0 +1,16 @@
+-- | 
+-- Metrics that do not log anything.
+module Cheops.Logger.Internal.Metric.Noop
+  ( submitLog
+  , flushLog
+  ) where
+
+-- | Write metrics when message is submitted.
+submitLog :: IO () -> IO ()
+{-# INLINE submitLog #-}
+submitLog = id
+
+-- | Write metrics when message is flushed.
+flushLog :: IO () -> IO ()
+{-# INLINE flushLog #-}
+flushLog = id

examples/Main.o

@@ -1,6 +1,6 @@
 -- | 
--- Metrics support.
-module Cheops.Logger.Internal.Metric
+-- Metrics support using prometheus.
+module Cheops.Logger.Internal.Metric.Prometheus
   ( submitLog
   , flushLog
   ) where
@@ -10,13 +10,15 @@ import Prometheus.Metric.WindowGauge as Window
 
 -- | Write metrics when message is submitted.
 submitLog :: IO () -> IO ()
+{-# INLINE submitLog #-}
 submitLog f = do
   incCounter metric_submitted_total
   f
   Window.incGauge metric_in_flight
 
 -- | Write metrics when message is flushed.
 flushLog :: IO () -> IO ()
+{-# INLINE flushLog #-}
 flushLog f = do
   f
   incCounter metric_written_total

src/Cheops/Logger.hs

@@ -0,0 +1,3 @@
+signature Cheops.Logger.Internal.Metrics where
+  flushLog :: IO () -> IO ()
+  submitLog ::  IO () -> IO ()