107148cf2SLukasz Kazmierczak #pragma once 207148cf2SLukasz Kazmierczak 33ccb3adbSEd Tanous #include "app.hpp" 4539d8c6bSEd Tanous #include "generated/enums/metric_definition.hpp" 5dd1c4a9cSSzymon Dompke #include "generated/enums/resource.hpp" 6dd1c4a9cSSzymon Dompke #include "generated/enums/triggers.hpp" 73ccb3adbSEd Tanous #include "query.hpp" 83ccb3adbSEd Tanous #include "registries/privilege_registry.hpp" 9dd1c4a9cSSzymon Dompke #include "utility.hpp" 1007148cf2SLukasz Kazmierczak #include "utils/collection.hpp" 113ccb3adbSEd Tanous #include "utils/dbus_utils.hpp" 125b90429aSEd Tanous #include "utils/json_utils.hpp" 131516c21bSJanet Adkins #include "utils/sensor_utils.hpp" 1407148cf2SLukasz Kazmierczak #include "utils/telemetry_utils.hpp" 153ccb3adbSEd Tanous #include "utils/time_utils.hpp" 1607148cf2SLukasz Kazmierczak 17ef4c65b7SEd Tanous #include <boost/url/format.hpp> 1889474494SKrzysztof Grobelny #include <sdbusplus/asio/property.hpp> 1989474494SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 2007148cf2SLukasz Kazmierczak 217a1dbc48SGeorge Liu #include <array> 227a1dbc48SGeorge Liu #include <string_view> 231b7e696bSLukasz Kazmierczak #include <tuple> 241b7e696bSLukasz Kazmierczak #include <variant> 251b7e696bSLukasz Kazmierczak #include <vector> 261b7e696bSLukasz Kazmierczak 2707148cf2SLukasz Kazmierczak namespace redfish 2807148cf2SLukasz Kazmierczak { 2907148cf2SLukasz Kazmierczak namespace telemetry 3007148cf2SLukasz Kazmierczak { 3107148cf2SLukasz Kazmierczak constexpr const char* triggerInterface = 3207148cf2SLukasz Kazmierczak "xyz.openbmc_project.Telemetry.Trigger"; 3307148cf2SLukasz Kazmierczak 341b7e696bSLukasz Kazmierczak using NumericThresholdParams = 351b7e696bSLukasz Kazmierczak std::tuple<std::string, uint64_t, std::string, double>; 361b7e696bSLukasz Kazmierczak 371b7e696bSLukasz Kazmierczak using DiscreteThresholdParams = 381b7e696bSLukasz Kazmierczak std::tuple<std::string, std::string, uint64_t, std::string>; 391b7e696bSLukasz Kazmierczak 40dd1c4a9cSSzymon Dompke using TriggerThresholdParams = 41dd1c4a9cSSzymon Dompke std::variant<std::vector<NumericThresholdParams>, 42dd1c4a9cSSzymon Dompke std::vector<DiscreteThresholdParams>>; 43dd1c4a9cSSzymon Dompke 441b7e696bSLukasz Kazmierczak using TriggerSensorsParams = 451b7e696bSLukasz Kazmierczak std::vector<std::pair<sdbusplus::message::object_path, std::string>>; 461b7e696bSLukasz Kazmierczak 47dd1c4a9cSSzymon Dompke inline triggers::TriggerActionEnum 48dd1c4a9cSSzymon Dompke toRedfishTriggerAction(std::string_view dbusValue) 491b7e696bSLukasz Kazmierczak { 50dd1c4a9cSSzymon Dompke if (dbusValue == 51dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.UpdateReport") 521b7e696bSLukasz Kazmierczak { 53dd1c4a9cSSzymon Dompke return triggers::TriggerActionEnum::RedfishMetricReport; 541b7e696bSLukasz Kazmierczak } 55dd1c4a9cSSzymon Dompke if (dbusValue == 56dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.LogToRedfishEventLog") 571b7e696bSLukasz Kazmierczak { 58dd1c4a9cSSzymon Dompke return triggers::TriggerActionEnum::RedfishEvent; 591b7e696bSLukasz Kazmierczak } 60dd1c4a9cSSzymon Dompke if (dbusValue == 61dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.LogToJournal") 621b7e696bSLukasz Kazmierczak { 63dd1c4a9cSSzymon Dompke return triggers::TriggerActionEnum::LogToLogService; 641b7e696bSLukasz Kazmierczak } 65dd1c4a9cSSzymon Dompke return triggers::TriggerActionEnum::Invalid; 661b7e696bSLukasz Kazmierczak } 671b7e696bSLukasz Kazmierczak 68dd1c4a9cSSzymon Dompke inline std::string toDbusTriggerAction(std::string_view redfishValue) 691b7e696bSLukasz Kazmierczak { 70dd1c4a9cSSzymon Dompke if (redfishValue == "RedfishMetricReport") 711b7e696bSLukasz Kazmierczak { 72dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.UpdateReport"; 73dd1c4a9cSSzymon Dompke } 74dd1c4a9cSSzymon Dompke if (redfishValue == "RedfishEvent") 75dd1c4a9cSSzymon Dompke { 76dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.LogToRedfishEventLog"; 77dd1c4a9cSSzymon Dompke } 78dd1c4a9cSSzymon Dompke if (redfishValue == "LogToLogService") 79dd1c4a9cSSzymon Dompke { 80dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.TriggerAction.LogToJournal"; 81dd1c4a9cSSzymon Dompke } 82dd1c4a9cSSzymon Dompke return ""; 83dd1c4a9cSSzymon Dompke } 841b7e696bSLukasz Kazmierczak 85dd1c4a9cSSzymon Dompke inline std::string toDbusSeverity(std::string_view redfishValue) 86dd1c4a9cSSzymon Dompke { 87dd1c4a9cSSzymon Dompke if (redfishValue == "OK") 88dd1c4a9cSSzymon Dompke { 89dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Severity.OK"; 90dd1c4a9cSSzymon Dompke } 91dd1c4a9cSSzymon Dompke if (redfishValue == "Warning") 92dd1c4a9cSSzymon Dompke { 93dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Severity.Warning"; 94dd1c4a9cSSzymon Dompke } 95dd1c4a9cSSzymon Dompke if (redfishValue == "Critical") 96dd1c4a9cSSzymon Dompke { 97dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Severity.Critical"; 98dd1c4a9cSSzymon Dompke } 99dd1c4a9cSSzymon Dompke return ""; 100dd1c4a9cSSzymon Dompke } 101dd1c4a9cSSzymon Dompke 102dd1c4a9cSSzymon Dompke inline resource::Health toRedfishSeverity(std::string_view dbusValue) 103dd1c4a9cSSzymon Dompke { 104dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Severity.OK") 105dd1c4a9cSSzymon Dompke { 106dd1c4a9cSSzymon Dompke return resource::Health::OK; 107dd1c4a9cSSzymon Dompke } 108dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Severity.Warning") 109dd1c4a9cSSzymon Dompke { 110dd1c4a9cSSzymon Dompke return resource::Health::Warning; 111dd1c4a9cSSzymon Dompke } 112dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Severity.Critical") 113dd1c4a9cSSzymon Dompke { 114dd1c4a9cSSzymon Dompke return resource::Health::Critical; 115dd1c4a9cSSzymon Dompke } 116dd1c4a9cSSzymon Dompke return resource::Health::Invalid; 117dd1c4a9cSSzymon Dompke } 118dd1c4a9cSSzymon Dompke 119dd1c4a9cSSzymon Dompke inline std::string toRedfishThresholdName(std::string_view dbusValue) 120dd1c4a9cSSzymon Dompke { 121dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Type.UpperCritical") 122dd1c4a9cSSzymon Dompke { 123dd1c4a9cSSzymon Dompke return "UpperCritical"; 124dd1c4a9cSSzymon Dompke } 125dd1c4a9cSSzymon Dompke 126dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Type.LowerCritical") 127dd1c4a9cSSzymon Dompke { 128dd1c4a9cSSzymon Dompke return "LowerCritical"; 129dd1c4a9cSSzymon Dompke } 130dd1c4a9cSSzymon Dompke 131dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Type.UpperWarning") 132dd1c4a9cSSzymon Dompke { 133dd1c4a9cSSzymon Dompke return "UpperWarning"; 134dd1c4a9cSSzymon Dompke } 135dd1c4a9cSSzymon Dompke 136dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Type.LowerWarning") 137dd1c4a9cSSzymon Dompke { 138dd1c4a9cSSzymon Dompke return "LowerWarning"; 139dd1c4a9cSSzymon Dompke } 140dd1c4a9cSSzymon Dompke 141dd1c4a9cSSzymon Dompke return ""; 142dd1c4a9cSSzymon Dompke } 143dd1c4a9cSSzymon Dompke 144dd1c4a9cSSzymon Dompke inline std::string toDbusActivation(std::string_view redfishValue) 145dd1c4a9cSSzymon Dompke { 146dd1c4a9cSSzymon Dompke if (redfishValue == "Either") 147dd1c4a9cSSzymon Dompke { 148dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Direction.Either"; 149dd1c4a9cSSzymon Dompke } 150dd1c4a9cSSzymon Dompke 151dd1c4a9cSSzymon Dompke if (redfishValue == "Decreasing") 152dd1c4a9cSSzymon Dompke { 153dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Direction.Decreasing"; 154dd1c4a9cSSzymon Dompke } 155dd1c4a9cSSzymon Dompke 156dd1c4a9cSSzymon Dompke if (redfishValue == "Increasing") 157dd1c4a9cSSzymon Dompke { 158dd1c4a9cSSzymon Dompke return "xyz.openbmc_project.Telemetry.Trigger.Direction.Increasing"; 159dd1c4a9cSSzymon Dompke } 160dd1c4a9cSSzymon Dompke 161dd1c4a9cSSzymon Dompke return ""; 162dd1c4a9cSSzymon Dompke } 163dd1c4a9cSSzymon Dompke 164dd1c4a9cSSzymon Dompke inline triggers::ThresholdActivation 165dd1c4a9cSSzymon Dompke toRedfishActivation(std::string_view dbusValue) 166dd1c4a9cSSzymon Dompke { 167dd1c4a9cSSzymon Dompke if (dbusValue == "xyz.openbmc_project.Telemetry.Trigger.Direction.Either") 168dd1c4a9cSSzymon Dompke { 169dd1c4a9cSSzymon Dompke return triggers::ThresholdActivation::Either; 170dd1c4a9cSSzymon Dompke } 171dd1c4a9cSSzymon Dompke 172dd1c4a9cSSzymon Dompke if (dbusValue == 173dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.Trigger.Direction.Decreasing") 174dd1c4a9cSSzymon Dompke { 175dd1c4a9cSSzymon Dompke return triggers::ThresholdActivation::Decreasing; 176dd1c4a9cSSzymon Dompke } 177dd1c4a9cSSzymon Dompke 178dd1c4a9cSSzymon Dompke if (dbusValue == 179dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.Trigger.Direction.Increasing") 180dd1c4a9cSSzymon Dompke { 181dd1c4a9cSSzymon Dompke return triggers::ThresholdActivation::Increasing; 182dd1c4a9cSSzymon Dompke } 183dd1c4a9cSSzymon Dompke 184dd1c4a9cSSzymon Dompke return triggers::ThresholdActivation::Invalid; 185dd1c4a9cSSzymon Dompke } 186dd1c4a9cSSzymon Dompke 187dd1c4a9cSSzymon Dompke enum class MetricType 188dd1c4a9cSSzymon Dompke { 189dd1c4a9cSSzymon Dompke Discrete, 190dd1c4a9cSSzymon Dompke Numeric 191dd1c4a9cSSzymon Dompke }; 192dd1c4a9cSSzymon Dompke 193dd1c4a9cSSzymon Dompke enum class DiscreteCondition 194dd1c4a9cSSzymon Dompke { 195dd1c4a9cSSzymon Dompke Specified, 196dd1c4a9cSSzymon Dompke Changed 197dd1c4a9cSSzymon Dompke }; 198dd1c4a9cSSzymon Dompke 199dd1c4a9cSSzymon Dompke struct Context 200dd1c4a9cSSzymon Dompke { 201dd1c4a9cSSzymon Dompke std::string id; 202dd1c4a9cSSzymon Dompke std::string name; 203dd1c4a9cSSzymon Dompke std::vector<std::string> actions; 204dd1c4a9cSSzymon Dompke std::vector<std::pair<sdbusplus::message::object_path, std::string>> 205dd1c4a9cSSzymon Dompke sensors; 206dd1c4a9cSSzymon Dompke std::vector<sdbusplus::message::object_path> reports; 207dd1c4a9cSSzymon Dompke TriggerThresholdParams thresholds; 208dd1c4a9cSSzymon Dompke 209dd1c4a9cSSzymon Dompke std::optional<DiscreteCondition> discreteCondition; 210dd1c4a9cSSzymon Dompke std::optional<MetricType> metricType; 211dd1c4a9cSSzymon Dompke std::optional<std::vector<std::string>> metricProperties; 212dd1c4a9cSSzymon Dompke }; 213dd1c4a9cSSzymon Dompke 214dd1c4a9cSSzymon Dompke inline std::optional<sdbusplus::message::object_path> 215dd1c4a9cSSzymon Dompke getReportPathFromReportDefinitionUri(const std::string& uri) 216dd1c4a9cSSzymon Dompke { 2176fd29553SEd Tanous boost::system::result<boost::urls::url_view> parsed = 218dd1c4a9cSSzymon Dompke boost::urls::parse_relative_ref(uri); 219dd1c4a9cSSzymon Dompke 220dd1c4a9cSSzymon Dompke if (!parsed) 2211b7e696bSLukasz Kazmierczak { 2221b7e696bSLukasz Kazmierczak return std::nullopt; 2231b7e696bSLukasz Kazmierczak } 2241b7e696bSLukasz Kazmierczak 225dd1c4a9cSSzymon Dompke std::string id; 226dd1c4a9cSSzymon Dompke if (!crow::utility::readUrlSegments( 227dd1c4a9cSSzymon Dompke *parsed, "redfish", "v1", "TelemetryService", 228dd1c4a9cSSzymon Dompke "MetricReportDefinitions", std::ref(id))) 229dd1c4a9cSSzymon Dompke { 230dd1c4a9cSSzymon Dompke return std::nullopt; 2311b7e696bSLukasz Kazmierczak } 2321b7e696bSLukasz Kazmierczak 233dd1c4a9cSSzymon Dompke return sdbusplus::message::object_path( 234dd1c4a9cSSzymon Dompke "/xyz/openbmc_project/Telemetry/Reports") / 235dd1c4a9cSSzymon Dompke "TelemetryService" / id; 236dd1c4a9cSSzymon Dompke } 237dd1c4a9cSSzymon Dompke 238dd1c4a9cSSzymon Dompke inline std::optional<MetricType> getMetricType(const std::string& metricType) 239dd1c4a9cSSzymon Dompke { 240dd1c4a9cSSzymon Dompke if (metricType == "Discrete") 241dd1c4a9cSSzymon Dompke { 242dd1c4a9cSSzymon Dompke return MetricType::Discrete; 243dd1c4a9cSSzymon Dompke } 244dd1c4a9cSSzymon Dompke if (metricType == "Numeric") 245dd1c4a9cSSzymon Dompke { 246dd1c4a9cSSzymon Dompke return MetricType::Numeric; 247dd1c4a9cSSzymon Dompke } 248dd1c4a9cSSzymon Dompke return std::nullopt; 249dd1c4a9cSSzymon Dompke } 250dd1c4a9cSSzymon Dompke 251dd1c4a9cSSzymon Dompke inline std::optional<DiscreteCondition> 252dd1c4a9cSSzymon Dompke getDiscreteCondition(const std::string& discreteTriggerCondition) 253dd1c4a9cSSzymon Dompke { 254dd1c4a9cSSzymon Dompke if (discreteTriggerCondition == "Specified") 255dd1c4a9cSSzymon Dompke { 256dd1c4a9cSSzymon Dompke return DiscreteCondition::Specified; 257dd1c4a9cSSzymon Dompke } 258dd1c4a9cSSzymon Dompke if (discreteTriggerCondition == "Changed") 259dd1c4a9cSSzymon Dompke { 260dd1c4a9cSSzymon Dompke return DiscreteCondition::Changed; 261dd1c4a9cSSzymon Dompke } 262dd1c4a9cSSzymon Dompke return std::nullopt; 263dd1c4a9cSSzymon Dompke } 264dd1c4a9cSSzymon Dompke 2652932dcb6SEd Tanous inline bool parseThreshold(crow::Response& res, 2662932dcb6SEd Tanous nlohmann::json::object_t& threshold, 2672932dcb6SEd Tanous std::string_view dbusThresholdName, 2682932dcb6SEd Tanous std::vector<NumericThresholdParams>& parsedParams) 269dd1c4a9cSSzymon Dompke { 270dd1c4a9cSSzymon Dompke double reading = 0.0; 271dd1c4a9cSSzymon Dompke std::string activation; 272dd1c4a9cSSzymon Dompke std::string dwellTimeStr; 273dd1c4a9cSSzymon Dompke 274afc474aeSMyung Bae if (!json_util::readJsonObject( // 275afc474aeSMyung Bae threshold, res, // 276afc474aeSMyung Bae "Activation", activation, // 277afc474aeSMyung Bae "DwellTime", dwellTimeStr, // 278afc474aeSMyung Bae "Reading", reading // 279afc474aeSMyung Bae )) 280dd1c4a9cSSzymon Dompke { 281dd1c4a9cSSzymon Dompke return false; 282dd1c4a9cSSzymon Dompke } 283dd1c4a9cSSzymon Dompke 284dd1c4a9cSSzymon Dompke std::string dbusActivation = toDbusActivation(activation); 285dd1c4a9cSSzymon Dompke 286dd1c4a9cSSzymon Dompke if (dbusActivation.empty()) 287dd1c4a9cSSzymon Dompke { 288dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "Activation", activation); 289dd1c4a9cSSzymon Dompke return false; 290dd1c4a9cSSzymon Dompke } 291dd1c4a9cSSzymon Dompke 292dd1c4a9cSSzymon Dompke std::optional<std::chrono::milliseconds> dwellTime = 293dd1c4a9cSSzymon Dompke time_utils::fromDurationString(dwellTimeStr); 294dd1c4a9cSSzymon Dompke if (!dwellTime) 295dd1c4a9cSSzymon Dompke { 296dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "DwellTime", dwellTimeStr); 297dd1c4a9cSSzymon Dompke return false; 298dd1c4a9cSSzymon Dompke } 299dd1c4a9cSSzymon Dompke 300dd1c4a9cSSzymon Dompke parsedParams.emplace_back(dbusThresholdName, 301dd1c4a9cSSzymon Dompke static_cast<uint64_t>(dwellTime->count()), 302dd1c4a9cSSzymon Dompke dbusActivation, reading); 3032932dcb6SEd Tanous return true; 3042932dcb6SEd Tanous } 3052932dcb6SEd Tanous 3062932dcb6SEd Tanous struct NumericThresholds 3072932dcb6SEd Tanous { 3082932dcb6SEd Tanous std::optional<nlohmann::json::object_t> upperCritical; 3092932dcb6SEd Tanous std::optional<nlohmann::json::object_t> upperWarning; 3102932dcb6SEd Tanous std::optional<nlohmann::json::object_t> lowerWarning; 3112932dcb6SEd Tanous std::optional<nlohmann::json::object_t> lowerCritical; 3122932dcb6SEd Tanous 3132932dcb6SEd Tanous bool any() const 3142932dcb6SEd Tanous { 3152932dcb6SEd Tanous return upperCritical || upperWarning || lowerWarning || lowerCritical; 3162932dcb6SEd Tanous } 3172932dcb6SEd Tanous }; 3182932dcb6SEd Tanous 319bd79bce8SPatrick Williams inline bool parseNumericThresholds( 320bd79bce8SPatrick Williams crow::Response& res, NumericThresholds& numericThresholds, Context& ctx) 3212932dcb6SEd Tanous { 3222932dcb6SEd Tanous std::vector<NumericThresholdParams> parsedParams; 3232932dcb6SEd Tanous if (numericThresholds.upperCritical) 3242932dcb6SEd Tanous { 3252932dcb6SEd Tanous if (!parseThreshold( 3262932dcb6SEd Tanous res, *numericThresholds.upperCritical, 3272932dcb6SEd Tanous "xyz.openbmc_project.Telemetry.Trigger.Type.UpperCritical", 3282932dcb6SEd Tanous parsedParams)) 3292932dcb6SEd Tanous { 3302932dcb6SEd Tanous return false; 3312932dcb6SEd Tanous } 3322932dcb6SEd Tanous } 3332932dcb6SEd Tanous if (numericThresholds.upperWarning) 3342932dcb6SEd Tanous { 3352932dcb6SEd Tanous if (!parseThreshold( 3362932dcb6SEd Tanous res, *numericThresholds.upperWarning, 3372932dcb6SEd Tanous "xyz.openbmc_project.Telemetry.Trigger.Type.UpperWarning", 3382932dcb6SEd Tanous parsedParams)) 3392932dcb6SEd Tanous { 3402932dcb6SEd Tanous return false; 3412932dcb6SEd Tanous } 3422932dcb6SEd Tanous } 3432932dcb6SEd Tanous if (numericThresholds.lowerWarning) 3442932dcb6SEd Tanous { 3452932dcb6SEd Tanous if (!parseThreshold( 3462932dcb6SEd Tanous res, *numericThresholds.lowerWarning, 3472932dcb6SEd Tanous "xyz.openbmc_project.Telemetry.Trigger.Type.LowerWarning", 3482932dcb6SEd Tanous parsedParams)) 3492932dcb6SEd Tanous { 3502932dcb6SEd Tanous return false; 3512932dcb6SEd Tanous } 3522932dcb6SEd Tanous } 3532932dcb6SEd Tanous if (numericThresholds.lowerCritical) 3542932dcb6SEd Tanous { 3552932dcb6SEd Tanous if (!parseThreshold( 3562932dcb6SEd Tanous res, *numericThresholds.lowerCritical, 3572932dcb6SEd Tanous "xyz.openbmc_project.Telemetry.Trigger.Type.LowerCritical", 3582932dcb6SEd Tanous parsedParams)) 3592932dcb6SEd Tanous { 3602932dcb6SEd Tanous return false; 3612932dcb6SEd Tanous } 362dd1c4a9cSSzymon Dompke } 363dd1c4a9cSSzymon Dompke 364dd1c4a9cSSzymon Dompke ctx.thresholds = std::move(parsedParams); 365dd1c4a9cSSzymon Dompke return true; 366dd1c4a9cSSzymon Dompke } 367dd1c4a9cSSzymon Dompke 368dd1c4a9cSSzymon Dompke inline bool parseDiscreteTriggers( 369dd1c4a9cSSzymon Dompke crow::Response& res, 3702932dcb6SEd Tanous std::optional<std::vector<nlohmann::json::object_t>>& discreteTriggers, 3712932dcb6SEd Tanous Context& ctx) 372dd1c4a9cSSzymon Dompke { 373dd1c4a9cSSzymon Dompke std::vector<DiscreteThresholdParams> parsedParams; 374dd1c4a9cSSzymon Dompke if (!discreteTriggers) 375dd1c4a9cSSzymon Dompke { 376dd1c4a9cSSzymon Dompke ctx.thresholds = std::move(parsedParams); 377dd1c4a9cSSzymon Dompke return true; 378dd1c4a9cSSzymon Dompke } 379dd1c4a9cSSzymon Dompke 380dd1c4a9cSSzymon Dompke parsedParams.reserve(discreteTriggers->size()); 3812932dcb6SEd Tanous for (nlohmann::json::object_t& thresholdInfo : *discreteTriggers) 382dd1c4a9cSSzymon Dompke { 383dd1c4a9cSSzymon Dompke std::optional<std::string> name = ""; 384dd1c4a9cSSzymon Dompke std::string value; 385dd1c4a9cSSzymon Dompke std::string dwellTimeStr; 386dd1c4a9cSSzymon Dompke std::string severity; 387dd1c4a9cSSzymon Dompke 388afc474aeSMyung Bae if (!json_util::readJsonObject( // 389afc474aeSMyung Bae thresholdInfo, res, // 390afc474aeSMyung Bae "DwellTime", dwellTimeStr, // 391afc474aeSMyung Bae "Name", name, // 392afc474aeSMyung Bae "Severity", severity, // 393afc474aeSMyung Bae "Value", value // 394afc474aeSMyung Bae )) 395dd1c4a9cSSzymon Dompke { 396dd1c4a9cSSzymon Dompke return false; 397dd1c4a9cSSzymon Dompke } 398dd1c4a9cSSzymon Dompke 399dd1c4a9cSSzymon Dompke std::optional<std::chrono::milliseconds> dwellTime = 400dd1c4a9cSSzymon Dompke time_utils::fromDurationString(dwellTimeStr); 401dd1c4a9cSSzymon Dompke if (!dwellTime) 402dd1c4a9cSSzymon Dompke { 403dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "DwellTime", dwellTimeStr); 404dd1c4a9cSSzymon Dompke return false; 405dd1c4a9cSSzymon Dompke } 406dd1c4a9cSSzymon Dompke 407dd1c4a9cSSzymon Dompke std::string dbusSeverity = toDbusSeverity(severity); 408dd1c4a9cSSzymon Dompke if (dbusSeverity.empty()) 409dd1c4a9cSSzymon Dompke { 410dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "Severity", severity); 411dd1c4a9cSSzymon Dompke return false; 412dd1c4a9cSSzymon Dompke } 413dd1c4a9cSSzymon Dompke 414dd1c4a9cSSzymon Dompke parsedParams.emplace_back(*name, dbusSeverity, 415dd1c4a9cSSzymon Dompke static_cast<uint64_t>(dwellTime->count()), 416dd1c4a9cSSzymon Dompke value); 417dd1c4a9cSSzymon Dompke } 418dd1c4a9cSSzymon Dompke 419dd1c4a9cSSzymon Dompke ctx.thresholds = std::move(parsedParams); 420dd1c4a9cSSzymon Dompke return true; 421dd1c4a9cSSzymon Dompke } 422dd1c4a9cSSzymon Dompke 423dd1c4a9cSSzymon Dompke inline bool parseTriggerThresholds( 424dd1c4a9cSSzymon Dompke crow::Response& res, 4252932dcb6SEd Tanous std::optional<std::vector<nlohmann::json::object_t>>& discreteTriggers, 4262932dcb6SEd Tanous NumericThresholds& numericThresholds, Context& ctx) 427dd1c4a9cSSzymon Dompke { 4282932dcb6SEd Tanous if (discreteTriggers && numericThresholds.any()) 429dd1c4a9cSSzymon Dompke { 430dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "DiscreteTriggers", 431dd1c4a9cSSzymon Dompke "NumericThresholds"); 432dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "NumericThresholds", 433dd1c4a9cSSzymon Dompke "DiscreteTriggers"); 434dd1c4a9cSSzymon Dompke return false; 435dd1c4a9cSSzymon Dompke } 436dd1c4a9cSSzymon Dompke 437dd1c4a9cSSzymon Dompke if (ctx.discreteCondition) 438dd1c4a9cSSzymon Dompke { 4392932dcb6SEd Tanous if (numericThresholds.any()) 440dd1c4a9cSSzymon Dompke { 441dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "DiscreteTriggerCondition", 442dd1c4a9cSSzymon Dompke "NumericThresholds"); 443dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "NumericThresholds", 444dd1c4a9cSSzymon Dompke "DiscreteTriggerCondition"); 445dd1c4a9cSSzymon Dompke return false; 446dd1c4a9cSSzymon Dompke } 447dd1c4a9cSSzymon Dompke } 448dd1c4a9cSSzymon Dompke 449dd1c4a9cSSzymon Dompke if (ctx.metricType) 450dd1c4a9cSSzymon Dompke { 4512932dcb6SEd Tanous if (*ctx.metricType == MetricType::Discrete && numericThresholds.any()) 452dd1c4a9cSSzymon Dompke { 453dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "NumericThresholds", 454dd1c4a9cSSzymon Dompke "MetricType"); 455dd1c4a9cSSzymon Dompke return false; 456dd1c4a9cSSzymon Dompke } 457dd1c4a9cSSzymon Dompke if (*ctx.metricType == MetricType::Numeric && discreteTriggers) 458dd1c4a9cSSzymon Dompke { 459dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "DiscreteTriggers", 460dd1c4a9cSSzymon Dompke "MetricType"); 461dd1c4a9cSSzymon Dompke return false; 462dd1c4a9cSSzymon Dompke } 463dd1c4a9cSSzymon Dompke if (*ctx.metricType == MetricType::Numeric && ctx.discreteCondition) 464dd1c4a9cSSzymon Dompke { 465dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "DiscreteTriggers", 466dd1c4a9cSSzymon Dompke "DiscreteTriggerCondition"); 467dd1c4a9cSSzymon Dompke return false; 468dd1c4a9cSSzymon Dompke } 469dd1c4a9cSSzymon Dompke } 470dd1c4a9cSSzymon Dompke 471dd1c4a9cSSzymon Dompke if (discreteTriggers || ctx.discreteCondition || 472dd1c4a9cSSzymon Dompke (ctx.metricType && *ctx.metricType == MetricType::Discrete)) 473dd1c4a9cSSzymon Dompke { 474dd1c4a9cSSzymon Dompke if (ctx.discreteCondition) 475dd1c4a9cSSzymon Dompke { 476dd1c4a9cSSzymon Dompke if (*ctx.discreteCondition == DiscreteCondition::Specified && 477dd1c4a9cSSzymon Dompke !discreteTriggers) 478dd1c4a9cSSzymon Dompke { 479dd1c4a9cSSzymon Dompke messages::createFailedMissingReqProperties(res, 480dd1c4a9cSSzymon Dompke "DiscreteTriggers"); 481dd1c4a9cSSzymon Dompke return false; 482dd1c4a9cSSzymon Dompke } 483dd1c4a9cSSzymon Dompke if (discreteTriggers && 484dd1c4a9cSSzymon Dompke ((*ctx.discreteCondition == DiscreteCondition::Specified && 485dd1c4a9cSSzymon Dompke discreteTriggers->empty()) || 486dd1c4a9cSSzymon Dompke (*ctx.discreteCondition == DiscreteCondition::Changed && 487dd1c4a9cSSzymon Dompke !discreteTriggers->empty()))) 488dd1c4a9cSSzymon Dompke { 489dd1c4a9cSSzymon Dompke messages::propertyValueConflict(res, "DiscreteTriggers", 490dd1c4a9cSSzymon Dompke "DiscreteTriggerCondition"); 491dd1c4a9cSSzymon Dompke return false; 492dd1c4a9cSSzymon Dompke } 493dd1c4a9cSSzymon Dompke } 494dd1c4a9cSSzymon Dompke if (!parseDiscreteTriggers(res, discreteTriggers, ctx)) 495dd1c4a9cSSzymon Dompke { 496dd1c4a9cSSzymon Dompke return false; 497dd1c4a9cSSzymon Dompke } 498dd1c4a9cSSzymon Dompke } 4992932dcb6SEd Tanous else if (numericThresholds.any()) 500dd1c4a9cSSzymon Dompke { 5012932dcb6SEd Tanous if (!parseNumericThresholds(res, numericThresholds, ctx)) 502dd1c4a9cSSzymon Dompke { 503dd1c4a9cSSzymon Dompke return false; 504dd1c4a9cSSzymon Dompke } 505dd1c4a9cSSzymon Dompke } 506dd1c4a9cSSzymon Dompke else 507dd1c4a9cSSzymon Dompke { 508dd1c4a9cSSzymon Dompke messages::createFailedMissingReqProperties( 509dd1c4a9cSSzymon Dompke res, "'DiscreteTriggers', 'NumericThresholds', " 510dd1c4a9cSSzymon Dompke "'DiscreteTriggerCondition' or 'MetricType'"); 511dd1c4a9cSSzymon Dompke return false; 512dd1c4a9cSSzymon Dompke } 513dd1c4a9cSSzymon Dompke return true; 514dd1c4a9cSSzymon Dompke } 515dd1c4a9cSSzymon Dompke 5162932dcb6SEd Tanous inline bool parseLinks(crow::Response& res, 5172932dcb6SEd Tanous const std::vector<std::string>& metricReportDefinitions, 5182932dcb6SEd Tanous Context& ctx) 519dd1c4a9cSSzymon Dompke { 5202932dcb6SEd Tanous ctx.reports.reserve(metricReportDefinitions.size()); 5212932dcb6SEd Tanous for (const std::string& reportDefinionUri : metricReportDefinitions) 522dd1c4a9cSSzymon Dompke { 523dd1c4a9cSSzymon Dompke std::optional<sdbusplus::message::object_path> reportPath = 524dd1c4a9cSSzymon Dompke getReportPathFromReportDefinitionUri(reportDefinionUri); 525dd1c4a9cSSzymon Dompke if (!reportPath) 526dd1c4a9cSSzymon Dompke { 527dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "MetricReportDefinitions", 528dd1c4a9cSSzymon Dompke reportDefinionUri); 529dd1c4a9cSSzymon Dompke return false; 530dd1c4a9cSSzymon Dompke } 531dd1c4a9cSSzymon Dompke ctx.reports.emplace_back(*reportPath); 532dd1c4a9cSSzymon Dompke } 533dd1c4a9cSSzymon Dompke return true; 534dd1c4a9cSSzymon Dompke } 535dd1c4a9cSSzymon Dompke 536dd1c4a9cSSzymon Dompke inline bool parseMetricProperties(crow::Response& res, Context& ctx) 537dd1c4a9cSSzymon Dompke { 538dd1c4a9cSSzymon Dompke if (!ctx.metricProperties) 539dd1c4a9cSSzymon Dompke { 540dd1c4a9cSSzymon Dompke return true; 541dd1c4a9cSSzymon Dompke } 542dd1c4a9cSSzymon Dompke 543dd1c4a9cSSzymon Dompke ctx.sensors.reserve(ctx.metricProperties->size()); 544dd1c4a9cSSzymon Dompke 545dd1c4a9cSSzymon Dompke size_t uriIdx = 0; 546dd1c4a9cSSzymon Dompke for (const std::string& uriStr : *ctx.metricProperties) 547dd1c4a9cSSzymon Dompke { 5484a7fbefdSEd Tanous boost::system::result<boost::urls::url> uri = 549dd1c4a9cSSzymon Dompke boost::urls::parse_relative_ref(uriStr); 550dd1c4a9cSSzymon Dompke if (!uri) 551dd1c4a9cSSzymon Dompke { 552dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect( 553dd1c4a9cSSzymon Dompke res, "MetricProperties/" + std::to_string(uriIdx), uriStr); 554dd1c4a9cSSzymon Dompke return false; 555dd1c4a9cSSzymon Dompke } 556dd1c4a9cSSzymon Dompke std::string chassisName; 557dd1c4a9cSSzymon Dompke std::string sensorName; 558dd1c4a9cSSzymon Dompke if (!crow::utility::readUrlSegments(*uri, "redfish", "v1", "Chassis", 559dd1c4a9cSSzymon Dompke std::ref(chassisName), "Sensors", 560dd1c4a9cSSzymon Dompke std::ref(sensorName))) 561dd1c4a9cSSzymon Dompke { 562dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect( 563dd1c4a9cSSzymon Dompke res, "MetricProperties/" + std::to_string(uriIdx), uriStr); 564dd1c4a9cSSzymon Dompke return false; 565dd1c4a9cSSzymon Dompke } 566dd1c4a9cSSzymon Dompke 567dd1c4a9cSSzymon Dompke std::pair<std::string, std::string> split = 5681516c21bSJanet Adkins redfish::sensor_utils::splitSensorNameAndType(sensorName); 569dd1c4a9cSSzymon Dompke if (split.first.empty() || split.second.empty()) 570dd1c4a9cSSzymon Dompke { 571dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect( 572dd1c4a9cSSzymon Dompke res, "MetricProperties/" + std::to_string(uriIdx), uriStr); 573dd1c4a9cSSzymon Dompke return false; 574dd1c4a9cSSzymon Dompke } 575dd1c4a9cSSzymon Dompke 576bd79bce8SPatrick Williams std::string sensorPath = 577bd79bce8SPatrick Williams "/xyz/openbmc_project/sensors/" + split.first + '/' + split.second; 578dd1c4a9cSSzymon Dompke 579dd1c4a9cSSzymon Dompke ctx.sensors.emplace_back(sensorPath, uriStr); 580dd1c4a9cSSzymon Dompke uriIdx++; 581dd1c4a9cSSzymon Dompke } 582dd1c4a9cSSzymon Dompke return true; 583dd1c4a9cSSzymon Dompke } 584dd1c4a9cSSzymon Dompke 585dd1c4a9cSSzymon Dompke inline bool parsePostTriggerParams(crow::Response& res, 586dd1c4a9cSSzymon Dompke const crow::Request& req, Context& ctx) 587dd1c4a9cSSzymon Dompke { 588dd1c4a9cSSzymon Dompke std::optional<std::string> id = ""; 589dd1c4a9cSSzymon Dompke std::optional<std::string> name = ""; 590dd1c4a9cSSzymon Dompke std::optional<std::string> metricType; 591dd1c4a9cSSzymon Dompke std::optional<std::vector<std::string>> triggerActions; 592dd1c4a9cSSzymon Dompke std::optional<std::string> discreteTriggerCondition; 5932932dcb6SEd Tanous std::optional<std::vector<nlohmann::json::object_t>> discreteTriggers; 5942932dcb6SEd Tanous std::optional<std::vector<std::string>> metricReportDefinitions; 5952932dcb6SEd Tanous NumericThresholds thresholds; 596afc474aeSMyung Bae 597afc474aeSMyung Bae if (!json_util::readJsonPatch( // 598afc474aeSMyung Bae req, res, // 599afc474aeSMyung Bae "Id", id, // 600afc474aeSMyung Bae "DiscreteTriggerCondition", discreteTriggerCondition, // 601afc474aeSMyung Bae "DiscreteTriggers", discreteTriggers, // 602afc474aeSMyung Bae "Links/MetricReportDefinitions", metricReportDefinitions, // 603afc474aeSMyung Bae "MetricProperties", ctx.metricProperties, // 604afc474aeSMyung Bae "MetricType", metricType, // 605afc474aeSMyung Bae "Name", name, // 606afc474aeSMyung Bae "NumericThresholds/LowerCritical", thresholds.lowerCritical, // 607afc474aeSMyung Bae "NumericThresholds/LowerWarning", thresholds.lowerWarning, // 608afc474aeSMyung Bae "NumericThresholds/UpperCritical", thresholds.upperCritical, // 609afc474aeSMyung Bae "NumericThresholds/UpperWarning", thresholds.upperWarning, // 610afc474aeSMyung Bae "TriggerActions", triggerActions // 611afc474aeSMyung Bae )) 612dd1c4a9cSSzymon Dompke { 613dd1c4a9cSSzymon Dompke return false; 614dd1c4a9cSSzymon Dompke } 615dd1c4a9cSSzymon Dompke 616dd1c4a9cSSzymon Dompke ctx.id = *id; 617dd1c4a9cSSzymon Dompke ctx.name = *name; 618dd1c4a9cSSzymon Dompke 619dd1c4a9cSSzymon Dompke if (metricType) 620dd1c4a9cSSzymon Dompke { 621d5736ef2SEd Tanous ctx.metricType = getMetricType(*metricType); 622d5736ef2SEd Tanous if (!ctx.metricType) 623dd1c4a9cSSzymon Dompke { 624dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "MetricType", *metricType); 625dd1c4a9cSSzymon Dompke return false; 626dd1c4a9cSSzymon Dompke } 627dd1c4a9cSSzymon Dompke } 628dd1c4a9cSSzymon Dompke 629dd1c4a9cSSzymon Dompke if (discreteTriggerCondition) 630dd1c4a9cSSzymon Dompke { 631d5736ef2SEd Tanous ctx.discreteCondition = getDiscreteCondition(*discreteTriggerCondition); 632d5736ef2SEd Tanous if (!ctx.discreteCondition) 633dd1c4a9cSSzymon Dompke { 634dd1c4a9cSSzymon Dompke messages::propertyValueIncorrect(res, "DiscreteTriggerCondition", 635dd1c4a9cSSzymon Dompke *discreteTriggerCondition); 636dd1c4a9cSSzymon Dompke return false; 637dd1c4a9cSSzymon Dompke } 638dd1c4a9cSSzymon Dompke } 639dd1c4a9cSSzymon Dompke 640dd1c4a9cSSzymon Dompke if (triggerActions) 641dd1c4a9cSSzymon Dompke { 642dd1c4a9cSSzymon Dompke ctx.actions.reserve(triggerActions->size()); 643dd1c4a9cSSzymon Dompke for (const std::string& action : *triggerActions) 644dd1c4a9cSSzymon Dompke { 645dd1c4a9cSSzymon Dompke std::string dbusAction = toDbusTriggerAction(action); 646dd1c4a9cSSzymon Dompke 647dd1c4a9cSSzymon Dompke if (dbusAction.empty()) 648dd1c4a9cSSzymon Dompke { 649dd1c4a9cSSzymon Dompke messages::propertyValueNotInList(res, action, "TriggerActions"); 650dd1c4a9cSSzymon Dompke return false; 651dd1c4a9cSSzymon Dompke } 652dd1c4a9cSSzymon Dompke 653dd1c4a9cSSzymon Dompke ctx.actions.emplace_back(dbusAction); 654dd1c4a9cSSzymon Dompke } 655dd1c4a9cSSzymon Dompke } 656dd1c4a9cSSzymon Dompke if (!parseMetricProperties(res, ctx)) 657dd1c4a9cSSzymon Dompke { 658dd1c4a9cSSzymon Dompke return false; 659dd1c4a9cSSzymon Dompke } 660dd1c4a9cSSzymon Dompke 6612932dcb6SEd Tanous if (!parseTriggerThresholds(res, discreteTriggers, thresholds, ctx)) 662dd1c4a9cSSzymon Dompke { 663dd1c4a9cSSzymon Dompke return false; 664dd1c4a9cSSzymon Dompke } 665dd1c4a9cSSzymon Dompke 6662932dcb6SEd Tanous if (metricReportDefinitions) 667dd1c4a9cSSzymon Dompke { 6682932dcb6SEd Tanous if (!parseLinks(res, *metricReportDefinitions, ctx)) 669dd1c4a9cSSzymon Dompke { 670dd1c4a9cSSzymon Dompke return false; 671dd1c4a9cSSzymon Dompke } 672dd1c4a9cSSzymon Dompke } 673dd1c4a9cSSzymon Dompke return true; 674dd1c4a9cSSzymon Dompke } 675dd1c4a9cSSzymon Dompke 676dd1c4a9cSSzymon Dompke inline void afterCreateTrigger( 677dd1c4a9cSSzymon Dompke const boost::system::error_code& ec, const std::string& dbusPath, 678dd1c4a9cSSzymon Dompke const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, const std::string& id) 679dd1c4a9cSSzymon Dompke { 680dd1c4a9cSSzymon Dompke if (ec == boost::system::errc::file_exists) 681dd1c4a9cSSzymon Dompke { 682dd1c4a9cSSzymon Dompke messages::resourceAlreadyExists(asyncResp->res, "Trigger", "Id", id); 683dd1c4a9cSSzymon Dompke return; 684dd1c4a9cSSzymon Dompke } 685dd1c4a9cSSzymon Dompke if (ec == boost::system::errc::too_many_files_open) 686dd1c4a9cSSzymon Dompke { 687dd1c4a9cSSzymon Dompke messages::createLimitReachedForResource(asyncResp->res); 688dd1c4a9cSSzymon Dompke return; 689dd1c4a9cSSzymon Dompke } 690dd1c4a9cSSzymon Dompke if (ec) 691dd1c4a9cSSzymon Dompke { 692dd1c4a9cSSzymon Dompke messages::internalError(asyncResp->res); 69362598e31SEd Tanous BMCWEB_LOG_ERROR("respHandler DBus error {}", ec); 694dd1c4a9cSSzymon Dompke return; 695dd1c4a9cSSzymon Dompke } 696dd1c4a9cSSzymon Dompke 697dd1c4a9cSSzymon Dompke const std::optional<std::string>& triggerId = 698dd1c4a9cSSzymon Dompke getTriggerIdFromDbusPath(dbusPath); 699dd1c4a9cSSzymon Dompke if (!triggerId) 700dd1c4a9cSSzymon Dompke { 701dd1c4a9cSSzymon Dompke messages::internalError(asyncResp->res); 70262598e31SEd Tanous BMCWEB_LOG_ERROR("Unknown data returned by " 70362598e31SEd Tanous "AddTrigger DBus method"); 704dd1c4a9cSSzymon Dompke return; 705dd1c4a9cSSzymon Dompke } 706dd1c4a9cSSzymon Dompke 707dd1c4a9cSSzymon Dompke messages::created(asyncResp->res); 708dd1c4a9cSSzymon Dompke boost::urls::url locationUrl = boost::urls::format( 709dd1c4a9cSSzymon Dompke "/redfish/v1/TelemetryService/Triggers/{}", *triggerId); 710dd1c4a9cSSzymon Dompke asyncResp->res.addHeader("Location", locationUrl.buffer()); 711dd1c4a9cSSzymon Dompke } 712dd1c4a9cSSzymon Dompke 713dd1c4a9cSSzymon Dompke inline std::optional<nlohmann::json::array_t> 714dd1c4a9cSSzymon Dompke getTriggerActions(const std::vector<std::string>& dbusActions) 715dd1c4a9cSSzymon Dompke { 716dd1c4a9cSSzymon Dompke nlohmann::json::array_t triggerActions; 717dd1c4a9cSSzymon Dompke for (const std::string& dbusAction : dbusActions) 718dd1c4a9cSSzymon Dompke { 719dd1c4a9cSSzymon Dompke triggers::TriggerActionEnum redfishAction = 720dd1c4a9cSSzymon Dompke toRedfishTriggerAction(dbusAction); 721dd1c4a9cSSzymon Dompke 722dd1c4a9cSSzymon Dompke if (redfishAction == triggers::TriggerActionEnum::Invalid) 723dd1c4a9cSSzymon Dompke { 724dd1c4a9cSSzymon Dompke return std::nullopt; 725dd1c4a9cSSzymon Dompke } 726dd1c4a9cSSzymon Dompke 727dd1c4a9cSSzymon Dompke triggerActions.emplace_back(redfishAction); 728dd1c4a9cSSzymon Dompke } 729dd1c4a9cSSzymon Dompke 730dd1c4a9cSSzymon Dompke return triggerActions; 7311b7e696bSLukasz Kazmierczak } 7321b7e696bSLukasz Kazmierczak 7333f215c92SSzymon Dompke inline std::optional<nlohmann::json::array_t> 734*e3648032SEd Tanous getDiscreteTriggers(const TriggerThresholdParams& thresholdParams) 7351b7e696bSLukasz Kazmierczak { 736dd1c4a9cSSzymon Dompke nlohmann::json::array_t triggers; 7371b7e696bSLukasz Kazmierczak const std::vector<DiscreteThresholdParams>* discreteParams = 7381b7e696bSLukasz Kazmierczak std::get_if<std::vector<DiscreteThresholdParams>>(&thresholdParams); 7391b7e696bSLukasz Kazmierczak 740e662eae8SEd Tanous if (discreteParams == nullptr) 7411b7e696bSLukasz Kazmierczak { 7421b7e696bSLukasz Kazmierczak return std::nullopt; 7431b7e696bSLukasz Kazmierczak } 7441b7e696bSLukasz Kazmierczak 7451b7e696bSLukasz Kazmierczak for (const auto& [name, severity, dwellTime, value] : *discreteParams) 7461b7e696bSLukasz Kazmierczak { 7471b7e696bSLukasz Kazmierczak std::optional<std::string> duration = 7481b7e696bSLukasz Kazmierczak time_utils::toDurationStringFromUint(dwellTime); 7491b7e696bSLukasz Kazmierczak 7501b7e696bSLukasz Kazmierczak if (!duration) 7511b7e696bSLukasz Kazmierczak { 7521b7e696bSLukasz Kazmierczak return std::nullopt; 7531b7e696bSLukasz Kazmierczak } 754613dabeaSEd Tanous nlohmann::json::object_t trigger; 755613dabeaSEd Tanous trigger["Name"] = name; 756dd1c4a9cSSzymon Dompke trigger["Severity"] = toRedfishSeverity(severity); 757613dabeaSEd Tanous trigger["DwellTime"] = *duration; 758613dabeaSEd Tanous trigger["Value"] = value; 759ad539545SPatrick Williams triggers.emplace_back(std::move(trigger)); 7601b7e696bSLukasz Kazmierczak } 7611b7e696bSLukasz Kazmierczak 762dd1c4a9cSSzymon Dompke return triggers; 7631b7e696bSLukasz Kazmierczak } 7641b7e696bSLukasz Kazmierczak 7651b7e696bSLukasz Kazmierczak inline std::optional<nlohmann::json> 766*e3648032SEd Tanous getNumericThresholds(const TriggerThresholdParams& thresholdParams) 7671b7e696bSLukasz Kazmierczak { 768dd1c4a9cSSzymon Dompke nlohmann::json::object_t thresholds; 7691b7e696bSLukasz Kazmierczak const std::vector<NumericThresholdParams>* numericParams = 7701b7e696bSLukasz Kazmierczak std::get_if<std::vector<NumericThresholdParams>>(&thresholdParams); 7711b7e696bSLukasz Kazmierczak 772e662eae8SEd Tanous if (numericParams == nullptr) 7731b7e696bSLukasz Kazmierczak { 7741b7e696bSLukasz Kazmierczak return std::nullopt; 7751b7e696bSLukasz Kazmierczak } 7761b7e696bSLukasz Kazmierczak 7771b7e696bSLukasz Kazmierczak for (const auto& [type, dwellTime, activation, reading] : *numericParams) 7781b7e696bSLukasz Kazmierczak { 7791b7e696bSLukasz Kazmierczak std::optional<std::string> duration = 7801b7e696bSLukasz Kazmierczak time_utils::toDurationStringFromUint(dwellTime); 7811b7e696bSLukasz Kazmierczak 7821b7e696bSLukasz Kazmierczak if (!duration) 7831b7e696bSLukasz Kazmierczak { 7841b7e696bSLukasz Kazmierczak return std::nullopt; 7851b7e696bSLukasz Kazmierczak } 786dd1c4a9cSSzymon Dompke nlohmann::json& threshold = thresholds[toRedfishThresholdName(type)]; 7871476687dSEd Tanous threshold["Reading"] = reading; 788dd1c4a9cSSzymon Dompke threshold["Activation"] = toRedfishActivation(activation); 7891476687dSEd Tanous threshold["DwellTime"] = *duration; 7901b7e696bSLukasz Kazmierczak } 7911b7e696bSLukasz Kazmierczak 792dd1c4a9cSSzymon Dompke return thresholds; 7931b7e696bSLukasz Kazmierczak } 7941b7e696bSLukasz Kazmierczak 7953f215c92SSzymon Dompke inline std::optional<nlohmann::json> getMetricReportDefinitions( 7963f215c92SSzymon Dompke const std::vector<sdbusplus::message::object_path>& reportPaths) 7971b7e696bSLukasz Kazmierczak { 7981b7e696bSLukasz Kazmierczak nlohmann::json reports = nlohmann::json::array(); 7993f215c92SSzymon Dompke 8003f215c92SSzymon Dompke for (const sdbusplus::message::object_path& path : reportPaths) 8011b7e696bSLukasz Kazmierczak { 8023f215c92SSzymon Dompke std::string reportId = path.filename(); 8033f215c92SSzymon Dompke if (reportId.empty()) 8043f215c92SSzymon Dompke { 8053f215c92SSzymon Dompke { 80662598e31SEd Tanous BMCWEB_LOG_ERROR("Property Reports contains invalid value: {}", 80762598e31SEd Tanous path.str); 8083f215c92SSzymon Dompke return std::nullopt; 8093f215c92SSzymon Dompke } 8103f215c92SSzymon Dompke } 8113f215c92SSzymon Dompke 8121476687dSEd Tanous nlohmann::json::object_t report; 813ef4c65b7SEd Tanous report["@odata.id"] = boost::urls::format( 814ef4c65b7SEd Tanous "/redfish/v1/TelemetryService/MetricReportDefinitions/{}", 815ef4c65b7SEd Tanous reportId); 816b2ba3072SPatrick Williams reports.emplace_back(std::move(report)); 8171b7e696bSLukasz Kazmierczak } 8181b7e696bSLukasz Kazmierczak 8193f215c92SSzymon Dompke return {std::move(reports)}; 8201b7e696bSLukasz Kazmierczak } 8211b7e696bSLukasz Kazmierczak 8221b7e696bSLukasz Kazmierczak inline std::vector<std::string> 8231b7e696bSLukasz Kazmierczak getMetricProperties(const TriggerSensorsParams& sensors) 8241b7e696bSLukasz Kazmierczak { 8251b7e696bSLukasz Kazmierczak std::vector<std::string> metricProperties; 8261b7e696bSLukasz Kazmierczak metricProperties.reserve(sensors.size()); 8271b7e696bSLukasz Kazmierczak for (const auto& [_, metadata] : sensors) 8281b7e696bSLukasz Kazmierczak { 8291b7e696bSLukasz Kazmierczak metricProperties.emplace_back(metadata); 8301b7e696bSLukasz Kazmierczak } 8311b7e696bSLukasz Kazmierczak 8321b7e696bSLukasz Kazmierczak return metricProperties; 8331b7e696bSLukasz Kazmierczak } 8341b7e696bSLukasz Kazmierczak 835*e3648032SEd Tanous inline bool fillTrigger(nlohmann::json& json, const std::string& id, 836*e3648032SEd Tanous const dbus::utility::DBusPropertiesMap& properties) 8371b7e696bSLukasz Kazmierczak { 8381b7e696bSLukasz Kazmierczak const std::string* name = nullptr; 8391b7e696bSLukasz Kazmierczak const bool* discrete = nullptr; 8401b7e696bSLukasz Kazmierczak const TriggerSensorsParams* sensors = nullptr; 8413f215c92SSzymon Dompke const std::vector<sdbusplus::message::object_path>* reports = nullptr; 84289474494SKrzysztof Grobelny const std::vector<std::string>* triggerActions = nullptr; 843*e3648032SEd Tanous const TriggerThresholdParams* thresholds = nullptr; 8441b7e696bSLukasz Kazmierczak 84589474494SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 84689474494SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), properties, "Name", name, "Discrete", 84789474494SKrzysztof Grobelny discrete, "Sensors", sensors, "Reports", reports, "TriggerActions", 84889474494SKrzysztof Grobelny triggerActions, "Thresholds", thresholds); 84989474494SKrzysztof Grobelny 85089474494SKrzysztof Grobelny if (!success) 8511b7e696bSLukasz Kazmierczak { 85289474494SKrzysztof Grobelny return false; 8531b7e696bSLukasz Kazmierczak } 8541b7e696bSLukasz Kazmierczak 85589474494SKrzysztof Grobelny if (triggerActions != nullptr) 85689474494SKrzysztof Grobelny { 857dd1c4a9cSSzymon Dompke std::optional<nlohmann::json::array_t> redfishTriggerActions = 85889474494SKrzysztof Grobelny getTriggerActions(*triggerActions); 85989474494SKrzysztof Grobelny if (!redfishTriggerActions) 8601b7e696bSLukasz Kazmierczak { 86162598e31SEd Tanous BMCWEB_LOG_ERROR( 86262598e31SEd Tanous "Property TriggerActions is invalid in Trigger: {}", id); 8631b7e696bSLukasz Kazmierczak return false; 8641b7e696bSLukasz Kazmierczak } 865dd1c4a9cSSzymon Dompke json["TriggerActions"] = *redfishTriggerActions; 86689474494SKrzysztof Grobelny } 8671b7e696bSLukasz Kazmierczak 86889474494SKrzysztof Grobelny if (reports != nullptr) 8693f215c92SSzymon Dompke { 8703f215c92SSzymon Dompke std::optional<nlohmann::json> linkedReports = 8713f215c92SSzymon Dompke getMetricReportDefinitions(*reports); 8723f215c92SSzymon Dompke if (!linkedReports) 8733f215c92SSzymon Dompke { 87462598e31SEd Tanous BMCWEB_LOG_ERROR("Property Reports is invalid in Trigger: {}", id); 8753f215c92SSzymon Dompke return false; 8763f215c92SSzymon Dompke } 87789474494SKrzysztof Grobelny json["Links"]["MetricReportDefinitions"] = *linkedReports; 87889474494SKrzysztof Grobelny } 8791b7e696bSLukasz Kazmierczak 88089474494SKrzysztof Grobelny if (discrete != nullptr) 88189474494SKrzysztof Grobelny { 8821b7e696bSLukasz Kazmierczak if (*discrete) 8831b7e696bSLukasz Kazmierczak { 8843f215c92SSzymon Dompke std::optional<nlohmann::json::array_t> discreteTriggers = 8851b7e696bSLukasz Kazmierczak getDiscreteTriggers(*thresholds); 8861b7e696bSLukasz Kazmierczak 8871b7e696bSLukasz Kazmierczak if (!discreteTriggers) 8881b7e696bSLukasz Kazmierczak { 88962598e31SEd Tanous BMCWEB_LOG_ERROR("Property Thresholds is invalid for discrete " 89062598e31SEd Tanous "triggers in Trigger: {}", 89162598e31SEd Tanous id); 8921b7e696bSLukasz Kazmierczak return false; 8931b7e696bSLukasz Kazmierczak } 8941b7e696bSLukasz Kazmierczak 8951b7e696bSLukasz Kazmierczak json["DiscreteTriggers"] = *discreteTriggers; 8961b7e696bSLukasz Kazmierczak json["DiscreteTriggerCondition"] = 8971b7e696bSLukasz Kazmierczak discreteTriggers->empty() ? "Changed" : "Specified"; 898539d8c6bSEd Tanous json["MetricType"] = metric_definition::MetricType::Discrete; 8991b7e696bSLukasz Kazmierczak } 9001b7e696bSLukasz Kazmierczak else 9011b7e696bSLukasz Kazmierczak { 9021b7e696bSLukasz Kazmierczak std::optional<nlohmann::json> numericThresholds = 9031b7e696bSLukasz Kazmierczak getNumericThresholds(*thresholds); 9041b7e696bSLukasz Kazmierczak 9051b7e696bSLukasz Kazmierczak if (!numericThresholds) 9061b7e696bSLukasz Kazmierczak { 90762598e31SEd Tanous BMCWEB_LOG_ERROR("Property Thresholds is invalid for numeric " 90862598e31SEd Tanous "thresholds in Trigger: {}", 90962598e31SEd Tanous id); 9101b7e696bSLukasz Kazmierczak return false; 9111b7e696bSLukasz Kazmierczak } 9121b7e696bSLukasz Kazmierczak 9131b7e696bSLukasz Kazmierczak json["NumericThresholds"] = *numericThresholds; 914539d8c6bSEd Tanous json["MetricType"] = metric_definition::MetricType::Numeric; 9151b7e696bSLukasz Kazmierczak } 91689474494SKrzysztof Grobelny } 91789474494SKrzysztof Grobelny 91889474494SKrzysztof Grobelny if (name != nullptr) 91989474494SKrzysztof Grobelny { 92089474494SKrzysztof Grobelny json["Name"] = *name; 92189474494SKrzysztof Grobelny } 92289474494SKrzysztof Grobelny 92389474494SKrzysztof Grobelny if (sensors != nullptr) 92489474494SKrzysztof Grobelny { 92589474494SKrzysztof Grobelny json["MetricProperties"] = getMetricProperties(*sensors); 92689474494SKrzysztof Grobelny } 9271b7e696bSLukasz Kazmierczak 9283f215c92SSzymon Dompke json["@odata.type"] = "#Triggers.v1_2_0.Triggers"; 929ef4c65b7SEd Tanous json["@odata.id"] = 930ef4c65b7SEd Tanous boost::urls::format("/redfish/v1/TelemetryService/Triggers/{}", id); 9313f215c92SSzymon Dompke json["Id"] = id; 9321b7e696bSLukasz Kazmierczak 9331b7e696bSLukasz Kazmierczak return true; 9341b7e696bSLukasz Kazmierczak } 9351b7e696bSLukasz Kazmierczak 936dd1c4a9cSSzymon Dompke inline void handleTriggerCollectionPost( 937dd1c4a9cSSzymon Dompke App& app, const crow::Request& req, 938dd1c4a9cSSzymon Dompke const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 939dd1c4a9cSSzymon Dompke { 940dd1c4a9cSSzymon Dompke if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 941dd1c4a9cSSzymon Dompke { 942dd1c4a9cSSzymon Dompke return; 943dd1c4a9cSSzymon Dompke } 944dd1c4a9cSSzymon Dompke 945dd1c4a9cSSzymon Dompke telemetry::Context ctx; 946dd1c4a9cSSzymon Dompke if (!telemetry::parsePostTriggerParams(asyncResp->res, req, ctx)) 947dd1c4a9cSSzymon Dompke { 948dd1c4a9cSSzymon Dompke return; 949dd1c4a9cSSzymon Dompke } 950dd1c4a9cSSzymon Dompke 951dd1c4a9cSSzymon Dompke crow::connections::systemBus->async_method_call( 952dd1c4a9cSSzymon Dompke [asyncResp, id = ctx.id](const boost::system::error_code& ec, 953dd1c4a9cSSzymon Dompke const std::string& dbusPath) { 954dd1c4a9cSSzymon Dompke afterCreateTrigger(ec, dbusPath, asyncResp, id); 955dd1c4a9cSSzymon Dompke }, 956dd1c4a9cSSzymon Dompke service, "/xyz/openbmc_project/Telemetry/Triggers", 957dd1c4a9cSSzymon Dompke "xyz.openbmc_project.Telemetry.TriggerManager", "AddTrigger", 958dd1c4a9cSSzymon Dompke "TelemetryService/" + ctx.id, ctx.name, ctx.actions, ctx.sensors, 959dd1c4a9cSSzymon Dompke ctx.reports, ctx.thresholds); 960dd1c4a9cSSzymon Dompke } 961dd1c4a9cSSzymon Dompke 96207148cf2SLukasz Kazmierczak } // namespace telemetry 96307148cf2SLukasz Kazmierczak 96407148cf2SLukasz Kazmierczak inline void requestRoutesTriggerCollection(App& app) 96507148cf2SLukasz Kazmierczak { 96607148cf2SLukasz Kazmierczak BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/Triggers/") 96707148cf2SLukasz Kazmierczak .privileges(redfish::privileges::getTriggersCollection) 96807148cf2SLukasz Kazmierczak .methods(boost::beast::http::verb::get)( 96945ca1b86SEd Tanous [&app](const crow::Request& req, 97007148cf2SLukasz Kazmierczak const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { 9713ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 97245ca1b86SEd Tanous { 97345ca1b86SEd Tanous return; 97445ca1b86SEd Tanous } 97507148cf2SLukasz Kazmierczak asyncResp->res.jsonValue["@odata.type"] = 97607148cf2SLukasz Kazmierczak "#TriggersCollection.TriggersCollection"; 977ae9031f0SWilly Tu asyncResp->res.jsonValue["@odata.id"] = 978ae9031f0SWilly Tu "/redfish/v1/TelemetryService/Triggers"; 97907148cf2SLukasz Kazmierczak asyncResp->res.jsonValue["Name"] = "Triggers Collection"; 9807a1dbc48SGeorge Liu constexpr std::array<std::string_view, 1> interfaces{ 9817a1dbc48SGeorge Liu telemetry::triggerInterface}; 98207148cf2SLukasz Kazmierczak collection_util::getCollectionMembers( 983ae9031f0SWilly Tu asyncResp, 984ae9031f0SWilly Tu boost::urls::url("/redfish/v1/TelemetryService/Triggers"), 985ae9031f0SWilly Tu interfaces, 98607148cf2SLukasz Kazmierczak "/xyz/openbmc_project/Telemetry/Triggers/TelemetryService"); 98707148cf2SLukasz Kazmierczak }); 988dd1c4a9cSSzymon Dompke 989dd1c4a9cSSzymon Dompke BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/Triggers/") 990dd1c4a9cSSzymon Dompke .privileges(redfish::privileges::postTriggersCollection) 991dd1c4a9cSSzymon Dompke .methods(boost::beast::http::verb::post)(std::bind_front( 992dd1c4a9cSSzymon Dompke telemetry::handleTriggerCollectionPost, std::ref(app))); 99307148cf2SLukasz Kazmierczak } 99407148cf2SLukasz Kazmierczak 9951b7e696bSLukasz Kazmierczak inline void requestRoutesTrigger(App& app) 9961b7e696bSLukasz Kazmierczak { 9971b7e696bSLukasz Kazmierczak BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/Triggers/<str>/") 9981b7e696bSLukasz Kazmierczak .privileges(redfish::privileges::getTriggers) 9991b7e696bSLukasz Kazmierczak .methods(boost::beast::http::verb::get)( 100045ca1b86SEd Tanous [&app](const crow::Request& req, 10011b7e696bSLukasz Kazmierczak const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 10021b7e696bSLukasz Kazmierczak const std::string& id) { 10033ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 100445ca1b86SEd Tanous { 100545ca1b86SEd Tanous return; 100645ca1b86SEd Tanous } 100789474494SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 100889474494SKrzysztof Grobelny *crow::connections::systemBus, telemetry::service, 1009bd79bce8SPatrick Williams telemetry::getDbusTriggerPath(id), 1010bd79bce8SPatrick Williams telemetry::triggerInterface, 10111b7e696bSLukasz Kazmierczak [asyncResp, 10125e7e2dc5SEd Tanous id](const boost::system::error_code& ec, 1013*e3648032SEd Tanous const dbus::utility::DBusPropertiesMap& ret) { 10141b7e696bSLukasz Kazmierczak if (ec.value() == EBADR || 10151b7e696bSLukasz Kazmierczak ec == boost::system::errc::host_unreachable) 10161b7e696bSLukasz Kazmierczak { 1017bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 1018bd79bce8SPatrick Williams "Triggers", id); 10191b7e696bSLukasz Kazmierczak return; 10201b7e696bSLukasz Kazmierczak } 10211b7e696bSLukasz Kazmierczak if (ec) 10221b7e696bSLukasz Kazmierczak { 102362598e31SEd Tanous BMCWEB_LOG_ERROR("respHandler DBus error {}", ec); 10241b7e696bSLukasz Kazmierczak messages::internalError(asyncResp->res); 10251b7e696bSLukasz Kazmierczak return; 10261b7e696bSLukasz Kazmierczak } 10271b7e696bSLukasz Kazmierczak 1028bd79bce8SPatrick Williams if (!telemetry::fillTrigger(asyncResp->res.jsonValue, 1029bd79bce8SPatrick Williams id, ret)) 10301b7e696bSLukasz Kazmierczak { 10311b7e696bSLukasz Kazmierczak messages::internalError(asyncResp->res); 10321b7e696bSLukasz Kazmierczak } 103389474494SKrzysztof Grobelny }); 10341b7e696bSLukasz Kazmierczak }); 1035163994a8SSzymon Dompke 1036163994a8SSzymon Dompke BMCWEB_ROUTE(app, "/redfish/v1/TelemetryService/Triggers/<str>/") 1037163994a8SSzymon Dompke .privileges(redfish::privileges::deleteTriggers) 1038163994a8SSzymon Dompke .methods(boost::beast::http::verb::delete_)( 103945ca1b86SEd Tanous [&app](const crow::Request& req, 1040163994a8SSzymon Dompke const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1041163994a8SSzymon Dompke const std::string& id) { 10423ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 104345ca1b86SEd Tanous { 104445ca1b86SEd Tanous return; 104545ca1b86SEd Tanous } 1046bd79bce8SPatrick Williams const std::string triggerPath = 1047bd79bce8SPatrick Williams telemetry::getDbusTriggerPath(id); 1048163994a8SSzymon Dompke 1049163994a8SSzymon Dompke crow::connections::systemBus->async_method_call( 10505e7e2dc5SEd Tanous [asyncResp, id](const boost::system::error_code& ec) { 1051163994a8SSzymon Dompke if (ec.value() == EBADR) 1052163994a8SSzymon Dompke { 1053bd79bce8SPatrick Williams messages::resourceNotFound(asyncResp->res, 1054bd79bce8SPatrick Williams "Triggers", id); 1055163994a8SSzymon Dompke return; 1056163994a8SSzymon Dompke } 1057163994a8SSzymon Dompke 1058163994a8SSzymon Dompke if (ec) 1059163994a8SSzymon Dompke { 106062598e31SEd Tanous BMCWEB_LOG_ERROR("respHandler DBus error {}", ec); 1061163994a8SSzymon Dompke messages::internalError(asyncResp->res); 1062163994a8SSzymon Dompke return; 1063163994a8SSzymon Dompke } 1064163994a8SSzymon Dompke 1065bd79bce8SPatrick Williams asyncResp->res.result( 1066bd79bce8SPatrick Williams boost::beast::http::status::no_content); 1067163994a8SSzymon Dompke }, 1068163994a8SSzymon Dompke telemetry::service, triggerPath, 1069163994a8SSzymon Dompke "xyz.openbmc_project.Object.Delete", "Delete"); 1070163994a8SSzymon Dompke }); 10711b7e696bSLukasz Kazmierczak } 10721b7e696bSLukasz Kazmierczak 107307148cf2SLukasz Kazmierczak } // namespace redfish 1074