Logger Class Reference

Basic timestamped logger with optional SD file logging. More...

#include <Logger.h>

Collaboration diagram for Logger:

Static Public Member Functions
static void	info (const char *msg)
	Log an informational message.
static void	warn (const char *msg)
	Log a warning message.
static void	error (const char *msg)
	Log an error message.
static void	setMinLogLevel (LogLevel level)
	Set the minimum log level (filters lower levels).
static void	enableFileLogging (const std::string &path)
	Enable writing logs to SD card via a storage manager.
static bool	forEachLine (const std::function< void(const char *line)> &handler)
	Streams each line of the log file to the provided handler.

Static Private Member Functions
static void	log (LogLevel level, const char *msg)
static void	getTimeString (char *buffer, size_t len)
static const char *	levelToString (LogLevel level)

Static Private Attributes
static LogLevel	minLevel = LOG_INFO
static std::string	logPath = ""
static bool	logToFile = false

Detailed Description

This logger is designed for embedded use, providing filtered logging based on severity and timestamp, and supporting optional output to SD.

Definition at line 50 of file Logger.h.

Member Function Documentation

enableFileLogging()

void Logger::enableFileLogging ( const std::string &  path )

static

Enable writing logs to SD card via a storage manager.

Parameters

path	Path to the log file on SD card (e.g. "/log/system.log").

Parameters

path	Path to the log file on SD card (e.g. "/log/system.log").

Definition at line 47 of file Logger.cpp.

{
    logPath = path;
    logToFile = !logPath.empty();
}

References logPath, and logToFile.

error()

void Logger::error ( const char *  msg )

static

Log an error message.

Parameters

msg	The message to log.

Parameters

msg	The message to log.

Definition at line 35 of file Logger.cpp.

{
    log(LOG_ERROR, msg);
}

References log(), and LOG_ERROR.

Here is the call graph for this function:

forEachLine()

bool Logger::forEachLine ( const std::function< void(const char *line)> &  handler )

static

Parameters

handler

Function to call with each line (null-terminated C-string).

Returns

false if the log file could not be opened, true otherwise.

Definition at line 102 of file Logger.cpp.

                                                                           {
    if (logPath.empty()) return false;
 
    auto* storage = AppContext::get<StorageManager>();
    auto reader = storage->openReader(logPath);
    if (!reader) return false;
 
    char line[128];
    while (reader->readLine(line, sizeof(line))) {
        handler(line);
    }
 
    reader->close();
    return true;
}

References AppContext::getTypeKey(), and logPath.

Here is the call graph for this function:

getTimeString()

void Logger::getTimeString ( char *  buffer, size_t  len  )

staticprivate

Definition at line 79 of file Logger.cpp.

{
    time_t now = PicoTime::now();
    struct tm *t = gmtime(&now); // Use UTC
    strftime(buffer, len, "%Y-%m-%dT%H:%M:%SZ", t); // ISO format
}

References PicoTime::now().

Referenced by log().

Here is the call graph for this function:

Here is the caller graph for this function:

info()

void Logger::info ( const char *  msg )

static

Log an informational message.

Parameters

msg	The message to log.

Parameters

msg	The message to log.

Definition at line 23 of file Logger.cpp.

{
    log(LOG_INFO, msg);
}

References log(), and LOG_INFO.

Here is the call graph for this function:

levelToString()

const char * Logger::levelToString ( LogLevel  level )

staticprivate

Definition at line 87 of file Logger.cpp.

{
    switch (level)
    {
    case LOG_INFO:
        return "INFO";
    case LOG_WARN:
        return "WARN";
    case LOG_ERROR:
        return "ERROR";
    default:
        return "???";
    }
}

References LOG_ERROR, LOG_INFO, and LOG_WARN.

Referenced by log().

Here is the caller graph for this function:

log()

void Logger::log ( LogLevel  level, const char *  msg  )

staticprivate

Definition at line 54 of file Logger.cpp.

{
    if (level < minLevel)
        return;
 
    char timeBuf[32];
    getTimeString(timeBuf, sizeof(timeBuf));
    const char *levelStr = levelToString(level);
 
    // Output to stdout
    printf("[%s] [%s] %s\n", timeBuf, levelStr, msg);
 
    // Optionally append to log file
    if (logToFile) {
        auto* storage = AppContext::get<StorageManager>();
        if (storage) {
            char fullMsg[256];
            snprintf(fullMsg, sizeof(fullMsg), "[%s] [%s] %s\n", timeBuf, levelStr, msg);
            storage->appendToFile(logPath, reinterpret_cast<const uint8_t*>(fullMsg), strlen(fullMsg));
        }
    }
    
}

References getTimeString(), AppContext::getTypeKey(), levelToString(), logPath, logToFile, and minLevel.

Referenced by error(), info(), and warn().

Here is the call graph for this function:

Here is the caller graph for this function:

setMinLogLevel()

void Logger::setMinLogLevel ( LogLevel  level )

static

Set the minimum log level (filters lower levels).

Parameters

level

Messages below this level will be suppressed.

Parameters

level

Messages below this level will be suppressed.

Definition at line 41 of file Logger.cpp.

{
    minLevel = level;
}

References minLevel.

warn()

void Logger::warn ( const char *  msg )

static

Log a warning message.

Parameters

msg	The message to log.

Parameters

msg	The message to log.

Definition at line 29 of file Logger.cpp.

{
    log(LOG_WARN, msg);
}

References log(), and LOG_WARN.

Here is the call graph for this function:

Member Data Documentation

logPath

std::string Logger::logPath = ""

inlinestaticprivate

Definition at line 96 of file Logger.h.

Referenced by enableFileLogging(), forEachLine(), and log().

logToFile

bool Logger::logToFile = false

inlinestaticprivate

Definition at line 97 of file Logger.h.

Referenced by enableFileLogging(), and log().

minLevel

LogLevel Logger::minLevel = LOG_INFO

staticprivate

Definition at line 91 of file Logger.h.

Referenced by log(), and setMinLogLevel().

---

The documentation for this class was generated from the following files:

• Logger.h
• Logger.cpp