Implementing a logging system in C++17
$begingroup$
So, I've been programming for what is a probably a little bit and made a very simple logging system for my personal projects. While it works out fairly well so far, I would like advice on how to make it perform better and stuff I can do to make it more usable in general.
Main questions include:
Is my code thread safe? If not, how do I make it thread safe?
Is there a way to make the interface a bit cleaner for use? Right now
# definefeels a bit hacky.
Is there a way to avoid the use of a global
unique_ptr?
Should I just make it a header only library? Is there any benefits in doing so?
In addition to this I would appreciate any other advice on how to improve the system.
Code as it is now:
HPP:
#pragma once
/*
Use it by including this header in every file required, and in your main function start a new log.
Logger::startLog("Log.txt");
Use the various error levels by naming them and simply passing the info and what you want to output.
Logger::log(ERROR, "Something went wrong.");
*/
// For the unique pointers.
#include <memory>
// Filestream.
#include <fstream>
// String class for names and parameters passed around.
#include <string>
#define FATAL Logger::Level::Fatal
#define ERROR Logger::Level::Error
#define WARNING Logger::Level::Warning
#define INFO Logger::Level::Info
#define DEBUG Logger::Level::Debug
namespace Logger {
// Severity level enum.
enum class Level {
Fatal,
Error,
Warning,
Info,
Debug
};
// Initialize the log.
void startLog(const std::string& filepath);
// Log a message.
void log(Level s, const std::string& msg);
// Logging class.
class Log {
public:
Log(const std::string& filepath);
void addLog(Level s, const std::string& msg);
~Log();
private:
// File for logging.
std::ofstream m_logfile;
std::string levels[5] = {"Fatal", "Error", "Warning", "Info", "Debug"};
};
}
CPP:
#include "Log.hpp"
namespace Logger {
// Global Logging Object.
std::unique_ptr<Log> g_log;
// Initalize our logging object.
void startLog(const std::string& filepath) {
g_log = std::make_unique<Log>(filepath);
Logger::log(Level::Info, "Started logging system.");
}
// Method which logs.
void log(Level s, const std::string& msg) {
g_log->addLog(s, msg);
}
// Create our global logging object.
Log::Log(const std::string& filepath) : m_logfile{} {
m_logfile.open(filepath);
}
// Add a message to our log.
void Log::addLog(Level s, const std::string& msg) {
if (m_logfile.is_open()) {
m_logfile << levels[static_cast<int>(s)] << ": " << msg << std::endl;
}
}
Log::~Log() {
addLog(Level::Info, "Stopped logging system.");
m_logfile.close();
}
}
Thanks!
c++ c++17
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
add a comment |
$begingroup$
So, I've been programming for what is a probably a little bit and made a very simple logging system for my personal projects. While it works out fairly well so far, I would like advice on how to make it perform better and stuff I can do to make it more usable in general.
Main questions include:
Is my code thread safe? If not, how do I make it thread safe?
Is there a way to make the interface a bit cleaner for use? Right now
# definefeels a bit hacky.
Is there a way to avoid the use of a global
unique_ptr?
Should I just make it a header only library? Is there any benefits in doing so?
In addition to this I would appreciate any other advice on how to improve the system.
Code as it is now:
HPP:
#pragma once
/*
Use it by including this header in every file required, and in your main function start a new log.
Logger::startLog("Log.txt");
Use the various error levels by naming them and simply passing the info and what you want to output.
Logger::log(ERROR, "Something went wrong.");
*/
// For the unique pointers.
#include <memory>
// Filestream.
#include <fstream>
// String class for names and parameters passed around.
#include <string>
#define FATAL Logger::Level::Fatal
#define ERROR Logger::Level::Error
#define WARNING Logger::Level::Warning
#define INFO Logger::Level::Info
#define DEBUG Logger::Level::Debug
namespace Logger {
// Severity level enum.
enum class Level {
Fatal,
Error,
Warning,
Info,
Debug
};
// Initialize the log.
void startLog(const std::string& filepath);
// Log a message.
void log(Level s, const std::string& msg);
// Logging class.
class Log {
public:
Log(const std::string& filepath);
void addLog(Level s, const std::string& msg);
~Log();
private:
// File for logging.
std::ofstream m_logfile;
std::string levels[5] = {"Fatal", "Error", "Warning", "Info", "Debug"};
};
}
CPP:
#include "Log.hpp"
namespace Logger {
// Global Logging Object.
std::unique_ptr<Log> g_log;
// Initalize our logging object.
void startLog(const std::string& filepath) {
g_log = std::make_unique<Log>(filepath);
Logger::log(Level::Info, "Started logging system.");
}
// Method which logs.
void log(Level s, const std::string& msg) {
g_log->addLog(s, msg);
}
// Create our global logging object.
Log::Log(const std::string& filepath) : m_logfile{} {
m_logfile.open(filepath);
}
// Add a message to our log.
void Log::addLog(Level s, const std::string& msg) {
if (m_logfile.is_open()) {
m_logfile << levels[static_cast<int>(s)] << ": " << msg << std::endl;
}
}
Log::~Log() {
addLog(Level::Info, "Stopped logging system.");
m_logfile.close();
}
}
Thanks!
c++ c++17
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
add a comment |
$begingroup$
So, I've been programming for what is a probably a little bit and made a very simple logging system for my personal projects. While it works out fairly well so far, I would like advice on how to make it perform better and stuff I can do to make it more usable in general.
Main questions include:
Is my code thread safe? If not, how do I make it thread safe?
Is there a way to make the interface a bit cleaner for use? Right now
# definefeels a bit hacky.
Is there a way to avoid the use of a global
unique_ptr?
Should I just make it a header only library? Is there any benefits in doing so?
In addition to this I would appreciate any other advice on how to improve the system.
Code as it is now:
HPP:
#pragma once
/*
Use it by including this header in every file required, and in your main function start a new log.
Logger::startLog("Log.txt");
Use the various error levels by naming them and simply passing the info and what you want to output.
Logger::log(ERROR, "Something went wrong.");
*/
// For the unique pointers.
#include <memory>
// Filestream.
#include <fstream>
// String class for names and parameters passed around.
#include <string>
#define FATAL Logger::Level::Fatal
#define ERROR Logger::Level::Error
#define WARNING Logger::Level::Warning
#define INFO Logger::Level::Info
#define DEBUG Logger::Level::Debug
namespace Logger {
// Severity level enum.
enum class Level {
Fatal,
Error,
Warning,
Info,
Debug
};
// Initialize the log.
void startLog(const std::string& filepath);
// Log a message.
void log(Level s, const std::string& msg);
// Logging class.
class Log {
public:
Log(const std::string& filepath);
void addLog(Level s, const std::string& msg);
~Log();
private:
// File for logging.
std::ofstream m_logfile;
std::string levels[5] = {"Fatal", "Error", "Warning", "Info", "Debug"};
};
}
CPP:
#include "Log.hpp"
namespace Logger {
// Global Logging Object.
std::unique_ptr<Log> g_log;
// Initalize our logging object.
void startLog(const std::string& filepath) {
g_log = std::make_unique<Log>(filepath);
Logger::log(Level::Info, "Started logging system.");
}
// Method which logs.
void log(Level s, const std::string& msg) {
g_log->addLog(s, msg);
}
// Create our global logging object.
Log::Log(const std::string& filepath) : m_logfile{} {
m_logfile.open(filepath);
}
// Add a message to our log.
void Log::addLog(Level s, const std::string& msg) {
if (m_logfile.is_open()) {
m_logfile << levels[static_cast<int>(s)] << ": " << msg << std::endl;
}
}
Log::~Log() {
addLog(Level::Info, "Stopped logging system.");
m_logfile.close();
}
}
Thanks!
c++ c++17
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
So, I've been programming for what is a probably a little bit and made a very simple logging system for my personal projects. While it works out fairly well so far, I would like advice on how to make it perform better and stuff I can do to make it more usable in general.
Main questions include:
Is my code thread safe? If not, how do I make it thread safe?
Is there a way to make the interface a bit cleaner for use? Right now
# definefeels a bit hacky.
Is there a way to avoid the use of a global
unique_ptr?
Should I just make it a header only library? Is there any benefits in doing so?
In addition to this I would appreciate any other advice on how to improve the system.
Code as it is now:
HPP:
#pragma once
/*
Use it by including this header in every file required, and in your main function start a new log.
Logger::startLog("Log.txt");
Use the various error levels by naming them and simply passing the info and what you want to output.
Logger::log(ERROR, "Something went wrong.");
*/
// For the unique pointers.
#include <memory>
// Filestream.
#include <fstream>
// String class for names and parameters passed around.
#include <string>
#define FATAL Logger::Level::Fatal
#define ERROR Logger::Level::Error
#define WARNING Logger::Level::Warning
#define INFO Logger::Level::Info
#define DEBUG Logger::Level::Debug
namespace Logger {
// Severity level enum.
enum class Level {
Fatal,
Error,
Warning,
Info,
Debug
};
// Initialize the log.
void startLog(const std::string& filepath);
// Log a message.
void log(Level s, const std::string& msg);
// Logging class.
class Log {
public:
Log(const std::string& filepath);
void addLog(Level s, const std::string& msg);
~Log();
private:
// File for logging.
std::ofstream m_logfile;
std::string levels[5] = {"Fatal", "Error", "Warning", "Info", "Debug"};
};
}
CPP:
#include "Log.hpp"
namespace Logger {
// Global Logging Object.
std::unique_ptr<Log> g_log;
// Initalize our logging object.
void startLog(const std::string& filepath) {
g_log = std::make_unique<Log>(filepath);
Logger::log(Level::Info, "Started logging system.");
}
// Method which logs.
void log(Level s, const std::string& msg) {
g_log->addLog(s, msg);
}
// Create our global logging object.
Log::Log(const std::string& filepath) : m_logfile{} {
m_logfile.open(filepath);
}
// Add a message to our log.
void Log::addLog(Level s, const std::string& msg) {
if (m_logfile.is_open()) {
m_logfile << levels[static_cast<int>(s)] << ": " << msg << std::endl;
}
}
Log::~Log() {
addLog(Level::Info, "Stopped logging system.");
m_logfile.close();
}
}
Thanks!
c++ c++17
c++ c++17
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 1 hour ago
RiettyRietty
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 1 hour ago
RiettyRietty
62
asked 1 hour ago
RiettyRietty
62
62
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
New contributor
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
Rietty is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
return StackExchange.using("mathjaxEditing", function () {
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
});
});
}, "mathjax-editing");
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "196"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Rietty is a new contributor. Be nice, and check out our Code of Conduct.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f211957%2fimplementing-a-logging-system-in-c17%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Rietty is a new contributor. Be nice, and check out our Code of Conduct.
Rietty is a new contributor. Be nice, and check out our Code of Conduct.
Rietty is a new contributor. Be nice, and check out our Code of Conduct.
Rietty is a new contributor. Be nice, and check out our Code of Conduct.
Thanks for contributing an answer to Code Review Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
Use MathJax to format equations. MathJax reference.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f211957%2fimplementing-a-logging-system-in-c17%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
