xref: /openbmc/bmcweb/features/redfish/lib/metric_report.hpp (revision 168e20c1306e3e689907ba43e14ea679e2328611)
1081ebf06SWludzik, Jozef #pragma once
2081ebf06SWludzik, Jozef 
34028ff77SEd Tanous #include "utils/collection.hpp"
4081ebf06SWludzik, Jozef #include "utils/telemetry_utils.hpp"
5081ebf06SWludzik, Jozef 
67e860f15SJohn Edward Broadbent #include <app.hpp>
7*168e20c1SEd Tanous #include <dbus_utility.hpp>
8ed398213SEd Tanous #include <registries/privilege_registry.hpp>
97e860f15SJohn Edward Broadbent 
10081ebf06SWludzik, Jozef namespace redfish
11081ebf06SWludzik, Jozef {
12081ebf06SWludzik, Jozef 
13081ebf06SWludzik, Jozef namespace telemetry
14081ebf06SWludzik, Jozef {
15081ebf06SWludzik, Jozef 
16081ebf06SWludzik, Jozef using Readings =
17081ebf06SWludzik, Jozef     std::vector<std::tuple<std::string, std::string, double, uint64_t>>;
18081ebf06SWludzik, Jozef using TimestampReadings = std::tuple<uint64_t, Readings>;
19081ebf06SWludzik, Jozef 
20081ebf06SWludzik, Jozef inline nlohmann::json toMetricValues(const Readings& readings)
21081ebf06SWludzik, Jozef {
22081ebf06SWludzik, Jozef     nlohmann::json metricValues = nlohmann::json::array_t();
23081ebf06SWludzik, Jozef 
24081ebf06SWludzik, Jozef     for (auto& [id, metadata, sensorValue, timestamp] : readings)
25081ebf06SWludzik, Jozef     {
26081ebf06SWludzik, Jozef         metricValues.push_back({
27081ebf06SWludzik, Jozef             {"MetricId", id},
28081ebf06SWludzik, Jozef             {"MetricProperty", metadata},
29081ebf06SWludzik, Jozef             {"MetricValue", std::to_string(sensorValue)},
301d8782e7SNan Zhou             {"Timestamp", crow::utility::getDateTimeUint(timestamp)},
31081ebf06SWludzik, Jozef         });
32081ebf06SWludzik, Jozef     }
33081ebf06SWludzik, Jozef 
34081ebf06SWludzik, Jozef     return metricValues;
35081ebf06SWludzik, Jozef }
36081ebf06SWludzik, Jozef 
37c0353249SWludzik, Jozef inline bool fillReport(nlohmann::json& json, const std::string& id,
38*168e20c1SEd Tanous                        const dbus::utility::DbusVariantType& var)
39081ebf06SWludzik, Jozef {
40c0353249SWludzik, Jozef     json["@odata.type"] = "#MetricReport.v1_3_0.MetricReport";
41c0353249SWludzik, Jozef     json["@odata.id"] = telemetry::metricReportUri + std::string("/") + id;
42c0353249SWludzik, Jozef     json["Id"] = id;
43c0353249SWludzik, Jozef     json["Name"] = id;
44c0353249SWludzik, Jozef     json["MetricReportDefinition"]["@odata.id"] =
454028ff77SEd Tanous         telemetry::metricReportDefinitionUri + std::string("/") + id;
46081ebf06SWludzik, Jozef 
47081ebf06SWludzik, Jozef     const TimestampReadings* timestampReadings =
48081ebf06SWludzik, Jozef         std::get_if<TimestampReadings>(&var);
49081ebf06SWludzik, Jozef     if (!timestampReadings)
50081ebf06SWludzik, Jozef     {
51081ebf06SWludzik, Jozef         BMCWEB_LOG_ERROR << "Property type mismatch or property is missing";
52c0353249SWludzik, Jozef         return false;
53081ebf06SWludzik, Jozef     }
54081ebf06SWludzik, Jozef 
55081ebf06SWludzik, Jozef     const auto& [timestamp, readings] = *timestampReadings;
561d8782e7SNan Zhou     json["Timestamp"] = crow::utility::getDateTimeUint(timestamp);
57c0353249SWludzik, Jozef     json["MetricValues"] = toMetricValues(readings);
58c0353249SWludzik, Jozef     return true;
59081ebf06SWludzik, Jozef }
60081ebf06SWludzik, Jozef } // namespace telemetry
61081ebf06SWludzik, Jozef 
627e860f15SJohn Edward Broadbent inline void requestRoutesMetricReportCollection(App& app)
63081ebf06SWludzik, Jozef {
647e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/MetricReports/")
65ed398213SEd Tanous         .privileges(redfish::privileges::getMetricReportCollection)
667e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
677e860f15SJohn Edward Broadbent             [](const crow::Request&,
687e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
698d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.type"] =
70081ebf06SWludzik, Jozef                     "#MetricReportCollection.MetricReportCollection";
718d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.id"] =
72081ebf06SWludzik, Jozef                     "/redfish/v1/TelemetryService/MetricReports";
738d1b46d7Szhanghch05                 asyncResp->res.jsonValue["Name"] = "Metric Report Collection";
744028ff77SEd Tanous                 const std::vector<const char*> interfaces{
754028ff77SEd Tanous                     telemetry::reportInterface};
764028ff77SEd Tanous                 collection_util::getCollectionMembers(
774028ff77SEd Tanous                     asyncResp, telemetry::metricReportUri, interfaces,
784028ff77SEd Tanous                     "/xyz/openbmc_project/Telemetry/Reports/TelemetryService");
797e860f15SJohn Edward Broadbent             });
80081ebf06SWludzik, Jozef }
81081ebf06SWludzik, Jozef 
827e860f15SJohn Edward Broadbent inline void requestRoutesMetricReport(App& app)
83081ebf06SWludzik, Jozef {
847e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/MetricReports/<str>/")
85ed398213SEd Tanous         .privileges(redfish::privileges::getMetricReport)
867e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
877e860f15SJohn Edward Broadbent             [](const crow::Request&,
887e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
897e860f15SJohn Edward Broadbent                const std::string& id) {
90081ebf06SWludzik, Jozef                 const std::string reportPath = telemetry::getDbusReportPath(id);
91081ebf06SWludzik, Jozef                 crow::connections::systemBus->async_method_call(
927e860f15SJohn Edward Broadbent                     [asyncResp, id,
937e860f15SJohn Edward Broadbent                      reportPath](const boost::system::error_code& ec) {
94081ebf06SWludzik, Jozef                         if (ec.value() == EBADR ||
95081ebf06SWludzik, Jozef                             ec == boost::system::errc::host_unreachable)
96081ebf06SWludzik, Jozef                         {
977e860f15SJohn Edward Broadbent                             messages::resourceNotFound(asyncResp->res,
987e860f15SJohn Edward Broadbent                                                        "MetricReport", id);
99081ebf06SWludzik, Jozef                             return;
100081ebf06SWludzik, Jozef                         }
101081ebf06SWludzik, Jozef                         if (ec)
102081ebf06SWludzik, Jozef                         {
103081ebf06SWludzik, Jozef                             BMCWEB_LOG_ERROR << "respHandler DBus error " << ec;
104081ebf06SWludzik, Jozef                             messages::internalError(asyncResp->res);
105081ebf06SWludzik, Jozef                             return;
106081ebf06SWludzik, Jozef                         }
107081ebf06SWludzik, Jozef 
108081ebf06SWludzik, Jozef                         crow::connections::systemBus->async_method_call(
1097e860f15SJohn Edward Broadbent                             [asyncResp,
1107e860f15SJohn Edward Broadbent                              id](const boost::system::error_code ec,
111*168e20c1SEd Tanous                                  const dbus::utility::DbusVariantType& ret) {
112081ebf06SWludzik, Jozef                                 if (ec)
113081ebf06SWludzik, Jozef                                 {
1147e860f15SJohn Edward Broadbent                                     BMCWEB_LOG_ERROR
1157e860f15SJohn Edward Broadbent                                         << "respHandler DBus error " << ec;
116081ebf06SWludzik, Jozef                                     messages::internalError(asyncResp->res);
117081ebf06SWludzik, Jozef                                     return;
118081ebf06SWludzik, Jozef                                 }
119081ebf06SWludzik, Jozef 
120c0353249SWludzik, Jozef                                 if (!telemetry::fillReport(
121c0353249SWludzik, Jozef                                         asyncResp->res.jsonValue, id, ret))
122c0353249SWludzik, Jozef                                 {
123c0353249SWludzik, Jozef                                     messages::internalError(asyncResp->res);
124c0353249SWludzik, Jozef                                 }
125081ebf06SWludzik, Jozef                             },
126081ebf06SWludzik, Jozef                             telemetry::service, reportPath,
127081ebf06SWludzik, Jozef                             "org.freedesktop.DBus.Properties", "Get",
128081ebf06SWludzik, Jozef                             telemetry::reportInterface, "Readings");
129081ebf06SWludzik, Jozef                     },
130081ebf06SWludzik, Jozef                     telemetry::service, reportPath, telemetry::reportInterface,
131081ebf06SWludzik, Jozef                     "Update");
1327e860f15SJohn Edward Broadbent             });
133081ebf06SWludzik, Jozef }
134081ebf06SWludzik, Jozef } // namespace redfish
135