Replace logging with std::format
std::format is a much more modern logging solution, and gives us a lot
more flexibility, and better compile times when doing logging.
Unfortunately, given its level of compile time checks, it needs to be a
method, instead of the stream style logging we had before. This
requires a pretty substantial change. Fortunately, this change can be
largely automated, via the script included in this commit under
scripts/replace_logs.py. This is to aid people in moving their
patchsets over to the new form in the short period where old patches
will be based on the old logging. The intention is that this script
eventually goes away.
The old style logging (stream based) looked like.
BMCWEB_LOG_DEBUG << "Foo " << foo;
The new equivalent of the above would be:
BMCWEB_LOG_DEBUG("Foo {}", foo);
In the course of doing this, this also cleans up several ignored linter
errors, including macro usage, and array to pointer deconstruction.
Note, This patchset does remove the timestamp from the log message. In
practice, this was duplicated between journald and bmcweb, and there's
no need for both to exist.
One design decision of note is the addition of logPtr. Because the
compiler can't disambiguate between const char* and const MyThing*, it's
necessary to add an explicit cast to void*. This is identical to how
fmt handled it.
Tested: compiled with logging meson_option enabled, and launched bmcweb
Saw the usual logging, similar to what was present before:
```
[Error include/webassets.hpp:60] Unable to find or open /usr/share/www/ static file hosting disabled
[Debug include/persistent_data.hpp:133] Restored Session Timeout: 1800
[Debug redfish-core/include/event_service_manager.hpp:671] Old eventService config not exist
[Info src/webserver_main.cpp:59] Starting webserver on port 18080
[Error redfish-core/include/event_service_manager.hpp:1301] inotify_add_watch failed for redfish log file.
[Info src/webserver_main.cpp:137] Start Hostname Monitor Service...
```
Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: I86a46aa2454be7fe80df608cb7e5573ca4029ec8
diff --git a/include/obmc_console.hpp b/include/obmc_console.hpp
index f9b978d..2dd3edb 100644
--- a/include/obmc_console.hpp
+++ b/include/obmc_console.hpp
@@ -36,13 +36,13 @@
{
if (doingWrite)
{
- BMCWEB_LOG_DEBUG << "Already writing. Bailing out";
+ BMCWEB_LOG_DEBUG("Already writing. Bailing out");
return;
}
if (inputBuffer.empty())
{
- BMCWEB_LOG_DEBUG << "Outbuffer empty. Bailing out";
+ BMCWEB_LOG_DEBUG("Outbuffer empty. Bailing out");
return;
}
@@ -67,8 +67,7 @@
}
if (ec)
{
- BMCWEB_LOG_ERROR << "Error in host serial write "
- << ec.message();
+ BMCWEB_LOG_ERROR("Error in host serial write {}", ec.message());
return;
}
self->doWrite();
@@ -87,12 +86,12 @@
void doRead()
{
- BMCWEB_LOG_DEBUG << "Reading from socket";
+ BMCWEB_LOG_DEBUG("Reading from socket");
hostSocket.async_read_some(
boost::asio::buffer(outputBuffer),
[this, weakSelf(weak_from_this())](
const boost::system::error_code& ec, std::size_t bytesRead) {
- BMCWEB_LOG_DEBUG << "read done. Read " << bytesRead << " bytes";
+ BMCWEB_LOG_DEBUG("read done. Read {} bytes", bytesRead);
std::shared_ptr<ConsoleHandler> self = weakSelf.lock();
if (self == nullptr)
{
@@ -100,8 +99,8 @@
}
if (ec)
{
- BMCWEB_LOG_ERROR << "Couldn't read from host serial port: "
- << ec.message();
+ BMCWEB_LOG_ERROR("Couldn't read from host serial port: {}",
+ ec.message());
conn.close("Error connecting to host port");
return;
}
@@ -120,8 +119,9 @@
if (ec)
{
- BMCWEB_LOG_ERROR << "Failed to assign the DBUS socket"
- << " Socket assign error: " << ec.message();
+ BMCWEB_LOG_ERROR(
+ "Failed to assign the DBUS socket Socket assign error: {}",
+ ec.message());
return false;
}
@@ -155,15 +155,15 @@
// then remove the handler from handlers map.
inline void onClose(crow::websocket::Connection& conn, const std::string& err)
{
- BMCWEB_LOG_INFO << "Closing websocket. Reason: " << err;
+ BMCWEB_LOG_INFO("Closing websocket. Reason: {}", err);
auto iter = getConsoleHandlerMap().find(&conn);
if (iter == getConsoleHandlerMap().end())
{
- BMCWEB_LOG_CRITICAL << "Unable to find connection " << &conn;
+ BMCWEB_LOG_CRITICAL("Unable to find connection {}", logPtr(&conn));
return;
}
- BMCWEB_LOG_DEBUG << "Remove connection " << &conn << " from obmc console";
+ BMCWEB_LOG_DEBUG("Remove connection {} from obmc console", logPtr(&conn));
// Removed last connection so remove the path
getConsoleHandlerMap().erase(iter);
@@ -175,8 +175,9 @@
{
if (ec)
{
- BMCWEB_LOG_ERROR << "Failed to call console Connect() method"
- << " DBUS error: " << ec.message();
+ BMCWEB_LOG_ERROR(
+ "Failed to call console Connect() method DBUS error: {}",
+ ec.message());
conn.close("Failed to connect");
return;
}
@@ -185,20 +186,20 @@
auto iter = getConsoleHandlerMap().find(&conn);
if (iter == getConsoleHandlerMap().end())
{
- BMCWEB_LOG_ERROR << "Connection was already closed";
+ BMCWEB_LOG_ERROR("Connection was already closed");
return;
}
int fd = dup(unixfd);
if (fd == -1)
{
- BMCWEB_LOG_ERROR << "Failed to dup the DBUS unixfd"
- << " error: " << strerror(errno);
+ BMCWEB_LOG_ERROR("Failed to dup the DBUS unixfd error: {}",
+ strerror(errno));
conn.close("Internal error");
return;
}
- BMCWEB_LOG_DEBUG << "Console unix FD: " << unixfd << " duped FD: " << fd;
+ BMCWEB_LOG_DEBUG("Console duped FD: {}", fd);
if (!iter->second->connect(fd))
{
@@ -217,14 +218,14 @@
auto iter = getConsoleHandlerMap().find(&conn);
if (iter == getConsoleHandlerMap().end())
{
- BMCWEB_LOG_ERROR << "Connection was already closed";
+ BMCWEB_LOG_ERROR("Connection was already closed");
return;
}
if (ec)
{
- BMCWEB_LOG_WARNING << "getDbusObject() for consoles failed. DBUS error:"
- << ec.message();
+ BMCWEB_LOG_WARNING("getDbusObject() for consoles failed. DBUS error:{}",
+ ec.message());
conn.close("getDbusObject() for consoles failed.");
return;
}
@@ -232,15 +233,15 @@
const auto valueIface = objInfo.begin();
if (valueIface == objInfo.end())
{
- BMCWEB_LOG_WARNING << "getDbusObject() returned unexpected size: "
- << objInfo.size();
+ BMCWEB_LOG_WARNING("getDbusObject() returned unexpected size: {}",
+ objInfo.size());
conn.close("getDbusObject() returned unexpected size");
return;
}
const std::string& consoleService = valueIface->first;
- BMCWEB_LOG_DEBUG << "Looking up unixFD for Service " << consoleService
- << " Path " << consoleObjPath;
+ BMCWEB_LOG_DEBUG("Looking up unixFD for Service {} Path {}", consoleService,
+ consoleObjPath);
// Call Connect() method to get the unix FD
crow::connections::systemBus->async_method_call(
[&conn](const boost::system::error_code& ec1,
@@ -257,7 +258,7 @@
{
std::string consoleLeaf;
- BMCWEB_LOG_DEBUG << "Connection " << &conn << " opened";
+ BMCWEB_LOG_DEBUG("Connection {} opened", logPtr(&conn));
if (getConsoleHandlerMap().size() >= maxSessions)
{
@@ -286,8 +287,8 @@
sdbusplus::message::object_path("/xyz/openbmc_project/console") /
consoleLeaf;
- BMCWEB_LOG_DEBUG << "Console Object path = " << consolePath
- << " Request target = " << conn.url().path();
+ BMCWEB_LOG_DEBUG("Console Object path = {} Request target = {}",
+ consolePath, conn.url().path());
// mapper call lambda
constexpr std::array<std::string_view, 1> interfaces = {
@@ -307,7 +308,7 @@
auto handler = getConsoleHandlerMap().find(&conn);
if (handler == getConsoleHandlerMap().end())
{
- BMCWEB_LOG_CRITICAL << "Unable to find connection " << &conn;
+ BMCWEB_LOG_CRITICAL("Unable to find connection {}", logPtr(&conn));
return;
}
handler->second->inputBuffer += data;