1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
From 8ba1bcc3503cafb33b1a06356d4f8f92ae23e39a Mon Sep 17 00:00:00 2001
From: Krzysztof Grobelny <krzysztof.grobelny@intel.com>
Date: Thu, 17 Jun 2021 13:37:57 +0000
Subject: [PATCH] Switched bmcweb to use new telemetry service API
Added support for multiple MetricProperties. Added support for new
parameters: CollectionTimeScope, CollectionDuration.
Tested:
- It is possible to create MetricReportDefinitions with multiple
MetricProperties.
- Stub values for new parameters are correctly passed to telemetry
service.
- All existing telemetry service functionalities remain unchanged.
Change-Id: I2cd17069e3ea015c8f5571c29278f1d50536272a
Signed-off-by: Krzysztof Grobelny <krzysztof.grobelny@intel.com>
---
redfish-core/lib/metric_report_definition.hpp | 212 ++++++++++--------
1 file changed, 114 insertions(+), 98 deletions(-)
diff --git a/redfish-core/lib/metric_report_definition.hpp b/redfish-core/lib/metric_report_definition.hpp
index a0c4f1d..7c26787 100644
--- a/redfish-core/lib/metric_report_definition.hpp
+++ b/redfish-core/lib/metric_report_definition.hpp
@@ -7,6 +7,8 @@
#include <app.hpp>
#include <boost/container/flat_map.hpp>
#include <registries/privilege_registry.hpp>
+#include <sdbusplus/asio/property.hpp>
+#include <sdbusplus/unpack_properties.hpp>
#include <tuple>
#include <variant>
@@ -17,87 +19,90 @@ namespace redfish
namespace telemetry
{
-using ReadingParameters =
- std::vector<std::tuple<sdbusplus::message::object_path, std::string,
- std::string, std::string>>;
+using ReadingParameters = std::vector<
+ std::tuple<std::vector<sdbusplus::message::object_path>, std::string,
+ std::string, std::string, std::string, uint64_t>>;
inline void fillReportDefinition(
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, const std::string& id,
const std::vector<
- std::pair<std::string, std::variant<std::string, bool, uint64_t,
- ReadingParameters>>>& ret)
+ std::pair<std::string, std::variant<std::monostate, std::string, bool,
+ uint64_t, ReadingParameters>>>&
+ properties)
{
- 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)
+ try
{
- if (key == "EmitsReadingsUpdate")
+ bool emitsReadingsUpdate = false;
+ bool logToMetricReportsCollection = false;
+ ReadingParameters readingParams;
+ std::string reportingType;
+ uint64_t interval = 0u;
+
+ sdbusplus::unpackProperties(
+ properties, "EmitsReadingsUpdate", emitsReadingsUpdate,
+ "LogToMetricReportsCollection", logToMetricReportsCollection,
+ "ReadingParametersFutureVersion", readingParams, "ReportingType",
+ reportingType, "Interval", interval);
+
+ std::vector<std::string> redfishReportActions;
+ redfishReportActions.reserve(2);
+ if (emitsReadingsUpdate)
{
- emitsReadingsUpdate = std::get_if<bool>(&var);
+ redfishReportActions.emplace_back("RedfishEvent");
}
- else if (key == "LogToMetricReportsCollection")
+ if (logToMetricReportsCollection)
{
- logToMetricReportsCollection = std::get_if<bool>(&var);
+ redfishReportActions.emplace_back("LogToMetricReportsCollection");
}
- 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")
+
+ nlohmann::json metrics = nlohmann::json::array();
+ for (auto& [sensorPath, operationType, id, metadata,
+ collectionTimeScope, collectionDuration] : readingParams)
{
- interval = std::get_if<uint64_t>(&var);
+ std::vector<std::string> metricProperties;
+
+ nlohmann::json parsedMetadata = nlohmann::json::parse(metadata);
+ if (!json_util::readJson(parsedMetadata, asyncResp->res,
+ "MetricProperties", metricProperties))
+ {
+ BMCWEB_LOG_ERROR << "Failed to read metadata";
+ messages::internalError(asyncResp->res);
+ return;
+ }
+
+ metrics.push_back({
+ {"MetricId", id},
+ {"MetricProperties", std::move(metricProperties)},
+ });
}
- }
- 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");
+ 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";
+ 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));
}
- if (*logToMetricReportsCollection)
+ catch (const sdbusplus::exception::UnpackPropertyError& error)
{
- redfishReportActions.emplace_back("LogToMetricReportsCollection");
+ BMCWEB_LOG_ERROR << error.what() << ", property: "
+ << error.propertyName + ", reason: " << error.reason;
+ messages::internalError(asyncResp->res);
}
-
- nlohmann::json metrics = nlohmann::json::array();
- for (auto& [sensorPath, operationType, id, metadata] : *readingParams)
+ catch (const nlohmann::json::parse_error& e)
{
- metrics.push_back({
- {"MetricId", id},
- {"MetricProperties", {metadata}},
- });
+ BMCWEB_LOG_ERROR << "Failed to parse metadata: " << e.what();
+ messages::internalError(asyncResp->res);
}
- 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));
}
struct AddReportArgs
@@ -275,6 +280,11 @@ class AddReport
for (const auto& [id, uris] : args.metrics)
{
+ std::vector<sdbusplus::message::object_path> dbusPaths;
+ dbusPaths.reserve(uris.size());
+ nlohmann::json metadata;
+ metadata["MetricProperties"] = nlohmann::json::array();
+
for (size_t i = 0; i < uris.size(); i++)
{
const std::string& uri = uris[i];
@@ -291,8 +301,12 @@ class AddReport
}
const std::string& dbusPath = el->second;
- readingParams.emplace_back(dbusPath, "SINGLE", id, uri);
+ dbusPaths.emplace_back(dbusPath);
+ metadata["MetricProperties"].emplace_back(uri);
}
+
+ readingParams.emplace_back(dbusPaths, "SINGLE", id, metadata.dump(),
+ "Point", 0u);
}
const std::shared_ptr<bmcweb::AsyncResp> aResp = asyncResp;
crow::connections::systemBus->async_method_call(
@@ -330,10 +344,10 @@ class AddReport
messages::created(aResp->res);
},
telemetry::service, "/xyz/openbmc_project/Telemetry/Reports",
- "xyz.openbmc_project.Telemetry.ReportManager", "AddReport",
- "TelemetryService/" + args.name, args.reportingType,
- args.emitsReadingsUpdate, args.logToMetricReportsCollection,
- args.interval, readingParams);
+ "xyz.openbmc_project.Telemetry.ReportManager",
+ "AddReportFutureVersion", "TelemetryService/" + args.name,
+ args.reportingType, args.emitsReadingsUpdate,
+ args.logToMetricReportsCollection, args.interval, readingParams);
}
void insert(const boost::container::flat_map<std::string, std::string>& el)
@@ -415,37 +429,39 @@ inline void requestRoutesMetricReportDefinition(App& app)
BMCWEB_ROUTE(app,
"/redfish/v1/TelemetryService/MetricReportDefinitions/<str>/")
.privileges(redfish::privileges::getMetricReportDefinition)
- .methods(boost::beast::http::verb::get)(
- [](const crow::Request&,
- const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
- const std::string& id) {
- 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;
- }
+ .methods(
+ boost::beast::http::verb::get)([](const crow::Request&,
+ const std::shared_ptr<
+ bmcweb::AsyncResp>& asyncResp,
+ const std::string& id) {
+ sdbusplus::asio::getAllProperties(
+ *crow::connections::systemBus, telemetry::service,
+ telemetry::getDbusReportPath(id), telemetry::reportInterface,
+ [asyncResp,
+ id](boost::system::error_code ec,
+ const std::vector<std::pair<
+ std::string,
+ std::variant<std::monostate, std::string, bool,
+ uint64_t, telemetry::ReadingParameters>>>&
+ properties) {
+ 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, properties);
+ });
+ });
- telemetry::fillReportDefinition(asyncResp, id, ret);
- },
- telemetry::service, telemetry::getDbusReportPath(id),
- "org.freedesktop.DBus.Properties", "GetAll",
- telemetry::reportInterface);
- });
BMCWEB_ROUTE(app,
"/redfish/v1/TelemetryService/MetricReportDefinitions/<str>/")
.privileges(redfish::privileges::deleteMetricReportDefinitionCollection)
--
2.25.1
|
