Merge pull request #274 from RiugaBachi/fast-logger-migration

Fast logger migration
snoyberg · Mar 31, 2023 · dcdfd80 · dcdfd80
2 parents 0c808b9 + d58364f
commit dcdfd80
Show file tree

Hide file tree

Showing 17 changed files with 809 additions and 772 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,3 +1,35 @@
+## 2.1
+
++ Log naming and directory scheme has changed for both main keter logs and app logs.  
+  Old logs were named `dir/current.log` for the current log and `%Y%m%d_%H%M%S.log` 
+  (`time` package conventions) for rotated logs.  
+  Current logs have been brought up one level and named after their old directory:  
+  `logs/keter/current.log` -> `logs/keter.log`  
+  Rotated logs will now simply have `.1` `.2` ascending appended to the name of the base logs 
+  rather than be named after the date and time they were rotated at:  
+  `logs/keter/20230413_231415.log` -> `logs/keter.log.1`  
+  `logs/__builtin__/20230413_231415.log` -> `logs/__builtin__.log.1`  
+  `logs/app-foo/20230413_231415.log` -> `logs/app-foo.log.1`  
+  Please update anything that depended on the old log naming and directory conventions accordingly.
++ Added the `rotate-logs` option (default: true) in the keter config file.  
+  When true, the main keter (non-app!) logs will rotate like they have in previous versions.  
+  When false, the main keter logs will emit straight to stderr; this is useful e.g. if you're 
+  running keter via systemd, which captures stderr output for you.
++ Internal logging implementation has been switched over to `fast-logger` instead of the
+  old in-house logging solution.  
+  Please be aware that compared to the old logging solution, the usage of `fast-logger` does
+  not 100% guarantee consistent time ordering. If anything previously depended on tailing the last
+  line of a log and critically assumed that messages will be in order, it should now parse via 
+  timestamp instead.
++ The `LogMessage` ADT has been removed.
++ Replaced individual logging calls with TH splice -style calls where sensible to have access to source location info.
++ Updated log message format to make use of the additional info:  
+  `"$time|$module$:$line_num|$log_level> $msg"`
++ Added `Keter.Context`, exposing the new `KeterM` monad and related functions.  
+  This monad carries a mappable global config and logger around, eliminating the need to pass various configuration data and the logger to everything.
++ Refactored most `Keter.*` module functions to be actions in `KeterM`  
+  Please anticipate breaking changes for anything written against the exposed API.
+
 ## 2.0.1
 
 + Force usage of http-reverse-proxy versions above 0.6.0.1.

diff --git a/etc/keter-config.yaml b/etc/keter-config.yaml
@@ -4,6 +4,9 @@
 # the config file directory.
 root: ..
 
+# Whether or not to rotate logs, otherwise log straight to stderr
+rotate-logs: false
+
 # Keter can listen on multiple ports for incoming connections. These ports can
 # have HTTPS either enabled or disabled.
 listeners:

diff --git a/keter.cabal b/keter.cabal
@@ -1,6 +1,6 @@
 Cabal-version:       >=1.10
 Name:                keter
-Version:             2.0.1
+Version:             2.1.0
 Synopsis:            Web application deployment manager, focusing on Haskell web frameworks
 Description:
     Deployment system for web applications, originally intended for hosting Yesod
@@ -62,6 +62,9 @@ Library
                      , attoparsec                >= 0.10
                      , http-client               >= 0.5.0
                      , http-conduit              >= 2.1
+                     , fast-logger               < 3.3
+                     , monad-logger              < 0.4
+                     , unliftio-core             < 0.3
                      , case-insensitive
                      , array
                      , mtl
@@ -95,14 +98,15 @@ Library
                        Keter.AppManager
                        Keter.LabelMap
                        Keter.Cli
+                       Keter.Context
                        Keter.Main
                        Keter.PortPool
                        Keter.Proxy
                        Keter.HostManager
                        Keter.Rewrite
                        Keter.Yaml.FilePath
                        Keter.TempTarball
-                       Keter.Conduit.LogFile
+                       Keter.Logger
                        Keter.Conduit.Process.Unix
   Other-Modules:
                        Keter.Aeson.KeyHelper
@@ -124,6 +128,8 @@ test-suite test
     type: exitcode-stdio-1.0
     build-depends:   base
                    , transformers
+                   , mtl
+                   , monad-logger
                    , conduit
                    , bytestring
                    , unix