Switch to lg2 for logging
After enabling C++20, lg2 is preferred for logging. This patch replaces
all phosphor::logging::log calls to lg2 calls.
Tested:
Build pass.
Change-Id: Ic37bc36f43c2b3a1c61b1328af95e3a41c8d6d40
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@intel.com>
diff --git a/phosphor-ldap-config/ldap_config.cpp b/phosphor-ldap-config/ldap_config.cpp
index b7bd4c6..45968ac 100644
--- a/phosphor-ldap-config/ldap_config.cpp
+++ b/phosphor-ldap-config/ldap_config.cpp
@@ -152,7 +152,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
}
@@ -170,7 +170,6 @@
{
if (enabled())
{
-
writeConfig();
}
parent.startOrStopService(nslcdService, enabled());
@@ -181,7 +180,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
}
@@ -320,7 +319,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return;
@@ -347,7 +346,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return value;
@@ -372,16 +371,15 @@
}
else
{
- log<level::ERR>("bad LDAP Server URI",
- entry("LDAPSERVERURI=%s", value.c_str()));
+ lg2::error("Bad LDAP Server URI {URI}", "URI", value);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("ldapServerURI"),
Argument::ARGUMENT_VALUE(value.c_str()));
}
if (secureLDAP && !fs::exists(tlsCacertFile.c_str()))
{
- log<level::ERR>("LDAP server's CA certificate not provided",
- entry("TLSCACERTFILE=%s", tlsCacertFile.c_str()));
+ lg2::error("LDAP server CA certificate not found at {PATH}", "PATH",
+ tlsCacertFile);
elog<NoCACertificate>();
}
val = ConfigIface::ldapServerURI(value);
@@ -407,7 +405,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -425,8 +423,8 @@
if (value.empty())
{
- log<level::ERR>("Not a valid LDAP BINDDN",
- entry("LDAPBINDDN=%s", value.c_str()));
+ lg2::error("'{BINDDN}' is not a valid LDAP BindDN", "BINDDN",
+ value);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("ldapBindDN"),
Argument::ARGUMENT_VALUE(value.c_str()));
}
@@ -450,7 +448,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -468,8 +466,8 @@
if (value.empty())
{
- log<level::ERR>("Not a valid LDAP BASEDN",
- entry("BASEDN=%s", value.c_str()));
+ lg2::error("'{BASEDN}' is not a valid LDAP BaseDN", "BASEDN",
+ value);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("ldapBaseDN"),
Argument::ARGUMENT_VALUE(value.c_str()));
}
@@ -493,7 +491,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -525,7 +523,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -569,7 +567,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return isEnable;
@@ -601,7 +599,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -633,7 +631,7 @@
}
catch (const std::exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
elog<InternalFailure>();
}
return val;
@@ -731,7 +729,7 @@
}
catch (const cereal::Exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Exception: {ERR}", "ERR", e);
std::error_code ec;
fs::remove(configPersistPath, ec);
return false;
@@ -786,7 +784,7 @@
{
if (groupName.empty())
{
- log<level::ERR>("Group name is empty");
+ lg2::error("Group name is empty");
elog<InvalidArgument>(Argument::ARGUMENT_NAME("Group name"),
Argument::ARGUMENT_VALUE("Null"));
}
@@ -795,7 +793,8 @@
{
if (val.second.get()->groupName() == groupName)
{
- log<level::ERR>("Group name already exists");
+ lg2::error("Group name '{GROUPNAME}' already exists", "GROUPNAME",
+ groupName);
elog<PrivilegeMappingExists>();
}
}
@@ -805,15 +804,15 @@
{
if (privilege.empty())
{
- log<level::ERR>("Privilege level is empty");
+ lg2::error("Privilege level is empty");
elog<InvalidArgument>(Argument::ARGUMENT_NAME("Privilege level"),
Argument::ARGUMENT_VALUE("Null"));
}
if (std::find(privMgr.begin(), privMgr.end(), privilege) == privMgr.end())
{
- log<level::ERR>("Invalid privilege");
- elog<InvalidArgument>(Argument::ARGUMENT_NAME("Privilege level"),
+ lg2::error("Invalid privilege '{PRIVILEGE}'", "PRIVILEGE", privilege);
+ elog<InvalidArgument>(Argument::ARGUMENT_NAME("Privilege"),
Argument::ARGUMENT_VALUE(privilege.c_str()));
}
}
diff --git a/phosphor-ldap-config/ldap_config.hpp b/phosphor-ldap-config/ldap_config.hpp
index c1ba5ec..1528512 100644
--- a/phosphor-ldap-config/ldap_config.hpp
+++ b/phosphor-ldap-config/ldap_config.hpp
@@ -6,7 +6,7 @@
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <sdbusplus/bus.hpp>
#include <sdbusplus/server/object.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
diff --git a/phosphor-ldap-config/ldap_config_mgr.cpp b/phosphor-ldap-config/ldap_config_mgr.cpp
index a359273..d2ef4e0 100644
--- a/phosphor-ldap-config/ldap_config_mgr.cpp
+++ b/phosphor-ldap-config/ldap_config_mgr.cpp
@@ -17,7 +17,6 @@
constexpr auto ldapScheme = "ldap";
constexpr auto ldapsScheme = "ldaps";
-using namespace phosphor::logging;
using namespace sdbusplus::xyz::openbmc_project::Common::Error;
namespace fs = std::filesystem;
using Argument = xyz::openbmc_project::Common::InvalidArgument;
@@ -52,9 +51,8 @@
}
catch (const sdbusplus::exception_t& ex)
{
- log<level::ERR>("Failed to restart service",
- entry("SERVICE=%s", service.c_str()),
- entry("ERR=%s", ex.what()));
+ lg2::error("Failed to restart service {SERVICE}: {ERR}", "SERVICE",
+ service, "ERR", ex);
elog<InternalFailure>();
}
}
@@ -69,9 +67,8 @@
}
catch (const sdbusplus::exception_t& ex)
{
- log<level::ERR>("Failed to stop service",
- entry("SERVICE=%s", service.c_str()),
- entry("ERR=%s", ex.what()));
+ lg2::error("Failed to stop service {SERVICE}: {ERR}", "SERVICE",
+ service, "ERR", ex);
elog<InternalFailure>();
}
}
@@ -94,31 +91,30 @@
}
else
{
- log<level::ERR>("bad LDAP Server URI",
- entry("LDAPSERVERURI=%s", ldapServerURI.c_str()));
+ lg2::error("Bad LDAP Server URI {URI}", "URI", ldapServerURI);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("ldapServerURI"),
Argument::ARGUMENT_VALUE(ldapServerURI.c_str()));
}
if (secureLDAP && !fs::exists(tlsCacertFile.c_str()))
{
- log<level::ERR>("LDAP server's CA certificate not provided",
- entry("TLSCACERTFILE=%s", tlsCacertFile.c_str()));
+ lg2::error("LDAP server CA certificate not found at {PATH}", "PATH",
+ tlsCacertFile);
elog<NoCACertificate>();
}
if (ldapBindDN.empty())
{
- log<level::ERR>("Not a valid LDAP BINDDN",
- entry("LDAPBINDDN=%s", ldapBindDN.c_str()));
+ lg2::error("'{BINDDN}' is not a valid LDAP BindDN", "BINDDN",
+ ldapBindDN);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("LDAPBindDN"),
Argument::ARGUMENT_VALUE(ldapBindDN.c_str()));
}
if (ldapBaseDN.empty())
{
- log<level::ERR>("Not a valid LDAP BASEDN",
- entry("LDAPBASEDN=%s", ldapBaseDN.c_str()));
+ lg2::error("'{BASEDN}' is not a valid LDAP BaseDN", "BASEDN",
+ ldapBaseDN);
elog<InvalidArgument>(Argument::ARGUMENT_NAME("LDAPBaseDN"),
Argument::ARGUMENT_VALUE(ldapBaseDN.c_str()));
}
diff --git a/phosphor-ldap-config/ldap_config_mgr.hpp b/phosphor-ldap-config/ldap_config_mgr.hpp
index 850fc54..3b48127 100644
--- a/phosphor-ldap-config/ldap_config_mgr.hpp
+++ b/phosphor-ldap-config/ldap_config_mgr.hpp
@@ -6,7 +6,7 @@
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <sdbusplus/bus.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
#include <xyz/openbmc_project/User/Ldap/Config/server.hpp>
diff --git a/phosphor-ldap-config/ldap_mapper_entry.cpp b/phosphor-ldap-config/ldap_mapper_entry.cpp
index af57e2d..f903c1f 100644
--- a/phosphor-ldap-config/ldap_mapper_entry.cpp
+++ b/phosphor-ldap-config/ldap_mapper_entry.cpp
@@ -7,7 +7,7 @@
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/elog.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
#include <xyz/openbmc_project/User/Common/error.hpp>
diff --git a/phosphor-ldap-config/ldap_mapper_serialize.cpp b/phosphor-ldap-config/ldap_mapper_serialize.cpp
index 66cea37..2842ba2 100644
--- a/phosphor-ldap-config/ldap_mapper_serialize.cpp
+++ b/phosphor-ldap-config/ldap_mapper_serialize.cpp
@@ -4,7 +4,7 @@
#include <cereal/archives/binary.hpp>
#include <cereal/types/string.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <fstream>
@@ -18,8 +18,6 @@
namespace ldap
{
-using namespace phosphor::logging;
-
/** @brief Function required by Cereal to perform serialization.
*
* @tparam Archive - Cereal archive type (binary in this case).
@@ -82,13 +80,15 @@
}
catch (const cereal::Exception& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Failed to deserialize {FILE}: {ERR}", "FILE", path, "ERR",
+ e);
fs::remove(path);
return false;
}
catch (const std::length_error& e)
{
- log<level::ERR>(e.what());
+ lg2::error("Failed to deserialize {FILE}: {ERR}", "FILE", path, "ERR",
+ e);
fs::remove(path);
return false;
}
diff --git a/phosphor-ldap-config/main.cpp b/phosphor-ldap-config/main.cpp
index e2bedaf..be97abd 100644
--- a/phosphor-ldap-config/main.cpp
+++ b/phosphor-ldap-config/main.cpp
@@ -3,7 +3,7 @@
#include "ldap_config_mgr.hpp"
#include <phosphor-logging/elog-errors.hpp>
-#include <phosphor-logging/log.hpp>
+#include <phosphor-logging/lg2.hpp>
#include <sdbusplus/bus.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
@@ -21,8 +21,8 @@
phosphor::ldap::defaultNslcdFile) ||
!std::filesystem::exists(configDir / phosphor::ldap::nsSwitchFile))
{
- log<level::ERR>("Error starting LDAP Config App, configfile(s) are "
- "missing, exiting!!!");
+ lg2::error("Failed to start phosphor-ldap-manager, configfile(s) are "
+ "missing");
elog<InternalFailure>();
}
auto bus = sdbusplus::bus::new_default();