Skip to content

SDSTOR-21921 Improve LOG_EVERY_N logic with memory optimization and t… #882

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
xiaoxichen merged 5 commits into from
May 8, 2026
Merged

SDSTOR-21921 Improve LOG_EVERY_N logic with memory optimization and t… #882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7cf764
SDSTOR-21921 Improve LOG_EVERY_N logic with memory optimization and t…
xiaoxichen May 7, 2026
eeb7a9c
Fix fmt::make_format_args compilation error
xiaoxichen May 7, 2026
e3c007c
Fix off-by-one error in count tracking and improve memory cleanup
xiaoxichen May 7, 2026
0d4b49a
Add missing functional include and handle edge case
xiaoxichen May 8, 2026
7643a6b
Add documentation and warning for interval_sec > 300s
xiaoxichen May 8, 2026
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,6 @@ CMakeUserPresets.json

# claude
.claude/**

# worktrees
.worktrees/
2 changes: 1 addition & 1 deletion conanfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

class HomestoreConan(ConanFile):
name = "homestore"
version = "7.5.6"
version = "7.5.7"

homepage = "https://github.com/eBay/Homestore"
description = "HomeStore Storage Engine"
Expand Down
153 changes: 133 additions & 20 deletions src/lib/common/homestore_assert.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

#include <chrono>
#include <cstdint>
#include <functional>
#include <iterator>
#include <string>
#include <string_view>
Expand Down Expand Up @@ -143,21 +144,63 @@
fmt::make_format_args(detail_name, detail_val)))) \
(); \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{msgcb}, fmt::make_format_args(args...)); \
const auto count{check_logged_already(buf)}; \
if (count % freq == 0) { \
if (count) { \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{" ...Repeated {} times in this thread"}, \
fmt::make_format_args(freq)); \
} \
return true; \
} \
return false; \
return check_and_format_log(buf, freq, 0); \
}), \
msg, ##__VA_ARGS__); \
}

#define HS_LOG_EVERY_N(level, mod, freq, msg, ...) HS_DETAILED_LOG_EVERY_N(level, mod, freq, , , , , msg, ##__VA_ARGS__)

#define HS_DETAILED_LOG_EVERY_N_SEC(level, mod, interval_sec, submod_name, submod_val, detail_name, detail_val, msg, \
...) \
{ \
LOG##level##MOD_FMT( \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(mod), base, mod), \
([&](fmt::memory_buffer& buf, const char* const msgcb, auto&&... args) -> bool { \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}:{}] "}, \
fmt::make_format_args(unmove(file_name(__FILE__)), unmove(__LINE__))); \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(submod_name), BOOST_PP_EMPTY, \
BOOST_PP_IDENTITY(fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}={}] "}, \
fmt::make_format_args(submod_name, submod_val)))) \
(); \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(detail_name), BOOST_PP_EMPTY, \
BOOST_PP_IDENTITY(fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}={}] "}, \
fmt::make_format_args(detail_name, detail_val)))) \
(); \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{msgcb}, fmt::make_format_args(args...)); \
return check_and_format_log(buf, 0, interval_sec); \
}), \
msg, ##__VA_ARGS__); \
}

#define HS_LOG_EVERY_N_SEC(level, mod, interval_sec, msg, ...) \
HS_DETAILED_LOG_EVERY_N_SEC(level, mod, interval_sec, , , , , msg, ##__VA_ARGS__)

#define HS_DETAILED_LOG_EVERY_N_OR_SEC(level, mod, freq, interval_sec, submod_name, submod_val, detail_name, \
detail_val, msg, ...) \
{ \
LOG##level##MOD_FMT( \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(mod), base, mod), \
([&](fmt::memory_buffer& buf, const char* const msgcb, auto&&... args) -> bool { \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}:{}] "}, \
fmt::make_format_args(unmove(file_name(__FILE__)), unmove(__LINE__))); \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(submod_name), BOOST_PP_EMPTY, \
BOOST_PP_IDENTITY(fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}={}] "}, \
fmt::make_format_args(submod_name, submod_val)))) \
(); \
BOOST_PP_IF(BOOST_VMD_IS_EMPTY(detail_name), BOOST_PP_EMPTY, \
BOOST_PP_IDENTITY(fmt::vformat_to(fmt::appender{buf}, fmt::string_view{"[{}={}] "}, \
fmt::make_format_args(detail_name, detail_val)))) \
(); \
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{msgcb}, fmt::make_format_args(args...)); \
return check_and_format_log(buf, freq, interval_sec); \
}), \
msg, ##__VA_ARGS__); \
}

#define HS_LOG_EVERY_N_OR_SEC(level, mod, freq, interval_sec, msg, ...) \
HS_DETAILED_LOG_EVERY_N_OR_SEC(level, mod, freq, interval_sec, , , , , msg, ##__VA_ARGS__)

#define HS_SUBMOD_LOG(level, mod, req, submod_name, submod_val, msg, ...) \
HS_DETAILED_LOG(level, mod, req, submod_name, submod_val, , , msg, ##__VA_ARGS__)
#define HS_REQ_LOG(level, mod, req, msg, ...) HS_SUBMOD_LOG(level, mod, req, , , msg, ##__VA_ARGS__)
Expand Down Expand Up @@ -310,16 +353,86 @@
#define HS_REL_ASSERT_NULL(val, ...) HS_ASSERT_NULL(RELEASE_ASSERT_CMP, val, ##__VA_ARGS__)
#define HS_REL_ASSERT_NOTNULL(val, ...) HS_ASSERT_NOTNULL(RELEASE_ASSERT_CMP, val, ##__VA_ARGS__)

[[maybe_unused]] static uint64_t check_logged_already(const fmt::memory_buffer& buf) {
/**
* Rate-limited logging helper with count-based and time-based controls.
*
* State is cleaned up every 300 seconds to prevent unbounded memory growth.
* This means time-based rate limiting works correctly only when interval_sec < 300.
* If interval_sec >= 300, the behavior effectively becomes "log first occurrence after each 5min reset."
*/
[[maybe_unused]] static bool check_and_format_log(fmt::memory_buffer& buf, uint64_t freq = 0,
uint64_t interval_sec = 0) {
static constexpr uint64_t COUNTER_RESET_SEC{300}; // Reset every 5 minutes
static thread_local std::unordered_map< std::string, std::pair< Clock::time_point, uint64_t > > log_map{};

const std::string_view msg{buf.data()};
auto [it, happened] = log_map.emplace(msg, std::make_pair(Clock::now(), 0));
HS_REL_ASSERT(it != std::cend(log_map), "Expected entry to be either present or new insertion to succeed");
auto& [tm, count] = it->second;
auto result = count;
count = (get_elapsed_time_sec(tm) > COUNTER_RESET_SEC) ? static_cast< decltype(count) >(0) : count + 1;
tm = Clock::now();
return result;
static thread_local Clock::time_point last_cleanup{Clock::now()};
static thread_local std::unordered_map< size_t, std::pair< uint32_t, uint64_t > > log_map{};
// hash -> (last_log_ms, count)

// Warn once if interval_sec exceeds cleanup period
if (interval_sec > COUNTER_RESET_SEC) {
static thread_local bool warned = false;
if (!warned) {
LOGWARN("interval_sec={} exceeds cleanup period ({}s) - time-based rate limiting may not work as expected",
interval_sec, COUNTER_RESET_SEC);
warned = true;
}
}

const auto now = Clock::now();
if (get_elapsed_time_sec(last_cleanup) > COUNTER_RESET_SEC) {
std::unordered_map< size_t, std::pair< uint32_t, uint64_t > >().swap(log_map); // Actually release memory
last_cleanup = now;
}

// Hash the buffer content BEFORE appending any suffix
const std::string_view msg{buf.data(), buf.size()};
const size_t msg_hash = std::hash< std::string_view >{}(msg);

Comment thread
xiaoxichen marked this conversation as resolved.
// Milliseconds since last cleanup (max ~49 days with uint32_t)
const uint32_t now_ms =
std::chrono::duration_cast< std::chrono::milliseconds >(now - last_cleanup).count();

auto [it, happened] = log_map.emplace(msg_hash, std::make_pair(now_ms, 0));
uint32_t elapsed_ms = 0;
Comment thread
xiaoxichen marked this conversation as resolved.
uint64_t count = 0;

if (!happened) {
// Entry exists - increment count and calculate elapsed time
elapsed_ms = now_ms - it->second.first; // Time since last log emission
it->second.second++; // Increment count
count = it->second.second;
}

// Decide if we should log
bool should_log = false;
if (happened) {
// Always log first occurrence (new entry)
should_log = true;
} else if (freq == 0 && interval_sec == 0) {
// Both rate limiters disabled: always log (fallback behavior)
should_log = true;
} else if (freq > 0 && count % freq == 0) {
// Count-based: log every Nth occurrence
should_log = true;
} else if (interval_sec > 0 && elapsed_ms >= static_cast< uint32_t >(interval_sec) * 1000) {
Comment thread
xiaoxichen marked this conversation as resolved.
// Time-based: log if enough time has passed since last emission
Comment thread
xiaoxichen marked this conversation as resolved.
should_log = true;
}

// If logging, update timestamp and append suffix
if (should_log) {
// Append formatted suffix if not first occurrence
if (!happened && count > 0) {
// Always show elapsed time and count since last log
fmt::vformat_to(fmt::appender{buf}, fmt::string_view{" ...Last logged {}ms ago, {} occurrences"},
fmt::make_format_args(elapsed_ms, count));
}

// Update state after logging (so next log shows "since this log")
if (!happened) {
it->second.first = now_ms; // Update timestamp
it->second.second = 0; // Reset count (next occurrence will be "1 since this log")
}
}

return should_log;
}
Loading