1b52664e2SAppaRao Puli /* 2b52664e2SAppaRao Puli // Copyright (c) 2020 Intel Corporation 3b52664e2SAppaRao Puli // 4b52664e2SAppaRao Puli // Licensed under the Apache License, Version 2.0 (the "License"); 5b52664e2SAppaRao Puli // you may not use this file except in compliance with the License. 6b52664e2SAppaRao Puli // You may obtain a copy of the License at 7b52664e2SAppaRao Puli // 8b52664e2SAppaRao Puli // http://www.apache.org/licenses/LICENSE-2.0 9b52664e2SAppaRao Puli // 10b52664e2SAppaRao Puli // Unless required by applicable law or agreed to in writing, software 11b52664e2SAppaRao Puli // distributed under the License is distributed on an "AS IS" BASIS, 12b52664e2SAppaRao Puli // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13b52664e2SAppaRao Puli // See the License for the specific language governing permissions and 14b52664e2SAppaRao Puli // limitations under the License. 15b52664e2SAppaRao Puli */ 16b52664e2SAppaRao Puli #pragma once 17b52664e2SAppaRao Puli #include "node.hpp" 187f4eb588SAppaRao Puli #include "registries.hpp" 197f4eb588SAppaRao Puli #include "registries/base_message_registry.hpp" 207f4eb588SAppaRao Puli #include "registries/openbmc_message_registry.hpp" 217f4eb588SAppaRao Puli 227f4eb588SAppaRao Puli #include <sys/inotify.h> 23b52664e2SAppaRao Puli 24fb4fd5d4SZhenfei Tai #include <boost/asio/io_context.hpp> 25b52664e2SAppaRao Puli #include <boost/container/flat_map.hpp> 261214b7e7SGunnar Mills #include <error_messages.hpp> 271214b7e7SGunnar Mills #include <http_client.hpp> 284bbf237fSAppaRao Puli #include <server_sent_events.hpp> 291214b7e7SGunnar Mills #include <utils/json_utils.hpp> 301214b7e7SGunnar Mills 31b52664e2SAppaRao Puli #include <cstdlib> 32b52664e2SAppaRao Puli #include <ctime> 331bf712bcSAyushi Smriti #include <fstream> 34b52664e2SAppaRao Puli #include <memory> 35b52664e2SAppaRao Puli #include <variant> 36b52664e2SAppaRao Puli 37b52664e2SAppaRao Puli namespace redfish 38b52664e2SAppaRao Puli { 39156d6b00SAppaRao Puli 40156d6b00SAppaRao Puli using ReadingsObjType = 4193f5d7c7SWludzik, Jozef std::vector<std::tuple<std::string, std::string, double, int32_t>>; 427d1cc387SAppaRao Puli using EventServiceConfig = std::tuple<bool, uint32_t, uint32_t>; 43156d6b00SAppaRao Puli 44156d6b00SAppaRao Puli static constexpr const char* eventFormatType = "Event"; 45156d6b00SAppaRao Puli static constexpr const char* metricReportFormatType = "MetricReport"; 46156d6b00SAppaRao Puli 471bf712bcSAyushi Smriti static constexpr const char* eventServiceFile = 481bf712bcSAyushi Smriti "/var/lib/bmcweb/eventservice_config.json"; 491bf712bcSAyushi Smriti 507f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 5123a21a1cSEd Tanous static std::optional<boost::asio::posix::stream_descriptor> inotifyConn; 52b792cc56SAppaRao Puli static constexpr const char* redfishEventLogDir = "/var/log"; 53b792cc56SAppaRao Puli static constexpr const char* redfishEventLogFile = "/var/log/redfish"; 54b792cc56SAppaRao Puli static constexpr const size_t iEventSize = sizeof(inotify_event); 55b792cc56SAppaRao Puli static int inotifyFd = -1; 56b792cc56SAppaRao Puli static int dirWatchDesc = -1; 57b792cc56SAppaRao Puli static int fileWatchDesc = -1; 587f4eb588SAppaRao Puli 597f4eb588SAppaRao Puli // <ID, timestamp, RedfishLogId, registryPrefix, MessageId, MessageArgs> 607f4eb588SAppaRao Puli using EventLogObjectsType = 617f4eb588SAppaRao Puli std::tuple<std::string, std::string, std::string, std::string, std::string, 625e715de6SAppaRao Puli std::vector<std::string>>; 637f4eb588SAppaRao Puli 647f4eb588SAppaRao Puli namespace message_registries 657f4eb588SAppaRao Puli { 667f4eb588SAppaRao Puli static const Message* 677f4eb588SAppaRao Puli getMsgFromRegistry(const std::string& messageKey, 687f4eb588SAppaRao Puli const boost::beast::span<const MessageEntry>& registry) 697f4eb588SAppaRao Puli { 707f4eb588SAppaRao Puli boost::beast::span<const MessageEntry>::const_iterator messageIt = 717f4eb588SAppaRao Puli std::find_if(registry.cbegin(), registry.cend(), 727f4eb588SAppaRao Puli [&messageKey](const MessageEntry& messageEntry) { 737f4eb588SAppaRao Puli return !messageKey.compare(messageEntry.first); 747f4eb588SAppaRao Puli }); 757f4eb588SAppaRao Puli if (messageIt != registry.cend()) 767f4eb588SAppaRao Puli { 777f4eb588SAppaRao Puli return &messageIt->second; 787f4eb588SAppaRao Puli } 797f4eb588SAppaRao Puli 807f4eb588SAppaRao Puli return nullptr; 817f4eb588SAppaRao Puli } 827f4eb588SAppaRao Puli 837f4eb588SAppaRao Puli static const Message* formatMessage(const std::string_view& messageID) 847f4eb588SAppaRao Puli { 857f4eb588SAppaRao Puli // Redfish MessageIds are in the form 867f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 877f4eb588SAppaRao Puli // the right Message 887f4eb588SAppaRao Puli std::vector<std::string> fields; 897f4eb588SAppaRao Puli fields.reserve(4); 907f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 917f4eb588SAppaRao Puli if (fields.size() != 4) 927f4eb588SAppaRao Puli { 937f4eb588SAppaRao Puli return nullptr; 947f4eb588SAppaRao Puli } 957f4eb588SAppaRao Puli std::string& registryName = fields[0]; 967f4eb588SAppaRao Puli std::string& messageKey = fields[3]; 977f4eb588SAppaRao Puli 987f4eb588SAppaRao Puli // Find the right registry and check it for the MessageKey 997f4eb588SAppaRao Puli if (std::string(base::header.registryPrefix) == registryName) 1007f4eb588SAppaRao Puli { 1017f4eb588SAppaRao Puli return getMsgFromRegistry( 1027f4eb588SAppaRao Puli messageKey, boost::beast::span<const MessageEntry>(base::registry)); 1037f4eb588SAppaRao Puli } 1047f4eb588SAppaRao Puli if (std::string(openbmc::header.registryPrefix) == registryName) 1057f4eb588SAppaRao Puli { 1067f4eb588SAppaRao Puli return getMsgFromRegistry( 1077f4eb588SAppaRao Puli messageKey, 1087f4eb588SAppaRao Puli boost::beast::span<const MessageEntry>(openbmc::registry)); 1097f4eb588SAppaRao Puli } 1107f4eb588SAppaRao Puli return nullptr; 1117f4eb588SAppaRao Puli } 1127f4eb588SAppaRao Puli } // namespace message_registries 1137f4eb588SAppaRao Puli 1147f4eb588SAppaRao Puli namespace event_log 1157f4eb588SAppaRao Puli { 11623a21a1cSEd Tanous inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 1177f4eb588SAppaRao Puli const bool firstEntry = true) 1187f4eb588SAppaRao Puli { 1197f4eb588SAppaRao Puli static time_t prevTs = 0; 1207f4eb588SAppaRao Puli static int index = 0; 1217f4eb588SAppaRao Puli if (firstEntry) 1227f4eb588SAppaRao Puli { 1237f4eb588SAppaRao Puli prevTs = 0; 1247f4eb588SAppaRao Puli } 1257f4eb588SAppaRao Puli 1267f4eb588SAppaRao Puli // Get the entry timestamp 1277f4eb588SAppaRao Puli std::time_t curTs = 0; 1287f4eb588SAppaRao Puli std::tm timeStruct = {}; 1297f4eb588SAppaRao Puli std::istringstream entryStream(logEntry); 1307f4eb588SAppaRao Puli if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 1317f4eb588SAppaRao Puli { 1327f4eb588SAppaRao Puli curTs = std::mktime(&timeStruct); 1337f4eb588SAppaRao Puli if (curTs == -1) 1347f4eb588SAppaRao Puli { 1357f4eb588SAppaRao Puli return false; 1367f4eb588SAppaRao Puli } 1377f4eb588SAppaRao Puli } 1387f4eb588SAppaRao Puli // If the timestamp isn't unique, increment the index 1397f4eb588SAppaRao Puli index = (curTs == prevTs) ? index + 1 : 0; 1407f4eb588SAppaRao Puli 1417f4eb588SAppaRao Puli // Save the timestamp 1427f4eb588SAppaRao Puli prevTs = curTs; 1437f4eb588SAppaRao Puli 1447f4eb588SAppaRao Puli entryID = std::to_string(curTs); 1457f4eb588SAppaRao Puli if (index > 0) 1467f4eb588SAppaRao Puli { 1477f4eb588SAppaRao Puli entryID += "_" + std::to_string(index); 1487f4eb588SAppaRao Puli } 1497f4eb588SAppaRao Puli return true; 1507f4eb588SAppaRao Puli } 1517f4eb588SAppaRao Puli 15223a21a1cSEd Tanous inline int getEventLogParams(const std::string& logEntry, 15323a21a1cSEd Tanous std::string& timestamp, std::string& messageID, 1545e715de6SAppaRao Puli std::vector<std::string>& messageArgs) 1557f4eb588SAppaRao Puli { 1567f4eb588SAppaRao Puli // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1577f4eb588SAppaRao Puli // First get the Timestamp 1587f4eb588SAppaRao Puli size_t space = logEntry.find_first_of(" "); 1597f4eb588SAppaRao Puli if (space == std::string::npos) 1607f4eb588SAppaRao Puli { 1617f4eb588SAppaRao Puli return -EINVAL; 1627f4eb588SAppaRao Puli } 1637f4eb588SAppaRao Puli timestamp = logEntry.substr(0, space); 1647f4eb588SAppaRao Puli // Then get the log contents 1657f4eb588SAppaRao Puli size_t entryStart = logEntry.find_first_not_of(" ", space); 1667f4eb588SAppaRao Puli if (entryStart == std::string::npos) 1677f4eb588SAppaRao Puli { 1687f4eb588SAppaRao Puli return -EINVAL; 1697f4eb588SAppaRao Puli } 1707f4eb588SAppaRao Puli std::string_view entry(logEntry); 1717f4eb588SAppaRao Puli entry.remove_prefix(entryStart); 1727f4eb588SAppaRao Puli // Use split to separate the entry into its fields 1737f4eb588SAppaRao Puli std::vector<std::string> logEntryFields; 1747f4eb588SAppaRao Puli boost::split(logEntryFields, entry, boost::is_any_of(","), 1757f4eb588SAppaRao Puli boost::token_compress_on); 1767f4eb588SAppaRao Puli // We need at least a MessageId to be valid 1777f4eb588SAppaRao Puli if (logEntryFields.size() < 1) 1787f4eb588SAppaRao Puli { 1797f4eb588SAppaRao Puli return -EINVAL; 1807f4eb588SAppaRao Puli } 1817f4eb588SAppaRao Puli messageID = logEntryFields[0]; 1827f4eb588SAppaRao Puli 1837f4eb588SAppaRao Puli // Get the MessageArgs from the log if there are any 1847f4eb588SAppaRao Puli if (logEntryFields.size() > 1) 1857f4eb588SAppaRao Puli { 1867f4eb588SAppaRao Puli std::string& messageArgsStart = logEntryFields[1]; 1877f4eb588SAppaRao Puli // If the first string is empty, assume there are no MessageArgs 1887f4eb588SAppaRao Puli if (!messageArgsStart.empty()) 1897f4eb588SAppaRao Puli { 1905e715de6SAppaRao Puli messageArgs.assign(logEntryFields.begin() + 1, 1915e715de6SAppaRao Puli logEntryFields.end()); 1927f4eb588SAppaRao Puli } 1937f4eb588SAppaRao Puli } 1947f4eb588SAppaRao Puli 1957f4eb588SAppaRao Puli return 0; 1967f4eb588SAppaRao Puli } 1977f4eb588SAppaRao Puli 19823a21a1cSEd Tanous inline void getRegistryAndMessageKey(const std::string& messageID, 1997f4eb588SAppaRao Puli std::string& registryName, 2007f4eb588SAppaRao Puli std::string& messageKey) 2017f4eb588SAppaRao Puli { 2027f4eb588SAppaRao Puli // Redfish MessageIds are in the form 2037f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 2047f4eb588SAppaRao Puli // the right Message 2057f4eb588SAppaRao Puli std::vector<std::string> fields; 2067f4eb588SAppaRao Puli fields.reserve(4); 2077f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 2087f4eb588SAppaRao Puli if (fields.size() == 4) 2097f4eb588SAppaRao Puli { 2107f4eb588SAppaRao Puli registryName = fields[0]; 2117f4eb588SAppaRao Puli messageKey = fields[3]; 2127f4eb588SAppaRao Puli } 2137f4eb588SAppaRao Puli } 2147f4eb588SAppaRao Puli 21523a21a1cSEd Tanous inline int formatEventLogEntry(const std::string& logEntryID, 2167f4eb588SAppaRao Puli const std::string& messageID, 2175e715de6SAppaRao Puli const std::vector<std::string>& messageArgs, 21823a21a1cSEd Tanous std::string timestamp, 21923a21a1cSEd Tanous const std::string customText, 2207f4eb588SAppaRao Puli nlohmann::json& logEntryJson) 2217f4eb588SAppaRao Puli { 2227f4eb588SAppaRao Puli // Get the Message from the MessageRegistry 2237f4eb588SAppaRao Puli const message_registries::Message* message = 2247f4eb588SAppaRao Puli message_registries::formatMessage(messageID); 2257f4eb588SAppaRao Puli 2267f4eb588SAppaRao Puli std::string msg; 2277f4eb588SAppaRao Puli std::string severity; 2287f4eb588SAppaRao Puli if (message != nullptr) 2297f4eb588SAppaRao Puli { 2307f4eb588SAppaRao Puli msg = message->message; 2317f4eb588SAppaRao Puli severity = message->severity; 2327f4eb588SAppaRao Puli } 2337f4eb588SAppaRao Puli 2347f4eb588SAppaRao Puli // Fill the MessageArgs into the Message 2357f4eb588SAppaRao Puli int i = 0; 2367f4eb588SAppaRao Puli for (const std::string& messageArg : messageArgs) 2377f4eb588SAppaRao Puli { 2387f4eb588SAppaRao Puli std::string argStr = "%" + std::to_string(++i); 2397f4eb588SAppaRao Puli size_t argPos = msg.find(argStr); 2407f4eb588SAppaRao Puli if (argPos != std::string::npos) 2417f4eb588SAppaRao Puli { 2427f4eb588SAppaRao Puli msg.replace(argPos, argStr.length(), messageArg); 2437f4eb588SAppaRao Puli } 2447f4eb588SAppaRao Puli } 2457f4eb588SAppaRao Puli 2467f4eb588SAppaRao Puli // Get the Created time from the timestamp. The log timestamp is in 2477f4eb588SAppaRao Puli // RFC3339 format which matches the Redfish format except for the 2487f4eb588SAppaRao Puli // fractional seconds between the '.' and the '+', so just remove them. 2497f4eb588SAppaRao Puli std::size_t dot = timestamp.find_first_of("."); 2507f4eb588SAppaRao Puli std::size_t plus = timestamp.find_first_of("+"); 2517f4eb588SAppaRao Puli if (dot != std::string::npos && plus != std::string::npos) 2527f4eb588SAppaRao Puli { 2537f4eb588SAppaRao Puli timestamp.erase(dot, plus - dot); 2547f4eb588SAppaRao Puli } 2557f4eb588SAppaRao Puli 2567f4eb588SAppaRao Puli // Fill in the log entry with the gathered data 2577f4eb588SAppaRao Puli logEntryJson = {{"EventId", logEntryID}, 2587f4eb588SAppaRao Puli {"EventType", "Event"}, 2597f4eb588SAppaRao Puli {"Severity", std::move(severity)}, 2607f4eb588SAppaRao Puli {"Message", std::move(msg)}, 2617f4eb588SAppaRao Puli {"MessageId", std::move(messageID)}, 2627f4eb588SAppaRao Puli {"MessageArgs", std::move(messageArgs)}, 2637f4eb588SAppaRao Puli {"EventTimestamp", std::move(timestamp)}, 2647f4eb588SAppaRao Puli {"Context", customText}}; 2657f4eb588SAppaRao Puli return 0; 2667f4eb588SAppaRao Puli } 2677f4eb588SAppaRao Puli 2687f4eb588SAppaRao Puli } // namespace event_log 2697f4eb588SAppaRao Puli #endif 2707f4eb588SAppaRao Puli 27123a21a1cSEd Tanous inline bool isFilterQuerySpecialChar(char c) 27207941a88SAyushi Smriti { 27307941a88SAyushi Smriti switch (c) 27407941a88SAyushi Smriti { 27507941a88SAyushi Smriti case '(': 27607941a88SAyushi Smriti case ')': 27707941a88SAyushi Smriti case '\'': 27807941a88SAyushi Smriti return true; 27907941a88SAyushi Smriti default: 28007941a88SAyushi Smriti return false; 28107941a88SAyushi Smriti } 28207941a88SAyushi Smriti } 28307941a88SAyushi Smriti 28423a21a1cSEd Tanous inline bool 28523a21a1cSEd Tanous readSSEQueryParams(std::string sseFilter, std::string& formatType, 28607941a88SAyushi Smriti std::vector<std::string>& messageIds, 28707941a88SAyushi Smriti std::vector<std::string>& registryPrefixes, 288144b6318SAppaRao Puli std::vector<std::string>& metricReportDefinitions) 28907941a88SAyushi Smriti { 29007941a88SAyushi Smriti sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(), 29107941a88SAyushi Smriti isFilterQuerySpecialChar), 29207941a88SAyushi Smriti sseFilter.end()); 29307941a88SAyushi Smriti 29407941a88SAyushi Smriti std::vector<std::string> result; 29507941a88SAyushi Smriti boost::split(result, sseFilter, boost::is_any_of(" "), 29607941a88SAyushi Smriti boost::token_compress_on); 29707941a88SAyushi Smriti 29807941a88SAyushi Smriti BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size(); 29907941a88SAyushi Smriti 30007941a88SAyushi Smriti constexpr uint8_t divisor = 4; 30107941a88SAyushi Smriti constexpr uint8_t minTokenSize = 3; 30207941a88SAyushi Smriti if (result.size() % divisor != minTokenSize) 30307941a88SAyushi Smriti { 30407941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid SSE filter specified."; 30507941a88SAyushi Smriti return false; 30607941a88SAyushi Smriti } 30707941a88SAyushi Smriti 30807941a88SAyushi Smriti for (std::size_t i = 0; i < result.size(); i += divisor) 30907941a88SAyushi Smriti { 31007941a88SAyushi Smriti std::string& key = result[i]; 31107941a88SAyushi Smriti std::string& op = result[i + 1]; 31207941a88SAyushi Smriti std::string& value = result[i + 2]; 31307941a88SAyushi Smriti 31407941a88SAyushi Smriti if ((i + minTokenSize) < result.size()) 31507941a88SAyushi Smriti { 3164e0453b1SGunnar Mills std::string& separator = result[i + minTokenSize]; 31707941a88SAyushi Smriti // SSE supports only "or" and "and" in query params. 3184e0453b1SGunnar Mills if ((separator != "or") && (separator != "and")) 31907941a88SAyushi Smriti { 32007941a88SAyushi Smriti BMCWEB_LOG_ERROR 32107941a88SAyushi Smriti << "Invalid group operator in SSE query parameters"; 32207941a88SAyushi Smriti return false; 32307941a88SAyushi Smriti } 32407941a88SAyushi Smriti } 32507941a88SAyushi Smriti 32607941a88SAyushi Smriti // SSE supports only "eq" as per spec. 32707941a88SAyushi Smriti if (op != "eq") 32807941a88SAyushi Smriti { 32907941a88SAyushi Smriti BMCWEB_LOG_ERROR 33007941a88SAyushi Smriti << "Invalid assignment operator in SSE query parameters"; 33107941a88SAyushi Smriti return false; 33207941a88SAyushi Smriti } 33307941a88SAyushi Smriti 33407941a88SAyushi Smriti BMCWEB_LOG_DEBUG << key << " : " << value; 33507941a88SAyushi Smriti if (key == "EventFormatType") 33607941a88SAyushi Smriti { 33707941a88SAyushi Smriti formatType = value; 33807941a88SAyushi Smriti } 33907941a88SAyushi Smriti else if (key == "MessageId") 34007941a88SAyushi Smriti { 34107941a88SAyushi Smriti messageIds.push_back(value); 34207941a88SAyushi Smriti } 34307941a88SAyushi Smriti else if (key == "RegistryPrefix") 34407941a88SAyushi Smriti { 34507941a88SAyushi Smriti registryPrefixes.push_back(value); 34607941a88SAyushi Smriti } 34707941a88SAyushi Smriti else if (key == "MetricReportDefinition") 34807941a88SAyushi Smriti { 34907941a88SAyushi Smriti metricReportDefinitions.push_back(value); 35007941a88SAyushi Smriti } 35107941a88SAyushi Smriti else 35207941a88SAyushi Smriti { 35307941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid property(" << key 35407941a88SAyushi Smriti << ")in SSE filter query."; 35507941a88SAyushi Smriti return false; 35607941a88SAyushi Smriti } 35707941a88SAyushi Smriti } 35807941a88SAyushi Smriti return true; 35907941a88SAyushi Smriti } 36007941a88SAyushi Smriti 361b52664e2SAppaRao Puli class Subscription 362b52664e2SAppaRao Puli { 363b52664e2SAppaRao Puli public: 364b52664e2SAppaRao Puli std::string id; 365b52664e2SAppaRao Puli std::string destinationUrl; 366b52664e2SAppaRao Puli std::string protocol; 367b52664e2SAppaRao Puli std::string retryPolicy; 368b52664e2SAppaRao Puli std::string customText; 369b52664e2SAppaRao Puli std::string eventFormatType; 370b52664e2SAppaRao Puli std::string subscriptionType; 371b52664e2SAppaRao Puli std::vector<std::string> registryMsgIds; 372b52664e2SAppaRao Puli std::vector<std::string> registryPrefixes; 373e56f254cSSunitha Harish std::vector<std::string> resourceTypes; 374b52664e2SAppaRao Puli std::vector<nlohmann::json> httpHeaders; // key-value pair 375144b6318SAppaRao Puli std::vector<std::string> metricReportDefinitions; 376b52664e2SAppaRao Puli 377b52664e2SAppaRao Puli Subscription(const Subscription&) = delete; 378b52664e2SAppaRao Puli Subscription& operator=(const Subscription&) = delete; 379b52664e2SAppaRao Puli Subscription(Subscription&&) = delete; 380b52664e2SAppaRao Puli Subscription& operator=(Subscription&&) = delete; 381b52664e2SAppaRao Puli 382b52664e2SAppaRao Puli Subscription(const std::string& inHost, const std::string& inPort, 383b52664e2SAppaRao Puli const std::string& inPath, const std::string& inUriProto) : 3840b4bdd93SAppaRao Puli eventSeqNum(1), 3850b4bdd93SAppaRao Puli host(inHost), port(inPort), path(inPath), uriProto(inUriProto) 386b52664e2SAppaRao Puli { 387b52664e2SAppaRao Puli conn = std::make_shared<crow::HttpClient>( 388fe44eb0bSAyushi Smriti crow::connections::systemBus->get_io_context(), id, host, port, 389fe44eb0bSAyushi Smriti path); 390b52664e2SAppaRao Puli } 3914bbf237fSAppaRao Puli 392*23e64207SEd Tanous Subscription(const std::shared_ptr<boost::beast::tcp_stream>& adaptor) : 3934bbf237fSAppaRao Puli eventSeqNum(1) 3944bbf237fSAppaRao Puli { 3954bbf237fSAppaRao Puli sseConn = std::make_shared<crow::ServerSentEvents>(adaptor); 3964bbf237fSAppaRao Puli } 3974bbf237fSAppaRao Puli 398b52664e2SAppaRao Puli ~Subscription() 3991214b7e7SGunnar Mills {} 400b52664e2SAppaRao Puli 401b52664e2SAppaRao Puli void sendEvent(const std::string& msg) 402b52664e2SAppaRao Puli { 4034bbf237fSAppaRao Puli if (conn != nullptr) 4044bbf237fSAppaRao Puli { 405b52664e2SAppaRao Puli std::vector<std::pair<std::string, std::string>> reqHeaders; 406b52664e2SAppaRao Puli for (const auto& header : httpHeaders) 407b52664e2SAppaRao Puli { 408b52664e2SAppaRao Puli for (const auto& item : header.items()) 409b52664e2SAppaRao Puli { 410b52664e2SAppaRao Puli std::string key = item.key(); 411b52664e2SAppaRao Puli std::string val = item.value(); 412b52664e2SAppaRao Puli reqHeaders.emplace_back(std::pair(key, val)); 413b52664e2SAppaRao Puli } 414b52664e2SAppaRao Puli } 415b52664e2SAppaRao Puli conn->setHeaders(reqHeaders); 4162a5689a7SAppaRao Puli conn->sendData(msg); 41796330b99SSunitha Harish this->eventSeqNum++; 418b52664e2SAppaRao Puli } 419b52664e2SAppaRao Puli 4204bbf237fSAppaRao Puli if (sseConn != nullptr) 4214bbf237fSAppaRao Puli { 4224bbf237fSAppaRao Puli sseConn->sendData(eventSeqNum, msg); 4234bbf237fSAppaRao Puli } 4244bbf237fSAppaRao Puli } 4254bbf237fSAppaRao Puli 4260b4bdd93SAppaRao Puli void sendTestEventLog() 4270b4bdd93SAppaRao Puli { 4280b4bdd93SAppaRao Puli nlohmann::json logEntryArray; 4290b4bdd93SAppaRao Puli logEntryArray.push_back({}); 4300b4bdd93SAppaRao Puli nlohmann::json& logEntryJson = logEntryArray.back(); 4310b4bdd93SAppaRao Puli 4320b4bdd93SAppaRao Puli logEntryJson = {{"EventId", "TestID"}, 4330b4bdd93SAppaRao Puli {"EventType", "Event"}, 4340b4bdd93SAppaRao Puli {"Severity", "OK"}, 4350b4bdd93SAppaRao Puli {"Message", "Generated test event"}, 4360b4bdd93SAppaRao Puli {"MessageId", "OpenBMC.0.1.TestEventLog"}, 4370b4bdd93SAppaRao Puli {"MessageArgs", nlohmann::json::array()}, 4380b4bdd93SAppaRao Puli {"EventTimestamp", crow::utility::dateTimeNow()}, 4390b4bdd93SAppaRao Puli {"Context", customText}}; 4400b4bdd93SAppaRao Puli 4410b4bdd93SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 4420b4bdd93SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 4430b4bdd93SAppaRao Puli {"Name", "Event Log"}, 4440b4bdd93SAppaRao Puli {"Events", logEntryArray}}; 4450b4bdd93SAppaRao Puli 4460b4bdd93SAppaRao Puli this->sendEvent(msg.dump()); 4470b4bdd93SAppaRao Puli } 4480b4bdd93SAppaRao Puli 4497f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 4507f4eb588SAppaRao Puli void filterAndSendEventLogs( 4517f4eb588SAppaRao Puli const std::vector<EventLogObjectsType>& eventRecords) 4527f4eb588SAppaRao Puli { 4537f4eb588SAppaRao Puli nlohmann::json logEntryArray; 4547f4eb588SAppaRao Puli for (const EventLogObjectsType& logEntry : eventRecords) 4557f4eb588SAppaRao Puli { 4567f4eb588SAppaRao Puli const std::string& idStr = std::get<0>(logEntry); 4577f4eb588SAppaRao Puli const std::string& timestamp = std::get<1>(logEntry); 4587f4eb588SAppaRao Puli const std::string& messageID = std::get<2>(logEntry); 4597f4eb588SAppaRao Puli const std::string& registryName = std::get<3>(logEntry); 4607f4eb588SAppaRao Puli const std::string& messageKey = std::get<4>(logEntry); 4615e715de6SAppaRao Puli const std::vector<std::string>& messageArgs = std::get<5>(logEntry); 4627f4eb588SAppaRao Puli 4637f4eb588SAppaRao Puli // If registryPrefixes list is empty, don't filter events 4647f4eb588SAppaRao Puli // send everything. 4657f4eb588SAppaRao Puli if (registryPrefixes.size()) 4667f4eb588SAppaRao Puli { 4677f4eb588SAppaRao Puli auto obj = std::find(registryPrefixes.begin(), 4687f4eb588SAppaRao Puli registryPrefixes.end(), registryName); 4697f4eb588SAppaRao Puli if (obj == registryPrefixes.end()) 4707f4eb588SAppaRao Puli { 4717f4eb588SAppaRao Puli continue; 4727f4eb588SAppaRao Puli } 4737f4eb588SAppaRao Puli } 4747f4eb588SAppaRao Puli 4757f4eb588SAppaRao Puli // If registryMsgIds list is empty, don't filter events 4767f4eb588SAppaRao Puli // send everything. 4777f4eb588SAppaRao Puli if (registryMsgIds.size()) 4787f4eb588SAppaRao Puli { 4797f4eb588SAppaRao Puli auto obj = std::find(registryMsgIds.begin(), 4807f4eb588SAppaRao Puli registryMsgIds.end(), messageKey); 4817f4eb588SAppaRao Puli if (obj == registryMsgIds.end()) 4827f4eb588SAppaRao Puli { 4837f4eb588SAppaRao Puli continue; 4847f4eb588SAppaRao Puli } 4857f4eb588SAppaRao Puli } 4867f4eb588SAppaRao Puli 4877f4eb588SAppaRao Puli logEntryArray.push_back({}); 4887f4eb588SAppaRao Puli nlohmann::json& bmcLogEntry = logEntryArray.back(); 4897f4eb588SAppaRao Puli if (event_log::formatEventLogEntry(idStr, messageID, messageArgs, 4907f4eb588SAppaRao Puli timestamp, customText, 4917f4eb588SAppaRao Puli bmcLogEntry) != 0) 4927f4eb588SAppaRao Puli { 4937f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry failed"; 4947f4eb588SAppaRao Puli continue; 4957f4eb588SAppaRao Puli } 4967f4eb588SAppaRao Puli } 4977f4eb588SAppaRao Puli 4987f4eb588SAppaRao Puli if (logEntryArray.size() < 1) 4997f4eb588SAppaRao Puli { 5007f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 5017f4eb588SAppaRao Puli return; 5027f4eb588SAppaRao Puli } 5037f4eb588SAppaRao Puli 5047f4eb588SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 5057f4eb588SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 5067f4eb588SAppaRao Puli {"Name", "Event Log"}, 5077f4eb588SAppaRao Puli {"Events", logEntryArray}}; 5087f4eb588SAppaRao Puli 5097f4eb588SAppaRao Puli this->sendEvent(msg.dump()); 5107f4eb588SAppaRao Puli } 5117f4eb588SAppaRao Puli #endif 5127f4eb588SAppaRao Puli 51323a21a1cSEd Tanous void filterAndSendReports(const std::string& id2, 514156d6b00SAppaRao Puli const std::string& readingsTs, 515156d6b00SAppaRao Puli const ReadingsObjType& readings) 516156d6b00SAppaRao Puli { 517156d6b00SAppaRao Puli std::string metricReportDef = 51823a21a1cSEd Tanous "/redfish/v1/TelemetryService/MetricReportDefinitions/" + id2; 519156d6b00SAppaRao Puli 520156d6b00SAppaRao Puli // Empty list means no filter. Send everything. 521156d6b00SAppaRao Puli if (metricReportDefinitions.size()) 522156d6b00SAppaRao Puli { 523156d6b00SAppaRao Puli if (std::find(metricReportDefinitions.begin(), 524156d6b00SAppaRao Puli metricReportDefinitions.end(), 525156d6b00SAppaRao Puli metricReportDef) == metricReportDefinitions.end()) 526156d6b00SAppaRao Puli { 527156d6b00SAppaRao Puli return; 528156d6b00SAppaRao Puli } 529156d6b00SAppaRao Puli } 530156d6b00SAppaRao Puli 531156d6b00SAppaRao Puli nlohmann::json metricValuesArray = nlohmann::json::array(); 532156d6b00SAppaRao Puli for (const auto& it : readings) 533156d6b00SAppaRao Puli { 534156d6b00SAppaRao Puli metricValuesArray.push_back({}); 535156d6b00SAppaRao Puli nlohmann::json& entry = metricValuesArray.back(); 536156d6b00SAppaRao Puli 53793f5d7c7SWludzik, Jozef auto& [id, property, value, timestamp] = it; 53893f5d7c7SWludzik, Jozef 53993f5d7c7SWludzik, Jozef entry = {{"MetricId", id}, 54093f5d7c7SWludzik, Jozef {"MetricProperty", property}, 54193f5d7c7SWludzik, Jozef {"MetricValue", std::to_string(value)}, 54293f5d7c7SWludzik, Jozef {"Timestamp", crow::utility::getDateTime(timestamp)}}; 543156d6b00SAppaRao Puli } 544156d6b00SAppaRao Puli 545156d6b00SAppaRao Puli nlohmann::json msg = { 546156d6b00SAppaRao Puli {"@odata.id", "/redfish/v1/TelemetryService/MetricReports/" + id}, 547156d6b00SAppaRao Puli {"@odata.type", "#MetricReport.v1_3_0.MetricReport"}, 54823a21a1cSEd Tanous {"Id", id2}, 54923a21a1cSEd Tanous {"Name", id2}, 550156d6b00SAppaRao Puli {"Timestamp", readingsTs}, 551156d6b00SAppaRao Puli {"MetricReportDefinition", {{"@odata.id", metricReportDef}}}, 552156d6b00SAppaRao Puli {"MetricValues", metricValuesArray}}; 553156d6b00SAppaRao Puli 554156d6b00SAppaRao Puli this->sendEvent(msg.dump()); 555156d6b00SAppaRao Puli } 556156d6b00SAppaRao Puli 557fe44eb0bSAyushi Smriti void updateRetryConfig(const uint32_t retryAttempts, 558fe44eb0bSAyushi Smriti const uint32_t retryTimeoutInterval) 559fe44eb0bSAyushi Smriti { 56062de0c68SAppaRao Puli if (conn != nullptr) 56162de0c68SAppaRao Puli { 562fe44eb0bSAyushi Smriti conn->setRetryConfig(retryAttempts, retryTimeoutInterval); 563fe44eb0bSAyushi Smriti } 56462de0c68SAppaRao Puli } 565fe44eb0bSAyushi Smriti 566fe44eb0bSAyushi Smriti void updateRetryPolicy() 567fe44eb0bSAyushi Smriti { 56862de0c68SAppaRao Puli if (conn != nullptr) 56962de0c68SAppaRao Puli { 570fe44eb0bSAyushi Smriti conn->setRetryPolicy(retryPolicy); 571fe44eb0bSAyushi Smriti } 57262de0c68SAppaRao Puli } 573fe44eb0bSAyushi Smriti 57496330b99SSunitha Harish uint64_t getEventSeqNum() 57596330b99SSunitha Harish { 57696330b99SSunitha Harish return eventSeqNum; 57796330b99SSunitha Harish } 57896330b99SSunitha Harish 579b52664e2SAppaRao Puli private: 5800b4bdd93SAppaRao Puli uint64_t eventSeqNum; 581b52664e2SAppaRao Puli std::string host; 582b52664e2SAppaRao Puli std::string port; 583b52664e2SAppaRao Puli std::string path; 584b52664e2SAppaRao Puli std::string uriProto; 5854bbf237fSAppaRao Puli std::shared_ptr<crow::HttpClient> conn = nullptr; 5864bbf237fSAppaRao Puli std::shared_ptr<crow::ServerSentEvents> sseConn = nullptr; 587b52664e2SAppaRao Puli }; 588b52664e2SAppaRao Puli 5891bf712bcSAyushi Smriti static constexpr const bool defaultEnabledState = true; 5901bf712bcSAyushi Smriti static constexpr const uint32_t defaultRetryAttempts = 3; 5911bf712bcSAyushi Smriti static constexpr const uint32_t defaultRetryInterval = 30; 5921bf712bcSAyushi Smriti static constexpr const char* defaulEventFormatType = "Event"; 5931bf712bcSAyushi Smriti static constexpr const char* defaulSubscriptionType = "RedfishEvent"; 5941bf712bcSAyushi Smriti static constexpr const char* defaulRetryPolicy = "TerminateAfterRetries"; 5951bf712bcSAyushi Smriti 596b52664e2SAppaRao Puli class EventServiceManager 597b52664e2SAppaRao Puli { 598b52664e2SAppaRao Puli private: 5997d1cc387SAppaRao Puli bool serviceEnabled; 6007d1cc387SAppaRao Puli uint32_t retryAttempts; 6017d1cc387SAppaRao Puli uint32_t retryTimeoutInterval; 6027d1cc387SAppaRao Puli 603b52664e2SAppaRao Puli EventServiceManager(const EventServiceManager&) = delete; 604b52664e2SAppaRao Puli EventServiceManager& operator=(const EventServiceManager&) = delete; 605b52664e2SAppaRao Puli EventServiceManager(EventServiceManager&&) = delete; 606b52664e2SAppaRao Puli EventServiceManager& operator=(EventServiceManager&&) = delete; 607b52664e2SAppaRao Puli 6087d1cc387SAppaRao Puli EventServiceManager() : 60996330b99SSunitha Harish noOfEventLogSubscribers(0), noOfMetricReportSubscribers(0), eventId(1) 610b52664e2SAppaRao Puli { 6111bf712bcSAyushi Smriti // Load config from persist store. 6121bf712bcSAyushi Smriti initConfig(); 613b52664e2SAppaRao Puli } 614b52664e2SAppaRao Puli 6157f4eb588SAppaRao Puli std::string lastEventTStr; 6167d1cc387SAppaRao Puli size_t noOfEventLogSubscribers; 617156d6b00SAppaRao Puli size_t noOfMetricReportSubscribers; 618156d6b00SAppaRao Puli std::shared_ptr<sdbusplus::bus::match::match> matchTelemetryMonitor; 619b52664e2SAppaRao Puli boost::container::flat_map<std::string, std::shared_ptr<Subscription>> 620b52664e2SAppaRao Puli subscriptionsMap; 621b52664e2SAppaRao Puli 62296330b99SSunitha Harish uint64_t eventId; 62396330b99SSunitha Harish 624b52664e2SAppaRao Puli public: 625b52664e2SAppaRao Puli static EventServiceManager& getInstance() 626b52664e2SAppaRao Puli { 627b52664e2SAppaRao Puli static EventServiceManager handler; 628b52664e2SAppaRao Puli return handler; 629b52664e2SAppaRao Puli } 630b52664e2SAppaRao Puli 6311bf712bcSAyushi Smriti void loadDefaultConfig() 6321bf712bcSAyushi Smriti { 6331bf712bcSAyushi Smriti serviceEnabled = defaultEnabledState; 6341bf712bcSAyushi Smriti retryAttempts = defaultRetryAttempts; 6351bf712bcSAyushi Smriti retryTimeoutInterval = defaultRetryInterval; 6361bf712bcSAyushi Smriti } 6371bf712bcSAyushi Smriti 6381bf712bcSAyushi Smriti void initConfig() 6391bf712bcSAyushi Smriti { 6401bf712bcSAyushi Smriti std::ifstream eventConfigFile(eventServiceFile); 6411bf712bcSAyushi Smriti if (!eventConfigFile.good()) 6421bf712bcSAyushi Smriti { 6431bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService config not exist"; 6441bf712bcSAyushi Smriti loadDefaultConfig(); 6451bf712bcSAyushi Smriti return; 6461bf712bcSAyushi Smriti } 6471bf712bcSAyushi Smriti auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false); 6481bf712bcSAyushi Smriti if (jsonData.is_discarded()) 6491bf712bcSAyushi Smriti { 6501bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "EventService config parse error."; 6511bf712bcSAyushi Smriti loadDefaultConfig(); 6521bf712bcSAyushi Smriti return; 6531bf712bcSAyushi Smriti } 6541bf712bcSAyushi Smriti 6551bf712bcSAyushi Smriti nlohmann::json jsonConfig; 6561bf712bcSAyushi Smriti if (json_util::getValueFromJsonObject(jsonData, "Configuration", 6571bf712bcSAyushi Smriti jsonConfig)) 6581bf712bcSAyushi Smriti { 6591bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonConfig, "ServiceEnabled", 6601bf712bcSAyushi Smriti serviceEnabled)) 6611bf712bcSAyushi Smriti { 6621bf712bcSAyushi Smriti serviceEnabled = defaultEnabledState; 6631bf712bcSAyushi Smriti } 6641bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 6651bf712bcSAyushi Smriti jsonConfig, "DeliveryRetryAttempts", retryAttempts)) 6661bf712bcSAyushi Smriti { 6671bf712bcSAyushi Smriti retryAttempts = defaultRetryAttempts; 6681bf712bcSAyushi Smriti } 6691bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 6701bf712bcSAyushi Smriti jsonConfig, "DeliveryRetryIntervalSeconds", 6711bf712bcSAyushi Smriti retryTimeoutInterval)) 6721bf712bcSAyushi Smriti { 6731bf712bcSAyushi Smriti retryTimeoutInterval = defaultRetryInterval; 6741bf712bcSAyushi Smriti } 6751bf712bcSAyushi Smriti } 6761bf712bcSAyushi Smriti else 6771bf712bcSAyushi Smriti { 6781bf712bcSAyushi Smriti loadDefaultConfig(); 6791bf712bcSAyushi Smriti } 6801bf712bcSAyushi Smriti 6811bf712bcSAyushi Smriti nlohmann::json subscriptionsList; 6821bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonData, "Subscriptions", 6831bf712bcSAyushi Smriti subscriptionsList)) 6841bf712bcSAyushi Smriti { 6851bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService: Subscriptions not exist."; 6861bf712bcSAyushi Smriti return; 6871bf712bcSAyushi Smriti } 6881bf712bcSAyushi Smriti 6891bf712bcSAyushi Smriti for (nlohmann::json& jsonObj : subscriptionsList) 6901bf712bcSAyushi Smriti { 6911bf712bcSAyushi Smriti std::string protocol; 6921bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "Protocol", 6931bf712bcSAyushi Smriti protocol)) 6941bf712bcSAyushi Smriti { 6951bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "Invalid subscription Protocol exist."; 6961bf712bcSAyushi Smriti continue; 6971bf712bcSAyushi Smriti } 6984bbf237fSAppaRao Puli 6994bbf237fSAppaRao Puli std::string subscriptionType; 7004bbf237fSAppaRao Puli if (!json_util::getValueFromJsonObject(jsonObj, "SubscriptionType", 7014bbf237fSAppaRao Puli subscriptionType)) 7024bbf237fSAppaRao Puli { 7034bbf237fSAppaRao Puli subscriptionType = defaulSubscriptionType; 7044bbf237fSAppaRao Puli } 7054bbf237fSAppaRao Puli // SSE connections are initiated from client 7064bbf237fSAppaRao Puli // and can't be re-established from server. 7074bbf237fSAppaRao Puli if (subscriptionType == "SSE") 7084bbf237fSAppaRao Puli { 7094bbf237fSAppaRao Puli BMCWEB_LOG_DEBUG 7104bbf237fSAppaRao Puli << "The subscription type is SSE, so skipping."; 7114bbf237fSAppaRao Puli continue; 7124bbf237fSAppaRao Puli } 7134bbf237fSAppaRao Puli 7141bf712bcSAyushi Smriti std::string destination; 7151bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "Destination", 7161bf712bcSAyushi Smriti destination)) 7171bf712bcSAyushi Smriti { 7181bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "Invalid subscription destination exist."; 7191bf712bcSAyushi Smriti continue; 7201bf712bcSAyushi Smriti } 7211bf712bcSAyushi Smriti std::string host; 7221bf712bcSAyushi Smriti std::string urlProto; 7231bf712bcSAyushi Smriti std::string port; 7241bf712bcSAyushi Smriti std::string path; 7251bf712bcSAyushi Smriti bool status = 7261bf712bcSAyushi Smriti validateAndSplitUrl(destination, urlProto, host, port, path); 7271bf712bcSAyushi Smriti 7281bf712bcSAyushi Smriti if (!status) 7291bf712bcSAyushi Smriti { 7301bf712bcSAyushi Smriti BMCWEB_LOG_ERROR 7311bf712bcSAyushi Smriti << "Failed to validate and split destination url"; 7321bf712bcSAyushi Smriti continue; 7331bf712bcSAyushi Smriti } 7341bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = 7351bf712bcSAyushi Smriti std::make_shared<Subscription>(host, port, path, urlProto); 7361bf712bcSAyushi Smriti 7371bf712bcSAyushi Smriti subValue->destinationUrl = destination; 7381bf712bcSAyushi Smriti subValue->protocol = protocol; 7394bbf237fSAppaRao Puli subValue->subscriptionType = subscriptionType; 7401bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 7411bf712bcSAyushi Smriti jsonObj, "DeliveryRetryPolicy", subValue->retryPolicy)) 7421bf712bcSAyushi Smriti { 7431bf712bcSAyushi Smriti subValue->retryPolicy = defaulRetryPolicy; 7441bf712bcSAyushi Smriti } 7451bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "EventFormatType", 7461bf712bcSAyushi Smriti subValue->eventFormatType)) 7471bf712bcSAyushi Smriti { 7481bf712bcSAyushi Smriti subValue->eventFormatType = defaulEventFormatType; 7491bf712bcSAyushi Smriti } 7501bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "Context", 7511bf712bcSAyushi Smriti subValue->customText); 7521bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "MessageIds", 7531bf712bcSAyushi Smriti subValue->registryMsgIds); 7541bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "RegistryPrefixes", 7551bf712bcSAyushi Smriti subValue->registryPrefixes); 756e56f254cSSunitha Harish json_util::getValueFromJsonObject(jsonObj, "ResourceTypes", 757e56f254cSSunitha Harish subValue->resourceTypes); 7581bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "HttpHeaders", 7591bf712bcSAyushi Smriti subValue->httpHeaders); 7601bf712bcSAyushi Smriti json_util::getValueFromJsonObject( 7611bf712bcSAyushi Smriti jsonObj, "MetricReportDefinitions", 7621bf712bcSAyushi Smriti subValue->metricReportDefinitions); 7631bf712bcSAyushi Smriti 7641bf712bcSAyushi Smriti std::string id = addSubscription(subValue, false); 7651bf712bcSAyushi Smriti if (id.empty()) 7661bf712bcSAyushi Smriti { 7671bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Failed to add subscription"; 7681bf712bcSAyushi Smriti } 7691bf712bcSAyushi Smriti } 7701bf712bcSAyushi Smriti return; 7711bf712bcSAyushi Smriti } 7721bf712bcSAyushi Smriti 773b52664e2SAppaRao Puli void updateSubscriptionData() 774b52664e2SAppaRao Puli { 775b52664e2SAppaRao Puli // Persist the config and subscription data. 7761bf712bcSAyushi Smriti nlohmann::json jsonData; 7771bf712bcSAyushi Smriti 7781bf712bcSAyushi Smriti nlohmann::json& configObj = jsonData["Configuration"]; 7791bf712bcSAyushi Smriti configObj["ServiceEnabled"] = serviceEnabled; 7801bf712bcSAyushi Smriti configObj["DeliveryRetryAttempts"] = retryAttempts; 7811bf712bcSAyushi Smriti configObj["DeliveryRetryIntervalSeconds"] = retryTimeoutInterval; 7821bf712bcSAyushi Smriti 7831bf712bcSAyushi Smriti nlohmann::json& subListArray = jsonData["Subscriptions"]; 7841bf712bcSAyushi Smriti subListArray = nlohmann::json::array(); 7851bf712bcSAyushi Smriti 7861bf712bcSAyushi Smriti for (const auto& it : subscriptionsMap) 7871bf712bcSAyushi Smriti { 7881bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = it.second; 7894bbf237fSAppaRao Puli // Don't preserve SSE connections. Its initiated from 7904bbf237fSAppaRao Puli // client side and can't be re-established from server. 7914bbf237fSAppaRao Puli if (subValue->subscriptionType == "SSE") 7924bbf237fSAppaRao Puli { 7934bbf237fSAppaRao Puli BMCWEB_LOG_DEBUG 7944bbf237fSAppaRao Puli << "The subscription type is SSE, so skipping."; 7954bbf237fSAppaRao Puli continue; 7964bbf237fSAppaRao Puli } 7971bf712bcSAyushi Smriti 7984bbf237fSAppaRao Puli nlohmann::json entry; 7991bf712bcSAyushi Smriti entry["Context"] = subValue->customText; 8001bf712bcSAyushi Smriti entry["DeliveryRetryPolicy"] = subValue->retryPolicy; 8011bf712bcSAyushi Smriti entry["Destination"] = subValue->destinationUrl; 8021bf712bcSAyushi Smriti entry["EventFormatType"] = subValue->eventFormatType; 8031bf712bcSAyushi Smriti entry["HttpHeaders"] = subValue->httpHeaders; 8041bf712bcSAyushi Smriti entry["MessageIds"] = subValue->registryMsgIds; 8051bf712bcSAyushi Smriti entry["Protocol"] = subValue->protocol; 8061bf712bcSAyushi Smriti entry["RegistryPrefixes"] = subValue->registryPrefixes; 807e56f254cSSunitha Harish entry["ResourceTypes"] = subValue->resourceTypes; 8081bf712bcSAyushi Smriti entry["SubscriptionType"] = subValue->subscriptionType; 8091bf712bcSAyushi Smriti entry["MetricReportDefinitions"] = 8101bf712bcSAyushi Smriti subValue->metricReportDefinitions; 8111bf712bcSAyushi Smriti 8121bf712bcSAyushi Smriti subListArray.push_back(entry); 8131bf712bcSAyushi Smriti } 8141bf712bcSAyushi Smriti 8151bf712bcSAyushi Smriti const std::string tmpFile(std::string(eventServiceFile) + "_tmp"); 8161bf712bcSAyushi Smriti std::ofstream ofs(tmpFile, std::ios::out); 8171bf712bcSAyushi Smriti const auto& writeData = jsonData.dump(); 8181bf712bcSAyushi Smriti ofs << writeData; 8191bf712bcSAyushi Smriti ofs.close(); 8201bf712bcSAyushi Smriti 8211bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService config updated to file."; 8221bf712bcSAyushi Smriti if (std::rename(tmpFile.c_str(), eventServiceFile) != 0) 8231bf712bcSAyushi Smriti { 8241bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Error in renaming temporary file: " 8251bf712bcSAyushi Smriti << tmpFile.c_str(); 8261bf712bcSAyushi Smriti } 827b52664e2SAppaRao Puli } 828b52664e2SAppaRao Puli 8297d1cc387SAppaRao Puli EventServiceConfig getEventServiceConfig() 8307d1cc387SAppaRao Puli { 8317d1cc387SAppaRao Puli return {serviceEnabled, retryAttempts, retryTimeoutInterval}; 8327d1cc387SAppaRao Puli } 8337d1cc387SAppaRao Puli 8347d1cc387SAppaRao Puli void setEventServiceConfig(const EventServiceConfig& cfg) 8357d1cc387SAppaRao Puli { 8367d1cc387SAppaRao Puli bool updateConfig = false; 837fe44eb0bSAyushi Smriti bool updateRetryCfg = false; 8387d1cc387SAppaRao Puli 8397d1cc387SAppaRao Puli if (serviceEnabled != std::get<0>(cfg)) 8407d1cc387SAppaRao Puli { 8417d1cc387SAppaRao Puli serviceEnabled = std::get<0>(cfg); 8427d1cc387SAppaRao Puli if (serviceEnabled && noOfMetricReportSubscribers) 8437d1cc387SAppaRao Puli { 8447d1cc387SAppaRao Puli registerMetricReportSignal(); 8457d1cc387SAppaRao Puli } 8467d1cc387SAppaRao Puli else 8477d1cc387SAppaRao Puli { 8487d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8497d1cc387SAppaRao Puli } 8507d1cc387SAppaRao Puli updateConfig = true; 8517d1cc387SAppaRao Puli } 8527d1cc387SAppaRao Puli 8537d1cc387SAppaRao Puli if (retryAttempts != std::get<1>(cfg)) 8547d1cc387SAppaRao Puli { 8557d1cc387SAppaRao Puli retryAttempts = std::get<1>(cfg); 8567d1cc387SAppaRao Puli updateConfig = true; 857fe44eb0bSAyushi Smriti updateRetryCfg = true; 8587d1cc387SAppaRao Puli } 8597d1cc387SAppaRao Puli 8607d1cc387SAppaRao Puli if (retryTimeoutInterval != std::get<2>(cfg)) 8617d1cc387SAppaRao Puli { 8627d1cc387SAppaRao Puli retryTimeoutInterval = std::get<2>(cfg); 8637d1cc387SAppaRao Puli updateConfig = true; 864fe44eb0bSAyushi Smriti updateRetryCfg = true; 8657d1cc387SAppaRao Puli } 8667d1cc387SAppaRao Puli 8677d1cc387SAppaRao Puli if (updateConfig) 8687d1cc387SAppaRao Puli { 8697d1cc387SAppaRao Puli updateSubscriptionData(); 8707d1cc387SAppaRao Puli } 871fe44eb0bSAyushi Smriti 872fe44eb0bSAyushi Smriti if (updateRetryCfg) 873fe44eb0bSAyushi Smriti { 874fe44eb0bSAyushi Smriti // Update the changed retry config to all subscriptions 875fe44eb0bSAyushi Smriti for (const auto& it : 876fe44eb0bSAyushi Smriti EventServiceManager::getInstance().subscriptionsMap) 877fe44eb0bSAyushi Smriti { 878fe44eb0bSAyushi Smriti std::shared_ptr<Subscription> entry = it.second; 879fe44eb0bSAyushi Smriti entry->updateRetryConfig(retryAttempts, retryTimeoutInterval); 880fe44eb0bSAyushi Smriti } 881fe44eb0bSAyushi Smriti } 8827d1cc387SAppaRao Puli } 8837d1cc387SAppaRao Puli 8847d1cc387SAppaRao Puli void updateNoOfSubscribersCount() 8857d1cc387SAppaRao Puli { 8867d1cc387SAppaRao Puli size_t eventLogSubCount = 0; 8877d1cc387SAppaRao Puli size_t metricReportSubCount = 0; 8887d1cc387SAppaRao Puli for (const auto& it : subscriptionsMap) 8897d1cc387SAppaRao Puli { 8907d1cc387SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 8917d1cc387SAppaRao Puli if (entry->eventFormatType == eventFormatType) 8927d1cc387SAppaRao Puli { 8937d1cc387SAppaRao Puli eventLogSubCount++; 8947d1cc387SAppaRao Puli } 8957d1cc387SAppaRao Puli else if (entry->eventFormatType == metricReportFormatType) 8967d1cc387SAppaRao Puli { 8977d1cc387SAppaRao Puli metricReportSubCount++; 8987d1cc387SAppaRao Puli } 8997d1cc387SAppaRao Puli } 9007d1cc387SAppaRao Puli 9017d1cc387SAppaRao Puli noOfEventLogSubscribers = eventLogSubCount; 9027d1cc387SAppaRao Puli if (noOfMetricReportSubscribers != metricReportSubCount) 9037d1cc387SAppaRao Puli { 9047d1cc387SAppaRao Puli noOfMetricReportSubscribers = metricReportSubCount; 9057d1cc387SAppaRao Puli if (noOfMetricReportSubscribers) 9067d1cc387SAppaRao Puli { 9077d1cc387SAppaRao Puli registerMetricReportSignal(); 9087d1cc387SAppaRao Puli } 9097d1cc387SAppaRao Puli else 9107d1cc387SAppaRao Puli { 9117d1cc387SAppaRao Puli unregisterMetricReportSignal(); 9127d1cc387SAppaRao Puli } 9137d1cc387SAppaRao Puli } 9147d1cc387SAppaRao Puli } 9157d1cc387SAppaRao Puli 916b52664e2SAppaRao Puli std::shared_ptr<Subscription> getSubscription(const std::string& id) 917b52664e2SAppaRao Puli { 918b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 919b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 920b52664e2SAppaRao Puli { 921b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id; 922b52664e2SAppaRao Puli return nullptr; 923b52664e2SAppaRao Puli } 924b52664e2SAppaRao Puli std::shared_ptr<Subscription> subValue = obj->second; 925b52664e2SAppaRao Puli return subValue; 926b52664e2SAppaRao Puli } 927b52664e2SAppaRao Puli 9281bf712bcSAyushi Smriti std::string addSubscription(const std::shared_ptr<Subscription> subValue, 9291bf712bcSAyushi Smriti const bool updateFile = true) 930b52664e2SAppaRao Puli { 93123a21a1cSEd Tanous std::srand(static_cast<uint32_t>(std::time(nullptr))); 932b52664e2SAppaRao Puli std::string id; 933b52664e2SAppaRao Puli 934b52664e2SAppaRao Puli int retry = 3; 935b52664e2SAppaRao Puli while (retry) 936b52664e2SAppaRao Puli { 937b52664e2SAppaRao Puli id = std::to_string(std::rand()); 938b52664e2SAppaRao Puli auto inserted = subscriptionsMap.insert(std::pair(id, subValue)); 939b52664e2SAppaRao Puli if (inserted.second) 940b52664e2SAppaRao Puli { 941b52664e2SAppaRao Puli break; 942b52664e2SAppaRao Puli } 943b52664e2SAppaRao Puli --retry; 94423a21a1cSEd Tanous } 945b52664e2SAppaRao Puli 946b52664e2SAppaRao Puli if (retry <= 0) 947b52664e2SAppaRao Puli { 948b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Failed to generate random number"; 949b52664e2SAppaRao Puli return std::string(""); 950b52664e2SAppaRao Puli } 951b52664e2SAppaRao Puli 9527d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 9531bf712bcSAyushi Smriti 9541bf712bcSAyushi Smriti if (updateFile) 9551bf712bcSAyushi Smriti { 956b52664e2SAppaRao Puli updateSubscriptionData(); 9571bf712bcSAyushi Smriti } 9587f4eb588SAppaRao Puli 9597f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 9607f4eb588SAppaRao Puli if (lastEventTStr.empty()) 9617f4eb588SAppaRao Puli { 9627f4eb588SAppaRao Puli cacheLastEventTimestamp(); 9637f4eb588SAppaRao Puli } 9647f4eb588SAppaRao Puli #endif 965fe44eb0bSAyushi Smriti // Update retry configuration. 966fe44eb0bSAyushi Smriti subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 967fe44eb0bSAyushi Smriti subValue->updateRetryPolicy(); 968fe44eb0bSAyushi Smriti 969b52664e2SAppaRao Puli return id; 970b52664e2SAppaRao Puli } 971b52664e2SAppaRao Puli 972b52664e2SAppaRao Puli bool isSubscriptionExist(const std::string& id) 973b52664e2SAppaRao Puli { 974b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 975b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 976b52664e2SAppaRao Puli { 977b52664e2SAppaRao Puli return false; 978b52664e2SAppaRao Puli } 979b52664e2SAppaRao Puli return true; 980b52664e2SAppaRao Puli } 981b52664e2SAppaRao Puli 982b52664e2SAppaRao Puli void deleteSubscription(const std::string& id) 983b52664e2SAppaRao Puli { 984b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 985b52664e2SAppaRao Puli if (obj != subscriptionsMap.end()) 986b52664e2SAppaRao Puli { 987b52664e2SAppaRao Puli subscriptionsMap.erase(obj); 9887d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 989b52664e2SAppaRao Puli updateSubscriptionData(); 990b52664e2SAppaRao Puli } 991b52664e2SAppaRao Puli } 992b52664e2SAppaRao Puli 993b52664e2SAppaRao Puli size_t getNumberOfSubscriptions() 994b52664e2SAppaRao Puli { 995b52664e2SAppaRao Puli return subscriptionsMap.size(); 996b52664e2SAppaRao Puli } 997b52664e2SAppaRao Puli 998b52664e2SAppaRao Puli std::vector<std::string> getAllIDs() 999b52664e2SAppaRao Puli { 1000b52664e2SAppaRao Puli std::vector<std::string> idList; 1001b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 1002b52664e2SAppaRao Puli { 1003b52664e2SAppaRao Puli idList.emplace_back(it.first); 1004b52664e2SAppaRao Puli } 1005b52664e2SAppaRao Puli return idList; 1006b52664e2SAppaRao Puli } 1007b52664e2SAppaRao Puli 1008b52664e2SAppaRao Puli bool isDestinationExist(const std::string& destUrl) 1009b52664e2SAppaRao Puli { 1010b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 1011b52664e2SAppaRao Puli { 1012b52664e2SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 1013b52664e2SAppaRao Puli if (entry->destinationUrl == destUrl) 1014b52664e2SAppaRao Puli { 1015b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Destination exist already" << destUrl; 1016b52664e2SAppaRao Puli return true; 1017b52664e2SAppaRao Puli } 1018b52664e2SAppaRao Puli } 1019b52664e2SAppaRao Puli return false; 1020b52664e2SAppaRao Puli } 10210b4bdd93SAppaRao Puli 10220b4bdd93SAppaRao Puli void sendTestEventLog() 10230b4bdd93SAppaRao Puli { 10240b4bdd93SAppaRao Puli for (const auto& it : this->subscriptionsMap) 10250b4bdd93SAppaRao Puli { 10260b4bdd93SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 10270b4bdd93SAppaRao Puli entry->sendTestEventLog(); 10280b4bdd93SAppaRao Puli } 10290b4bdd93SAppaRao Puli } 1030e9a14131SAppaRao Puli 103196330b99SSunitha Harish void sendEvent(const nlohmann::json& eventMessageIn, 103296330b99SSunitha Harish const std::string& origin, const std::string& resType) 103396330b99SSunitha Harish { 103496330b99SSunitha Harish nlohmann::json eventRecord = nlohmann::json::array(); 103596330b99SSunitha Harish nlohmann::json eventMessage = eventMessageIn; 103696330b99SSunitha Harish // MemberId is 0 : since we are sending one event record. 103796330b99SSunitha Harish uint64_t memberId = 0; 103896330b99SSunitha Harish 103996330b99SSunitha Harish nlohmann::json event = { 104096330b99SSunitha Harish {"EventId", eventId}, 104196330b99SSunitha Harish {"MemberId", memberId}, 104296330b99SSunitha Harish {"EventTimestamp", crow::utility::dateTimeNow()}, 104396330b99SSunitha Harish {"OriginOfCondition", origin}}; 104496330b99SSunitha Harish for (nlohmann::json::iterator it = event.begin(); it != event.end(); 104596330b99SSunitha Harish ++it) 104696330b99SSunitha Harish { 104796330b99SSunitha Harish eventMessage[it.key()] = it.value(); 104896330b99SSunitha Harish } 104996330b99SSunitha Harish eventRecord.push_back(eventMessage); 105096330b99SSunitha Harish 105196330b99SSunitha Harish for (const auto& it : this->subscriptionsMap) 105296330b99SSunitha Harish { 105396330b99SSunitha Harish std::shared_ptr<Subscription> entry = it.second; 105496330b99SSunitha Harish bool isSubscribed = false; 105596330b99SSunitha Harish // Search the resourceTypes list for the subscription. 105696330b99SSunitha Harish // If resourceTypes list is empty, don't filter events 105796330b99SSunitha Harish // send everything. 105896330b99SSunitha Harish if (entry->resourceTypes.size()) 105996330b99SSunitha Harish { 106096330b99SSunitha Harish for (auto resource : entry->resourceTypes) 106196330b99SSunitha Harish { 106296330b99SSunitha Harish if (resType == resource) 106396330b99SSunitha Harish { 106496330b99SSunitha Harish BMCWEB_LOG_INFO << "ResourceType " << resource 106596330b99SSunitha Harish << " found in the subscribed list"; 106696330b99SSunitha Harish isSubscribed = true; 106796330b99SSunitha Harish break; 106896330b99SSunitha Harish } 106996330b99SSunitha Harish } 107096330b99SSunitha Harish } 107196330b99SSunitha Harish else // resourceTypes list is empty. 107296330b99SSunitha Harish { 107396330b99SSunitha Harish isSubscribed = true; 107496330b99SSunitha Harish } 107596330b99SSunitha Harish if (isSubscribed) 107696330b99SSunitha Harish { 107796330b99SSunitha Harish nlohmann::json msgJson = { 107896330b99SSunitha Harish {"@odata.type", "#Event.v1_4_0.Event"}, 107996330b99SSunitha Harish {"Name", "Event Log"}, 108096330b99SSunitha Harish {"Id", eventId}, 108196330b99SSunitha Harish {"Events", eventRecord}}; 108296330b99SSunitha Harish entry->sendEvent(msgJson.dump()); 108396330b99SSunitha Harish eventId++; // increament the eventId 108496330b99SSunitha Harish } 108596330b99SSunitha Harish else 108696330b99SSunitha Harish { 108796330b99SSunitha Harish BMCWEB_LOG_INFO << "Not subscribed to this resource"; 108896330b99SSunitha Harish } 108996330b99SSunitha Harish } 109096330b99SSunitha Harish } 10915738de59SAsmitha Karunanithi #ifdef BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE 10925738de59SAsmitha Karunanithi void sendBroadcastMsg(const std::string& broadcastMsg) 10935738de59SAsmitha Karunanithi { 10945738de59SAsmitha Karunanithi for (const auto& it : this->subscriptionsMap) 10955738de59SAsmitha Karunanithi { 10965738de59SAsmitha Karunanithi std::shared_ptr<Subscription> entry = it.second; 10975738de59SAsmitha Karunanithi nlohmann::json msgJson = { 10985738de59SAsmitha Karunanithi {"Timestamp", crow::utility::dateTimeNow()}, 10995738de59SAsmitha Karunanithi {"OriginOfCondition", "/ibm/v1/HMC/BroadcastService"}, 11005738de59SAsmitha Karunanithi {"Name", "Broadcast Message"}, 11015738de59SAsmitha Karunanithi {"Message", broadcastMsg}}; 11025738de59SAsmitha Karunanithi entry->sendEvent(msgJson.dump()); 11035738de59SAsmitha Karunanithi } 11045738de59SAsmitha Karunanithi } 11055738de59SAsmitha Karunanithi #endif 110696330b99SSunitha Harish 11077f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 11087f4eb588SAppaRao Puli void cacheLastEventTimestamp() 11097f4eb588SAppaRao Puli { 1110016761afSAppaRao Puli lastEventTStr.clear(); 11117f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 11127f4eb588SAppaRao Puli if (!logStream.good()) 11137f4eb588SAppaRao Puli { 11147f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed \n"; 11157f4eb588SAppaRao Puli return; 11167f4eb588SAppaRao Puli } 11177f4eb588SAppaRao Puli std::string logEntry; 11187f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 11197f4eb588SAppaRao Puli { 11207f4eb588SAppaRao Puli size_t space = logEntry.find_first_of(" "); 11217f4eb588SAppaRao Puli if (space == std::string::npos) 11227f4eb588SAppaRao Puli { 11237f4eb588SAppaRao Puli // Shouldn't enter here but lets skip it. 11247f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid log entry found."; 11257f4eb588SAppaRao Puli continue; 11267f4eb588SAppaRao Puli } 11277f4eb588SAppaRao Puli lastEventTStr = logEntry.substr(0, space); 11287f4eb588SAppaRao Puli } 11297f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Last Event time stamp set: " << lastEventTStr; 11307f4eb588SAppaRao Puli } 11317f4eb588SAppaRao Puli 11327f4eb588SAppaRao Puli void readEventLogsFromFile() 11337f4eb588SAppaRao Puli { 11347f4eb588SAppaRao Puli if (!serviceEnabled || !noOfEventLogSubscribers) 11357f4eb588SAppaRao Puli { 11367f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 11377f4eb588SAppaRao Puli return; 11387f4eb588SAppaRao Puli } 11397f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 11407f4eb588SAppaRao Puli if (!logStream.good()) 11417f4eb588SAppaRao Puli { 11427f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed"; 11437f4eb588SAppaRao Puli return; 11447f4eb588SAppaRao Puli } 11457f4eb588SAppaRao Puli 11467f4eb588SAppaRao Puli std::vector<EventLogObjectsType> eventRecords; 11477f4eb588SAppaRao Puli 11487f4eb588SAppaRao Puli bool startLogCollection = false; 11497f4eb588SAppaRao Puli bool firstEntry = true; 11507f4eb588SAppaRao Puli 11517f4eb588SAppaRao Puli std::string logEntry; 11527f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 11537f4eb588SAppaRao Puli { 1154016761afSAppaRao Puli if (!startLogCollection && !lastEventTStr.empty()) 11557f4eb588SAppaRao Puli { 11567f4eb588SAppaRao Puli if (boost::starts_with(logEntry, lastEventTStr)) 11577f4eb588SAppaRao Puli { 11587f4eb588SAppaRao Puli startLogCollection = true; 11597f4eb588SAppaRao Puli } 11607f4eb588SAppaRao Puli continue; 11617f4eb588SAppaRao Puli } 11627f4eb588SAppaRao Puli 11637f4eb588SAppaRao Puli std::string idStr; 11647f4eb588SAppaRao Puli if (!event_log::getUniqueEntryID(logEntry, idStr, firstEntry)) 11657f4eb588SAppaRao Puli { 11667f4eb588SAppaRao Puli continue; 11677f4eb588SAppaRao Puli } 11687f4eb588SAppaRao Puli firstEntry = false; 11697f4eb588SAppaRao Puli 11707f4eb588SAppaRao Puli std::string timestamp; 11717f4eb588SAppaRao Puli std::string messageID; 11725e715de6SAppaRao Puli std::vector<std::string> messageArgs; 11737f4eb588SAppaRao Puli if (event_log::getEventLogParams(logEntry, timestamp, messageID, 11747f4eb588SAppaRao Puli messageArgs) != 0) 11757f4eb588SAppaRao Puli { 11767f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry params failed"; 11777f4eb588SAppaRao Puli continue; 11787f4eb588SAppaRao Puli } 11797f4eb588SAppaRao Puli 11807f4eb588SAppaRao Puli std::string registryName; 11817f4eb588SAppaRao Puli std::string messageKey; 11827f4eb588SAppaRao Puli event_log::getRegistryAndMessageKey(messageID, registryName, 11837f4eb588SAppaRao Puli messageKey); 11847f4eb588SAppaRao Puli if (registryName.empty() || messageKey.empty()) 11857f4eb588SAppaRao Puli { 11867f4eb588SAppaRao Puli continue; 11877f4eb588SAppaRao Puli } 11887f4eb588SAppaRao Puli 11897f4eb588SAppaRao Puli lastEventTStr = timestamp; 11907f4eb588SAppaRao Puli eventRecords.emplace_back(idStr, timestamp, messageID, registryName, 11917f4eb588SAppaRao Puli messageKey, messageArgs); 11927f4eb588SAppaRao Puli } 11937f4eb588SAppaRao Puli 11947f4eb588SAppaRao Puli for (const auto& it : this->subscriptionsMap) 11957f4eb588SAppaRao Puli { 11967f4eb588SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 11977f4eb588SAppaRao Puli if (entry->eventFormatType == "Event") 11987f4eb588SAppaRao Puli { 11997f4eb588SAppaRao Puli entry->filterAndSendEventLogs(eventRecords); 12007f4eb588SAppaRao Puli } 12017f4eb588SAppaRao Puli } 12027f4eb588SAppaRao Puli } 12037f4eb588SAppaRao Puli 12047f4eb588SAppaRao Puli static void watchRedfishEventLogFile() 12057f4eb588SAppaRao Puli { 120623a21a1cSEd Tanous if (inotifyConn) 12077f4eb588SAppaRao Puli { 12087f4eb588SAppaRao Puli return; 12097f4eb588SAppaRao Puli } 12107f4eb588SAppaRao Puli 12117f4eb588SAppaRao Puli static std::array<char, 1024> readBuffer; 12127f4eb588SAppaRao Puli 12137f4eb588SAppaRao Puli inotifyConn->async_read_some( 12147f4eb588SAppaRao Puli boost::asio::buffer(readBuffer), 12157f4eb588SAppaRao Puli [&](const boost::system::error_code& ec, 12167f4eb588SAppaRao Puli const std::size_t& bytesTransferred) { 12177f4eb588SAppaRao Puli if (ec) 12187f4eb588SAppaRao Puli { 12197f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "Callback Error: " << ec.message(); 12207f4eb588SAppaRao Puli return; 12217f4eb588SAppaRao Puli } 12227f4eb588SAppaRao Puli std::size_t index = 0; 1223b792cc56SAppaRao Puli while ((index + iEventSize) <= bytesTransferred) 12247f4eb588SAppaRao Puli { 12257f4eb588SAppaRao Puli struct inotify_event event; 1226b792cc56SAppaRao Puli std::memcpy(&event, &readBuffer[index], iEventSize); 1227b792cc56SAppaRao Puli if (event.wd == dirWatchDesc) 1228b792cc56SAppaRao Puli { 1229b792cc56SAppaRao Puli if ((event.len == 0) || 1230b792cc56SAppaRao Puli (index + iEventSize + event.len > bytesTransferred)) 1231b792cc56SAppaRao Puli { 1232b792cc56SAppaRao Puli index += (iEventSize + event.len); 1233b792cc56SAppaRao Puli continue; 1234b792cc56SAppaRao Puli } 1235b792cc56SAppaRao Puli 1236b792cc56SAppaRao Puli std::string fileName(&readBuffer[index + iEventSize], 1237b792cc56SAppaRao Puli event.len); 1238b792cc56SAppaRao Puli if (std::strcmp(fileName.c_str(), "redfish") != 0) 1239b792cc56SAppaRao Puli { 1240b792cc56SAppaRao Puli index += (iEventSize + event.len); 1241b792cc56SAppaRao Puli continue; 1242b792cc56SAppaRao Puli } 1243b792cc56SAppaRao Puli 1244b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1245b792cc56SAppaRao Puli << "Redfish log file created/deleted. event.name: " 1246b792cc56SAppaRao Puli << fileName; 1247b792cc56SAppaRao Puli if (event.mask == IN_CREATE) 1248b792cc56SAppaRao Puli { 1249b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1250b792cc56SAppaRao Puli { 1251b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1252016761afSAppaRao Puli << "Remove and Add inotify watcher on " 1253016761afSAppaRao Puli "redfish event log file"; 1254016761afSAppaRao Puli // Remove existing inotify watcher and add 1255016761afSAppaRao Puli // with new redfish event log file. 1256016761afSAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1257016761afSAppaRao Puli fileWatchDesc = -1; 1258b792cc56SAppaRao Puli } 1259b792cc56SAppaRao Puli 1260b792cc56SAppaRao Puli fileWatchDesc = inotify_add_watch( 1261b792cc56SAppaRao Puli inotifyFd, redfishEventLogFile, IN_MODIFY); 1262b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1263b792cc56SAppaRao Puli { 1264b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1265b792cc56SAppaRao Puli << "inotify_add_watch failed for " 1266b792cc56SAppaRao Puli "redfish log file."; 1267b792cc56SAppaRao Puli return; 1268b792cc56SAppaRao Puli } 1269b792cc56SAppaRao Puli 1270b792cc56SAppaRao Puli EventServiceManager::getInstance() 1271b792cc56SAppaRao Puli .cacheLastEventTimestamp(); 1272b792cc56SAppaRao Puli EventServiceManager::getInstance() 1273b792cc56SAppaRao Puli .readEventLogsFromFile(); 1274b792cc56SAppaRao Puli } 1275b792cc56SAppaRao Puli else if ((event.mask == IN_DELETE) || 1276b792cc56SAppaRao Puli (event.mask == IN_MOVED_TO)) 1277b792cc56SAppaRao Puli { 1278b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1279b792cc56SAppaRao Puli { 1280b792cc56SAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1281b792cc56SAppaRao Puli fileWatchDesc = -1; 1282b792cc56SAppaRao Puli } 1283b792cc56SAppaRao Puli } 1284b792cc56SAppaRao Puli } 1285b792cc56SAppaRao Puli else if (event.wd == fileWatchDesc) 1286b792cc56SAppaRao Puli { 1287b792cc56SAppaRao Puli if (event.mask == IN_MODIFY) 12887f4eb588SAppaRao Puli { 12897f4eb588SAppaRao Puli EventServiceManager::getInstance() 12907f4eb588SAppaRao Puli .readEventLogsFromFile(); 12917f4eb588SAppaRao Puli } 1292b792cc56SAppaRao Puli } 1293b792cc56SAppaRao Puli index += (iEventSize + event.len); 12947f4eb588SAppaRao Puli } 12957f4eb588SAppaRao Puli 12967f4eb588SAppaRao Puli watchRedfishEventLogFile(); 12977f4eb588SAppaRao Puli }); 12987f4eb588SAppaRao Puli } 12997f4eb588SAppaRao Puli 13007f4eb588SAppaRao Puli static int startEventLogMonitor(boost::asio::io_context& ioc) 13017f4eb588SAppaRao Puli { 130223a21a1cSEd Tanous inotifyConn.emplace(ioc); 1303b792cc56SAppaRao Puli inotifyFd = inotify_init1(IN_NONBLOCK); 1304b792cc56SAppaRao Puli if (inotifyFd == -1) 13057f4eb588SAppaRao Puli { 13067f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "inotify_init1 failed."; 13077f4eb588SAppaRao Puli return -1; 13087f4eb588SAppaRao Puli } 1309b792cc56SAppaRao Puli 1310b792cc56SAppaRao Puli // Add watch on directory to handle redfish event log file 1311b792cc56SAppaRao Puli // create/delete. 1312b792cc56SAppaRao Puli dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir, 1313b792cc56SAppaRao Puli IN_CREATE | IN_MOVED_TO | IN_DELETE); 1314b792cc56SAppaRao Puli if (dirWatchDesc == -1) 13157f4eb588SAppaRao Puli { 13167f4eb588SAppaRao Puli BMCWEB_LOG_ERROR 1317b792cc56SAppaRao Puli << "inotify_add_watch failed for event log directory."; 13187f4eb588SAppaRao Puli return -1; 13197f4eb588SAppaRao Puli } 13207f4eb588SAppaRao Puli 1321b792cc56SAppaRao Puli // Watch redfish event log file for modifications. 1322b792cc56SAppaRao Puli fileWatchDesc = 1323b792cc56SAppaRao Puli inotify_add_watch(inotifyFd, redfishEventLogFile, IN_MODIFY); 1324b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1325b792cc56SAppaRao Puli { 1326b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1327b792cc56SAppaRao Puli << "inotify_add_watch failed for redfish log file."; 1328b792cc56SAppaRao Puli // Don't return error if file not exist. 1329b792cc56SAppaRao Puli // Watch on directory will handle create/delete of file. 1330b792cc56SAppaRao Puli } 1331b792cc56SAppaRao Puli 13327f4eb588SAppaRao Puli // monitor redfish event log file 1333b792cc56SAppaRao Puli inotifyConn->assign(inotifyFd); 13347f4eb588SAppaRao Puli watchRedfishEventLogFile(); 13357f4eb588SAppaRao Puli 13367f4eb588SAppaRao Puli return 0; 13377f4eb588SAppaRao Puli } 13387f4eb588SAppaRao Puli 13397f4eb588SAppaRao Puli #endif 13407f4eb588SAppaRao Puli 1341156d6b00SAppaRao Puli void getMetricReading(const std::string& service, 1342156d6b00SAppaRao Puli const std::string& objPath, const std::string& intf) 1343156d6b00SAppaRao Puli { 1344156d6b00SAppaRao Puli std::size_t found = objPath.find_last_of("/"); 1345156d6b00SAppaRao Puli if (found == std::string::npos) 1346156d6b00SAppaRao Puli { 1347156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid objPath received"; 1348156d6b00SAppaRao Puli return; 1349156d6b00SAppaRao Puli } 1350156d6b00SAppaRao Puli 1351156d6b00SAppaRao Puli std::string idStr = objPath.substr(found + 1); 1352156d6b00SAppaRao Puli if (idStr.empty()) 1353156d6b00SAppaRao Puli { 1354156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid ID in objPath"; 1355156d6b00SAppaRao Puli return; 1356156d6b00SAppaRao Puli } 1357156d6b00SAppaRao Puli 1358156d6b00SAppaRao Puli crow::connections::systemBus->async_method_call( 1359156d6b00SAppaRao Puli [idStr{std::move(idStr)}]( 1360156d6b00SAppaRao Puli const boost::system::error_code ec, 1361156d6b00SAppaRao Puli boost::container::flat_map< 136293f5d7c7SWludzik, Jozef std::string, std::variant<int32_t, ReadingsObjType>>& 1363156d6b00SAppaRao Puli resp) { 1364156d6b00SAppaRao Puli if (ec) 1365156d6b00SAppaRao Puli { 1366156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG 1367156d6b00SAppaRao Puli << "D-Bus call failed to GetAll metric readings."; 1368156d6b00SAppaRao Puli return; 1369156d6b00SAppaRao Puli } 1370156d6b00SAppaRao Puli 137193f5d7c7SWludzik, Jozef const int32_t* timestampPtr = 137293f5d7c7SWludzik, Jozef std::get_if<int32_t>(&resp["Timestamp"]); 1373156d6b00SAppaRao Puli if (!timestampPtr) 1374156d6b00SAppaRao Puli { 1375156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Failed to Get timestamp."; 1376156d6b00SAppaRao Puli return; 1377156d6b00SAppaRao Puli } 1378156d6b00SAppaRao Puli 1379156d6b00SAppaRao Puli ReadingsObjType* readingsPtr = 1380156d6b00SAppaRao Puli std::get_if<ReadingsObjType>(&resp["Readings"]); 1381156d6b00SAppaRao Puli if (!readingsPtr) 1382156d6b00SAppaRao Puli { 1383156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Failed to Get Readings property."; 1384156d6b00SAppaRao Puli return; 1385156d6b00SAppaRao Puli } 1386156d6b00SAppaRao Puli 1387156d6b00SAppaRao Puli if (!readingsPtr->size()) 1388156d6b00SAppaRao Puli { 1389156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "No metrics report to be transferred"; 1390156d6b00SAppaRao Puli return; 1391156d6b00SAppaRao Puli } 1392156d6b00SAppaRao Puli 1393156d6b00SAppaRao Puli for (const auto& it : 1394156d6b00SAppaRao Puli EventServiceManager::getInstance().subscriptionsMap) 1395156d6b00SAppaRao Puli { 1396156d6b00SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 1397156d6b00SAppaRao Puli if (entry->eventFormatType == metricReportFormatType) 1398156d6b00SAppaRao Puli { 139993f5d7c7SWludzik, Jozef entry->filterAndSendReports( 140093f5d7c7SWludzik, Jozef idStr, crow::utility::getDateTime(*timestampPtr), 1401156d6b00SAppaRao Puli *readingsPtr); 1402156d6b00SAppaRao Puli } 1403156d6b00SAppaRao Puli } 1404156d6b00SAppaRao Puli }, 1405156d6b00SAppaRao Puli service, objPath, "org.freedesktop.DBus.Properties", "GetAll", 1406156d6b00SAppaRao Puli intf); 1407156d6b00SAppaRao Puli } 1408156d6b00SAppaRao Puli 1409156d6b00SAppaRao Puli void unregisterMetricReportSignal() 1410156d6b00SAppaRao Puli { 14117d1cc387SAppaRao Puli if (matchTelemetryMonitor) 14127d1cc387SAppaRao Puli { 1413156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister"; 1414156d6b00SAppaRao Puli matchTelemetryMonitor.reset(); 1415156d6b00SAppaRao Puli matchTelemetryMonitor = nullptr; 1416156d6b00SAppaRao Puli } 14177d1cc387SAppaRao Puli } 1418156d6b00SAppaRao Puli 1419156d6b00SAppaRao Puli void registerMetricReportSignal() 1420156d6b00SAppaRao Puli { 14217d1cc387SAppaRao Puli if (!serviceEnabled || matchTelemetryMonitor) 1422156d6b00SAppaRao Puli { 14237d1cc387SAppaRao Puli BMCWEB_LOG_DEBUG << "Not registering metric report signal."; 1424156d6b00SAppaRao Puli return; 1425156d6b00SAppaRao Puli } 1426156d6b00SAppaRao Puli 1427156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Register"; 1428156d6b00SAppaRao Puli std::string matchStr( 1429156d6b00SAppaRao Puli "type='signal',member='ReportUpdate', " 1430156d6b00SAppaRao Puli "interface='xyz.openbmc_project.MonitoringService.Report'"); 1431156d6b00SAppaRao Puli 1432156d6b00SAppaRao Puli matchTelemetryMonitor = std::make_shared<sdbusplus::bus::match::match>( 1433156d6b00SAppaRao Puli *crow::connections::systemBus, matchStr, 1434156d6b00SAppaRao Puli [this](sdbusplus::message::message& msg) { 1435156d6b00SAppaRao Puli if (msg.is_method_error()) 1436156d6b00SAppaRao Puli { 1437156d6b00SAppaRao Puli BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error"; 1438156d6b00SAppaRao Puli return; 1439156d6b00SAppaRao Puli } 1440156d6b00SAppaRao Puli 1441156d6b00SAppaRao Puli std::string service = msg.get_sender(); 1442156d6b00SAppaRao Puli std::string objPath = msg.get_path(); 1443156d6b00SAppaRao Puli std::string intf = msg.get_interface(); 1444156d6b00SAppaRao Puli getMetricReading(service, objPath, intf); 1445156d6b00SAppaRao Puli }); 1446156d6b00SAppaRao Puli } 14471bf712bcSAyushi Smriti 14481bf712bcSAyushi Smriti bool validateAndSplitUrl(const std::string& destUrl, std::string& urlProto, 14491bf712bcSAyushi Smriti std::string& host, std::string& port, 14501bf712bcSAyushi Smriti std::string& path) 14511bf712bcSAyushi Smriti { 14521bf712bcSAyushi Smriti // Validate URL using regex expression 14531bf712bcSAyushi Smriti // Format: <protocol>://<host>:<port>/<path> 14541bf712bcSAyushi Smriti // protocol: http/https 14551bf712bcSAyushi Smriti const std::regex urlRegex( 14561bf712bcSAyushi Smriti "(http|https)://([^/\\x20\\x3f\\x23\\x3a]+):?([0-9]*)(/" 14571bf712bcSAyushi Smriti "([^\\x20\\x23\\x3f]*\\x3f?([^\\x20\\x23\\x3f])*)?)"); 14581bf712bcSAyushi Smriti std::cmatch match; 14591bf712bcSAyushi Smriti if (!std::regex_match(destUrl.c_str(), match, urlRegex)) 14601bf712bcSAyushi Smriti { 14611bf712bcSAyushi Smriti BMCWEB_LOG_INFO << "Dest. url did not match "; 14621bf712bcSAyushi Smriti return false; 14631bf712bcSAyushi Smriti } 14641bf712bcSAyushi Smriti 14651bf712bcSAyushi Smriti urlProto = std::string(match[1].first, match[1].second); 14661bf712bcSAyushi Smriti if (urlProto == "http") 14671bf712bcSAyushi Smriti { 14681bf712bcSAyushi Smriti #ifndef BMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING 14691bf712bcSAyushi Smriti return false; 14701bf712bcSAyushi Smriti #endif 14711bf712bcSAyushi Smriti } 14721bf712bcSAyushi Smriti 14731bf712bcSAyushi Smriti host = std::string(match[2].first, match[2].second); 14741bf712bcSAyushi Smriti port = std::string(match[3].first, match[3].second); 14751bf712bcSAyushi Smriti path = std::string(match[4].first, match[4].second); 14761bf712bcSAyushi Smriti if (port.empty()) 14771bf712bcSAyushi Smriti { 14781bf712bcSAyushi Smriti if (urlProto == "http") 14791bf712bcSAyushi Smriti { 14801bf712bcSAyushi Smriti port = "80"; 14811bf712bcSAyushi Smriti } 14821bf712bcSAyushi Smriti else 14831bf712bcSAyushi Smriti { 14841bf712bcSAyushi Smriti port = "443"; 14851bf712bcSAyushi Smriti } 14861bf712bcSAyushi Smriti } 14871bf712bcSAyushi Smriti if (path.empty()) 14881bf712bcSAyushi Smriti { 14891bf712bcSAyushi Smriti path = "/"; 14901bf712bcSAyushi Smriti } 14911bf712bcSAyushi Smriti return true; 14921bf712bcSAyushi Smriti } 149323a21a1cSEd Tanous }; 1494b52664e2SAppaRao Puli 1495b52664e2SAppaRao Puli } // namespace redfish 1496