commit a00f683cea5d288e2996a4b20abe3fb20d59f716
author Anwaar Hadi <anwaar.hadi@ibm.com> Thu Mar 27 15:03:11 2025 +0000
committer Anwaar Hadi <anwaar.hadi@ibm.com> Wed Apr 02 16:21:35 2025 +0000
tree 315db0fe2ea61285fe16ee45939ef391b6ede778
parent 235adf9148fb0242323733d91e1a3567b21e2765

Move the monitor application to lg2

Update the logging API used for files in phosphor-fan-presence/monitor
from the older phosphor::logging::log to the more recent lg2::log.

Tested:
* Verified journal traces worked correctly in simulation.
* Modified json and simulation parameters to force various
  application errors and verified correct output and key/value
  pairs using journalctl.

Change-Id: Id6f5161edfd09b672aba8751a6d2c6518665188a
Signed-off-by: Anwaar Hadi <anwaar.hadi@ibm.com>

monitor/tach_sensor.cpp

diff --git a/monitor/tach_sensor.cpp b/monitor/tach_sensor.cpp
index d26b246..5790bab 100644
--- a/monitor/tach_sensor.cpp
+++ b/monitor/tach_sensor.cpp
@@ -20,10 +20,9 @@
 #include "utility.hpp"
 
 #include <phosphor-logging/elog.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
 
 #include <filesystem>
-#include <format>
 #include <functional>
 #include <optional>
 #include <utility>
@@ -66,7 +65,10 @@
     }
     catch (const std::exception& e)
     {
-        phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
+        lg2::error(
+            "getProperty failed on path {PATH}, interface {INTERFACE}, property {PROPERTY_NAME}, Error: {ERROR}",
+            "PATH", path, "INTERFACE", interface, "PROPERTY_NAME", propertyName,
+            "ERROR", e);
     }
 }
 
@@ -318,11 +320,10 @@
 
     if (!timerRunning() || mode != _timerMode)
     {
-        log<level::DEBUG>(
-            std::format("Start timer({}) on tach sensor {}. [delay = {}s]",
-                        static_cast<int>(mode), _name,
-                        duration_cast<seconds>(getDelay(mode)).count())
-                .c_str());
+        lg2::debug(
+            "Start timer({MODE}) on tach sensor {NAME}. [delay = {DELAY}s]",
+            "MODE", static_cast<int>(mode), "NAME", _name, "DELAY",
+            duration_cast<seconds>(getDelay(mode)).count());
         _timer.restartOnce(getDelay(mode));
         _timerMode = mode;
     }
@@ -340,8 +341,8 @@
             return duration_cast<microseconds>(seconds(_funcDelay));
         default:
             // Log an internal error for undefined timer mode
-            log<level::ERR>("Undefined timer mode",
-                            entry("TIMER_MODE=%u", mode));
+            lg2::error("Undefined timer mode: {TIMER_MODE}", "TIMER_MODE",
+                       mode);
             elog<InternalFailure>();
             return duration_cast<microseconds>(seconds(0));
     }
@@ -354,11 +355,9 @@
         if (_counter < _threshold)
         {
             ++_counter;
-            log<level::DEBUG>(
-                std::format(
-                    "Incremented error counter on {} to {} (threshold {})",
-                    _name, _counter, _threshold)
-                    .c_str());
+            lg2::debug(
+                "Incremented error counter on {NAME} to {COUNTER} (threshold {THRESHOLD})",
+                "NAME", _name, "COUNTER", _counter, "THRESHOLD", _threshold);
         }
     }
     else
@@ -366,11 +365,9 @@
         if (_counter > 0)
         {
             --_counter;
-            log<level::DEBUG>(
-                std::format(
-                    "Decremented error counter on {} to {} (threshold {})",
-                    _name, _counter, _threshold)
-                    .c_str());
+            lg2::debug(
+                "Decremented error counter on {NAME} to {COUNTER} (threshold {THRESHOLD})",
+                "NAME", _name, "COUNTER", _counter, "THRESHOLD", _threshold);
         }
     }
 }
@@ -379,8 +376,7 @@
 {
     if (_countTimer)
     {
-        log<level::DEBUG>(
-            std::format("Starting count timer on sensor {}", _name).c_str());
+        lg2::debug("Starting count timer on sensor {NAME}", "NAME", _name);
         _countTimer->restart(std::chrono::seconds(_countInterval));
     }
 }
@@ -389,9 +385,8 @@
 {
     if (_countTimer && _countTimer->isEnabled())
     {
-        log<level::DEBUG>(
-            std::format("Stopping count timer on tach sensor {}.", _name)
-                .c_str());
+        lg2::debug("Stopping count timer on tach sensor {NAME}.", "NAME",
+                   _name);
         _countTimer->setEnabled(false);
     }
 }
@@ -408,7 +403,7 @@
 
     if (response.is_method_error())
     {
-        log<level::ERR>("Error in notify update of tach sensor inventory");
+        lg2::error("Error in notify update of tach sensor inventory");
     }
 }