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_manager_faultlog.cpp b/dump_manager_faultlog.cpp
index 7bb8352..8e0967e 100644
--- a/dump_manager_faultlog.cpp
+++ b/dump_manager_faultlog.cpp
@@ -5,10 +5,9 @@
#include "dump_utils.hpp"
#include "faultlog_dump_entry.hpp"
-#include <fmt/core.h>
-
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <xyz/openbmc_project/Common/File/error.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
@@ -33,18 +32,18 @@
sdbusplus::message::object_path
Manager::createDump(phosphor::dump::DumpCreateParams params)
{
- log<level::INFO>("In dump_manager_fault.cpp createDump");
+ lg2::info("In dump_manager_fault.cpp createDump");
// Currently we ignore the parameters.
// TODO phosphor-debug-collector/issues/22: Check parameter values and
// exit early if we don't receive the expected parameters
if (params.empty())
{
- log<level::INFO>("No additional parameters received");
+ lg2::info("No additional parameters received");
}
else
{
- log<level::INFO>("Got additional parameters");
+ lg2::info("Got additional parameters");
}
// Get the originator id and type from params
@@ -70,7 +69,7 @@
if (faultLogFile.is_open())
{
- log<level::INFO>("faultLogFile is open");
+ lg2::info("faultLogFile is open");
faultLogFile << "This is faultlog file #" << idString << " at "
<< std::string(FAULTLOG_DUMP_PATH) + idString << std::endl;
@@ -79,18 +78,17 @@
}
else
{
- log<level::ERR>(fmt::format("Failed to open fault log file at {}, "
- "errno({}), strerror(\"{}\"), "
- "OBJECTPATH({}), ID({})",
- faultLogFilePath.c_str(), errno,
- strerror(errno), objPath.c_str(), id)
- .c_str());
+ lg2::error(
+ "Failed to open fault log file at {FILE_PATH}, errno: {ERRNO}, "
+ "strerror: {STRERROR}, OBJECTPATH: {OBJECT_PATH}, ID: {ID}",
+ "FILE_PATH", faultLogFilePath, "ERRNO", errno, "STRERROR",
+ strerror(errno), "OBJECT_PATH", objPath, "ID", id);
elog<Open>(ErrnoOpen(errno), PathOpen(objPath.c_str()));
}
try
{
- log<level::INFO>("dump_manager_faultlog.cpp: add faultlog entry");
+ lg2::info("dump_manager_faultlog.cpp: add faultlog entry");
uint64_t timestamp =
std::chrono::duration_cast<std::chrono::microseconds>(
@@ -107,16 +105,15 @@
}
catch (const std::invalid_argument& e)
{
- log<level::ERR>(fmt::format("Error in creating dump entry, "
- "errormsg({}), OBJECTPATH({}), ID({})",
- e.what(), objPath.c_str(), id)
- .c_str());
+ lg2::error("Error in creating dump entry, errormsg: {ERROR}, "
+ "OBJECTPATH: {OBJECT_PATH}, ID: {ID}",
+ "ERROR", e, "OBJECT_PATH", objPath, "ID", id);
elog<InternalFailure>();
}
lastEntryId++;
- log<level::INFO>("End of dump_manager_faultlog.cpp createDump");
+ lg2::info("End of dump_manager_faultlog.cpp createDump");
return objPath.string();
}