loggingmanager: Call setvbuf on output files, defaulting to line-buffered, instead...

[prosody.git] / core / loggingmanager.lua

diff --git a/core/loggingmanager.lua b/core/loggingmanager.lua
index c63611468ba2fa2343567759ffb779e5d9220831..259c2c4411eca9bf71aed8355dec730f7498a856 100644 (file)
--- a/core/loggingmanager.lua
+++ b/core/loggingmanager.lua
@@ -15,6 +15,7 @@ local math_max, rep = math.max, string.rep;
 local os_date = os.date;
 local getstyle, setstyle = require "util.termcolours".getstyle, require "util.termcolours".setstyle;
 
+-- COMPAT: This should no longer be needed since the addition of setvbuf calls
 if os.getenv("__FLUSH_LOG") then
        local io_flush = io.flush;
        local _io_write = io_write;
@@ -26,8 +27,9 @@ local logger = require "util.logger";
 local prosody = prosody;
 
 _G.log = logger.init("general");
+prosody.log = logger.init("general");
 
-module "loggingmanager"
+local _ENV = nil;
 
 -- The log config used if none specified in the config file (see reload_logging for initialization)
 local default_logging;
@@ -45,16 +47,16 @@ local logging_levels = { "debug", "info", "warn", "error" }
 -- This function is called automatically when a new sink type is added [see apply_sink_rules()]
 local function add_rule(sink_config)
        local sink_maker = log_sink_types[sink_config.to];
-       if sink_maker then
-               -- Create sink
-               local sink = sink_maker(sink_config);
+       if not sink_maker then
+               return; -- No such sink type
+       end
 
-               -- Set sink for all chosen levels
-               for level in pairs(get_levels(sink_config.levels or logging_levels)) do
-                       logger.add_level_sink(level, sink);
-               end
-       else
-               -- No such sink type
+       -- Create sink
+       local sink = sink_maker(sink_config);
+
+       -- Set sink for all chosen levels
+       for level in pairs(get_levels(sink_config.levels or logging_levels)) do
+               logger.add_level_sink(level, sink);
        end
 end
 
@@ -136,7 +138,7 @@ function get_levels(criteria, set)
 end
 
 -- Initialize config, etc. --
-function reload_logging()
+local function reload_logging()
        local old_sink_types = {};
 
        for name, sink_maker in pairs(log_sink_types) do
@@ -156,7 +158,6 @@ function reload_logging()
 
        logging_config = config.get("*", "log") or default_logging;
 
-
        for name, sink_maker in pairs(old_sink_types) do
                log_sink_types[name] = sink_maker;
        end
@@ -177,13 +178,17 @@ end
 -- Column width for "source" (used by stdout and console)
 local sourcewidth = 20;
 
-function log_sink_types.stdout(config)
-       local timestamps = config.timestamps;
+function log_sink_types.stdout(sink_config)
+       local timestamps = sink_config.timestamps;
 
        if timestamps == true then
                timestamps = default_timestamp; -- Default format
        end
 
+       if sink_config.buffer_mode ~= false then
+               io.stdout:setvbuf(sink_config.buffer_mode or "line");
+       end
+
        return function (name, level, message, ...)
                sourcewidth = math_max(#name+2, sourcewidth);
                local namelen = #name;
@@ -207,18 +212,22 @@ do
                logstyles["warn"] = getstyle("bold", "yellow");
                logstyles["error"] = getstyle("bold", "red");
        end
-       function log_sink_types.console(config)
+       function log_sink_types.console(sink_config)
                -- Really if we don't want pretty colours then just use plain stdout
                if not do_pretty_printing then
-                       return log_sink_types.stdout(config);
+                       return log_sink_types.stdout(sink_config);
                end
 
-               local timestamps = config.timestamps;
+               local timestamps = sink_config.timestamps;
 
                if timestamps == true then
                        timestamps = default_timestamp; -- Default format
                end
 
+               if sink_config.buffer_mode ~= false then
+                       io.stdout:setvbuf(sink_config.buffer_mode or "line");
+               end
+
                return function (name, level, message, ...)
                        sourcewidth = math_max(#name+2, sourcewidth);
                        local namelen = #name;
@@ -240,15 +249,20 @@ do
 end
 
 local empty_function = function () end;
-function log_sink_types.file(config)
-       local log = config.filename;
+function log_sink_types.file(sink_config)
+       local log = sink_config.filename;
        local logfile = io_open(log, "a+");
        if not logfile then
                return empty_function;
        end
-       local write, flush = logfile.write, logfile.flush;
 
-       local timestamps = config.timestamps;
+       if sink_config.buffer_mode ~= false then
+               logfile:setvbuf(sink_config.buffer_mode or "line");
+       end
+
+       local write = logfile.write;
+
+       local timestamps = sink_config.timestamps;
 
        if timestamps == nil or timestamps == true then
                timestamps = default_timestamp; -- Default format
@@ -263,14 +277,16 @@ function log_sink_types.file(config)
                else
                        write(logfile, name, "\t" , level, "\t", message, "\n");
                end
-               flush(logfile);
        end;
 end
 
-function register_sink_type(name, sink_maker)
+local function register_sink_type(name, sink_maker)
        local old_sink_maker = log_sink_types[name];
        log_sink_types[name] = sink_maker;
        return old_sink_maker;
 end
 
-return _M;
+return {
+       reload_logging = reload_logging;
+       register_sink_type = register_sink_type;
+}