commit d6e10ada58b41970933eacfd7750a467602f4f38
author Riya Dixit <riyadixitagra@gmail.com> Thu Mar 28 19:44:16 2024 -0500
committer ManojKiran Eda <manojkiran.eda@gmail.com> Mon May 13 06:55:52 2024 +0000
tree b394656f419f850d303625e76617bd25d33cf22c
parent 9e0e826cd446dc5a5a27466d0bd0b2ee3137db91

host-bmc: Improving Logs (lg2)

This commit corrects the severity level of logs and also formats the
message string, fixing the ill-defined message string of the logs as
mentioned in the anti-pattern document [1]. Additionally, based on the
requirement this commit adds more debug information to logs.

[1]: https://github.com/openbmc/docs/blob/master/anti-patterns.md#ill-defined-data-structuring-in-lg2-message-strings

Change-Id: I75a2b54ac1d363cfb675f29e811ab341046fbccd
Signed-off-by: Riya Dixit <riyadixitagra@gmail.com>

host-bmc/dbus_to_event_handler.cpp

diff --git a/host-bmc/dbus_to_event_handler.cpp b/host-bmc/dbus_to_event_handler.cpp
index 891a769..85740cf 100644
--- a/host-bmc/dbus_to_event_handler.cpp
+++ b/host-bmc/dbus_to_event_handler.cpp
@@ -41,8 +41,9 @@
     if (rc != PLDM_SUCCESS)
     {
         instanceIdDb.free(mctp_eid, instanceId);
-        error("Failed to encode_platform_event_message_req, rc = {RC}", "RC",
-              rc);
+        error(
+            "Failed to encode platform event message request, response code '{RC}'",
+            "RC", rc);
         return;
     }
 
@@ -60,8 +61,8 @@
         if (rc || completionCode)
         {
             error(
-                "Failed to decode_platform_event_message_resp: rc = {RC}, cc = {CC}",
-                "RC", rc, "CC", static_cast<unsigned>(completionCode));
+                "Failed to decode response of platform_event message, response code '{RC}' and completion code '{CC}'",
+                "RC", rc, "CC", completionCode);
         }
     };
 
@@ -70,7 +71,8 @@
         std::move(requestMsg), std::move(platformEventMessageResponseHandler));
     if (rc)
     {
-        error("Failed to send the platform event message");
+        error("Failed to send the platform event message, response code '{RC}'",
+              "RC", rc);
     }
 }