Implementing Phosphor-Logging/LG2 logging
This commit introduces changes in the phosphor-debug-collector
repository to implement structured logging using the LG2
framework. The existing log calls in the repository,
have been replaced with LG2 logging, facilitates better
log tracking and troubleshooting by offering improved
detail in JSON object values.
Test:
- Created BMC dump
- Created system dump
Here is a example
{
"_EXE" : "/tmp/phosphor-dump-manager",
"_MACHINE_ID" : "f9ca96d99c7b4ba688556f632ffeff5d",
"_CAP_EFFECTIVE" : "1ffffffffff",
"LOG2_FMTMSG" : "Invalid Dump file name, FILENAME: {FILENAME}",
"__CURSOR" : "s=721ae7a5b6ed43ec904f2bb03e3c0403;i=2a8d0;\
b=b372b9a5989e46bb8e62b33310e181ea;m=2c05fda2b;t=5fdf0684c1e70;x=1592f60584d6486c",
"CODE_FUNC" : "void phosphor::dump::bmc::Manager::\
createEntry(const std::filesystem::__cxx11::path&)",
"_SYSTEMD_SLICE" : "system-dropbear.slice",
"CODE_LINE" : "174",
"__REALTIME_TIMESTAMP" : "1686583867350640",
"PRIORITY" : "3",
"_SYSTEMD_UNIT" : "dropbear@1-9.3.29.238:22-9.3.84.138:45432.service",
"_PID" : "16209",
"_BOOT_ID" : "b372b9a5989e46bb8e62b33310e181ea",
"_SOURCE_REALTIME_TIMESTAMP" : "1686583867350580",
"_TRANSPORT" : "journal",
"_HOSTNAME" : "openbmc",
"SYSLOG_IDENTIFIER" : "phosphor-dump-manager",
"MESSAGE" : "Invalid Dump file name, \
FILENAME: BMCDUMP.XXXXXXX.0000006.20230612153010",
"CODE_FILE" : \
"/usr/src/debug/phosphor-debug-collector/1.0+gitAUTOINC+a17f1c92ce-r1\
/dump_manager_bmc.cpp",
"_UID" : "0",
"_CMDLINE" : "/tmp/phosphor-dump-manager",
"_RUNTIME_SCOPE" : "system",
"FILENAME" : "BMCDUMP.XXXXXXXX.0000006.20230612153010",
"_SYSTEMD_INVOCATION_ID" : "64a11629aade4c96ab62154cbc4be8b7",
"__MONOTONIC_TIMESTAMP" : "11817441835",
"_SYSTEMD_CGROUP" : "/system.slice/system-dropbear.slice/\
dropbear@1-9.3.29.238:22-9.3.84.138:45432.service",
"_COMM" : "phosphor-dump-m",
"_GID" : "0"
}
Change-Id: I3a52b812b059b64d945493de2e2cc68a43f6d72a
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
diff --git a/dump_utils.cpp b/dump_utils.cpp
index 236bff0..ee75a4f 100644
--- a/dump_utils.cpp
+++ b/dump_utils.cpp
@@ -1,7 +1,6 @@
#include "dump_utils.hpp"
-#include <fmt/core.h>
-
+#include <phosphor-logging/lg2.hpp>
#include <phosphor-logging/log.hpp>
namespace phosphor
@@ -31,19 +30,18 @@
reply.read(response);
if (response.empty())
{
- log<level::ERR>(fmt::format("Error in mapper response for getting "
- "service name, PATH({}), INTERFACE({})",
- path, interface)
- .c_str());
+ lg2::error(
+ "Error in mapper response for getting service name, PATH: "
+ "{PATH}, INTERFACE: {INTERFACE}",
+ "PATH", path, "INTERFACE", interface);
return std::string{};
}
}
catch (const sdbusplus::exception_t& e)
{
- log<level::ERR>(fmt::format("Error in mapper method call, "
- "errormsg({}), PATH({}), INTERFACE({})",
- e.what(), path, interface)
- .c_str());
+ lg2::error("Error in mapper method call, errormsg: {ERROR}, "
+ "PATH: {PATH}, INTERFACE: {INTERFACE}",
+ "ERROR", e, "PATH", path, "INTERFACE", interface);
return std::string{};
}
return response[0].first;
@@ -86,20 +84,19 @@
}
catch (const sdbusplus::exception_t& e)
{
- log<level::ERR>(fmt::format("D-Bus call exception, OBJPATH({}), "
- "INTERFACE({}), EXCEPTION({})",
- hostStateObjPath, bootProgressInterface,
- e.what())
- .c_str());
+ lg2::error("D-Bus call exception, OBJPATH: {OBJ_PATH}, "
+ "INTERFACE: {INTERFACE}, EXCEPTION: {ERROR}",
+ "OBJ_PATH", hostStateObjPath, "INTERFACE",
+ bootProgressInterface, "ERROR", e);
throw std::runtime_error("Failed to get BootProgress stage");
}
catch (const std::bad_variant_access& e)
{
- log<level::ERR>(
- fmt::format("Exception raised while read BootProgress property "
- "value, OBJPATH({}), INTERFACE({}), EXCEPTION({})",
- hostStateObjPath, bootProgressInterface, e.what())
- .c_str());
+ lg2::error("Exception raised while read BootProgress property value, "
+ "OBJPATH: {OBJ_PATH}, INTERFACE: {INTERFACE}, "
+ "EXCEPTION: {ERROR}",
+ "OBJ_PATH", hostStateObjPath, "INTERFACE",
+ bootProgressInterface, "ERROR", e);
throw std::runtime_error("Failed to get BootProgress stage");
}