Core/Log: Allow configuring a maximum file size for a log file. If the file size is about to be exceeded, the core will create a new file titled <oldname>_.log and start outputting there.

This commit is contained in:
Machiavelli
2013-01-23 17:48:17 +01:00
parent 5e367c910a
commit 39c2d892f3
5 changed files with 43 additions and 5 deletions

View File

@@ -123,6 +123,12 @@ struct LogMessage
std::string prefix; std::string prefix;
std::string param1; std::string param1;
time_t mtime; time_t mtime;
///@ Returns size of the log message content in bytes
uint32 Size() const
{
return prefix.size() + text.size();
}
}; };
class Appender class Appender

View File

@@ -18,11 +18,12 @@
#include "AppenderFile.h" #include "AppenderFile.h"
#include "Common.h" #include "Common.h"
AppenderFile::AppenderFile(uint8 id, std::string const& name, LogLevel level, const char* _filename, const char* _logDir, const char* _mode, AppenderFlags _flags) AppenderFile::AppenderFile(uint8 id, std::string const& name, LogLevel level, const char* _filename, const char* _logDir, const char* _mode, AppenderFlags _flags, uint64 fileSize)
: Appender(id, name, APPENDER_FILE, level, _flags) : Appender(id, name, APPENDER_FILE, level, _flags)
, filename(_filename) , filename(_filename)
, logDir(_logDir) , logDir(_logDir)
, mode(_mode) , mode(_mode)
, _fileSize(fileSize)
{ {
dynamicName = std::string::npos != filename.find("%s"); dynamicName = std::string::npos != filename.find("%s");
backup = _flags & APPENDER_FLAGS_MAKE_FILE_BACKUP; backup = _flags & APPENDER_FLAGS_MAKE_FILE_BACKUP;
@@ -46,12 +47,25 @@ void AppenderFile::_write(LogMessage const& message)
char namebuf[TRINITY_PATH_MAX]; char namebuf[TRINITY_PATH_MAX];
snprintf(namebuf, TRINITY_PATH_MAX, filename.c_str(), message.param1.c_str()); snprintf(namebuf, TRINITY_PATH_MAX, filename.c_str(), message.param1.c_str());
logfile = OpenFile(namebuf, mode, backup); logfile = OpenFile(namebuf, mode, backup);
_fileSize = ftell(logfile);
} }
if (logfile) if (logfile)
{ {
if (!dynamicName && _fileSize + message.Size() > _maxFileSize)
{
/** @ We assume all log files have a .log extension.
If file "gol.log" is at its max capacity, this will spawn a new file, "gol_.log". If that one reaches capacity, it'll spawn "gol__.log", etc.
*/
filename.replace(filename.end() - 3, filename.end(), "_.log");
logfile = OpenFile(filename.c_str(), mode, backup);
_write(message);
return;
}
fprintf(logfile, "%s%s", message.prefix.c_str(), message.text.c_str()); fprintf(logfile, "%s%s", message.prefix.c_str(), message.text.c_str());
fflush(logfile); fflush(logfile);
_fileSize += message.Size();
if (dynamicName) if (dynamicName)
{ {
@@ -71,5 +85,7 @@ FILE* AppenderFile::OpenFile(std::string const &filename, std::string const &mod
rename(filename.c_str(), newName.c_str()); // no error handling... if we couldn't make a backup, just ignore rename(filename.c_str(), newName.c_str()); // no error handling... if we couldn't make a backup, just ignore
} }
return fopen((logDir + filename).c_str(), mode.c_str()); FILE* ret = fopen((logDir + filename).c_str(), mode.c_str());
_fileSize = ftell(ret);
return ret;
} }

View File

@@ -23,7 +23,7 @@
class AppenderFile: public Appender class AppenderFile: public Appender
{ {
public: public:
AppenderFile(uint8 _id, std::string const& _name, LogLevel level, const char* filename, const char* logDir, const char* mode, AppenderFlags flags); AppenderFile(uint8 _id, std::string const& _name, LogLevel level, const char* filename, const char* logDir, const char* mode, AppenderFlags flags, uint64 maxSize);
~AppenderFile(); ~AppenderFile();
FILE* OpenFile(std::string const& _name, std::string const& _mode, bool _backup); FILE* OpenFile(std::string const& _name, std::string const& _mode, bool _backup);
@@ -35,6 +35,8 @@ class AppenderFile: public Appender
std::string mode; std::string mode;
bool dynamicName; bool dynamicName;
bool backup; bool backup;
uint64 _maxFileSize;
uint64 _fileSize;
}; };
#endif #endif

View File

@@ -145,8 +145,15 @@ void Log::CreateAppenderFromConfig(const char* name)
filename += m_logsTimestamp; filename += m_logsTimestamp;
} }
uint64 maxFileSize = 0;
if (++iter != tokens.end())
{
char const* c = *iter;
maxFileSize = atoi(c);
}
uint8 id = NextAppenderId(); uint8 id = NextAppenderId();
appenders[id] = new AppenderFile(id, name, level, filename.c_str(), m_logsDir.c_str(), mode.c_str(), flags); appenders[id] = new AppenderFile(id, name, level, filename.c_str(), m_logsDir.c_str(), mode.c_str(), flags, maxFileSize);
//fprintf(stdout, "Log::CreateAppenderFromConfig: Created Appender %s (%u), Type FILE, Mask %u, File %s, Mode %s\n", name, id, level, filename.c_str(), mode.c_str()); // DEBUG - RemoveMe //fprintf(stdout, "Log::CreateAppenderFromConfig: Created Appender %s (%u), Type FILE, Mask %u, File %s, Mode %s\n", name, id, level, filename.c_str(), mode.c_str()); // DEBUG - RemoveMe
break; break;
} }

View File

@@ -2661,7 +2661,7 @@ PlayerDump.DisallowOverwrite = 1
# Appender config values: Given a appender "name" # Appender config values: Given a appender "name"
# Appender.name # Appender.name
# Description: Defines 'where to log' # Description: Defines 'where to log'
# Format: Type,LogLevel,Flags,optional1,optional2 # Format: Type,LogLevel,Flags,optional1,optional2,optional3
# #
# Type # Type
# 0 - (None) # 0 - (None)
@@ -2712,6 +2712,13 @@ PlayerDump.DisallowOverwrite = 1
# a - (Append) # a - (Append)
# w - (Overwrite) # w - (Overwrite)
# #
# MaxFileSize: Maximum file size of the log file before creating a new log file
# (read as optional3 if Type = File)
# Size is measured in bytes expressed in a 64-bit unsigned integer.
# Maximum value is 4294967295 (4 gb). Leave blank for no limit.
# NOTE: Does not work with dynamic filenames.
# Example: 536870912 (512 mb)
#
Appender.Console=1,3,0 Appender.Console=1,3,0
Appender.Server=2,2,0,Server.log,w Appender.Server=2,2,0,Server.log,w