diff options
author | Wludzik, Jozef <jozef.wludzik@intel.com> | 2020-04-27 18:24:15 +0300 |
---|---|---|
committer | Ed Tanous <ed@tanous.net> | 2021-02-09 20:14:30 +0300 |
commit | 081ebf06b4c947e828408029273699ff2d49a54f (patch) | |
tree | 73a97ed2c6ad1dff843ac860c07e44bf0e90b087 /redfish-core/lib/metric_report_definition.hpp | |
parent | eaa96da3f862bf814ac7147a8a87fd3eaa97731b (diff) | |
download | bmcweb-081ebf06b4c947e828408029273699ff2d49a54f.tar.xz |
Redfish TelemetryService schema implementation
Now user is able to communicate with Telemetry service using Redfish.
Added TelemetryService, MetricReports, MetricReportCollection,
MetricReportDefinition and MetricReportDefinitionCollection nodes
with GET method support. Added TelemetryService URI to root service.
Implemented communication with backend - Telemetry:
https://github.com/openbmc/telemetry
Added schemes attributes that are supported by Telemetry service
design, ref.:
https://github.com/openbmc/docs/blob/master/designs/telemetry.md
Change introduces function that converts decimal value into
duration format that is described by ISO 8601 and Redfish
specification.
Tested:
- Tested using romulus and s2600wf images on QEMU
- Verified DBus method calls to Telemetry service from bmcweb
- Verified bmcweb responses from new nodes in different cases:
- Report collection is empty
- Report collection is filled with artificial data
- Telemetry service is disabled
- Verified time_utils::toDurationString() output
- Passed RedfishServiceValidator.py
Signed-off-by: Wludzik, Jozef <jozef.wludzik@intel.com>
Signed-off-by: Adrian Ambrożewicz <adrian.ambrozewicz@linux.intel.com>
Signed-off-by: Krzysztof Grobelny <krzysztof.grobelny@intel.com>
Change-Id: Ie6b0b49f4ef5eeaef07d1209b6c349270c04d570
Diffstat (limited to 'redfish-core/lib/metric_report_definition.hpp')
-rw-r--r-- | redfish-core/lib/metric_report_definition.hpp | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/redfish-core/lib/metric_report_definition.hpp b/redfish-core/lib/metric_report_definition.hpp new file mode 100644 index 0000000000..59025d9e26 --- /dev/null +++ b/redfish-core/lib/metric_report_definition.hpp @@ -0,0 +1,188 @@ +#pragma once + +#include "node.hpp" +#include "utils/telemetry_utils.hpp" +#include "utils/time_utils.hpp" + +#include <tuple> +#include <variant> + +namespace redfish +{ + +namespace telemetry +{ + +using ReadingParameters = + std::vector<std::tuple<sdbusplus::message::object_path, std::string, + std::string, std::string>>; + +inline void fillReportDefinition( + const std::shared_ptr<AsyncResp>& asyncResp, const std::string& id, + const std::vector< + std::pair<std::string, std::variant<std::string, bool, uint64_t, + ReadingParameters>>>& ret) +{ + asyncResp->res.jsonValue["@odata.type"] = + "#MetricReportDefinition.v1_3_0.MetricReportDefinition"; + asyncResp->res.jsonValue["@odata.id"] = + telemetry::metricReportDefinitionUri + id; + asyncResp->res.jsonValue["Id"] = id; + asyncResp->res.jsonValue["Name"] = id; + asyncResp->res.jsonValue["MetricReport"]["@odata.id"] = + telemetry::metricReportUri + id; + asyncResp->res.jsonValue["Status"]["State"] = "Enabled"; + asyncResp->res.jsonValue["ReportUpdates"] = "Overwrite"; + + const bool* emitsReadingsUpdate = nullptr; + const bool* logToMetricReportsCollection = nullptr; + const ReadingParameters* readingParams = nullptr; + const std::string* reportingType = nullptr; + const uint64_t* interval = nullptr; + for (const auto& [key, var] : ret) + { + if (key == "EmitsReadingsUpdate") + { + emitsReadingsUpdate = std::get_if<bool>(&var); + } + else if (key == "LogToMetricReportsCollection") + { + logToMetricReportsCollection = std::get_if<bool>(&var); + } + else if (key == "ReadingParameters") + { + readingParams = std::get_if<ReadingParameters>(&var); + } + else if (key == "ReportingType") + { + reportingType = std::get_if<std::string>(&var); + } + else if (key == "Interval") + { + interval = std::get_if<uint64_t>(&var); + } + } + if (!emitsReadingsUpdate || !logToMetricReportsCollection || + !readingParams || !reportingType || !interval) + { + BMCWEB_LOG_ERROR << "Property type mismatch or property is missing"; + messages::internalError(asyncResp->res); + return; + } + + std::vector<std::string> redfishReportActions; + redfishReportActions.reserve(2); + if (*emitsReadingsUpdate) + { + redfishReportActions.emplace_back("RedfishEvent"); + } + if (*logToMetricReportsCollection) + { + redfishReportActions.emplace_back("LogToMetricReportsCollection"); + } + + nlohmann::json metrics = nlohmann::json::array(); + for (auto& [sensorPath, operationType, id, metadata] : *readingParams) + { + metrics.push_back({ + {"MetricId", id}, + {"MetricProperties", {metadata}}, + }); + } + asyncResp->res.jsonValue["Metrics"] = metrics; + asyncResp->res.jsonValue["MetricReportDefinitionType"] = *reportingType; + asyncResp->res.jsonValue["ReportActions"] = redfishReportActions; + asyncResp->res.jsonValue["Schedule"]["RecurrenceInterval"] = + time_utils::toDurationString(std::chrono::milliseconds(*interval)); +} +} // namespace telemetry + +class MetricReportDefinitionCollection : public Node +{ + public: + MetricReportDefinitionCollection(App& app) : + Node(app, "/redfish/v1/TelemetryService/MetricReportDefinitions/") + { + entityPrivileges = { + {boost::beast::http::verb::get, {{"Login"}}}, + {boost::beast::http::verb::head, {{"Login"}}}, + {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, + {boost::beast::http::verb::put, {{"ConfigureManager"}}}, + {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, + {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; + } + + private: + void doGet(crow::Response& res, const crow::Request&, + const std::vector<std::string>&) override + { + res.jsonValue["@odata.type"] = "#MetricReportDefinitionCollection." + "MetricReportDefinitionCollection"; + res.jsonValue["@odata.id"] = + "/redfish/v1/TelemetryService/MetricReportDefinitions"; + res.jsonValue["Name"] = "Metric Definition Collection"; + + auto asyncResp = std::make_shared<AsyncResp>(res); + telemetry::getReportCollection(asyncResp, + telemetry::metricReportDefinitionUri); + } +}; + +class MetricReportDefinition : public Node +{ + public: + MetricReportDefinition(App& app) : + Node(app, "/redfish/v1/TelemetryService/MetricReportDefinitions/<str>/", + std::string()) + { + entityPrivileges = { + {boost::beast::http::verb::get, {{"Login"}}}, + {boost::beast::http::verb::head, {{"Login"}}}, + {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, + {boost::beast::http::verb::put, {{"ConfigureManager"}}}, + {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, + {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; + } + + private: + void doGet(crow::Response& res, const crow::Request&, + const std::vector<std::string>& params) override + { + auto asyncResp = std::make_shared<AsyncResp>(res); + + if (params.size() != 1) + { + messages::internalError(asyncResp->res); + return; + } + + const std::string& id = params[0]; + crow::connections::systemBus->async_method_call( + [asyncResp, + id](const boost::system::error_code ec, + const std::vector<std::pair< + std::string, std::variant<std::string, bool, uint64_t, + telemetry::ReadingParameters>>>& + ret) { + if (ec.value() == EBADR || + ec == boost::system::errc::host_unreachable) + { + messages::resourceNotFound(asyncResp->res, + "MetricReportDefinition", id); + return; + } + if (ec) + { + BMCWEB_LOG_ERROR << "respHandler DBus error " << ec; + messages::internalError(asyncResp->res); + return; + } + + telemetry::fillReportDefinition(asyncResp, id, ret); + }, + telemetry::service, telemetry::getDbusReportPath(id), + "org.freedesktop.DBus.Properties", "GetAll", + telemetry::reportInterface); + } +}; +} // namespace redfish |