xref: /openbmc/bmcweb/features/redfish/lib/metric_report.hpp (revision 456cd875f3c56b45605d8a017e91d810876a035c)
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>
7168e20c1SEd Tanous #include <dbus_utility.hpp>
8ed398213SEd Tanous #include <registries/privilege_registry.hpp>
91e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp>
107e860f15SJohn Edward Broadbent 
11081ebf06SWludzik, Jozef namespace redfish
12081ebf06SWludzik, Jozef {
13081ebf06SWludzik, Jozef 
14081ebf06SWludzik, Jozef namespace telemetry
15081ebf06SWludzik, Jozef {
16081ebf06SWludzik, Jozef 
17*456cd875SSzymon Dompke constexpr const char* metricReportUri =
18*456cd875SSzymon Dompke     "/redfish/v1/TelemetryService/MetricReports";
19*456cd875SSzymon Dompke 
20081ebf06SWludzik, Jozef using Readings =
21081ebf06SWludzik, Jozef     std::vector<std::tuple<std::string, std::string, double, uint64_t>>;
22081ebf06SWludzik, Jozef using TimestampReadings = std::tuple<uint64_t, Readings>;
23081ebf06SWludzik, Jozef 
24081ebf06SWludzik, Jozef inline nlohmann::json toMetricValues(const Readings& readings)
25081ebf06SWludzik, Jozef {
26081ebf06SWludzik, Jozef     nlohmann::json metricValues = nlohmann::json::array_t();
27081ebf06SWludzik, Jozef 
289eb808c1SEd Tanous     for (const auto& [id, metadata, sensorValue, timestamp] : readings)
29081ebf06SWludzik, Jozef     {
30081ebf06SWludzik, Jozef         metricValues.push_back({
31081ebf06SWludzik, Jozef             {"MetricId", id},
32081ebf06SWludzik, Jozef             {"MetricProperty", metadata},
33081ebf06SWludzik, Jozef             {"MetricValue", std::to_string(sensorValue)},
3445c367e0SKrzysztof Grobelny             {"Timestamp", crow::utility::getDateTimeUintMs(timestamp)},
35081ebf06SWludzik, Jozef         });
36081ebf06SWludzik, Jozef     }
37081ebf06SWludzik, Jozef 
38081ebf06SWludzik, Jozef     return metricValues;
39081ebf06SWludzik, Jozef }
40081ebf06SWludzik, Jozef 
41c0353249SWludzik, Jozef inline bool fillReport(nlohmann::json& json, const std::string& id,
421e1e598dSJonathan Doman                        const TimestampReadings& timestampReadings)
43081ebf06SWludzik, Jozef {
44c0353249SWludzik, Jozef     json["@odata.type"] = "#MetricReport.v1_3_0.MetricReport";
45*456cd875SSzymon Dompke     json["@odata.id"] =
46*456cd875SSzymon Dompke         crow::utility::urlFromPieces("redfish", "v1", "TelemetryService",
47*456cd875SSzymon Dompke                                      "MetricReports", id)
48*456cd875SSzymon Dompke             .string();
49c0353249SWludzik, Jozef     json["Id"] = id;
50c0353249SWludzik, Jozef     json["Name"] = id;
51c0353249SWludzik, Jozef     json["MetricReportDefinition"]["@odata.id"] =
52*456cd875SSzymon Dompke         crow::utility::urlFromPieces("redfish", "v1", "TelemetryService",
53*456cd875SSzymon Dompke                                      "MetricReportDefinitions", id)
54*456cd875SSzymon Dompke             .string();
55081ebf06SWludzik, Jozef 
561e1e598dSJonathan Doman     const auto& [timestamp, readings] = timestampReadings;
5745c367e0SKrzysztof Grobelny     json["Timestamp"] = crow::utility::getDateTimeUintMs(timestamp);
58c0353249SWludzik, Jozef     json["MetricValues"] = toMetricValues(readings);
59c0353249SWludzik, Jozef     return true;
60081ebf06SWludzik, Jozef }
61081ebf06SWludzik, Jozef } // namespace telemetry
62081ebf06SWludzik, Jozef 
637e860f15SJohn Edward Broadbent inline void requestRoutesMetricReportCollection(App& app)
64081ebf06SWludzik, Jozef {
657e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/MetricReports/")
66ed398213SEd Tanous         .privileges(redfish::privileges::getMetricReportCollection)
677e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
687e860f15SJohn Edward Broadbent             [](const crow::Request&,
697e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
708d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.type"] =
71081ebf06SWludzik, Jozef                     "#MetricReportCollection.MetricReportCollection";
728d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.id"] =
73*456cd875SSzymon Dompke                     telemetry::metricReportUri;
748d1b46d7Szhanghch05                 asyncResp->res.jsonValue["Name"] = "Metric Report Collection";
754028ff77SEd Tanous                 const std::vector<const char*> interfaces{
764028ff77SEd Tanous                     telemetry::reportInterface};
774028ff77SEd Tanous                 collection_util::getCollectionMembers(
784028ff77SEd Tanous                     asyncResp, telemetry::metricReportUri, interfaces,
794028ff77SEd Tanous                     "/xyz/openbmc_project/Telemetry/Reports/TelemetryService");
807e860f15SJohn Edward Broadbent             });
81081ebf06SWludzik, Jozef }
82081ebf06SWludzik, Jozef 
837e860f15SJohn Edward Broadbent inline void requestRoutesMetricReport(App& app)
84081ebf06SWludzik, Jozef {
857e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/MetricReports/<str>/")
86ed398213SEd Tanous         .privileges(redfish::privileges::getMetricReport)
877e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
887e860f15SJohn Edward Broadbent             [](const crow::Request&,
897e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
907e860f15SJohn Edward Broadbent                const std::string& id) {
91081ebf06SWludzik, Jozef                 const std::string reportPath = telemetry::getDbusReportPath(id);
92081ebf06SWludzik, Jozef                 crow::connections::systemBus->async_method_call(
937e860f15SJohn Edward Broadbent                     [asyncResp, id,
947e860f15SJohn Edward Broadbent                      reportPath](const boost::system::error_code& ec) {
95081ebf06SWludzik, Jozef                         if (ec.value() == EBADR ||
96081ebf06SWludzik, Jozef                             ec == boost::system::errc::host_unreachable)
97081ebf06SWludzik, Jozef                         {
987e860f15SJohn Edward Broadbent                             messages::resourceNotFound(asyncResp->res,
997e860f15SJohn Edward Broadbent                                                        "MetricReport", id);
100081ebf06SWludzik, Jozef                             return;
101081ebf06SWludzik, Jozef                         }
102081ebf06SWludzik, Jozef                         if (ec)
103081ebf06SWludzik, Jozef                         {
104081ebf06SWludzik, Jozef                             BMCWEB_LOG_ERROR << "respHandler DBus error " << ec;
105081ebf06SWludzik, Jozef                             messages::internalError(asyncResp->res);
106081ebf06SWludzik, Jozef                             return;
107081ebf06SWludzik, Jozef                         }
108081ebf06SWludzik, Jozef 
1091e1e598dSJonathan Doman                         sdbusplus::asio::getProperty<
1101e1e598dSJonathan Doman                             telemetry::TimestampReadings>(
1111e1e598dSJonathan Doman                             *crow::connections::systemBus, telemetry::service,
1121e1e598dSJonathan Doman                             reportPath, telemetry::reportInterface, "Readings",
1137e860f15SJohn Edward Broadbent                             [asyncResp,
1147e860f15SJohn Edward Broadbent                              id](const boost::system::error_code ec,
1151e1e598dSJonathan Doman                                  const telemetry::TimestampReadings& ret) {
116081ebf06SWludzik, Jozef                                 if (ec)
117081ebf06SWludzik, Jozef                                 {
1187e860f15SJohn Edward Broadbent                                     BMCWEB_LOG_ERROR
1197e860f15SJohn Edward Broadbent                                         << "respHandler DBus error " << ec;
120081ebf06SWludzik, Jozef                                     messages::internalError(asyncResp->res);
121081ebf06SWludzik, Jozef                                     return;
122081ebf06SWludzik, Jozef                                 }
123081ebf06SWludzik, Jozef 
1241e1e598dSJonathan Doman                                 telemetry::fillReport(asyncResp->res.jsonValue,
1251e1e598dSJonathan Doman                                                       id, ret);
1261e1e598dSJonathan Doman                             });
127081ebf06SWludzik, Jozef                     },
128081ebf06SWludzik, Jozef                     telemetry::service, reportPath, telemetry::reportInterface,
129081ebf06SWludzik, Jozef                     "Update");
1307e860f15SJohn Edward Broadbent             });
131081ebf06SWludzik, Jozef }
132081ebf06SWludzik, Jozef } // namespace redfish
133