Logger.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Logger.qm Copyright 2018 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum required Qore version
 
 
 
 
namespace Logger {
 
class LoggerLevel : public Qore::Serializable {
 
public:
        const OFF = MAXINT;
        const FATAL = 50000;
        const ERROR = 40000;
        const WARN = 30000;
        const INFO = 20000;
        const DEBUG = 10000;
        const TRACE = 5000;
        const ALL = MININT;
 
private:
        int levelCode;
 
        string levelStr;
 
        static hash<string, LoggerLevel> levelMap;
 
        const LEVELSTR_TO_LEVEL = {
            'ALL':   ALL,
            'TRACE': TRACE,
            'DEBUG': DEBUG,
            'INFO':  INFO,
            'WARN':  WARN,
            'ERROR': ERROR,
            'FATAL': FATAL,
            'OFF':   OFF,
        };
 
        const LEVEL_TO_LEVEL_STR = map {$1.value: $1.key}, LEVELSTR_TO_LEVEL.pairIterator();
 
public:
 
 
    constructor(int code, string str);
 
 
     int getValue();
 
     string getStr();
 
 
     bool isGreaterOrEqual(LoggerLevel other);
 
 
     bool isEqual(LoggerLevel other);
 
      static LoggerLevel getLevelOff();
 
      static LoggerLevel getLevelFatal();
 
      static LoggerLevel getLevelError();
 
      static LoggerLevel getLevelWarn();
 
      static LoggerLevel getLevelInfo();
 
      static LoggerLevel getLevelDebug();
 
      static LoggerLevel getLevelTrace();
 
      static LoggerLevel getLevelAll();
 
 
      static LoggerLevel getLevel(int level, *LoggerLevel default_level);
 
 
      static *LoggerLevel getNextLowerLevel(int level);
 
 
      static *LoggerLevel getNextHigherLevel(int level);
 
 
      static LoggerLevel getLevel(string level_str, *LoggerLevel default_level);
};
 
 
class LoggerEventParameter {
 
public:
private:
        code callable;
        *list<auto> args;
 
public:
 
    constructor(code func);
 
 
     auto call();
};
 
 
class LoggerEvent : public Qore::Serializable {
 
public:
private:
        static date startTime = now_us();
 
        string fqcn;
 
        transient *Logger logger;
 
        string categoryName;
 
        LoggerLevel level;
 
        string messageFmt;
 
        *list<auto> messageArgs;
 
        *string renderedMessage;
 
        int threadId;
 
        date timeStamp;
 
        *hash<CallStackInfo> locationInfo;
 
        *hash<ExceptionInfo> throwableInfo;
 
        int uniqueId;
 
        static Sequence sequence(1);
 
public:
 
 
    constructor(Logger logger, LoggerLevel level, string message, *list<auto> args,
            *hash<CallStackInfo> location_info, int thread_id = gettid(), date time_stamp = now_us(),
            *hash<ExceptionInfo> throwable) {
        fqcn = get_class_name(logger);
        self.logger = logger;
        categoryName = logger.getName();
        self.level = level;
        messageFmt = message;
        messageArgs = args;
        locationInfo = location_info;
        threadId = thread_id;
        timeStamp = time_stamp;
        if (throwable);
 
    }
 
 
    constructor(string fqcn, softstring category, LoggerLevel level, string message, *list<auto> args,
            *hash<CallStackInfo> location_info, int thread_id = gettid(), date time_stamp = now_us(),
            *hash<ExceptionInfo> throwable) {
        self.fqcn = fqcn;
        categoryName = category;
        self.level = level;
        messageFmt = message;
        messageArgs = args;
        locationInfo = location_info;
        threadId = thread_id;
        timeStamp = time_stamp;
        if (throwable);
 
    }
 
     string getFullQualifiedClassname();
 
     *hash<CallStackInfo> getLocationInfo();
 
     LoggerLevel getLevel();
 
     *Logger getLogger();
 
     int getThreadId();
 
     string getCategoryName();
 
 
     string getMessage();
 
      static date getStartTime();
 
      static setStartTime(date time);
 
     date getTimeStamp();
 
 
     date getRelativeTime();
 
     *hash<ExceptionInfo> getThrowableInfo();
 
     int getUniqueId();
};
 
 
class LoggerAppenderQueue {
 
public:
private:
        Queue queue();
 
public:
 
 
     bool push(LoggerAppender appender, int type, auto params);
 
 
     process(timeout ms = 0);
 
     int size();
 
 
protected:
     *hash<auto> getEvent(timeout ms);
public:
 
};
 
 
class LoggerAppenderQueueThreadPool : public LoggerAppenderQueue {
 
public:
private:
        ThreadPool threadPool;
        Counter runningCounter(0);
        int maxThreads;
        hash<auto> pendingEvents;
        hash<auto> processingEvents;
        Queue finishedEvents();
        Sequence lastId(0);
        Mutex lock();
 
public:
 
 
private:
     worker(string id, LoggerAppender appender, list<auto> events);
public:
 
 
 
    constructor(ThreadPool tp, int max_threads = -1);
 
 
    destructor();
 
 
     ThreadPool getThreadPool();
 
 
     process(timeout ms = 0);
 
     int size();
};
 
 
class LoggerAppender {
 
public:
        const EVENT_OPEN = 1;
        const EVENT_LOG = 2;
        const EVENT_CLOSE = 3;
 
protected:
        RWLock lock();
 
public:
 
private:
        bool active = False;
 
        list<LoggerFilter> filters;
 
        string name;
 
        *LoggerAppenderQueue queue;
 
public:
 
 
    constructor(*string name);
 
 
    destructor();
 
 
     string getName();
 
 
     setQueue(*LoggerAppenderQueue queue);
 
     *LoggerAppenderQueue getQueue();
 
 
     open();
 
     close();
 
     bool isOpen();
 
 
     addFilter(LoggerFilter filter, bool top = False);
 
 
     removeFilter(LoggerFilter filter);
 
     removeAllFilters();
 
 
     list<LoggerFilter> getFilters();
 
 
protected:
    abstract  auto serializeImpl(LoggerEvent event);
public:
 
 
protected:
     bool pushEvent(int type, auto params);
public:
 
 
 
     bool post(LoggerEvent event);
 
 
     processEvent(int type, auto params);
 
 
    abstract  processEventImpl(int type, auto params);
protected:
     *object ensureAtomicOperations(int type);
public:
 
};
 
 
class LoggerAppenderNull : public LoggerAppender {
 
public:
    constructor(*string name);
 
 
protected:
     auto serializeImpl(LoggerEvent event);
public:
 
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerPattern {
 
public:
        const ESCAPE_CHAR = "%";
 
private:
        string origPattern;
 
public:
 
protected:
        list<auto> parsedPattern;  // subclass may provide value e.g. for unit tests
 
public:
 
 
    constructor(string pattern);
 
 
 
     setPattern(string value);
 
     string getPattern();
 
 
     string format(auto data);
 
 
protected:
    abstract  *string resolveField(auto data, string key, *string option);
public:
};
 
 
class LoggerLayout {
 
public:
    abstract  string format(LoggerEvent event);};
 
 
class LoggerLayoutPattern : public LoggerLayout, public LoggerPattern {
 
public:
        const DEFAULT_PATTERN = "%r [%t] %p %c - %m%n";
        const DEFAULT_DATE_FORMAT = "YYYY-MM-DD HH:mm:SS.u";
        const HostName = gethostname();
 
 
    constructor(string pattern = DEFAULT_PATTERN);
 
 
       static string getLineDelimiter();
 
 
     string format(LoggerEvent event);
 
 
protected:
     *string resolveField(auto event, string key, *string option);
public:
 
};
 
 
class LoggerAppenderWithLayout : public LoggerAppender {
 
public:
private:
        LoggerLayout layout;
 
public:
 
 
    constructor(*string name, LoggerLayout layout);
 
 
 
     setLayout(LoggerLayout layout);
 
     LoggerLayout getLayout();
 
 
protected:
     auto serializeImpl(LoggerEvent event);
public:
 
};
 
 
class LoggerAppenderStream : public LoggerAppenderWithLayout {
 
public:
private:
        StreamWriter writer;
        bool closed = False;
        bool assignThread;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, StreamWriter writer);
 
 
     StreamWriter getStreamWriter();
 
     bool hasAssignThread();
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerAppenderFile : public LoggerAppenderWithLayout {
 
public:
        const EVENT_REOPEN = 1001;
 
protected:
        File file;
        string fileName;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, string filename, *string encoding)
 ;
 
 
     File getFile();
 
     string getFileName();
 
 
     processEventImpl(int type, auto params);
 
    openFile();
 
 
    closeFile();
 
 
    reopen();
 
 
protected:
     *object ensureAtomicOperations(int type);
public:
 
};
 
 
class LoggerAppenderStdOut : public LoggerAppenderWithLayout {
 
public:
 
    constructor(*string name, LoggerLayout layout);
 
 
 
     processEventImpl(int type, auto params);
};
 
 
class LoggerAppenderStdErr : public LoggerAppenderWithLayout {
 
public:
 
    constructor(*string name, LoggerLayout layout);
 
 
 
     processEventImpl(int type, auto params);
};
 
class AbstractLoggerAppenderFileRotate : public LoggerAppenderFile {
 
public:
        const EVENT_ROTATE = 10001;
        const DEFAULT_ROTATION_COUNT = 10;
 
     rotate();
 
     abstract int getCount();
protected:
     *object ensureAtomicOperations(int type);
public:
 
};
 
 
class LoggerAppenderFileRotate : public AbstractLoggerAppenderFileRotate, protected LoggerPattern {
 
public:
        const DEFAULT_ARCHIVE_PATTERN = "%p%f.%i";
 
private:
        int count;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, string filename, int count = DEFAULT_ROTATION_COUNT,
            string archive = DEFAULT_ARCHIVE_PATTERN, *string encoding)
 ;
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
 
     string getArchiveFileName(int idx);
 
     int getCount();
};
 
 
class LoggerAppenderFileRing : public AbstractLoggerAppenderFileRotate, protected LoggerPattern {
 
public:
        const DEFAULT_DATE_FORMAT = "YYYYMMDDHHmmSS";
 
private:
        hash<auto> patternData;
 
public:
 
 
    constructor(*string name, LoggerLayout layout, string pattern, int count = DEFAULT_ROTATION_COUNT,
            *string encoding);
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
     int getCount();
 
     int getCurrentIndex();
};
 
 
class LoggerAppenderFileArchive : public LoggerAppenderFile, protected LoggerPattern {
 
public:
        const EVENT_ARCHIVE = 20;
        const DEFAULT_DATE_FORMAT = "YYYYMMDDHHmmSS";
        const DEFAULT_ARCHIVE_PATTERN = "%p%f.%d";
 
 
    constructor(*string name, LoggerLayout layout, string filename, string archive = DEFAULT_ARCHIVE_PATTERN,
        *string encoding);
 
 
 
protected:
     *string resolveField(auto data, string key, *string option);
public:
 
 
 
     processEventImpl(int type, auto params);
 
 
     string archive();
 
 
     string getArchiveFileName();
 
protected:
     *object ensureAtomicOperations(int type);
public:
 
};
 
 
class LoggerFilter {
 
public:
        const ACCEPT = 1;
 
        const NEUTRAL = 0;
 
        const DENY = -1;
 
 
     int eval(LoggerEvent event);
};
 
 
class LoggerFilterLevel : public LoggerFilter {
 
public:
private:
        LoggerLevel minLevel;
        LoggerLevel maxLevel;
 
public:
 
 
    constructor(LoggerLevel min_value = LoggerLevel::getLevelInfo(), LoggerLevel max_value = LoggerLevel::getLevelOff());
 
 
 
    constructor(int min_value, int max_value = LoggerLevel::OFF);
 
 
 
    constructor(string min_value, string max_value = 'OFF');
 
 
 
     setMinLevel(LoggerLevel value);
 
 
     setMinLevel(int value);
 
 
     setMinLevel(string value);
 
     LoggerLevel getMinLevel();
 
 
     setMaxLevel(LoggerLevel value);
 
 
     setMaxLevel(int value);
 
 
     setMaxLevel(string value);
 
     LoggerLevel getMaxLevel();
 
     int eval(LoggerEvent event);
};
 
 
class LoggerFilterRegex : public LoggerFilter {
 
public:
private:
        string regexStr;
        bool regexResult;
 
public:
 
 
    constructor(string regex_str = '', bool regex_result = True);
 
 
 
     setRegex(string regex_str, bool regex_result = True);
 
     string getRegex();
 
     bool getRegexResult();
 
     int eval(LoggerEvent event);
};
 
 
class Logger {
 
public:
private:
        transient RWLock lock();
 
        static RWLock hierarchyLock();
 
        bool additivity = True;
 
        *LoggerLevel currentLevel;
 
        string name;
 
        *Logger parent;
 
        list<LoggerAppender> appenders;
 
public:
 
 
    constructor(string name = '');
 
 
 
    constructor(string name, LoggerLevel level);
 
 
 
    constructor(LoggerLevel level);
 
 
    destructor();
 
 
     string getName();
 
     *Logger getParent();
 
 
     setParent(*Logger value);
 
 
     *LoggerLevel getLevel(bool effective = True);
 
 
     setLevel(*LoggerLevel level);
 
 
     setLevel(string level);
 
 
     setLevel(int level);
 
 
     *LoggerLevel decLevel();
 
 
     *LoggerLevel incLevel();
 
 
     setAdditivity(bool enable);
 
     bool getAdditivity();
 
 
     callAppenders(LoggerEvent event);
 
protected:
     hash<CallStackInfo> getLocation();
public:
 
 
 
     addAppender(LoggerAppender appender);
 
 
     removeAppender(LoggerAppender appender);
 
     removeAllAppenders();
 
 
     list<LoggerAppender> getAppenders();
 
private:
     logIntern(LoggerLevel level, string message, *list<auto> args, *hash<CallStackInfo> location,
public:
 
 
    private:internal logIntern(LoggerLevel level, string message, *list<auto> args, *hash<CallStackInfo> location,
            *hash<ExceptionInfo> throwable, date time_stamp) {
        if (isEnabledFor(level));
 
        {
            AutoReadLock awl(lock);
            if (parent && getAdditivity()) {
                // Forward the event upstream if additivity is turned on
                parent.logIntern(level, message, args, location, throwable, time_stamp);
            }
        }
    }
 
 
     log(LoggerLevel level, string message);
 
 
     log(int level, string message);
 
 
     log(string level, string message);
 
 
     logArgs(LoggerLevel level, string message, *softlist<auto> args);
 
 
     logArgs(int level, string message, *softlist<auto> args);
 
 
     logArgs(string level, string message, *softlist<auto> args);
 
 
     logEvent(LoggerEvent event);
 
 
     trace(string message);
 
 
     debug(string message);
 
 
     info(string message);
 
 
     warn(string message);
 
 
     error(string message);
 
 
     fatal(string message);
 
 
     assertLog(bool assertion, string message);
 
 
     traceVar(string var_name, auto value);
 
 
     debugVar(string var_name, auto value);
 
 
     bool isEnabledFor(LoggerLevel level);
 
 
     bool isEnabledFor(int level);
 
 
     bool isEnabledFor(string level);
 
     bool isTraceEnabled();
 
     bool isDebugEnabled();
 
     bool isInfoEnabled();
 
     bool isWarnEnabled();
 
     bool isErrorEnabled();
 
     bool isFatalEnabled();
};
 
class LoggerRoot : public Logger {
 
public:
    // Creates the object
    constructor(LoggerLevel level = LoggerLevel::getLevelAll());
 
 
    // Creates the object
    constructor(int level);
 
 
    // Creates the object
    constructor(string level);
 
 
 
     setLevel(*LoggerLevel value);
 
 
     setParent(*Logger value);
};
 
 
class StdoutAppender : public LoggerAppenderWithLayout {
 
public:
    constructor() ;
 
 
    processEventImpl(int type, auto params);
 
};
};