This is an automated email from the ASF dual-hosted git repository.
twice pushed a commit to branch unstable
in repository https://gitbox.apache.org/repos/asf/kvrocks.git
The following commit(s) were added to refs/heads/unstable by this push:
new 37532fde8 chore(log): replace logging calls in `cli/*` and `common/*`
(#2888)
37532fde8 is described below
commit 37532fde8045b32d533aeb91832a2019aa83dd63
Author: Twice <[email protected]>
AuthorDate: Sun Apr 20 20:29:21 2025 +0800
chore(log): replace logging calls in `cli/*` and `common/*` (#2888)
Signed-off-by: PragmaTwice <[email protected]>
---
src/cli/daemon_util.h | 14 +++++++-------
src/cli/main.cc | 14 +++++++-------
src/cli/signal_util.h | 11 ++++++-----
src/cli/version_util.h | 13 ++++++++-----
src/common/logging.h | 22 +++++++++++-----------
src/common/task_runner.cc | 2 +-
utils/kvrocks2redis/main.cc | 4 ++--
7 files changed, 42 insertions(+), 38 deletions(-)
diff --git a/src/cli/daemon_util.h b/src/cli/daemon_util.h
index 31be6a24d..da491bd93 100644
--- a/src/cli/daemon_util.h
+++ b/src/cli/daemon_util.h
@@ -34,10 +34,10 @@
inline bool SupervisedUpstart() {
const char *upstart_job = getenv("UPSTART_JOB");
if (!upstart_job) {
- LOG(WARNING) << "upstart supervision requested, but UPSTART_JOB not found";
+ warn("upstart supervision requested, but UPSTART_JOB not found");
return false;
}
- LOG(INFO) << "supervised by upstart, will stop to signal readiness";
+ info("supervised by upstart, will stop to signal readiness");
raise(SIGSTOP);
unsetenv("UPSTART_JOB");
return true;
@@ -46,13 +46,13 @@ inline bool SupervisedUpstart() {
inline bool SupervisedSystemd() {
const char *notify_socket = getenv("NOTIFY_SOCKET");
if (!notify_socket) {
- LOG(WARNING) << "systemd supervision requested, but NOTIFY_SOCKET not
found";
+ warn("systemd supervision requested, but NOTIFY_SOCKET not found");
return false;
}
auto fd = UniqueFD(socket(AF_UNIX, SOCK_DGRAM, 0));
if (!fd) {
- LOG(WARNING) << "Cannot connect to systemd socket " << notify_socket;
+ warn("Cannot connect to systemd socket {}", notify_socket);
return false;
}
@@ -79,7 +79,7 @@ inline bool SupervisedSystemd() {
sendto_flags |= MSG_NOSIGNAL;
#endif
if (sendmsg(*fd, &hdr, sendto_flags) < 0) {
- LOG(WARNING) << "Cannot send notification to systemd";
+ warn("Cannot send notification to systemd");
return false;
}
return true;
@@ -106,7 +106,7 @@ inline bool IsSupervisedMode(SupervisedMode mode) {
inline void Daemonize() {
pid_t pid = fork();
if (pid < 0) {
- LOG(ERROR) << "Failed to fork the process, err: " << strerror(errno);
+ error("Failed to fork the process, error: ", strerror(errno));
exit(1);
}
@@ -114,7 +114,7 @@ inline void Daemonize() {
// change the file mode
umask(0);
if (setsid() < 0) {
- LOG(ERROR) << "Failed to setsid, err: " << strerror(errno);
+ error("Failed to setsid, error: ", strerror(errno));
exit(1);
}
diff --git a/src/cli/main.cc b/src/cli/main.cc
index 19c4ae26e..88b4f4302 100644
--- a/src/cli/main.cc
+++ b/src/cli/main.cc
@@ -50,7 +50,7 @@ Server *srv = nullptr;
extern "C" void SignalHandler(int sig) {
if (srv && !srv->IsStopped()) {
- LOG(INFO) << "Signal " << strsignal(sig) << " (" << sig << ") received,
stopping the server";
+ info("Signal {} ({}) received, stopping the server", strsignal(sig), sig);
srv->Stop();
}
}
@@ -80,7 +80,7 @@ static CLIOptions ParseCommandLineOptions(int argc, char
**argv) {
if ((argv[i] == "-c"sv || argv[i] == "--config"sv) && i + 1 < argc) {
opts.conf_file = argv[++i];
} else if (argv[i] == "-v"sv || argv[i] == "--version"sv) {
- std::cout << "kvrocks " << PrintVersion << std::endl;
+ std::cout << "kvrocks " << PrintVersion() << std::endl;
std::exit(0);
} else if (argv[i] == "-h"sv || argv[i] == "--help"sv) {
PrintUsage(*argv);
@@ -167,7 +167,7 @@ int main(int argc, char *argv[]) {
std::cout << "Failed to initialize logging system. Error: " << s.Msg() <<
std::endl;
return 1;
}
- LOG(INFO) << "kvrocks " << PrintVersion;
+ info("kvrocks {}", PrintVersion());
// Tricky: We don't expect that different instances running on the same port,
// but the server use REUSE_PORT to support the multi listeners. So we
connect
// the listen port to check if the port has already listened or not.
@@ -175,7 +175,7 @@ int main(int argc, char *argv[]) {
uint32_t ports[] = {config.port, config.tls_port, 0};
for (uint32_t *port = ports; *port; ++port) {
if (util::IsPortInUse(*port)) {
- LOG(ERROR) << "Could not create server TCP since the specified port["
<< *port << "] is already in use";
+ error("Could not create the server since the specified port {} is
already in use", *port);
return 1;
}
}
@@ -184,7 +184,7 @@ int main(int argc, char *argv[]) {
if (config.daemonize && !is_supervised) Daemonize();
s = CreatePidFile(config.pidfile);
if (!s.IsOK()) {
- LOG(ERROR) << "Failed to create pidfile: " << s.Msg();
+ error("Failed to create pidfile: {}", s.Msg());
return 1;
}
auto pidfile_exit = MakeScopeExit([&config] { RemovePidFile(config.pidfile);
});
@@ -199,14 +199,14 @@ int main(int argc, char *argv[]) {
engine::Storage storage(&config);
s = storage.Open();
if (!s.IsOK()) {
- LOG(ERROR) << "Failed to open: " << s.Msg();
+ error("Failed to open the database: {}", s.Msg());
return 1;
}
Server server(&storage, &config);
srv = &server;
s = srv->Start();
if (!s.IsOK()) {
- LOG(ERROR) << "Failed to start server: " << s.Msg();
+ error("Failed to start server: {}", s.Msg());
return 1;
}
srv->Join();
diff --git a/src/cli/signal_util.h b/src/cli/signal_util.h
index 51368a631..0ca21d628 100644
--- a/src/cli/signal_util.h
+++ b/src/cli/signal_util.h
@@ -31,16 +31,17 @@
#include "version_util.h"
extern "C" inline void SegvHandler(int sig, [[maybe_unused]] siginfo_t *info,
[[maybe_unused]] void *secret) {
- LOG(ERROR) << "Ooops! Apache Kvrocks " << PrintVersion << " got signal: " <<
strsignal(sig) << " (" << sig << ")";
+ error("Ooops! Apache Kvrocks {} got signal: {} ({})", PrintVersion(),
strsignal(sig), sig);
auto trace = cpptrace::generate_trace();
std::string trace_str;
std::ostringstream os(trace_str);
trace.print(os);
- LOG(ERROR)
- << os.str()
- << "It would be greatly appreciated if you could submit this crash to
https://github.com/apache/kvrocks/issues "
- "along with the stacktrace above, logs and any relevant information.";
+
+ error("{}", os.str());
+ error(
+ "It would be greatly appreciated if you could submit this crash to
https://github.com/apache/kvrocks/issues "
+ "along with the stacktrace above, logs and any relevant information.");
struct sigaction act;
/* Make sure we exit with the right signal at the end. So for instance
diff --git a/src/cli/version_util.h b/src/cli/version_util.h
index 38a8bcc2b..b49c4994b 100644
--- a/src/cli/version_util.h
+++ b/src/cli/version_util.h
@@ -21,19 +21,22 @@
#pragma once
#include <iostream>
+#include <iterator>
+#include "fmt/base.h"
#include "version.h"
-inline std::ostream &PrintVersion(std::ostream &os) {
+inline std::string PrintVersion() {
+ std::string result;
if (VERSION != "unstable") {
- os << "version ";
+ result += "version ";
}
- os << VERSION;
+ result += VERSION;
if (!GIT_COMMIT.empty()) {
- os << " (commit " << GIT_COMMIT << ")";
+ fmt::format_to(std::back_inserter(result), " (commit {})", GIT_COMMIT);
}
- return os;
+ return result;
}
diff --git a/src/common/logging.h b/src/common/logging.h
index 4951ab9c5..11063cb41 100644
--- a/src/common/logging.h
+++ b/src/common/logging.h
@@ -30,43 +30,43 @@
// just like std::source_location::current() in C++20 and
__builtin_source_location(),
// but works in lower version compilers (GCC and Clang)
-inline spdlog::source_loc CurrentLocation(const char *filename =
__builtin_FILE(), int lineno = __builtin_LINE(),
- const char *funcname =
__builtin_FUNCTION()) {
+inline constexpr spdlog::source_loc CurrentLocation(const char *filename =
__builtin_FILE(),
+ int lineno =
__builtin_LINE(),
+ const char *funcname =
__builtin_FUNCTION()) {
return {filename, lineno, funcname};
}
-template <typename... Args>
struct FormatMessageWithLoc {
template <typename T>
- FormatMessageWithLoc(T &&v, spdlog::source_loc loc = CurrentLocation()) //
NOLINT
- : fmt(std::forward<T>(v)), current_loc(loc) {}
+ constexpr FormatMessageWithLoc(const T &v, spdlog::source_loc loc =
CurrentLocation()) // NOLINT
+ : fmt(v), current_loc(loc) {}
- spdlog::format_string_t<Args...> fmt;
+ std::string_view fmt;
spdlog::source_loc current_loc;
};
template <typename... Args>
-inline void debug(FormatMessageWithLoc<Args...> fmt, Args &&...args) { //
NOLINT
+inline void debug(FormatMessageWithLoc fmt, Args &&...args) { // NOLINT
spdlog::default_logger_raw()->log(fmt.current_loc, spdlog::level::debug,
fmt.fmt, std::forward<Args>(args)...);
}
template <typename... Args>
-inline void info(FormatMessageWithLoc<Args...> fmt, Args &&...args) { //
NOLINT
+inline void info(FormatMessageWithLoc fmt, Args &&...args) { // NOLINT
spdlog::default_logger_raw()->log(fmt.current_loc, spdlog::level::info,
fmt.fmt, std::forward<Args>(args)...);
}
template <typename... Args>
-inline void warn(FormatMessageWithLoc<Args...> fmt, Args &&...args) { //
NOLINT
+inline void warn(FormatMessageWithLoc fmt, Args &&...args) { // NOLINT
spdlog::default_logger_raw()->log(fmt.current_loc, spdlog::level::warn,
fmt.fmt, std::forward<Args>(args)...);
}
template <typename... Args>
-inline void error(FormatMessageWithLoc<Args...> fmt, Args &&...args) { //
NOLINT
+inline void error(FormatMessageWithLoc fmt, Args &&...args) { // NOLINT
spdlog::default_logger_raw()->log(fmt.current_loc, spdlog::level::err,
fmt.fmt, std::forward<Args>(args)...);
}
template <typename... Args>
-[[noreturn]] inline void fatal(FormatMessageWithLoc<Args...> fmt, Args
&&...args) { // NOLINT
+[[noreturn]] inline void fatal(FormatMessageWithLoc fmt, Args &&...args) { //
NOLINT
spdlog::default_logger_raw()->log(fmt.current_loc, spdlog::level::critical,
fmt.fmt, std::forward<Args>(args)...);
std::abort();
}
diff --git a/src/common/task_runner.cc b/src/common/task_runner.cc
index 810a66c58..6556d2493 100644
--- a/src/common/task_runner.cc
+++ b/src/common/task_runner.cc
@@ -45,7 +45,7 @@ Status TaskRunner::Join() {
for (auto &thread : threads_) {
if (auto s = util::ThreadJoin(thread); !s) {
- LOG(WARNING) << "Failed to join thread: " << s.Msg();
+ warn("Failed to join thread: {}", s.Msg());
continue;
}
}
diff --git a/utils/kvrocks2redis/main.cc b/utils/kvrocks2redis/main.cc
index 32ad12458..a258d68bd 100644
--- a/utils/kvrocks2redis/main.cc
+++ b/utils/kvrocks2redis/main.cc
@@ -73,7 +73,7 @@ static Options ParseCommandLineOptions(int argc, char **argv)
{
break;
}
case 'v':
- std::cout << "kvrocks2redis " << PrintVersion << std::endl;
+ std::cout << "kvrocks2redis " << PrintVersion() << std::endl;
exit(0);
case 'h':
default:
@@ -112,7 +112,7 @@ int main(int argc, char *argv[]) {
}
InitSpdlog(config);
- LOG(INFO) << "kvrocks2redis " << PrintVersion;
+ LOG(INFO) << "kvrocks2redis " << PrintVersion();
if (config.daemonize) Daemonize();
