Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 1 | #include "report_manager.hpp" |
| 2 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 3 | #include "report.hpp" |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 4 | #include "types/report_types.hpp" |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 5 | #include "utils/conversion.hpp" |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 6 | #include "utils/transform.hpp" |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 7 | |
| 8 | #include <phosphor-logging/log.hpp> |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 9 | #include <sdbusplus/exception.hpp> |
| 10 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 11 | #include <stdexcept> |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 12 | #include <system_error> |
| 13 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 14 | ReadingParameters |
| 15 | convertToReadingParameters(ReadingParametersPastVersion params) |
| 16 | { |
| 17 | return utils::transform(params, [](const auto& param) { |
| 18 | using namespace std::chrono_literals; |
| 19 | |
| 20 | return ReadingParameters::value_type( |
| 21 | std::vector{{std::get<0>(param)}}, std::get<1>(param), |
| 22 | std::get<2>(param), std::get<3>(param), |
| 23 | utils::enumToString(CollectionTimeScope::point), 0u); |
| 24 | }); |
| 25 | } |
| 26 | |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 27 | ReportManager::ReportManager( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 28 | std::unique_ptr<interfaces::ReportFactory> reportFactoryIn, |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 29 | std::unique_ptr<interfaces::JsonStorage> reportStorageIn, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 30 | const std::shared_ptr<sdbusplus::asio::object_server>& objServerIn) : |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 31 | reportFactory(std::move(reportFactoryIn)), |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 32 | reportStorage(std::move(reportStorageIn)), objServer(objServerIn) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 33 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 34 | reports.reserve(maxReports); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 35 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 36 | loadFromPersistent(); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 37 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 38 | reportManagerIface = objServer->add_unique_interface( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 39 | reportManagerPath, reportManagerIfaceName, [this](auto& dbusIface) { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 40 | dbusIface.register_property_r( |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 41 | "MaxReports", size_t{}, sdbusplus::vtable::property_::const_, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 42 | [](const auto&) { return maxReports; }); |
| 43 | dbusIface.register_property_r( |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 44 | "MaxReportNameLength", size_t{}, |
| 45 | sdbusplus::vtable::property_::const_, |
| 46 | [](const auto&) { return maxReportNameLength; }); |
| 47 | dbusIface.register_property_r( |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 48 | "MinInterval", uint64_t{}, sdbusplus::vtable::property_::const_, |
| 49 | [](const auto&) -> uint64_t { return minInterval.count(); }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 50 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 51 | dbusIface.register_method( |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 52 | "AddReport", [this](boost::asio::yield_context& yield, |
| 53 | const std::string& reportName, |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 54 | const std::string& reportingType, |
| 55 | const bool emitsReadingsUpdate, |
| 56 | const bool logToMetricReportsCollection, |
| 57 | const uint64_t interval, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 58 | ReadingParametersPastVersion metricParams) { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 59 | constexpr auto enabledDefault = true; |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 60 | constexpr uint64_t appendLimitDefault = 0; |
| 61 | constexpr ReportUpdates reportUpdatesDefault = |
| 62 | ReportUpdates::Overwrite; |
| 63 | return addReport( |
| 64 | yield, reportName, reportingType, |
| 65 | emitsReadingsUpdate, |
| 66 | logToMetricReportsCollection, |
| 67 | Milliseconds(interval), appendLimitDefault, |
| 68 | reportUpdatesToString(reportUpdatesDefault), |
| 69 | convertToReadingParameters( |
| 70 | std::move(metricParams)), |
| 71 | enabledDefault) |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 72 | .getPath(); |
| 73 | }); |
| 74 | |
| 75 | dbusIface.register_method( |
| 76 | "AddReportFutureVersion", |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 77 | |
| 78 | [this]( |
| 79 | boost::asio::yield_context& yield, |
| 80 | const std::string& reportName, |
| 81 | const std::string& reportingType, |
| 82 | const std::string& reportUpdates, |
| 83 | const uint64_t appendLimit, const bool emitsReadingsUpdate, |
| 84 | const bool logToMetricReportsCollection, |
| 85 | const uint64_t interval, ReadingParameters metricParams) { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 86 | constexpr auto enabledDefault = true; |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 87 | return addReport(yield, reportName, reportingType, |
| 88 | emitsReadingsUpdate, |
| 89 | logToMetricReportsCollection, |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 90 | Milliseconds(interval), appendLimit, |
| 91 | reportUpdates, std::move(metricParams), |
| 92 | enabledDefault) |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 93 | .getPath(); |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 94 | }); |
| 95 | }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 96 | } |
| 97 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 98 | void ReportManager::removeReport(const interfaces::Report* report) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 99 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 100 | reports.erase( |
| 101 | std::remove_if(reports.begin(), reports.end(), |
| 102 | [report](const auto& x) { return report == x.get(); }), |
| 103 | reports.end()); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 104 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 105 | |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 106 | void ReportManager::verifyReportNameLength(const std::string& reportName) |
| 107 | { |
| 108 | if (reportName.length() > maxReportNameLength) |
| 109 | { |
| 110 | throw sdbusplus::exception::SdBusError( |
| 111 | static_cast<int>(std::errc::invalid_argument), |
Szymon Dompke | e28aa53 | 2021-10-27 12:33:12 +0200 | [diff] [blame] | 112 | "Report name exceeds maximum length"); |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 113 | } |
| 114 | } |
| 115 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 116 | void ReportManager::verifyAddReport( |
| 117 | const std::string& reportName, const std::string& reportingType, |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 118 | Milliseconds interval, const std::string& reportUpdates, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 119 | const std::vector<LabeledMetricParameters>& readingParams) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 120 | { |
| 121 | if (reports.size() >= maxReports) |
| 122 | { |
| 123 | throw sdbusplus::exception::SdBusError( |
| 124 | static_cast<int>(std::errc::too_many_files_open), |
| 125 | "Reached maximal report count"); |
| 126 | } |
| 127 | |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 128 | verifyReportNameLength(reportName); |
| 129 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 130 | for (const auto& report : reports) |
| 131 | { |
| 132 | if (report->getName() == reportName) |
| 133 | { |
| 134 | throw sdbusplus::exception::SdBusError( |
| 135 | static_cast<int>(std::errc::file_exists), "Duplicate report"); |
| 136 | } |
| 137 | } |
| 138 | |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 139 | if (std::find(supportedReportingType.begin(), supportedReportingType.end(), |
| 140 | reportingType) == supportedReportingType.end()) |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 141 | { |
| 142 | throw sdbusplus::exception::SdBusError( |
| 143 | static_cast<int>(std::errc::invalid_argument), |
| 144 | "Invalid reportingType"); |
| 145 | } |
| 146 | |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 147 | verifyReportUpdates(reportUpdates); |
| 148 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 149 | if (reportingType == "Periodic" && interval < minInterval) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 150 | { |
| 151 | throw sdbusplus::exception::SdBusError( |
| 152 | static_cast<int>(std::errc::invalid_argument), "Invalid interval"); |
| 153 | } |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 154 | |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 155 | if (readingParams.size() > maxReadingParams) |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 156 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 157 | { |
| 158 | throw sdbusplus::exception::SdBusError( |
| 159 | static_cast<int>(std::errc::argument_list_too_long), |
| 160 | "Too many reading parameters"); |
| 161 | } |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 162 | |
| 163 | try |
| 164 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 165 | namespace ts = utils::tstring; |
| 166 | |
| 167 | for (const LabeledMetricParameters& item : readingParams) |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 168 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 169 | utils::toOperationType( |
| 170 | utils::toUnderlying(item.at_label<ts::OperationType>())); |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 171 | } |
| 172 | } |
| 173 | catch (const std::exception& e) |
| 174 | { |
| 175 | throw sdbusplus::exception::SdBusError( |
| 176 | static_cast<int>(std::errc::invalid_argument), e.what()); |
| 177 | } |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 178 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 179 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 180 | interfaces::Report& ReportManager::addReport( |
| 181 | boost::asio::yield_context& yield, const std::string& reportName, |
| 182 | const std::string& reportingType, const bool emitsReadingsUpdate, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 183 | const bool logToMetricReportsCollection, Milliseconds interval, |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 184 | const uint64_t appendLimit, const std::string& reportUpdates, |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 185 | ReadingParameters metricParams, const bool enabled) |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 186 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 187 | auto labeledMetricParams = |
| 188 | reportFactory->convertMetricParams(yield, metricParams); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 189 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 190 | return addReport(reportName, reportingType, emitsReadingsUpdate, |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 191 | logToMetricReportsCollection, interval, appendLimit, |
| 192 | reportUpdates, std::move(labeledMetricParams), enabled); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | interfaces::Report& ReportManager::addReport( |
| 196 | const std::string& reportName, const std::string& reportingType, |
| 197 | const bool emitsReadingsUpdate, const bool logToMetricReportsCollection, |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 198 | Milliseconds interval, const uint64_t appendLimit, |
| 199 | const std::string& reportUpdates, |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 200 | std::vector<LabeledMetricParameters> labeledMetricParams, |
| 201 | const bool enabled) |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 202 | { |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 203 | verifyAddReport(reportName, reportingType, interval, reportUpdates, |
| 204 | labeledMetricParams); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 205 | |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 206 | reports.emplace_back(reportFactory->make( |
| 207 | reportName, reportingType, emitsReadingsUpdate, |
| 208 | logToMetricReportsCollection, interval, appendLimit, reportUpdates, |
| 209 | *this, *reportStorage, labeledMetricParams, enabled)); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 210 | return *reports.back(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 211 | } |
| 212 | |
| 213 | void ReportManager::loadFromPersistent() |
| 214 | { |
| 215 | std::vector<interfaces::JsonStorage::FilePath> paths = |
| 216 | reportStorage->list(); |
| 217 | |
| 218 | for (const auto& path : paths) |
| 219 | { |
| 220 | std::optional<nlohmann::json> data = reportStorage->load(path); |
| 221 | try |
| 222 | { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 223 | bool enabled = data->at("Enabled").get<bool>(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 224 | size_t version = data->at("Version").get<size_t>(); |
| 225 | if (version != Report::reportVersion) |
| 226 | { |
| 227 | throw std::logic_error("Invalid version"); |
| 228 | } |
| 229 | std::string& name = data->at("Name").get_ref<std::string&>(); |
| 230 | std::string& reportingType = |
| 231 | data->at("ReportingType").get_ref<std::string&>(); |
| 232 | bool emitsReadingsSignal = |
| 233 | data->at("EmitsReadingsUpdate").get<bool>(); |
| 234 | bool logToMetricReportsCollection = |
| 235 | data->at("LogToMetricReportsCollection").get<bool>(); |
| 236 | uint64_t interval = data->at("Interval").get<uint64_t>(); |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 237 | uint64_t appendLimit = data->at("AppendLimit").get<uint64_t>(); |
| 238 | std::string reportUpdates = |
| 239 | data->at("ReportUpdates").get<std::string>(); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 240 | auto readingParameters = |
| 241 | data->at("ReadingParameters") |
| 242 | .get<std::vector<LabeledMetricParameters>>(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 243 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 244 | addReport(name, reportingType, emitsReadingsSignal, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 245 | logToMetricReportsCollection, Milliseconds(interval), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 246 | appendLimit, reportUpdates, std::move(readingParameters), |
| 247 | enabled); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 248 | } |
| 249 | catch (const std::exception& e) |
| 250 | { |
| 251 | phosphor::logging::log<phosphor::logging::level::ERR>( |
| 252 | "Failed to load report from storage", |
| 253 | phosphor::logging::entry( |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 254 | "FILENAME=%s", |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 255 | static_cast<std::filesystem::path>(path).c_str()), |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 256 | phosphor::logging::entry("EXCEPTION_MSG=%s", e.what())); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 257 | reportStorage->remove(path); |
| 258 | } |
| 259 | } |
| 260 | } |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 261 | |
| 262 | void ReportManager::updateReport(const std::string& name) |
| 263 | { |
| 264 | for (auto& report : reports) |
| 265 | { |
| 266 | if (report->getName() == name) |
| 267 | { |
| 268 | report->updateReadings(); |
| 269 | return; |
| 270 | } |
| 271 | } |
| 272 | } |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame^] | 273 | |
| 274 | void ReportManager::verifyReportUpdates(const std::string& reportUpdates) |
| 275 | { |
| 276 | if (std::find(supportedReportUpdates.begin(), supportedReportUpdates.end(), |
| 277 | reportUpdates) == supportedReportUpdates.end()) |
| 278 | { |
| 279 | throw sdbusplus::exception::SdBusError( |
| 280 | static_cast<int>(std::errc::invalid_argument), |
| 281 | "Invalid ReportUpdates"); |
| 282 | } |
| 283 | } |