feat(probe): added probe namespace

Probe handles LogManager (for tracking multiple log files) as well as a few utility functions such as wait, pause, glVisView, and rayView (future)
This commit is contained in:
2025-02-23 11:26:41 -05:00
parent 17fea1e046
commit 411a767dc4
5 changed files with 210 additions and 188 deletions

View File

@@ -1,104 +0,0 @@
#include <iostream>
#include <string>
#include <fstream>
#include <sstream>
#include <queue>
#include <mutex>
#include <condition_variable>
#include <chrono>
#include <thread>
#include <atomic>
#include <unordered_map>
#include <iomanip>
#include "logger.h"
Record makeRecord(const std::string& message, const std::string& context, DiagnosticLevel level) {
return {message, context, std::chrono::system_clock::now(), level};
}
std::string timestepToString(const std::chrono::time_point<std::chrono::system_clock>& timestamp) {
std::time_t timeT = std::chrono::system_clock::to_time_t(timestamp);
std::tm tmStruct = *std::localtime(&timeT);
std::ostringstream oss;
oss << std::put_time(&tmStruct, "%Y-%m-%d %H:%M:%S");
return oss.str();
}
std::unordered_map<std::string, Logger*> Logger::instances;
std::mutex Logger::mapMutex;
Logger::Logger(const std::string& filename) : filename(filename), logFile(filename, std::ios::app) {
logThread = std::thread(&Logger::processesLogs, this);
}
void Logger::processesLogs() {
while (running || !logQueue.empty()) {
std::unique_lock<std::mutex> lock(queueMutex);
queueCondition.wait(lock, [this] { return !logQueue.empty() || !running; });
while (!logQueue.empty()) {
logFile << logQueue.front() << std::endl;
logQueue.pop();
}
}
}
std::string Logger::levelAsString(DiagnosticLevel level) {
switch (level) {
case DiagnosticLevel::DEBUG:
return "DEBUG";
case DiagnosticLevel::INFO:
return "INFO";
case DiagnosticLevel::WARNING:
return "WARNING";
case DiagnosticLevel::ERROR:
return "ERROR";
case DiagnosticLevel::CRITICAL:
return "CRITICAL";
case DiagnosticLevel::NONE:
return "NONE";
}
return "";
}
Logger& Logger::getInstance(const std::string& filename) {
std::lock_guard<std::mutex> lock(mapMutex);
auto it = instances.find(filename);
if (it == instances.end()) {
it = instances.emplace(filename, new Logger(filename)).first;
}
return *it->second;
}
void Logger::log(const Record& record) {
std::stringstream ss;
ss << levelAsString(record.level) << " @ " << timestepToString(record.timestamp) << " [" << record.context << "] :" << record.message;
std::lock_guard<std::mutex> lock(queueMutex);
logQueue.push(ss.str());
queueCondition.notify_one();
}
void Logger::log(const std::string& message, const std::string& context, DiagnosticLevel level) {
log(makeRecord(message, context, level));
}
void Logger::log(const std::string& message, DiagnosticLevel level) {
log(makeRecord(message, "", level));
}
void Logger::log(const std::string& message) {
log(makeRecord(message, "", DiagnosticLevel::INFO));
}
Logger::~Logger() {
{
std::lock_guard<std::mutex> lock(queueMutex);
running = false;
}
queueCondition.notify_one();
if (logThread.joinable()) {
logThread.join();
}
std::this_thread::sleep_for(std::chrono::milliseconds(100)); // wait for the log thread to finish writing
}

View File

@@ -0,0 +1,99 @@
#include "quill/Backend.h"
#include "quill/Frontend.h"
#include "quill/Logger.h"
#include "quill/sinks/ConsoleSink.h"
#include "quill/sinks/FileSink.h"
#include <stdexcept>
#include <string>
#include <iostream>
#include <chrono>
#include "mfem.hpp"
#include "config.h"
#include "probe.h"
namespace Probe {
void pause() {
std::cout << "Execution paused. Please press enter to continue..."
<< std::endl; // Use endl to flush
std::cin.get();
}
void wait(int seconds) {
std::this_thread::sleep_for(std::chrono::seconds(seconds));
}
void glVisView(mfem::GridFunction& u, mfem::Mesh& mesh,
const std::string& windowTitle) {
Config& config = Config::getInstance();
if (config.get<bool>("Probe:GLVis:Visualization", true)) {
std::string vishost = config.get<std::string>("Probe:GLVis:Host", "localhost");
int visport = config.get<int>("Probe:GLVis:Port", 19916); // Changed default port
mfem::socketstream sol_sock(vishost.c_str(), visport);
sol_sock.precision(8);
sol_sock << "solution\n" << mesh << u
<< "window_title '" << windowTitle << "'\n" << std::flush; // Added title
}
}
LogManager::LogManager() {
Config& config = Config::getInstance();
quill::Backend::start();
auto CLILogger = quill::Frontend::create_or_get_logger(
"root",
quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1"));
newFileLogger(config.get<std::string>("Probe:LogManager:DefaultLogName", "4DSSE.log"), "log");
loggerMap.emplace("stdout", CLILogger);
}
LogManager::~LogManager() = default;
quill::Logger* LogManager::getLogger(const std::string& loggerName) {
auto it = loggerMap.find(loggerName); // Find *once*
if (it == loggerMap.end()) {
throw std::runtime_error("Cannot find logger " + loggerName);
}
return it->second; // Return the raw pointer from the shared_ptr
}
std::vector<std::string> LogManager::getLoggerNames() {
std::vector<std::string> loggerNames;
loggerNames.reserve(loggerMap.size());
for (const auto& pair : loggerMap) { // Use range-based for loop and const auto&
loggerNames.push_back(pair.first);
}
return loggerNames;
}
std::vector<quill::Logger*> LogManager::getLoggers() {
std::vector<quill::Logger*> loggers;
loggers.reserve(loggerMap.size());
for (const auto& pair : loggerMap) {
loggers.push_back(pair.second); // Get the raw pointer
}
return loggers;
}
quill::Logger* LogManager::newFileLogger(const std::string& filename,
const std::string& loggerName) {
auto file_sink = quill::Frontend::create_or_get_sink<quill::FileSink>(
filename,
[]() {
quill::FileSinkConfig cfg;
cfg.set_open_mode('w');
return cfg;
}(),
quill::FileEventNotifier{});
// Get the raw pointer.
quill::Logger* rawLogger = quill::Frontend::create_or_get_logger(loggerName, std::move(file_sink));
// Create a shared_ptr from the raw pointer.
loggerMap.emplace(loggerName, rawLogger);
return rawLogger;
}
} // namespace Probe