Skip to content

feat(logger): Update tag logger mutex to be mutable, set standard log methods to be const #536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 12, 2025
Merged

feat(logger): Update tag logger mutex to be mutable, set standard log methods to be const #536

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions components/logger/include/logger.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
*/
Logger(Logger &&other) noexcept // cppcheck-suppress missingMemberCopy
: tag_([&other] {
std::lock_guard<std::mutex> lock(other.tag_mutex_);
std::scoped_lock lock(other.tag_mutex_);
return std::move(other.tag_);
}())
, rate_limit_(std::move(other.rate_limit_))
Expand All @@ -155,7 +155,7 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param tag The new tag.
*/
void set_tag(const std::string_view tag) {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
tag_ = tag;
}

Expand Down Expand Up @@ -194,7 +194,8 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param args optional arguments passed to be formatted.
* @return formatted std::string
*/
template <typename... Args> std::string format(std::string_view rt_fmt_str, Args &&...args) {
template <typename... Args>
std::string format(std::string_view rt_fmt_str, Args &&...args) const {
return fmt::vformat(rt_fmt_str, fmt::make_format_args(args...));
}

Expand All @@ -203,16 +204,16 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param rt_fmt_str format string
* @param args optional arguments passed to be formatted.
*/
template <typename... Args> void debug(std::string_view rt_fmt_str, Args &&...args) {
template <typename... Args> void debug(std::string_view rt_fmt_str, Args &&...args) const {
#if ESPP_LOGGER_DEBUG_ENABLED
if (level_ > espp::Logger::Verbosity::DEBUG)
return;
auto msg = format(rt_fmt_str, std::forward<Args>(args)...);
if (include_time_) {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::color::gray), "[{}/D][{}]: {}\n", tag_, get_time(), msg);
} else {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::color::gray), "[{}/D]:{}\n", tag_, msg);
}
#endif
Expand All @@ -223,16 +224,16 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param rt_fmt_str format string
* @param args optional arguments passed to be formatted.
*/
template <typename... Args> void info(std::string_view rt_fmt_str, Args &&...args) {
template <typename... Args> void info(std::string_view rt_fmt_str, Args &&...args) const {
#if ESPP_LOGGER_INFO_ENABLED
if (level_ > espp::Logger::Verbosity::INFO)
return;
auto msg = format(rt_fmt_str, std::forward<Args>(args)...);
if (include_time_) {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::green), "[{}/I][{}]: {}\n", tag_, get_time(), msg);
} else {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::green), "[{}/I]:{}\n", tag_, msg);
}
#endif
Expand All @@ -243,16 +244,16 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param rt_fmt_str format string
* @param args optional arguments passed to be formatted.
*/
template <typename... Args> void warn(std::string_view rt_fmt_str, Args &&...args) {
template <typename... Args> void warn(std::string_view rt_fmt_str, Args &&...args) const {
#if ESPP_LOGGER_WARN_ENABLED
if (level_ > espp::Logger::Verbosity::WARN)
return;
auto msg = format(rt_fmt_str, std::forward<Args>(args)...);
if (include_time_) {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::yellow), "[{}/W][{}]: {}\n", tag_, get_time(), msg);
} else {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::yellow), "[{}/W]:{}\n", tag_, msg);
}
#endif
Expand All @@ -263,16 +264,16 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
* @param rt_fmt_str format string
* @param args optional arguments passed to be formatted.
*/
template <typename... Args> void error(std::string_view rt_fmt_str, Args &&...args) {
template <typename... Args> void error(std::string_view rt_fmt_str, Args &&...args) const {
#if ESPP_LOGGER_ERROR_ENABLED
if (level_ > espp::Logger::Verbosity::ERROR)
return;
auto msg = format(rt_fmt_str, std::forward<Args>(args)...);
if (include_time_) {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::red), "[{}/E][{}]: {}\n", tag_, get_time(), msg);
} else {
std::lock_guard<std::mutex> lock(tag_mutex_);
std::scoped_lock lock(tag_mutex_);
fmt::print(fg(fmt::terminal_color::red), "[{}/E]:{}\n", tag_, msg);
}
#endif
Expand Down Expand Up @@ -438,8 +439,8 @@ rate limit. @note Only calls that have _rate_limited suffixed will be rate limit
*/
static std::chrono::steady_clock::time_point start_time_;

std::mutex tag_mutex_; ///< Mutex for the tag.
std::string tag_; ///< Name of the logger to be prepended to all logs.
mutable std::mutex tag_mutex_; ///< Mutex for the tag.
std::string tag_; ///< Name of the logger to be prepended to all logs.
std::chrono::duration<float> rate_limit_{
0.0f}; ///< Rate limit for the logger. If set to 0, no rate limiting will be performed.
std::chrono::high_resolution_clock::time_point
Expand Down