[GH-99] T5.1.1 added configuration to logging feature (#90)

* [#228] T3.1.2 added configuration to logging feature

Signed-off-by: Alexander Diemand <[email protected]>

* [GH-99] export types and functions via the logging feature

Signed-off-by: Alexander Diemand <[email protected]>

* [GH-99] export LoggerName

Signed-off-by: Alexander Diemand <[email protected]>

* [GH-99] check operating system in cabal file

Signed-off-by: Alexander Diemand <[email protected]>

* [GH-99] less comments

Signed-off-by: Alexander Diemand <[email protected]>

Author: CodiePP

app/Cardano/Shell/Features/Logging.hs

@@ -6,14 +6,22 @@
 module Cardano.Shell.Features.Logging
     ( LoggingLayer (..)
     , createLoggingFeature
+    -- re-exports
     , Trace
+    , Configuration
+    , LoggerName
+    , Severity (..)
     ) where
 
+import qualified Control.Monad.STM as STM
 import           Cardano.Prelude hiding (trace)
 
 import           Cardano.BM.Configuration (Configuration)
 import qualified Cardano.BM.Configuration as Config
 import           Cardano.BM.Data.LogItem (LoggerName)
+import           Cardano.BM.Data.Severity (Severity (..))
+import qualified Cardano.BM.Observer.Monadic as Monadic
+import qualified Cardano.BM.Observer.STM as Stm
 import           Cardano.BM.Setup (setupTrace_, shutdown)
 import           Cardano.BM.Trace (Trace)
 import qualified Cardano.BM.Trace as Trace
@@ -48,13 +56,16 @@ data LoggingParameters = LoggingParameters
 -- the functions effects and constraining the user (programmer) of those function to use specific effects in them.
 -- https://github.com/input-output-hk/cardano-sl/blob/develop/util/src/Pos/Util/Log/LogSafe.hs
 data LoggingLayer = LoggingLayer
-    { llBasicTrace :: forall m . MonadIO m => Trace m Text
-    , llLogDebug   :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
-    , llLogInfo    :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
-    , llLogNotice  :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
-    , llLogWarning :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
-    , llLogError   :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
-    , llAppendName :: forall m a. (MonadIO m, Show a) => LoggerName -> Trace m a -> m (Trace m a)
+    { llBasicTrace      :: forall m . MonadIO m => Trace m Text
+    , llLogDebug        :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
+    , llLogInfo         :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
+    , llLogNotice       :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
+    , llLogWarning      :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
+    , llLogError        :: forall m a. (MonadIO m, Show a) => Trace m a  -> a -> m ()
+    , llAppendName      :: forall m a. (MonadIO m, Show a) => LoggerName -> Trace m a -> m (Trace m a)
+    , llConfiguration   :: Configuration
+    , llBracketMonadX   :: forall m a t. (MonadIO m, Show a) => Configuration -> Trace m a -> Severity -> Text -> m t -> m t
+    , llBracketStmIO    :: forall a t. (Show a) => Configuration -> Trace IO a -> Severity -> Text -> STM.STM t -> IO t
     }
 
 --------------------------------
@@ -94,13 +105,16 @@ loggingCardanoFeatureInit loggingConfig = do
     let initLogging :: CardanoEnvironment -> NoDependency -> CardanoConfiguration -> LoggingParameters -> IO LoggingLayer
         initLogging _ _ _ _ = do
             pure $ LoggingLayer
-                    { llBasicTrace  = Trace.natTrace liftIO baseTrace
-                    , llLogDebug    = Trace.logDebug
-                    , llLogInfo     = Trace.logInfo
-                    , llLogNotice   = Trace.logNotice
-                    , llLogWarning  = Trace.logWarning
-                    , llLogError    = Trace.logError
-                    , llAppendName  = Trace.appendName
+                    { llBasicTrace    = Trace.natTrace liftIO baseTrace
+                    , llLogDebug      = Trace.logDebug
+                    , llLogInfo       = Trace.logInfo
+                    , llLogNotice     = Trace.logNotice
+                    , llLogWarning    = Trace.logWarning
+                    , llLogError      = Trace.logError
+                    , llAppendName    = Trace.appendName
+                    , llConfiguration = lpConfiguration loggingConfig
+                    , llBracketMonadX = Monadic.bracketObserveX
+                    , llBracketStmIO  = Stm.bracketObserveIO
                     }
     let cleanupLogging :: LoggingLayer -> IO ()
         cleanupLogging _ = shutdown switchBoard

cabal.project

@@ -0,0 +1,14 @@
+
+source-repository-package
+  type: git
+  location: https://github.com/input-output-hk/iohk-monitoring-framework
+  tag: d4139f18f77d2f837d52383859a27974f4f4e162
+  subdir: contra-tracer
+
+source-repository-package
+  type: git
+  location: https://github.com/input-output-hk/iohk-monitoring-framework
+  tag: d4139f18f77d2f837d52383859a27974f4f4e162
+  subdir: iohk-monitoring
+
+with-compiler: ghc-8.6.4

cardano-shell.cabal

@@ -45,30 +45,28 @@ library
     , specs
   build-depends:
       aeson
-    , base >=4.7 && <5
+    , base >=4.11 && <5
     , binary
     , bytestring
-    , cardano-prelude
     , Cabal
+    , cardano-prelude
     , concurrency
-    -- general util
     , containers
+    , contravariant
+    , dhall
     , directory
     , formatting
     , iohk-monitoring
-    , safe-exceptions
-    , text
-    , transformers
-    , unix
-    -- json & config
-    , contravariant
-    , dhall
-    , ekg-core
     , process
     , QuickCheck
+    , safe-exceptions
+    , stm
     , text
     , transformers
-    , unix
+  if os(windows)
+     build-depends:    Win32
+  else
+     build-depends:    unix
 
   default-language:    Haskell2010
   default-extensions:  NoImplicitPrelude
@@ -96,6 +94,7 @@ executable cardano-shell-exe
     , cardano-prelude
     -- util
     , safe-exceptions
+    , stm
     -- features
     , iohk-monitoring
   default-language:    Haskell2010
@@ -149,7 +148,6 @@ executable cardano-launcher
     , async
     -- process managment
     , process
-    , unix
     , turtle
     -- directory
     , directory
@@ -158,6 +156,11 @@ executable cardano-launcher
     , formatting
     -- exception handling
     , safe-exceptions
+  if os(windows)
+     build-depends:    Win32
+  else
+     build-depends:    unix
+
   default-language:    Haskell2010
   default-extensions:  NoImplicitPrelude
                        OverloadedStrings

cardano-shell.nix

@@ -1,8 +1,8 @@
 { mkDerivation, aeson, async, base, binary, bytestring, Cabal
 , cardano-prelude, cardano-sl-x509, concurrency, containers
-, contravariant, dejafu, dhall, directory, ekg-core, filepath
+, contravariant, dejafu, dhall, directory, filepath
 , formatting, hspec, hspec-contrib, hunit-dejafu, iohk-monitoring
-, process, QuickCheck, safe-exceptions, stdenv, text, transformers
+, process, QuickCheck, safe-exceptions, stdenv, stm, text, transformers
 , turtle, unix
 }:
 mkDerivation {
@@ -13,8 +13,8 @@ mkDerivation {
   isExecutable = true;
   libraryHaskellDepends = [
     aeson base binary bytestring Cabal cardano-prelude concurrency
-    containers contravariant dhall directory ekg-core formatting
-    iohk-monitoring process QuickCheck safe-exceptions text
+    containers contravariant dhall directory formatting
+    iohk-monitoring process QuickCheck safe-exceptions stm text
     transformers unix
   ];
   executableHaskellDepends = [

iohk-monitoring-contra-tracer.nix

@@ -6,8 +6,8 @@ mkDerivation {
   version = "0.1.0.0";
   src = fetchgit {
     url = "https://github.com/input-output-hk/iohk-monitoring-framework";
-    sha256 = "16sxwx8y2wg8kws15ybhk9vkq6crs5bp7ky37x1vrvpvb3ilc5x0";
-    rev = "8fb87e83468831289820ef9edb3d5ef912b0db0f";
+    sha256 = "02yr3alnf74qpa8vg1kk9h034blmb4nzpsbzb0n5jymsyy8r1i4c";
+    rev = "d4139f18f77d2f837d52383859a27974f4f4e162";
     fetchSubmodules = true;
   };
   postUnpack = "sourceRoot+=/contra-tracer; echo source root reset to $sourceRoot";

iohk-monitoring.nix

@@ -9,11 +9,11 @@
 }:
 mkDerivation {
   pname = "iohk-monitoring";
-  version = "0.1.5.0";
+  version = "0.1.7.1";
   src = fetchgit {
     url = "https://github.com/input-output-hk/iohk-monitoring-framework";
-    sha256 = "16sxwx8y2wg8kws15ybhk9vkq6crs5bp7ky37x1vrvpvb3ilc5x0";
-    rev = "8fb87e83468831289820ef9edb3d5ef912b0db0f";
+    sha256 = "02yr3alnf74qpa8vg1kk9h034blmb4nzpsbzb0n5jymsyy8r1i4c";
+    rev = "d4139f18f77d2f837d52383859a27974f4f4e162";
     fetchSubmodules = true;
   };
   postUnpack = "sourceRoot+=/iohk-monitoring; echo source root reset to $sourceRoot";

src/Cardano/Shell/Types.hs

@@ -17,8 +17,6 @@ import           Control.Concurrent.Classy (MonadConc)
 
 import           Cardano.Shell.Constants.Types (CardanoConfiguration (..))
 
-import qualified System.Metrics as Ekg
-
 -- | The top level module we use to run the key functions.
 newtype CardanoApplication = CardanoApplication { runCardanoApplication :: IO () }
 
@@ -37,17 +35,13 @@ applicationProductionMode _          = False
 -- All features have access to this environment.
 data CardanoEnvironment = CardanoEnvironment
     { ceLogEnv   :: Text
-    , ceEkgStore :: Ekg.Store
-     -- ...
     }
 
 -- | Initialise 'ServerEnv'
 initializeCardanoEnvironment :: IO CardanoEnvironment
 initializeCardanoEnvironment = do
-    ekgStore <- Ekg.newStore
     return CardanoEnvironment
         { ceLogEnv      = "To implement"
-        , ceEkgStore    = ekgStore
         }
 
 -- | The option to not have any additional dependency for the @CardanoFeature@.

stack.yaml

@@ -47,7 +47,7 @@ extra-deps:
       - test
 
   - git: https://github.com/input-output-hk/iohk-monitoring-framework
-    commit: 8fb87e83468831289820ef9edb3d5ef912b0db0f
+    commit: d4139f18f77d2f837d52383859a27974f4f4e162
     subdirs:
       - contra-tracer
       - iohk-monitoring