log_services: Add AdditionalDataURI to log entries
The File Path property was added to the DBus Event Log Entries with
https://github.com/openbmc/phosphor-logging/commit/1ff95efecaf24bf296b291ed85798b6e22189d0f
The Path was added to indicate the path to the Entry file and that the
file could be offloaded out of the BMC. Check if the Path property
exists, and if so add an AdditionalDataURI field to the EventLog
redfish output and populate it with string
"LogServices/EventLog/attachment/id" in the same fashion as
the dump URI entry. An implementation of GET on that path is done in a
subsequent commit.
The new Path property is located under the
xyz.openbmc_project.Common.FilePath interface. The rest of the current
properties are under the xyz.openbmc_project.Logging.Entry interface.
In order to read the Path property for an individual entry
(endpoint Entries/<str>/), need to remove the Entry interface from the
GetAll call so that all properties from all interfaces are returned.
In order to get the Path property when querying all entries
(endpoint Entries/), need to query the properties under the Entry and
FilePath interface, then build the json response for that entry.
Tested:
- Ran Redfish validator
- Verified the new AdditionalDataURI was correct for both
LogServices/EventLog/Entries and LogServices/EventLog/Entries/<str>:
$ curl -k -H "X-Auth-Token: $token" \
https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries/7
{
"@odata.id":
"/redfish/v1/Systems/system/LogServices/EventLog/Entries/7",
"@odata.type": "#LogEntry.v1_8_0.LogEntry",
"AdditionalDataURI":
"/redfish/v1/Systems/system/LogServices/EventLog/attachment/7",
- Verified that AdditionalDataURI is not added if the Path property
doesn't exist.
Change-Id: Ib82361bae19a99e74d53f4ab5c4b446d277f0937
Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
diff --git a/redfish-core/lib/log_services.hpp b/redfish-core/lib/log_services.hpp
index 47d61c0..1d076a3 100644
--- a/redfish-core/lib/log_services.hpp
+++ b/redfish-core/lib/log_services.hpp
@@ -1396,95 +1396,120 @@
entriesArray = nlohmann::json::array();
for (auto& objectPath : resp)
{
+ uint32_t* id = nullptr;
+ std::time_t timestamp{};
+ std::time_t updateTimestamp{};
+ std::string* severity = nullptr;
+ std::string* message = nullptr;
+ std::string* filePath = nullptr;
+ bool resolved = false;
for (auto& interfaceMap : objectPath.second)
{
- if (interfaceMap.first !=
+ if (interfaceMap.first ==
"xyz.openbmc_project.Logging.Entry")
{
- BMCWEB_LOG_DEBUG << "Bailing early on "
- << interfaceMap.first;
- continue;
- }
- entriesArray.push_back({});
- nlohmann::json& thisEntry = entriesArray.back();
- uint32_t* id = nullptr;
- std::time_t timestamp{};
- std::time_t updateTimestamp{};
- std::string* severity = nullptr;
- std::string* message = nullptr;
- bool resolved = false;
-
- for (auto& propertyMap : interfaceMap.second)
- {
- if (propertyMap.first == "Id")
+ for (auto& propertyMap : interfaceMap.second)
{
- id = std::get_if<uint32_t>(&propertyMap.second);
- }
- else if (propertyMap.first == "Timestamp")
- {
- const uint64_t* millisTimeStamp =
- std::get_if<uint64_t>(&propertyMap.second);
- if (millisTimeStamp != nullptr)
+ if (propertyMap.first == "Id")
{
- timestamp = crow::utility::getTimestamp(
- *millisTimeStamp);
+ id = std::get_if<uint32_t>(
+ &propertyMap.second);
}
- }
- else if (propertyMap.first == "UpdateTimestamp")
- {
- const uint64_t* millisTimeStamp =
- std::get_if<uint64_t>(&propertyMap.second);
- if (millisTimeStamp != nullptr)
+ else if (propertyMap.first == "Timestamp")
{
- updateTimestamp =
- crow::utility::getTimestamp(
+ const uint64_t* millisTimeStamp =
+ std::get_if<uint64_t>(
+ &propertyMap.second);
+ if (millisTimeStamp != nullptr)
+ {
+ timestamp = crow::utility::getTimestamp(
*millisTimeStamp);
+ }
}
- }
- else if (propertyMap.first == "Severity")
- {
- severity = std::get_if<std::string>(
- &propertyMap.second);
- }
- else if (propertyMap.first == "Message")
- {
- message = std::get_if<std::string>(
- &propertyMap.second);
- }
- else if (propertyMap.first == "Resolved")
- {
- bool* resolveptr =
- std::get_if<bool>(&propertyMap.second);
- if (resolveptr == nullptr)
+ else if (propertyMap.first == "UpdateTimestamp")
{
- messages::internalError(asyncResp->res);
- return;
+ const uint64_t* millisTimeStamp =
+ std::get_if<uint64_t>(
+ &propertyMap.second);
+ if (millisTimeStamp != nullptr)
+ {
+ updateTimestamp =
+ crow::utility::getTimestamp(
+ *millisTimeStamp);
+ }
}
- resolved = *resolveptr;
+ else if (propertyMap.first == "Severity")
+ {
+ severity = std::get_if<std::string>(
+ &propertyMap.second);
+ }
+ else if (propertyMap.first == "Message")
+ {
+ message = std::get_if<std::string>(
+ &propertyMap.second);
+ }
+ else if (propertyMap.first == "Resolved")
+ {
+ bool* resolveptr =
+ std::get_if<bool>(&propertyMap.second);
+ if (resolveptr == nullptr)
+ {
+ messages::internalError(asyncResp->res);
+ return;
+ }
+ resolved = *resolveptr;
+ }
+ }
+ if (id == nullptr || message == nullptr ||
+ severity == nullptr)
+ {
+ messages::internalError(asyncResp->res);
+ return;
}
}
- if (id == nullptr || message == nullptr ||
- severity == nullptr)
+ else if (interfaceMap.first ==
+ "xyz.openbmc_project.Common.FilePath")
{
- messages::internalError(asyncResp->res);
- return;
+ for (auto& propertyMap : interfaceMap.second)
+ {
+ if (propertyMap.first == "Path")
+ {
+ filePath = std::get_if<std::string>(
+ &propertyMap.second);
+ }
+ }
}
- thisEntry = {
- {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
- {"@odata.id",
- "/redfish/v1/Systems/system/LogServices/EventLog/"
- "Entries/" +
- std::to_string(*id)},
- {"Name", "System Event Log Entry"},
- {"Id", std::to_string(*id)},
- {"Message", *message},
- {"Resolved", resolved},
- {"EntryType", "Event"},
- {"Severity",
- translateSeverityDbusToRedfish(*severity)},
- {"Created", crow::utility::getDateTime(timestamp)},
- {"Modified",
- crow::utility::getDateTime(updateTimestamp)}};
+ }
+ // Object path without the xyz.openbmc_project.Logging.Entry
+ // interface, ignore and continue.
+ if (id == nullptr || message == nullptr ||
+ severity == nullptr)
+ {
+ continue;
+ }
+ entriesArray.push_back({});
+ nlohmann::json& thisEntry = entriesArray.back();
+ thisEntry["@odata.type"] = "#LogEntry.v1_8_0.LogEntry";
+ thisEntry["@odata.id"] = "/redfish/v1/Systems/system/"
+ "LogServices/EventLog/Entries/" +
+ std::to_string(*id);
+ thisEntry["Name"] = "System Event Log Entry";
+ thisEntry["Id"] = std::to_string(*id);
+ thisEntry["Message"] = *message;
+ thisEntry["Resolved"] = resolved;
+ thisEntry["EntryType"] = "Event";
+ thisEntry["Severity"] =
+ translateSeverityDbusToRedfish(*severity);
+ thisEntry["Created"] =
+ crow::utility::getDateTime(timestamp);
+ thisEntry["Modified"] =
+ crow::utility::getDateTime(updateTimestamp);
+ if (filePath != nullptr)
+ {
+ thisEntry["AdditionalDataURI"] =
+ "/redfish/v1/Systems/system/LogServices/EventLog/"
+ "attachment/" +
+ std::to_string(*id);
}
}
std::sort(entriesArray.begin(), entriesArray.end(),
@@ -1553,6 +1578,7 @@
std::time_t updateTimestamp{};
std::string* severity = nullptr;
std::string* message = nullptr;
+ std::string* filePath = nullptr;
bool resolved = false;
for (auto& propertyMap : resp)
@@ -1601,31 +1627,44 @@
}
resolved = *resolveptr;
}
+ else if (propertyMap.first == "Path")
+ {
+ filePath =
+ std::get_if<std::string>(&propertyMap.second);
+ }
}
if (id == nullptr || message == nullptr || severity == nullptr)
{
messages::internalError(asyncResp->res);
return;
}
- asyncResp->res.jsonValue = {
- {"@odata.type", "#LogEntry.v1_8_0.LogEntry"},
- {"@odata.id",
- "/redfish/v1/Systems/system/LogServices/EventLog/"
- "Entries/" +
- std::to_string(*id)},
- {"Name", "System Event Log Entry"},
- {"Id", std::to_string(*id)},
- {"Message", *message},
- {"Resolved", resolved},
- {"EntryType", "Event"},
- {"Severity", translateSeverityDbusToRedfish(*severity)},
- {"Created", crow::utility::getDateTime(timestamp)},
- {"Modified", crow::utility::getDateTime(updateTimestamp)}};
+ asyncResp->res.jsonValue["@odata.type"] =
+ "#LogEntry.v1_8_0.LogEntry";
+ asyncResp->res.jsonValue["@odata.id"] =
+ "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
+ std::to_string(*id);
+ asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
+ asyncResp->res.jsonValue["Id"] = std::to_string(*id);
+ asyncResp->res.jsonValue["Message"] = *message;
+ asyncResp->res.jsonValue["Resolved"] = resolved;
+ asyncResp->res.jsonValue["EntryType"] = "Event";
+ asyncResp->res.jsonValue["Severity"] =
+ translateSeverityDbusToRedfish(*severity);
+ asyncResp->res.jsonValue["Created"] =
+ crow::utility::getDateTime(timestamp);
+ asyncResp->res.jsonValue["Modified"] =
+ crow::utility::getDateTime(updateTimestamp);
+ if (filePath != nullptr)
+ {
+ asyncResp->res.jsonValue["AdditionalDataURI"] =
+ "/redfish/v1/Systems/system/LogServices/EventLog/"
+ "attachment/" +
+ std::to_string(*id);
+ }
},
"xyz.openbmc_project.Logging",
"/xyz/openbmc_project/logging/entry/" + entryID,
- "org.freedesktop.DBus.Properties", "GetAll",
- "xyz.openbmc_project.Logging.Entry");
+ "org.freedesktop.DBus.Properties", "GetAll", "");
}
void doPatch(crow::Response& res, const crow::Request& req,