[#345] logging configuration for logging to file

cardano-launcher/app/Main.hs

@@ -8,11 +8,15 @@ module Main where
 import           Cardano.Prelude hiding (option)
 import qualified Prelude
 
+import           Control.Exception.Safe (throwM)
+
 -- Yes, we should use these seldomly but here it seems quite acceptable.
 import           Data.IORef (newIORef, readIORef, writeIORef)
 import           Data.Text.Lazy.Builder (fromString, fromText)
 
 import           Distribution.System (OS (Windows), buildOS)
+
+import           System.FilePath ((</>))
 import           System.Environment (setEnv)
 import           System.Exit (exitWith)
 import           System.IO.Silently (hSilence)
@@ -25,6 +29,9 @@ import           Options.Applicative (Parser, ParserInfo, auto, execParser,
                                       fullDesc, header, help, helper, info,
                                       long, metavar, option, optional, progDesc)
 
+import qualified Cardano.BM.Configuration.Model as CM
+import           Cardano.BM.Data.Output
+import           Cardano.BM.Data.Rotation
 import           Cardano.BM.Setup (withTrace)
 import qualified Cardano.BM.Trace as Trace
 import           Cardano.BM.Tracing
@@ -41,11 +48,9 @@ import           Cardano.Shell.Launcher (LoggingDependencies (..), TLSError,
                                          TLSPath (..), WalletRunner (..),
                                          generateTlsCertificates, runLauncher,
                                          walletRunnerProcess)
+import           Cardano.Shell.Launcher.Types (nullLogging)
 import           Cardano.Shell.Update.Lib (UpdaterData (..),
                                            runDefaultUpdateProcess)
-import           Control.Exception.Safe (throwM)
-
-import           System.FilePath ((</>))
 
 --------------------------------------------------------------------------------
 -- Main
@@ -72,7 +77,7 @@ main = silence $ do
 
     -- This function either stubs out the wallet exit code or
     -- returns the "real" function.
-    let walletExectionFunction =
+    let walletExecutionFunction =
             WalletRunner $ \daedalusBin walletArguments -> do
                 -- Check if we have any exit codes remaining.
                 stubExitCodes       <- readIORef walletTestExitCodesMVar
@@ -104,8 +109,37 @@ main = silence $ do
                         -- Otherwise run the real deal, the real function.
                         runDefaultUpdateProcess filePath arguments
 
+    -- We get the launcher options. We don't log them currently because of the cat-mouse deps.
+    launcherOptions <- do
+        eLauncherOptions <- getLauncherOptions nullLogging (launcherConfigPath launcherCLI)
+        case eLauncherOptions of
+            Left err -> do
+                putTextLn $
+                    "Error occured while parsing configuration file: " <> show err
+                throwM $ LauncherOptionsError (show err)
+            Right lo -> pure lo
 
     logConfig           <- defaultConfigStdout
+    let logfilepath     = lologsPrefix launcherOptions </> "launcher"
+
+    -- We configure the logging to be on stdout and in the file as well.
+    CM.setSetupScribes logConfig
+        [ScribeDefinition {
+            scName      = toS logfilepath,
+            scFormat    = ScText,
+            scKind      = FileSK,
+            scPrivacy   = ScPublic,
+            scRotation  = Just $ RotationParameters
+                { rpLogLimitBytes = 10000000
+                , rpMaxAgeHours   = 24
+                , rpKeepFilesNum  = 3
+                }
+        }]
+
+    CM.setDefaultScribes logConfig
+        [ "StdoutSK::text"
+        , "FileSK::" <> toS logfilepath
+        ]
 
     -- A safer way to close the tracing.
     withTrace logConfig "launcher" $ \baseTrace -> do
@@ -122,15 +156,6 @@ main = silence $ do
         setEnv "LC_ALL" "en_GB.UTF-8"
         setEnv "LANG"   "en_GB.UTF-8"
 
-        launcherOptions <- do
-            eLauncherOptions <- getLauncherOptions loggingDependencies (launcherConfigPath launcherCLI)
-            case eLauncherOptions of
-                Left err -> do
-                    logErrorMessage baseTrace $
-                        "Error occured while parsing configuration file: " <> show err
-                    throwM $ LauncherOptionsError (show err)
-                Right lo -> pure lo
-
         let lockFile = loStateDir launcherOptions </> "daedalus_lockfile"
         Trace.logNotice baseTrace $ "Locking file so that multiple applications won't run at same time"
         -- Check if it's locked or not. Will throw an exception if the
@@ -183,7 +208,7 @@ main = silence $ do
         -- Finally, run the launcher once everything is set up!
         exitCode <- runLauncher
                         loggingDependencies
-                        walletExectionFunction
+                        walletExecutionFunction
                         daedalusBin
                         updaterExecutionFunction
                         updaterData

cardano-launcher/cardano-launcher.cabal

@@ -89,6 +89,7 @@ executable cardano-launcher
     , optparse-applicative
     -- directory
     , directory
+    , filepath
 
   if os(windows)
     ghc-options: -optl-mwindows

cardano-launcher/src/Cardano/Shell/Configuration.hs

@@ -50,6 +50,7 @@ data LauncherOptions = LauncherOptions
     , loWorkingDirectory    :: !FilePath
     , loStateDir            :: !FilePath
     -- On WIN it should set this directory as current.
+    , lologsPrefix          :: !FilePath
     } deriving (Show, Generic)
 
 instance FromJSON LauncherOptions where
@@ -63,6 +64,7 @@ instance FromJSON LauncherOptions where
         tlsPath             <- o .:? "tlsPath"
         workingDir          <- o .: "workingDir"
         stateDir            <- o .: "stateDir"
+        logsPrefix          <- o .: "logsPrefix"
 
         pure $ LauncherOptions
             configuration
@@ -73,6 +75,7 @@ instance FromJSON LauncherOptions where
             daedalusBin
             workingDir
             stateDir
+            logsPrefix
 
 -- | Configuration yaml file location and the key to use. The file should
 -- parse to a MultiConfiguration and the 'cfoKey' should be one of the keys