xref: /openbmc/bmcweb/features/redfish/lib/metric_report.hpp (revision c035324925c9c09855e0717ef7af5caae3c296ff)
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>
7ed398213SEd Tanous #include <registries/privilege_registry.hpp>
87e860f15SJohn Edward Broadbent 
9081ebf06SWludzik, Jozef namespace redfish
10081ebf06SWludzik, Jozef {
11081ebf06SWludzik, Jozef 
12081ebf06SWludzik, Jozef namespace telemetry
13081ebf06SWludzik, Jozef {
14081ebf06SWludzik, Jozef 
15081ebf06SWludzik, Jozef using Readings =
16081ebf06SWludzik, Jozef     std::vector<std::tuple<std::string, std::string, double, uint64_t>>;
17081ebf06SWludzik, Jozef using TimestampReadings = std::tuple<uint64_t, Readings>;
18081ebf06SWludzik, Jozef 
19081ebf06SWludzik, Jozef inline nlohmann::json toMetricValues(const Readings& readings)
20081ebf06SWludzik, Jozef {
21081ebf06SWludzik, Jozef     nlohmann::json metricValues = nlohmann::json::array_t();
22081ebf06SWludzik, Jozef 
23081ebf06SWludzik, Jozef     for (auto& [id, metadata, sensorValue, timestamp] : readings)
24081ebf06SWludzik, Jozef     {
25081ebf06SWludzik, Jozef         metricValues.push_back({
26081ebf06SWludzik, Jozef             {"MetricId", id},
27081ebf06SWludzik, Jozef             {"MetricProperty", metadata},
28081ebf06SWludzik, Jozef             {"MetricValue", std::to_string(sensorValue)},
29081ebf06SWludzik, Jozef             {"Timestamp",
30081ebf06SWludzik, Jozef              crow::utility::getDateTime(static_cast<time_t>(timestamp))},
31081ebf06SWludzik, Jozef         });
32081ebf06SWludzik, Jozef     }
33081ebf06SWludzik, Jozef 
34081ebf06SWludzik, Jozef     return metricValues;
35081ebf06SWludzik, Jozef }
36081ebf06SWludzik, Jozef 
37*c0353249SWludzik, Jozef inline bool fillReport(nlohmann::json& json, const std::string& id,
38081ebf06SWludzik, Jozef                        const std::variant<TimestampReadings>& var)
39081ebf06SWludzik, Jozef {
40*c0353249SWludzik, Jozef     json["@odata.type"] = "#MetricReport.v1_3_0.MetricReport";
41*c0353249SWludzik, Jozef     json["@odata.id"] = telemetry::metricReportUri + std::string("/") + id;
42*c0353249SWludzik, Jozef     json["Id"] = id;
43*c0353249SWludzik, Jozef     json["Name"] = id;
44*c0353249SWludzik, 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";
52*c0353249SWludzik, Jozef         return false;
53081ebf06SWludzik, Jozef     }
54081ebf06SWludzik, Jozef 
55081ebf06SWludzik, Jozef     const auto& [timestamp, readings] = *timestampReadings;
56*c0353249SWludzik, Jozef     json["Timestamp"] =
57081ebf06SWludzik, Jozef         crow::utility::getDateTime(static_cast<time_t>(timestamp));
58*c0353249SWludzik, Jozef     json["MetricValues"] = toMetricValues(readings);
59*c0353249SWludzik, 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"] =
73081ebf06SWludzik, Jozef                     "/redfish/v1/TelemetryService/MetricReports";
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 
109081ebf06SWludzik, Jozef                         crow::connections::systemBus->async_method_call(
1107e860f15SJohn Edward Broadbent                             [asyncResp,
1117e860f15SJohn Edward Broadbent                              id](const boost::system::error_code ec,
1127e860f15SJohn Edward Broadbent                                  const std::variant<
1137e860f15SJohn Edward Broadbent                                      telemetry::TimestampReadings>& ret) {
114081ebf06SWludzik, Jozef                                 if (ec)
115081ebf06SWludzik, Jozef                                 {
1167e860f15SJohn Edward Broadbent                                     BMCWEB_LOG_ERROR
1177e860f15SJohn Edward Broadbent                                         << "respHandler DBus error " << ec;
118081ebf06SWludzik, Jozef                                     messages::internalError(asyncResp->res);
119081ebf06SWludzik, Jozef                                     return;
120081ebf06SWludzik, Jozef                                 }
121081ebf06SWludzik, Jozef 
122*c0353249SWludzik, Jozef                                 if (!telemetry::fillReport(
123*c0353249SWludzik, Jozef                                         asyncResp->res.jsonValue, id, ret))
124*c0353249SWludzik, Jozef                                 {
125*c0353249SWludzik, Jozef                                     messages::internalError(asyncResp->res);
126*c0353249SWludzik, Jozef                                 }
127081ebf06SWludzik, Jozef                             },
128081ebf06SWludzik, Jozef                             telemetry::service, reportPath,
129081ebf06SWludzik, Jozef                             "org.freedesktop.DBus.Properties", "Get",
130081ebf06SWludzik, Jozef                             telemetry::reportInterface, "Readings");
131081ebf06SWludzik, Jozef                     },
132081ebf06SWludzik, Jozef                     telemetry::service, reportPath, telemetry::reportInterface,
133081ebf06SWludzik, Jozef                     "Update");
1347e860f15SJohn Edward Broadbent             });
135081ebf06SWludzik, Jozef }
136081ebf06SWludzik, Jozef } // namespace redfish
137