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 17c0353249SWludzik, Jozef #include "metric_report.hpp" 187f4eb588SAppaRao Puli #include "registries.hpp" 197f4eb588SAppaRao Puli #include "registries/base_message_registry.hpp" 207f4eb588SAppaRao Puli #include "registries/openbmc_message_registry.hpp" 21b304bd79SP Dheeraj Srujan Kumar #include "registries/task_event_message_registry.hpp" 227f4eb588SAppaRao Puli 237f4eb588SAppaRao Puli #include <sys/inotify.h> 24b52664e2SAppaRao Puli 2511ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp> 2611ba3979SEd Tanous #include <boost/algorithm/string/split.hpp> 27fb4fd5d4SZhenfei Tai #include <boost/asio/io_context.hpp> 28b52664e2SAppaRao Puli #include <boost/container/flat_map.hpp> 29168e20c1SEd Tanous #include <dbus_utility.hpp> 301214b7e7SGunnar Mills #include <error_messages.hpp> 3128afb49cSJunLin Chen #include <event_service_store.hpp> 32eb1c47d3SEd Tanous #include <http/utility.hpp> 331214b7e7SGunnar Mills #include <http_client.hpp> 3428afb49cSJunLin Chen #include <persistent_data.hpp> 35fc76b8acSEd Tanous #include <random.hpp> 36b5b40605Snitroglycerine #include <sdbusplus/bus/match.hpp> 374bbf237fSAppaRao Puli #include <server_sent_events.hpp> 381214b7e7SGunnar Mills #include <utils/json_utils.hpp> 391214b7e7SGunnar Mills 40b52664e2SAppaRao Puli #include <cstdlib> 41b52664e2SAppaRao Puli #include <ctime> 421bf712bcSAyushi Smriti #include <fstream> 43b52664e2SAppaRao Puli #include <memory> 4426702d01SEd Tanous #include <span> 45b52664e2SAppaRao Puli 46b52664e2SAppaRao Puli namespace redfish 47b52664e2SAppaRao Puli { 48156d6b00SAppaRao Puli 49156d6b00SAppaRao Puli using ReadingsObjType = 5093f5d7c7SWludzik, Jozef std::vector<std::tuple<std::string, std::string, double, int32_t>>; 51156d6b00SAppaRao Puli 52156d6b00SAppaRao Puli static constexpr const char* eventFormatType = "Event"; 53156d6b00SAppaRao Puli static constexpr const char* metricReportFormatType = "MetricReport"; 54156d6b00SAppaRao Puli 551bf712bcSAyushi Smriti static constexpr const char* eventServiceFile = 561bf712bcSAyushi Smriti "/var/lib/bmcweb/eventservice_config.json"; 571bf712bcSAyushi Smriti 58fffb8c1fSEd Tanous namespace registries 597f4eb588SAppaRao Puli { 6026702d01SEd Tanous inline std::span<const MessageEntry> 61b304bd79SP Dheeraj Srujan Kumar getRegistryFromPrefix(const std::string& registryName) 62b304bd79SP Dheeraj Srujan Kumar { 63b304bd79SP Dheeraj Srujan Kumar if (task_event::header.registryPrefix == registryName) 64b304bd79SP Dheeraj Srujan Kumar { 6526702d01SEd Tanous return {task_event::registry}; 66b304bd79SP Dheeraj Srujan Kumar } 67b304bd79SP Dheeraj Srujan Kumar if (openbmc::header.registryPrefix == registryName) 68b304bd79SP Dheeraj Srujan Kumar { 6926702d01SEd Tanous return {openbmc::registry}; 70b304bd79SP Dheeraj Srujan Kumar } 71b304bd79SP Dheeraj Srujan Kumar if (base::header.registryPrefix == registryName) 72b304bd79SP Dheeraj Srujan Kumar { 7326702d01SEd Tanous return {base::registry}; 74b304bd79SP Dheeraj Srujan Kumar } 7526702d01SEd Tanous return {openbmc::registry}; 76b304bd79SP Dheeraj Srujan Kumar } 77fffb8c1fSEd Tanous } // namespace registries 78b304bd79SP Dheeraj Srujan Kumar 794642bf8fSGeorge Liu #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 804642bf8fSGeorge Liu static std::optional<boost::asio::posix::stream_descriptor> inotifyConn; 814642bf8fSGeorge Liu static constexpr const char* redfishEventLogDir = "/var/log"; 824642bf8fSGeorge Liu static constexpr const char* redfishEventLogFile = "/var/log/redfish"; 834642bf8fSGeorge Liu static constexpr const size_t iEventSize = sizeof(inotify_event); 844642bf8fSGeorge Liu static int inotifyFd = -1; 854642bf8fSGeorge Liu static int dirWatchDesc = -1; 864642bf8fSGeorge Liu static int fileWatchDesc = -1; 874642bf8fSGeorge Liu 884642bf8fSGeorge Liu // <ID, timestamp, RedfishLogId, registryPrefix, MessageId, MessageArgs> 894642bf8fSGeorge Liu using EventLogObjectsType = 904642bf8fSGeorge Liu std::tuple<std::string, std::string, std::string, std::string, std::string, 914642bf8fSGeorge Liu std::vector<std::string>>; 924642bf8fSGeorge Liu 93fffb8c1fSEd Tanous namespace registries 944642bf8fSGeorge Liu { 957f4eb588SAppaRao Puli static const Message* 967f4eb588SAppaRao Puli getMsgFromRegistry(const std::string& messageKey, 9726702d01SEd Tanous const std::span<const MessageEntry>& registry) 987f4eb588SAppaRao Puli { 9926702d01SEd Tanous std::span<const MessageEntry>::iterator messageIt = 10026702d01SEd Tanous std::find_if(registry.begin(), registry.end(), 1017f4eb588SAppaRao Puli [&messageKey](const MessageEntry& messageEntry) { 10255f79e6fSEd Tanous return messageKey == messageEntry.first; 1037f4eb588SAppaRao Puli }); 10426702d01SEd Tanous if (messageIt != registry.end()) 1057f4eb588SAppaRao Puli { 1067f4eb588SAppaRao Puli return &messageIt->second; 1077f4eb588SAppaRao Puli } 1087f4eb588SAppaRao Puli 1097f4eb588SAppaRao Puli return nullptr; 1107f4eb588SAppaRao Puli } 1117f4eb588SAppaRao Puli 1127f4eb588SAppaRao Puli static const Message* formatMessage(const std::string_view& messageID) 1137f4eb588SAppaRao Puli { 1147f4eb588SAppaRao Puli // Redfish MessageIds are in the form 1157f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 1167f4eb588SAppaRao Puli // the right Message 1177f4eb588SAppaRao Puli std::vector<std::string> fields; 1187f4eb588SAppaRao Puli fields.reserve(4); 1197f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 1207f4eb588SAppaRao Puli if (fields.size() != 4) 1217f4eb588SAppaRao Puli { 1227f4eb588SAppaRao Puli return nullptr; 1237f4eb588SAppaRao Puli } 12402cad96eSEd Tanous const std::string& registryName = fields[0]; 12502cad96eSEd Tanous const std::string& messageKey = fields[3]; 1267f4eb588SAppaRao Puli 1277f4eb588SAppaRao Puli // Find the right registry and check it for the MessageKey 128b304bd79SP Dheeraj Srujan Kumar return getMsgFromRegistry(messageKey, getRegistryFromPrefix(registryName)); 1297f4eb588SAppaRao Puli } 130fffb8c1fSEd Tanous } // namespace registries 1317f4eb588SAppaRao Puli 1327f4eb588SAppaRao Puli namespace event_log 1337f4eb588SAppaRao Puli { 1342558979cSP Dheeraj Srujan Kumar inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID) 1357f4eb588SAppaRao Puli { 1367f4eb588SAppaRao Puli static time_t prevTs = 0; 1377f4eb588SAppaRao Puli static int index = 0; 1387f4eb588SAppaRao Puli 1397f4eb588SAppaRao Puli // Get the entry timestamp 1407f4eb588SAppaRao Puli std::time_t curTs = 0; 1417f4eb588SAppaRao Puli std::tm timeStruct = {}; 1427f4eb588SAppaRao Puli std::istringstream entryStream(logEntry); 1437f4eb588SAppaRao Puli if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 1447f4eb588SAppaRao Puli { 1457f4eb588SAppaRao Puli curTs = std::mktime(&timeStruct); 1467f4eb588SAppaRao Puli if (curTs == -1) 1477f4eb588SAppaRao Puli { 1487f4eb588SAppaRao Puli return false; 1497f4eb588SAppaRao Puli } 1507f4eb588SAppaRao Puli } 1517f4eb588SAppaRao Puli // If the timestamp isn't unique, increment the index 1527f4eb588SAppaRao Puli index = (curTs == prevTs) ? index + 1 : 0; 1537f4eb588SAppaRao Puli 1547f4eb588SAppaRao Puli // Save the timestamp 1557f4eb588SAppaRao Puli prevTs = curTs; 1567f4eb588SAppaRao Puli 1577f4eb588SAppaRao Puli entryID = std::to_string(curTs); 1587f4eb588SAppaRao Puli if (index > 0) 1597f4eb588SAppaRao Puli { 1607f4eb588SAppaRao Puli entryID += "_" + std::to_string(index); 1617f4eb588SAppaRao Puli } 1627f4eb588SAppaRao Puli return true; 1637f4eb588SAppaRao Puli } 1647f4eb588SAppaRao Puli 16523a21a1cSEd Tanous inline int getEventLogParams(const std::string& logEntry, 16623a21a1cSEd Tanous std::string& timestamp, std::string& messageID, 1675e715de6SAppaRao Puli std::vector<std::string>& messageArgs) 1687f4eb588SAppaRao Puli { 1697f4eb588SAppaRao Puli // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1707f4eb588SAppaRao Puli // First get the Timestamp 171f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1727f4eb588SAppaRao Puli if (space == std::string::npos) 1737f4eb588SAppaRao Puli { 1747f4eb588SAppaRao Puli return -EINVAL; 1757f4eb588SAppaRao Puli } 1767f4eb588SAppaRao Puli timestamp = logEntry.substr(0, space); 1777f4eb588SAppaRao Puli // Then get the log contents 178f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1797f4eb588SAppaRao Puli if (entryStart == std::string::npos) 1807f4eb588SAppaRao Puli { 1817f4eb588SAppaRao Puli return -EINVAL; 1827f4eb588SAppaRao Puli } 1837f4eb588SAppaRao Puli std::string_view entry(logEntry); 1847f4eb588SAppaRao Puli entry.remove_prefix(entryStart); 1857f4eb588SAppaRao Puli // Use split to separate the entry into its fields 1867f4eb588SAppaRao Puli std::vector<std::string> logEntryFields; 1877f4eb588SAppaRao Puli boost::split(logEntryFields, entry, boost::is_any_of(","), 1887f4eb588SAppaRao Puli boost::token_compress_on); 1897f4eb588SAppaRao Puli // We need at least a MessageId to be valid 19026f6976fSEd Tanous if (logEntryFields.empty()) 1917f4eb588SAppaRao Puli { 1927f4eb588SAppaRao Puli return -EINVAL; 1937f4eb588SAppaRao Puli } 1947f4eb588SAppaRao Puli messageID = logEntryFields[0]; 1957f4eb588SAppaRao Puli 1967f4eb588SAppaRao Puli // Get the MessageArgs from the log if there are any 1977f4eb588SAppaRao Puli if (logEntryFields.size() > 1) 1987f4eb588SAppaRao Puli { 19902cad96eSEd Tanous const std::string& messageArgsStart = logEntryFields[1]; 2007f4eb588SAppaRao Puli // If the first string is empty, assume there are no MessageArgs 2017f4eb588SAppaRao Puli if (!messageArgsStart.empty()) 2027f4eb588SAppaRao Puli { 2035e715de6SAppaRao Puli messageArgs.assign(logEntryFields.begin() + 1, 2045e715de6SAppaRao Puli logEntryFields.end()); 2057f4eb588SAppaRao Puli } 2067f4eb588SAppaRao Puli } 2077f4eb588SAppaRao Puli 2087f4eb588SAppaRao Puli return 0; 2097f4eb588SAppaRao Puli } 2107f4eb588SAppaRao Puli 21123a21a1cSEd Tanous inline void getRegistryAndMessageKey(const std::string& messageID, 2127f4eb588SAppaRao Puli std::string& registryName, 2137f4eb588SAppaRao Puli std::string& messageKey) 2147f4eb588SAppaRao Puli { 2157f4eb588SAppaRao Puli // Redfish MessageIds are in the form 2167f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 2177f4eb588SAppaRao Puli // the right Message 2187f4eb588SAppaRao Puli std::vector<std::string> fields; 2197f4eb588SAppaRao Puli fields.reserve(4); 2207f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 2217f4eb588SAppaRao Puli if (fields.size() == 4) 2227f4eb588SAppaRao Puli { 2237f4eb588SAppaRao Puli registryName = fields[0]; 2247f4eb588SAppaRao Puli messageKey = fields[3]; 2257f4eb588SAppaRao Puli } 2267f4eb588SAppaRao Puli } 2277f4eb588SAppaRao Puli 22823a21a1cSEd Tanous inline int formatEventLogEntry(const std::string& logEntryID, 2297f4eb588SAppaRao Puli const std::string& messageID, 230c5ba4c27SEd Tanous const std::span<std::string_view> messageArgs, 23123a21a1cSEd Tanous std::string timestamp, 232b5a76932SEd Tanous const std::string& customText, 2337f4eb588SAppaRao Puli nlohmann::json& logEntryJson) 2347f4eb588SAppaRao Puli { 2357f4eb588SAppaRao Puli // Get the Message from the MessageRegistry 236fffb8c1fSEd Tanous const registries::Message* message = registries::formatMessage(messageID); 2377f4eb588SAppaRao Puli 23880f595e7SEd Tanous if (message == nullptr) 2397f4eb588SAppaRao Puli { 24080f595e7SEd Tanous return -1; 2417f4eb588SAppaRao Puli } 2427f4eb588SAppaRao Puli 24380f595e7SEd Tanous std::string msg = 24480f595e7SEd Tanous redfish::registries::fillMessageArgs(messageArgs, message->message); 24580f595e7SEd Tanous if (msg.empty()) 24680f595e7SEd Tanous { 24780f595e7SEd Tanous return -1; 24880f595e7SEd Tanous } 2497f4eb588SAppaRao Puli 2507f4eb588SAppaRao Puli // Get the Created time from the timestamp. The log timestamp is in 2517f4eb588SAppaRao Puli // RFC3339 format which matches the Redfish format except for the 2527f4eb588SAppaRao Puli // fractional seconds between the '.' and the '+', so just remove them. 253f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 254b2f7609bSEd Tanous std::size_t plus = timestamp.find_first_of('+', dot); 2557f4eb588SAppaRao Puli if (dot != std::string::npos && plus != std::string::npos) 2567f4eb588SAppaRao Puli { 2577f4eb588SAppaRao Puli timestamp.erase(dot, plus - dot); 2587f4eb588SAppaRao Puli } 2597f4eb588SAppaRao Puli 2607f4eb588SAppaRao Puli // Fill in the log entry with the gathered data 2611476687dSEd Tanous logEntryJson["EventId"] = logEntryID; 2621476687dSEd Tanous logEntryJson["EventType"] = "Event"; 26380f595e7SEd Tanous logEntryJson["Severity"] = message->messageSeverity; 2641476687dSEd Tanous logEntryJson["Message"] = std::move(msg); 2651476687dSEd Tanous logEntryJson["MessageId"] = messageID; 2661476687dSEd Tanous logEntryJson["MessageArgs"] = messageArgs; 2671476687dSEd Tanous logEntryJson["EventTimestamp"] = std::move(timestamp); 2681476687dSEd Tanous logEntryJson["Context"] = customText; 2697f4eb588SAppaRao Puli return 0; 2707f4eb588SAppaRao Puli } 2717f4eb588SAppaRao Puli 2727f4eb588SAppaRao Puli } // namespace event_log 2737f4eb588SAppaRao Puli #endif 2747f4eb588SAppaRao Puli 27523a21a1cSEd Tanous inline bool isFilterQuerySpecialChar(char c) 27607941a88SAyushi Smriti { 27707941a88SAyushi Smriti switch (c) 27807941a88SAyushi Smriti { 27907941a88SAyushi Smriti case '(': 28007941a88SAyushi Smriti case ')': 28107941a88SAyushi Smriti case '\'': 28207941a88SAyushi Smriti return true; 28307941a88SAyushi Smriti default: 28407941a88SAyushi Smriti return false; 28507941a88SAyushi Smriti } 28607941a88SAyushi Smriti } 28707941a88SAyushi Smriti 28823a21a1cSEd Tanous inline bool 28923a21a1cSEd Tanous readSSEQueryParams(std::string sseFilter, std::string& formatType, 29007941a88SAyushi Smriti std::vector<std::string>& messageIds, 29107941a88SAyushi Smriti std::vector<std::string>& registryPrefixes, 292144b6318SAppaRao Puli std::vector<std::string>& metricReportDefinitions) 29307941a88SAyushi Smriti { 29407941a88SAyushi Smriti sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(), 29507941a88SAyushi Smriti isFilterQuerySpecialChar), 29607941a88SAyushi Smriti sseFilter.end()); 29707941a88SAyushi Smriti 29807941a88SAyushi Smriti std::vector<std::string> result; 29907941a88SAyushi Smriti boost::split(result, sseFilter, boost::is_any_of(" "), 30007941a88SAyushi Smriti boost::token_compress_on); 30107941a88SAyushi Smriti 30207941a88SAyushi Smriti BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size(); 30307941a88SAyushi Smriti 30407941a88SAyushi Smriti constexpr uint8_t divisor = 4; 30507941a88SAyushi Smriti constexpr uint8_t minTokenSize = 3; 30607941a88SAyushi Smriti if (result.size() % divisor != minTokenSize) 30707941a88SAyushi Smriti { 30807941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid SSE filter specified."; 30907941a88SAyushi Smriti return false; 31007941a88SAyushi Smriti } 31107941a88SAyushi Smriti 31207941a88SAyushi Smriti for (std::size_t i = 0; i < result.size(); i += divisor) 31307941a88SAyushi Smriti { 31402cad96eSEd Tanous const std::string& key = result[i]; 31502cad96eSEd Tanous const std::string& op = result[i + 1]; 31602cad96eSEd Tanous const std::string& value = result[i + 2]; 31707941a88SAyushi Smriti 31807941a88SAyushi Smriti if ((i + minTokenSize) < result.size()) 31907941a88SAyushi Smriti { 32002cad96eSEd Tanous const std::string& separator = result[i + minTokenSize]; 32107941a88SAyushi Smriti // SSE supports only "or" and "and" in query params. 3224e0453b1SGunnar Mills if ((separator != "or") && (separator != "and")) 32307941a88SAyushi Smriti { 32407941a88SAyushi Smriti BMCWEB_LOG_ERROR 32507941a88SAyushi Smriti << "Invalid group operator in SSE query parameters"; 32607941a88SAyushi Smriti return false; 32707941a88SAyushi Smriti } 32807941a88SAyushi Smriti } 32907941a88SAyushi Smriti 33007941a88SAyushi Smriti // SSE supports only "eq" as per spec. 33107941a88SAyushi Smriti if (op != "eq") 33207941a88SAyushi Smriti { 33307941a88SAyushi Smriti BMCWEB_LOG_ERROR 33407941a88SAyushi Smriti << "Invalid assignment operator in SSE query parameters"; 33507941a88SAyushi Smriti return false; 33607941a88SAyushi Smriti } 33707941a88SAyushi Smriti 33807941a88SAyushi Smriti BMCWEB_LOG_DEBUG << key << " : " << value; 33907941a88SAyushi Smriti if (key == "EventFormatType") 34007941a88SAyushi Smriti { 34107941a88SAyushi Smriti formatType = value; 34207941a88SAyushi Smriti } 34307941a88SAyushi Smriti else if (key == "MessageId") 34407941a88SAyushi Smriti { 34507941a88SAyushi Smriti messageIds.push_back(value); 34607941a88SAyushi Smriti } 34707941a88SAyushi Smriti else if (key == "RegistryPrefix") 34807941a88SAyushi Smriti { 34907941a88SAyushi Smriti registryPrefixes.push_back(value); 35007941a88SAyushi Smriti } 35107941a88SAyushi Smriti else if (key == "MetricReportDefinition") 35207941a88SAyushi Smriti { 35307941a88SAyushi Smriti metricReportDefinitions.push_back(value); 35407941a88SAyushi Smriti } 35507941a88SAyushi Smriti else 35607941a88SAyushi Smriti { 35707941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid property(" << key 35807941a88SAyushi Smriti << ")in SSE filter query."; 35907941a88SAyushi Smriti return false; 36007941a88SAyushi Smriti } 36107941a88SAyushi Smriti } 36207941a88SAyushi Smriti return true; 36307941a88SAyushi Smriti } 36407941a88SAyushi Smriti 36528afb49cSJunLin Chen class Subscription : public persistent_data::UserSubscription 366b52664e2SAppaRao Puli { 367b52664e2SAppaRao Puli public: 368b52664e2SAppaRao Puli Subscription(const Subscription&) = delete; 369b52664e2SAppaRao Puli Subscription& operator=(const Subscription&) = delete; 370b52664e2SAppaRao Puli Subscription(Subscription&&) = delete; 371b52664e2SAppaRao Puli Subscription& operator=(Subscription&&) = delete; 372b52664e2SAppaRao Puli 373eb1c47d3SEd Tanous Subscription(const std::string& inHost, uint16_t inPort, 374b52664e2SAppaRao Puli const std::string& inPath, const std::string& inUriProto) : 3750b4bdd93SAppaRao Puli eventSeqNum(1), 3760b4bdd93SAppaRao Puli host(inHost), port(inPort), path(inPath), uriProto(inUriProto) 377b52664e2SAppaRao Puli { 3787adb85acSSunitha Harish // Subscription constructor 379b52664e2SAppaRao Puli } 3804bbf237fSAppaRao Puli 3814e23a444SEd Tanous explicit Subscription( 3820d5f5cf4SEd Tanous const std::shared_ptr<boost::asio::ip::tcp::socket>& adaptor) : 383b31cef67SEd Tanous eventSeqNum(1), 384b31cef67SEd Tanous sseConn(std::make_shared<crow::ServerSentEvents>(adaptor)) 385b31cef67SEd Tanous {} 3864bbf237fSAppaRao Puli 3879f616dd1SEd Tanous ~Subscription() = default; 388b52664e2SAppaRao Puli 389f52c03c1SCarson Labrado bool sendEvent(std::string& msg) 390b52664e2SAppaRao Puli { 3916ba8c82eSsunharis_in persistent_data::EventServiceConfig eventServiceConfig = 3926ba8c82eSsunharis_in persistent_data::EventServiceStore::getInstance() 3936ba8c82eSsunharis_in .getEventServiceConfig(); 3946ba8c82eSsunharis_in if (!eventServiceConfig.enabled) 3956ba8c82eSsunharis_in { 3966ba8c82eSsunharis_in return false; 3976ba8c82eSsunharis_in } 3986ba8c82eSsunharis_in 399e38778a5SAppaRao Puli bool useSSL = (uriProto == "https"); 400f52c03c1SCarson Labrado // A connection pool will be created if one does not already exist 401244256ccSCarson Labrado crow::HttpClient::getInstance().sendData( 402e38778a5SAppaRao Puli msg, id, host, port, path, useSSL, httpHeaders, 403244256ccSCarson Labrado boost::beast::http::verb::post, retryPolicyName); 4047adb85acSSunitha Harish eventSeqNum++; 4057adb85acSSunitha Harish 4064bbf237fSAppaRao Puli if (sseConn != nullptr) 4074bbf237fSAppaRao Puli { 4084bbf237fSAppaRao Puli sseConn->sendData(eventSeqNum, msg); 4094bbf237fSAppaRao Puli } 4106ba8c82eSsunharis_in return true; 4114bbf237fSAppaRao Puli } 4124bbf237fSAppaRao Puli 4136ba8c82eSsunharis_in bool sendTestEventLog() 4140b4bdd93SAppaRao Puli { 4150b4bdd93SAppaRao Puli nlohmann::json logEntryArray; 4160b4bdd93SAppaRao Puli logEntryArray.push_back({}); 4170b4bdd93SAppaRao Puli nlohmann::json& logEntryJson = logEntryArray.back(); 4180b4bdd93SAppaRao Puli 419*613dabeaSEd Tanous logEntryJson["EventId"] = "TestID"; 420*613dabeaSEd Tanous logEntryJson["EventType"] = "Event"; 421*613dabeaSEd Tanous logEntryJson["Severity"] = "OK"; 422*613dabeaSEd Tanous logEntryJson["Message"] = "Generated test event"; 423*613dabeaSEd Tanous logEntryJson["MessageId"] = "OpenBMC.0.2.TestEventLog"; 424*613dabeaSEd Tanous logEntryJson["MessageArgs"] = nlohmann::json::array(); 425*613dabeaSEd Tanous logEntryJson["EventTimestamp"] = 426*613dabeaSEd Tanous redfish::time_utils::getDateTimeOffsetNow().first; 427*613dabeaSEd Tanous logEntryJson["Context"] = customText; 4280b4bdd93SAppaRao Puli 4291476687dSEd Tanous nlohmann::json msg; 4301476687dSEd Tanous msg["@odata.type"] = "#Event.v1_4_0.Event"; 4311476687dSEd Tanous msg["Id"] = std::to_string(eventSeqNum); 4321476687dSEd Tanous msg["Name"] = "Event Log"; 4331476687dSEd Tanous msg["Events"] = logEntryArray; 4340b4bdd93SAppaRao Puli 435f52c03c1SCarson Labrado std::string strMsg = 436f52c03c1SCarson Labrado msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); 437f52c03c1SCarson Labrado return this->sendEvent(strMsg); 4380b4bdd93SAppaRao Puli } 4390b4bdd93SAppaRao Puli 4407f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 4417f4eb588SAppaRao Puli void filterAndSendEventLogs( 4427f4eb588SAppaRao Puli const std::vector<EventLogObjectsType>& eventRecords) 4437f4eb588SAppaRao Puli { 4447f4eb588SAppaRao Puli nlohmann::json logEntryArray; 4457f4eb588SAppaRao Puli for (const EventLogObjectsType& logEntry : eventRecords) 4467f4eb588SAppaRao Puli { 4477f4eb588SAppaRao Puli const std::string& idStr = std::get<0>(logEntry); 4487f4eb588SAppaRao Puli const std::string& timestamp = std::get<1>(logEntry); 4497f4eb588SAppaRao Puli const std::string& messageID = std::get<2>(logEntry); 4507f4eb588SAppaRao Puli const std::string& registryName = std::get<3>(logEntry); 4517f4eb588SAppaRao Puli const std::string& messageKey = std::get<4>(logEntry); 4525e715de6SAppaRao Puli const std::vector<std::string>& messageArgs = std::get<5>(logEntry); 4537f4eb588SAppaRao Puli 4547f4eb588SAppaRao Puli // If registryPrefixes list is empty, don't filter events 4557f4eb588SAppaRao Puli // send everything. 45626f6976fSEd Tanous if (!registryPrefixes.empty()) 4577f4eb588SAppaRao Puli { 4587f4eb588SAppaRao Puli auto obj = std::find(registryPrefixes.begin(), 4597f4eb588SAppaRao Puli registryPrefixes.end(), registryName); 4607f4eb588SAppaRao Puli if (obj == registryPrefixes.end()) 4617f4eb588SAppaRao Puli { 4627f4eb588SAppaRao Puli continue; 4637f4eb588SAppaRao Puli } 4647f4eb588SAppaRao Puli } 4657f4eb588SAppaRao Puli 4667f4eb588SAppaRao Puli // If registryMsgIds list is empty, don't filter events 4677f4eb588SAppaRao Puli // send everything. 46826f6976fSEd Tanous if (!registryMsgIds.empty()) 4697f4eb588SAppaRao Puli { 4707f4eb588SAppaRao Puli auto obj = std::find(registryMsgIds.begin(), 4717f4eb588SAppaRao Puli registryMsgIds.end(), messageKey); 4727f4eb588SAppaRao Puli if (obj == registryMsgIds.end()) 4737f4eb588SAppaRao Puli { 4747f4eb588SAppaRao Puli continue; 4757f4eb588SAppaRao Puli } 4767f4eb588SAppaRao Puli } 4777f4eb588SAppaRao Puli 478c5ba4c27SEd Tanous std::vector<std::string_view> messageArgsView(messageArgs.begin(), 479c5ba4c27SEd Tanous messageArgs.end()); 480c5ba4c27SEd Tanous 4817f4eb588SAppaRao Puli logEntryArray.push_back({}); 4827f4eb588SAppaRao Puli nlohmann::json& bmcLogEntry = logEntryArray.back(); 483c5ba4c27SEd Tanous if (event_log::formatEventLogEntry(idStr, messageID, 484c5ba4c27SEd Tanous messageArgsView, timestamp, 485c5ba4c27SEd Tanous customText, bmcLogEntry) != 0) 4867f4eb588SAppaRao Puli { 4877f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry failed"; 4887f4eb588SAppaRao Puli continue; 4897f4eb588SAppaRao Puli } 4907f4eb588SAppaRao Puli } 4917f4eb588SAppaRao Puli 49226f6976fSEd Tanous if (logEntryArray.empty()) 4937f4eb588SAppaRao Puli { 4947f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 4957f4eb588SAppaRao Puli return; 4967f4eb588SAppaRao Puli } 4977f4eb588SAppaRao Puli 4981476687dSEd Tanous nlohmann::json msg; 4991476687dSEd Tanous msg["@odata.type"] = "#Event.v1_4_0.Event"; 5001476687dSEd Tanous msg["Id"] = std::to_string(eventSeqNum); 5011476687dSEd Tanous msg["Name"] = "Event Log"; 5021476687dSEd Tanous msg["Events"] = logEntryArray; 5037f4eb588SAppaRao Puli 504f52c03c1SCarson Labrado std::string strMsg = 505f52c03c1SCarson Labrado msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); 506f52c03c1SCarson Labrado this->sendEvent(strMsg); 5077f4eb588SAppaRao Puli } 5087f4eb588SAppaRao Puli #endif 5097f4eb588SAppaRao Puli 510248d0230SEd Tanous void filterAndSendReports(const std::string& reportId, 5111e1e598dSJonathan Doman const telemetry::TimestampReadings& var) 512156d6b00SAppaRao Puli { 513456cd875SSzymon Dompke boost::urls::url mrdUri = 514456cd875SSzymon Dompke crow::utility::urlFromPieces("redfish", "v1", "TelemetryService", 515456cd875SSzymon Dompke "MetricReportDefinitions", reportId); 516156d6b00SAppaRao Puli 517156d6b00SAppaRao Puli // Empty list means no filter. Send everything. 51826f6976fSEd Tanous if (!metricReportDefinitions.empty()) 519156d6b00SAppaRao Puli { 520156d6b00SAppaRao Puli if (std::find(metricReportDefinitions.begin(), 521156d6b00SAppaRao Puli metricReportDefinitions.end(), 522456cd875SSzymon Dompke mrdUri.string()) == metricReportDefinitions.end()) 523156d6b00SAppaRao Puli { 524156d6b00SAppaRao Puli return; 525156d6b00SAppaRao Puli } 526156d6b00SAppaRao Puli } 527156d6b00SAppaRao Puli 528c0353249SWludzik, Jozef nlohmann::json msg; 529248d0230SEd Tanous if (!telemetry::fillReport(msg, reportId, var)) 530156d6b00SAppaRao Puli { 531c0353249SWludzik, Jozef BMCWEB_LOG_ERROR << "Failed to fill the MetricReport for DBus " 532c0353249SWludzik, Jozef "Report with id " 533248d0230SEd Tanous << reportId; 534c0353249SWludzik, Jozef return; 535156d6b00SAppaRao Puli } 536156d6b00SAppaRao Puli 53722daffd7SAppaRao Puli // Context is set by user during Event subscription and it must be 53822daffd7SAppaRao Puli // set for MetricReport response. 53922daffd7SAppaRao Puli if (!customText.empty()) 54022daffd7SAppaRao Puli { 54122daffd7SAppaRao Puli msg["Context"] = customText; 54222daffd7SAppaRao Puli } 54322daffd7SAppaRao Puli 544f52c03c1SCarson Labrado std::string strMsg = 545f52c03c1SCarson Labrado msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace); 546f52c03c1SCarson Labrado this->sendEvent(strMsg); 547156d6b00SAppaRao Puli } 548156d6b00SAppaRao Puli 549fe44eb0bSAyushi Smriti void updateRetryConfig(const uint32_t retryAttempts, 550fe44eb0bSAyushi Smriti const uint32_t retryTimeoutInterval) 551fe44eb0bSAyushi Smriti { 552f52c03c1SCarson Labrado crow::HttpClient::getInstance().setRetryConfig( 553a7a80296SCarson Labrado retryAttempts, retryTimeoutInterval, retryRespHandler, 554a7a80296SCarson Labrado retryPolicyName); 55562de0c68SAppaRao Puli } 556fe44eb0bSAyushi Smriti 557fe44eb0bSAyushi Smriti void updateRetryPolicy() 558fe44eb0bSAyushi Smriti { 559f52c03c1SCarson Labrado crow::HttpClient::getInstance().setRetryPolicy(retryPolicy, 560f52c03c1SCarson Labrado retryPolicyName); 56162de0c68SAppaRao Puli } 562fe44eb0bSAyushi Smriti 5639eb808c1SEd Tanous uint64_t getEventSeqNum() const 56496330b99SSunitha Harish { 56596330b99SSunitha Harish return eventSeqNum; 56696330b99SSunitha Harish } 56796330b99SSunitha Harish 568b52664e2SAppaRao Puli private: 5690b4bdd93SAppaRao Puli uint64_t eventSeqNum; 570b52664e2SAppaRao Puli std::string host; 571eb1c47d3SEd Tanous uint16_t port = 0; 572b52664e2SAppaRao Puli std::string path; 573b52664e2SAppaRao Puli std::string uriProto; 5744bbf237fSAppaRao Puli std::shared_ptr<crow::ServerSentEvents> sseConn = nullptr; 575f52c03c1SCarson Labrado std::string retryPolicyName = "SubscriptionEvent"; 576a7a80296SCarson Labrado 577a7a80296SCarson Labrado // Check used to indicate what response codes are valid as part of our retry 578a7a80296SCarson Labrado // policy. 2XX is considered acceptable 579a7a80296SCarson Labrado static boost::system::error_code retryRespHandler(unsigned int respCode) 580a7a80296SCarson Labrado { 581a7a80296SCarson Labrado BMCWEB_LOG_DEBUG 582a7a80296SCarson Labrado << "Checking response code validity for SubscriptionEvent"; 583a7a80296SCarson Labrado if ((respCode < 200) || (respCode >= 300)) 584a7a80296SCarson Labrado { 585a7a80296SCarson Labrado return boost::system::errc::make_error_code( 586a7a80296SCarson Labrado boost::system::errc::result_out_of_range); 587a7a80296SCarson Labrado } 588a7a80296SCarson Labrado 589a7a80296SCarson Labrado // Return 0 if the response code is valid 590a7a80296SCarson Labrado return boost::system::errc::make_error_code( 591a7a80296SCarson Labrado boost::system::errc::success); 5929fa6d147SNan Zhou } 593b52664e2SAppaRao Puli }; 594b52664e2SAppaRao Puli 595b52664e2SAppaRao Puli class EventServiceManager 596b52664e2SAppaRao Puli { 597b52664e2SAppaRao Puli private: 598d3a9e084SEd Tanous bool serviceEnabled = false; 599d3a9e084SEd Tanous uint32_t retryAttempts = 0; 600d3a9e084SEd Tanous uint32_t retryTimeoutInterval = 0; 6017d1cc387SAppaRao Puli 6029f616dd1SEd Tanous EventServiceManager() 603b52664e2SAppaRao Puli { 6041bf712bcSAyushi Smriti // Load config from persist store. 6051bf712bcSAyushi Smriti initConfig(); 606b52664e2SAppaRao Puli } 607b52664e2SAppaRao Puli 6082558979cSP Dheeraj Srujan Kumar std::streampos redfishLogFilePosition{0}; 6099f616dd1SEd Tanous size_t noOfEventLogSubscribers{0}; 6109f616dd1SEd Tanous size_t noOfMetricReportSubscribers{0}; 61159d494eeSPatrick Williams std::shared_ptr<sdbusplus::bus::match_t> matchTelemetryMonitor; 612b52664e2SAppaRao Puli boost::container::flat_map<std::string, std::shared_ptr<Subscription>> 613b52664e2SAppaRao Puli subscriptionsMap; 614b52664e2SAppaRao Puli 6159f616dd1SEd Tanous uint64_t eventId{1}; 61696330b99SSunitha Harish 617b52664e2SAppaRao Puli public: 6189f616dd1SEd Tanous EventServiceManager(const EventServiceManager&) = delete; 6199f616dd1SEd Tanous EventServiceManager& operator=(const EventServiceManager&) = delete; 6209f616dd1SEd Tanous EventServiceManager(EventServiceManager&&) = delete; 6219f616dd1SEd Tanous EventServiceManager& operator=(EventServiceManager&&) = delete; 622ecd6a3a2SEd Tanous ~EventServiceManager() = default; 6239f616dd1SEd Tanous 624b52664e2SAppaRao Puli static EventServiceManager& getInstance() 625b52664e2SAppaRao Puli { 626b52664e2SAppaRao Puli static EventServiceManager handler; 627b52664e2SAppaRao Puli return handler; 628b52664e2SAppaRao Puli } 629b52664e2SAppaRao Puli 6301bf712bcSAyushi Smriti void initConfig() 6311bf712bcSAyushi Smriti { 63228afb49cSJunLin Chen loadOldBehavior(); 6331bf712bcSAyushi Smriti 63428afb49cSJunLin Chen persistent_data::EventServiceConfig eventServiceConfig = 63528afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 63628afb49cSJunLin Chen .getEventServiceConfig(); 6371bf712bcSAyushi Smriti 63828afb49cSJunLin Chen serviceEnabled = eventServiceConfig.enabled; 63928afb49cSJunLin Chen retryAttempts = eventServiceConfig.retryAttempts; 64028afb49cSJunLin Chen retryTimeoutInterval = eventServiceConfig.retryTimeoutInterval; 6411bf712bcSAyushi Smriti 64228afb49cSJunLin Chen for (const auto& it : persistent_data::EventServiceStore::getInstance() 64328afb49cSJunLin Chen .subscriptionsConfigMap) 6441bf712bcSAyushi Smriti { 64528afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> newSub = 64628afb49cSJunLin Chen it.second; 6474bbf237fSAppaRao Puli 6481bf712bcSAyushi Smriti std::string host; 6491bf712bcSAyushi Smriti std::string urlProto; 650eb1c47d3SEd Tanous uint16_t port = 0; 6511bf712bcSAyushi Smriti std::string path; 65211baefe4SEd Tanous bool status = crow::utility::validateAndSplitUrl( 65311baefe4SEd Tanous newSub->destinationUrl, urlProto, host, port, path); 6541bf712bcSAyushi Smriti 6551bf712bcSAyushi Smriti if (!status) 6561bf712bcSAyushi Smriti { 6571bf712bcSAyushi Smriti BMCWEB_LOG_ERROR 6581bf712bcSAyushi Smriti << "Failed to validate and split destination url"; 6591bf712bcSAyushi Smriti continue; 6601bf712bcSAyushi Smriti } 6611bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = 6621bf712bcSAyushi Smriti std::make_shared<Subscription>(host, port, path, urlProto); 6631bf712bcSAyushi Smriti 66428afb49cSJunLin Chen subValue->id = newSub->id; 66528afb49cSJunLin Chen subValue->destinationUrl = newSub->destinationUrl; 66628afb49cSJunLin Chen subValue->protocol = newSub->protocol; 66728afb49cSJunLin Chen subValue->retryPolicy = newSub->retryPolicy; 66828afb49cSJunLin Chen subValue->customText = newSub->customText; 66928afb49cSJunLin Chen subValue->eventFormatType = newSub->eventFormatType; 67028afb49cSJunLin Chen subValue->subscriptionType = newSub->subscriptionType; 67128afb49cSJunLin Chen subValue->registryMsgIds = newSub->registryMsgIds; 67228afb49cSJunLin Chen subValue->registryPrefixes = newSub->registryPrefixes; 67328afb49cSJunLin Chen subValue->resourceTypes = newSub->resourceTypes; 67428afb49cSJunLin Chen subValue->httpHeaders = newSub->httpHeaders; 67528afb49cSJunLin Chen subValue->metricReportDefinitions = newSub->metricReportDefinitions; 6761bf712bcSAyushi Smriti 67728afb49cSJunLin Chen if (subValue->id.empty()) 6781bf712bcSAyushi Smriti { 6791bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Failed to add subscription"; 6801bf712bcSAyushi Smriti } 68128afb49cSJunLin Chen subscriptionsMap.insert(std::pair(subValue->id, subValue)); 68228afb49cSJunLin Chen 68328afb49cSJunLin Chen updateNoOfSubscribersCount(); 68428afb49cSJunLin Chen 68528afb49cSJunLin Chen #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 6862558979cSP Dheeraj Srujan Kumar 6872558979cSP Dheeraj Srujan Kumar cacheRedfishLogFile(); 6882558979cSP Dheeraj Srujan Kumar 68928afb49cSJunLin Chen #endif 69028afb49cSJunLin Chen // Update retry configuration. 69128afb49cSJunLin Chen subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 69228afb49cSJunLin Chen subValue->updateRetryPolicy(); 6931bf712bcSAyushi Smriti } 6941bf712bcSAyushi Smriti } 6951bf712bcSAyushi Smriti 69656d2396dSEd Tanous static void loadOldBehavior() 697b52664e2SAppaRao Puli { 69828afb49cSJunLin Chen std::ifstream eventConfigFile(eventServiceFile); 69928afb49cSJunLin Chen if (!eventConfigFile.good()) 7001bf712bcSAyushi Smriti { 70128afb49cSJunLin Chen BMCWEB_LOG_DEBUG << "Old eventService config not exist"; 70228afb49cSJunLin Chen return; 70328afb49cSJunLin Chen } 70428afb49cSJunLin Chen auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false); 70528afb49cSJunLin Chen if (jsonData.is_discarded()) 7064bbf237fSAppaRao Puli { 70728afb49cSJunLin Chen BMCWEB_LOG_ERROR << "Old eventService config parse error."; 70828afb49cSJunLin Chen return; 70928afb49cSJunLin Chen } 71028afb49cSJunLin Chen 71128afb49cSJunLin Chen for (const auto& item : jsonData.items()) 71228afb49cSJunLin Chen { 71328afb49cSJunLin Chen if (item.key() == "Configuration") 71428afb49cSJunLin Chen { 71528afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 71628afb49cSJunLin Chen .getEventServiceConfig() 71728afb49cSJunLin Chen .fromJson(item.value()); 71828afb49cSJunLin Chen } 71928afb49cSJunLin Chen else if (item.key() == "Subscriptions") 72028afb49cSJunLin Chen { 72128afb49cSJunLin Chen for (const auto& elem : item.value()) 72228afb49cSJunLin Chen { 72328afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> 72428afb49cSJunLin Chen newSubscription = 72528afb49cSJunLin Chen persistent_data::UserSubscription::fromJson(elem, 72628afb49cSJunLin Chen true); 72728afb49cSJunLin Chen if (newSubscription == nullptr) 72828afb49cSJunLin Chen { 72928afb49cSJunLin Chen BMCWEB_LOG_ERROR << "Problem reading subscription " 73028afb49cSJunLin Chen "from old persistent store"; 7314bbf237fSAppaRao Puli continue; 7324bbf237fSAppaRao Puli } 7331bf712bcSAyushi Smriti 73428afb49cSJunLin Chen std::uniform_int_distribution<uint32_t> dist(0); 73528afb49cSJunLin Chen bmcweb::OpenSSLGenerator gen; 7361bf712bcSAyushi Smriti 73728afb49cSJunLin Chen std::string id; 7381bf712bcSAyushi Smriti 73928afb49cSJunLin Chen int retry = 3; 740e662eae8SEd Tanous while (retry != 0) 7411bf712bcSAyushi Smriti { 74228afb49cSJunLin Chen id = std::to_string(dist(gen)); 74328afb49cSJunLin Chen if (gen.error()) 7447d1cc387SAppaRao Puli { 74528afb49cSJunLin Chen retry = 0; 74628afb49cSJunLin Chen break; 74728afb49cSJunLin Chen } 74828afb49cSJunLin Chen newSubscription->id = id; 74928afb49cSJunLin Chen auto inserted = 75028afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 75128afb49cSJunLin Chen .subscriptionsConfigMap.insert( 75228afb49cSJunLin Chen std::pair(id, newSubscription)); 75328afb49cSJunLin Chen if (inserted.second) 75428afb49cSJunLin Chen { 75528afb49cSJunLin Chen break; 75628afb49cSJunLin Chen } 75728afb49cSJunLin Chen --retry; 7587d1cc387SAppaRao Puli } 7597d1cc387SAppaRao Puli 76028afb49cSJunLin Chen if (retry <= 0) 76128afb49cSJunLin Chen { 76228afb49cSJunLin Chen BMCWEB_LOG_ERROR 76328afb49cSJunLin Chen << "Failed to generate random number from old " 76428afb49cSJunLin Chen "persistent store"; 76528afb49cSJunLin Chen continue; 76628afb49cSJunLin Chen } 76728afb49cSJunLin Chen } 76828afb49cSJunLin Chen } 76928afb49cSJunLin Chen 77028afb49cSJunLin Chen persistent_data::getConfig().writeData(); 77128afb49cSJunLin Chen std::remove(eventServiceFile); 77228afb49cSJunLin Chen BMCWEB_LOG_DEBUG << "Remove old eventservice config"; 77328afb49cSJunLin Chen } 77428afb49cSJunLin Chen } 77528afb49cSJunLin Chen 7769eb808c1SEd Tanous void updateSubscriptionData() const 77728afb49cSJunLin Chen { 77828afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 77928afb49cSJunLin Chen .eventServiceConfig.enabled = serviceEnabled; 78028afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 78128afb49cSJunLin Chen .eventServiceConfig.retryAttempts = retryAttempts; 78228afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 78328afb49cSJunLin Chen .eventServiceConfig.retryTimeoutInterval = retryTimeoutInterval; 78428afb49cSJunLin Chen 78528afb49cSJunLin Chen persistent_data::getConfig().writeData(); 78628afb49cSJunLin Chen } 78728afb49cSJunLin Chen 78828afb49cSJunLin Chen void setEventServiceConfig(const persistent_data::EventServiceConfig& cfg) 7897d1cc387SAppaRao Puli { 7907d1cc387SAppaRao Puli bool updateConfig = false; 791fe44eb0bSAyushi Smriti bool updateRetryCfg = false; 7927d1cc387SAppaRao Puli 79328afb49cSJunLin Chen if (serviceEnabled != cfg.enabled) 7947d1cc387SAppaRao Puli { 79528afb49cSJunLin Chen serviceEnabled = cfg.enabled; 796e662eae8SEd Tanous if (serviceEnabled && noOfMetricReportSubscribers != 0U) 7977d1cc387SAppaRao Puli { 7987d1cc387SAppaRao Puli registerMetricReportSignal(); 7997d1cc387SAppaRao Puli } 8007d1cc387SAppaRao Puli else 8017d1cc387SAppaRao Puli { 8027d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8037d1cc387SAppaRao Puli } 8047d1cc387SAppaRao Puli updateConfig = true; 8057d1cc387SAppaRao Puli } 8067d1cc387SAppaRao Puli 80728afb49cSJunLin Chen if (retryAttempts != cfg.retryAttempts) 8087d1cc387SAppaRao Puli { 80928afb49cSJunLin Chen retryAttempts = cfg.retryAttempts; 8107d1cc387SAppaRao Puli updateConfig = true; 811fe44eb0bSAyushi Smriti updateRetryCfg = true; 8127d1cc387SAppaRao Puli } 8137d1cc387SAppaRao Puli 81428afb49cSJunLin Chen if (retryTimeoutInterval != cfg.retryTimeoutInterval) 8157d1cc387SAppaRao Puli { 81628afb49cSJunLin Chen retryTimeoutInterval = cfg.retryTimeoutInterval; 8177d1cc387SAppaRao Puli updateConfig = true; 818fe44eb0bSAyushi Smriti updateRetryCfg = true; 8197d1cc387SAppaRao Puli } 8207d1cc387SAppaRao Puli 8217d1cc387SAppaRao Puli if (updateConfig) 8227d1cc387SAppaRao Puli { 8237d1cc387SAppaRao Puli updateSubscriptionData(); 8247d1cc387SAppaRao Puli } 825fe44eb0bSAyushi Smriti 826fe44eb0bSAyushi Smriti if (updateRetryCfg) 827fe44eb0bSAyushi Smriti { 828fe44eb0bSAyushi Smriti // Update the changed retry config to all subscriptions 829fe44eb0bSAyushi Smriti for (const auto& it : 830fe44eb0bSAyushi Smriti EventServiceManager::getInstance().subscriptionsMap) 831fe44eb0bSAyushi Smriti { 832fe44eb0bSAyushi Smriti std::shared_ptr<Subscription> entry = it.second; 833fe44eb0bSAyushi Smriti entry->updateRetryConfig(retryAttempts, retryTimeoutInterval); 834fe44eb0bSAyushi Smriti } 835fe44eb0bSAyushi Smriti } 8367d1cc387SAppaRao Puli } 8377d1cc387SAppaRao Puli 8387d1cc387SAppaRao Puli void updateNoOfSubscribersCount() 8397d1cc387SAppaRao Puli { 8407d1cc387SAppaRao Puli size_t eventLogSubCount = 0; 8417d1cc387SAppaRao Puli size_t metricReportSubCount = 0; 8427d1cc387SAppaRao Puli for (const auto& it : subscriptionsMap) 8437d1cc387SAppaRao Puli { 8447d1cc387SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 8457d1cc387SAppaRao Puli if (entry->eventFormatType == eventFormatType) 8467d1cc387SAppaRao Puli { 8477d1cc387SAppaRao Puli eventLogSubCount++; 8487d1cc387SAppaRao Puli } 8497d1cc387SAppaRao Puli else if (entry->eventFormatType == metricReportFormatType) 8507d1cc387SAppaRao Puli { 8517d1cc387SAppaRao Puli metricReportSubCount++; 8527d1cc387SAppaRao Puli } 8537d1cc387SAppaRao Puli } 8547d1cc387SAppaRao Puli 8557d1cc387SAppaRao Puli noOfEventLogSubscribers = eventLogSubCount; 8567d1cc387SAppaRao Puli if (noOfMetricReportSubscribers != metricReportSubCount) 8577d1cc387SAppaRao Puli { 8587d1cc387SAppaRao Puli noOfMetricReportSubscribers = metricReportSubCount; 859e662eae8SEd Tanous if (noOfMetricReportSubscribers != 0U) 8607d1cc387SAppaRao Puli { 8617d1cc387SAppaRao Puli registerMetricReportSignal(); 8627d1cc387SAppaRao Puli } 8637d1cc387SAppaRao Puli else 8647d1cc387SAppaRao Puli { 8657d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8667d1cc387SAppaRao Puli } 8677d1cc387SAppaRao Puli } 8687d1cc387SAppaRao Puli } 8697d1cc387SAppaRao Puli 870b52664e2SAppaRao Puli std::shared_ptr<Subscription> getSubscription(const std::string& id) 871b52664e2SAppaRao Puli { 872b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 873b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 874b52664e2SAppaRao Puli { 875b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id; 876b52664e2SAppaRao Puli return nullptr; 877b52664e2SAppaRao Puli } 878b52664e2SAppaRao Puli std::shared_ptr<Subscription> subValue = obj->second; 879b52664e2SAppaRao Puli return subValue; 880b52664e2SAppaRao Puli } 881b52664e2SAppaRao Puli 882b5a76932SEd Tanous std::string addSubscription(const std::shared_ptr<Subscription>& subValue, 8831bf712bcSAyushi Smriti const bool updateFile = true) 884b52664e2SAppaRao Puli { 885fc76b8acSEd Tanous 886fc76b8acSEd Tanous std::uniform_int_distribution<uint32_t> dist(0); 887fc76b8acSEd Tanous bmcweb::OpenSSLGenerator gen; 888fc76b8acSEd Tanous 889b52664e2SAppaRao Puli std::string id; 890b52664e2SAppaRao Puli 891b52664e2SAppaRao Puli int retry = 3; 892e662eae8SEd Tanous while (retry != 0) 893b52664e2SAppaRao Puli { 894fc76b8acSEd Tanous id = std::to_string(dist(gen)); 895fc76b8acSEd Tanous if (gen.error()) 896fc76b8acSEd Tanous { 897fc76b8acSEd Tanous retry = 0; 898fc76b8acSEd Tanous break; 899fc76b8acSEd Tanous } 900b52664e2SAppaRao Puli auto inserted = subscriptionsMap.insert(std::pair(id, subValue)); 901b52664e2SAppaRao Puli if (inserted.second) 902b52664e2SAppaRao Puli { 903b52664e2SAppaRao Puli break; 904b52664e2SAppaRao Puli } 905b52664e2SAppaRao Puli --retry; 90623a21a1cSEd Tanous } 907b52664e2SAppaRao Puli 908b52664e2SAppaRao Puli if (retry <= 0) 909b52664e2SAppaRao Puli { 910b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Failed to generate random number"; 911abb93cddSEd Tanous return ""; 912b52664e2SAppaRao Puli } 913b52664e2SAppaRao Puli 91428afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> newSub = 91528afb49cSJunLin Chen std::make_shared<persistent_data::UserSubscription>(); 91628afb49cSJunLin Chen newSub->id = id; 91728afb49cSJunLin Chen newSub->destinationUrl = subValue->destinationUrl; 91828afb49cSJunLin Chen newSub->protocol = subValue->protocol; 91928afb49cSJunLin Chen newSub->retryPolicy = subValue->retryPolicy; 92028afb49cSJunLin Chen newSub->customText = subValue->customText; 92128afb49cSJunLin Chen newSub->eventFormatType = subValue->eventFormatType; 92228afb49cSJunLin Chen newSub->subscriptionType = subValue->subscriptionType; 92328afb49cSJunLin Chen newSub->registryMsgIds = subValue->registryMsgIds; 92428afb49cSJunLin Chen newSub->registryPrefixes = subValue->registryPrefixes; 92528afb49cSJunLin Chen newSub->resourceTypes = subValue->resourceTypes; 92628afb49cSJunLin Chen newSub->httpHeaders = subValue->httpHeaders; 92728afb49cSJunLin Chen newSub->metricReportDefinitions = subValue->metricReportDefinitions; 92828afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 92928afb49cSJunLin Chen .subscriptionsConfigMap.emplace(newSub->id, newSub); 93028afb49cSJunLin Chen 9317d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 9321bf712bcSAyushi Smriti 9331bf712bcSAyushi Smriti if (updateFile) 9341bf712bcSAyushi Smriti { 935b52664e2SAppaRao Puli updateSubscriptionData(); 9361bf712bcSAyushi Smriti } 9377f4eb588SAppaRao Puli 9387f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 9392558979cSP Dheeraj Srujan Kumar if (redfishLogFilePosition != 0) 9407f4eb588SAppaRao Puli { 9412558979cSP Dheeraj Srujan Kumar cacheRedfishLogFile(); 9427f4eb588SAppaRao Puli } 9437f4eb588SAppaRao Puli #endif 944fe44eb0bSAyushi Smriti // Update retry configuration. 945fe44eb0bSAyushi Smriti subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 946fe44eb0bSAyushi Smriti subValue->updateRetryPolicy(); 947fe44eb0bSAyushi Smriti 948b52664e2SAppaRao Puli return id; 949b52664e2SAppaRao Puli } 950b52664e2SAppaRao Puli 951b52664e2SAppaRao Puli bool isSubscriptionExist(const std::string& id) 952b52664e2SAppaRao Puli { 953b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 95455f79e6fSEd Tanous return obj != subscriptionsMap.end(); 955b52664e2SAppaRao Puli } 956b52664e2SAppaRao Puli 957b52664e2SAppaRao Puli void deleteSubscription(const std::string& id) 958b52664e2SAppaRao Puli { 959b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 960b52664e2SAppaRao Puli if (obj != subscriptionsMap.end()) 961b52664e2SAppaRao Puli { 962b52664e2SAppaRao Puli subscriptionsMap.erase(obj); 96328afb49cSJunLin Chen auto obj2 = persistent_data::EventServiceStore::getInstance() 96428afb49cSJunLin Chen .subscriptionsConfigMap.find(id); 96528afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 96628afb49cSJunLin Chen .subscriptionsConfigMap.erase(obj2); 9677d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 968b52664e2SAppaRao Puli updateSubscriptionData(); 969b52664e2SAppaRao Puli } 970b52664e2SAppaRao Puli } 971b52664e2SAppaRao Puli 972b52664e2SAppaRao Puli size_t getNumberOfSubscriptions() 973b52664e2SAppaRao Puli { 974b52664e2SAppaRao Puli return subscriptionsMap.size(); 975b52664e2SAppaRao Puli } 976b52664e2SAppaRao Puli 977b52664e2SAppaRao Puli std::vector<std::string> getAllIDs() 978b52664e2SAppaRao Puli { 979b52664e2SAppaRao Puli std::vector<std::string> idList; 980b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 981b52664e2SAppaRao Puli { 982b52664e2SAppaRao Puli idList.emplace_back(it.first); 983b52664e2SAppaRao Puli } 984b52664e2SAppaRao Puli return idList; 985b52664e2SAppaRao Puli } 986b52664e2SAppaRao Puli 987b52664e2SAppaRao Puli bool isDestinationExist(const std::string& destUrl) 988b52664e2SAppaRao Puli { 989b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 990b52664e2SAppaRao Puli { 991b52664e2SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 992b52664e2SAppaRao Puli if (entry->destinationUrl == destUrl) 993b52664e2SAppaRao Puli { 994b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Destination exist already" << destUrl; 995b52664e2SAppaRao Puli return true; 996b52664e2SAppaRao Puli } 997b52664e2SAppaRao Puli } 998b52664e2SAppaRao Puli return false; 999b52664e2SAppaRao Puli } 10000b4bdd93SAppaRao Puli 10016ba8c82eSsunharis_in bool sendTestEventLog() 10020b4bdd93SAppaRao Puli { 10030b4bdd93SAppaRao Puli for (const auto& it : this->subscriptionsMap) 10040b4bdd93SAppaRao Puli { 10050b4bdd93SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 10066ba8c82eSsunharis_in if (!entry->sendTestEventLog()) 10076ba8c82eSsunharis_in { 10086ba8c82eSsunharis_in return false; 10090b4bdd93SAppaRao Puli } 10100b4bdd93SAppaRao Puli } 10116ba8c82eSsunharis_in return true; 10126ba8c82eSsunharis_in } 1013e9a14131SAppaRao Puli 1014*613dabeaSEd Tanous void sendEvent(nlohmann::json eventMessage, const std::string& origin, 1015*613dabeaSEd Tanous const std::string& resType) 101696330b99SSunitha Harish { 1017dbb59d4dSEd Tanous if (!serviceEnabled || (noOfEventLogSubscribers == 0U)) 10186ba8c82eSsunharis_in { 10196ba8c82eSsunharis_in BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 10206ba8c82eSsunharis_in return; 10216ba8c82eSsunharis_in } 102296330b99SSunitha Harish nlohmann::json eventRecord = nlohmann::json::array(); 102396330b99SSunitha Harish 1024*613dabeaSEd Tanous eventMessage["EventId"] = eventId; 1025*613dabeaSEd Tanous // MemberId is 0 : since we are sending one event record. 1026*613dabeaSEd Tanous eventMessage["MemberId"] = 0; 1027*613dabeaSEd Tanous eventMessage["EventTimestamp"] = 1028*613dabeaSEd Tanous redfish::time_utils::getDateTimeOffsetNow().first; 1029*613dabeaSEd Tanous eventMessage["OriginOfCondition"] = origin; 1030*613dabeaSEd Tanous 1031*613dabeaSEd Tanous eventRecord.emplace_back(std::move(eventMessage)); 103296330b99SSunitha Harish 103396330b99SSunitha Harish for (const auto& it : this->subscriptionsMap) 103496330b99SSunitha Harish { 103596330b99SSunitha Harish std::shared_ptr<Subscription> entry = it.second; 103696330b99SSunitha Harish bool isSubscribed = false; 103796330b99SSunitha Harish // Search the resourceTypes list for the subscription. 103896330b99SSunitha Harish // If resourceTypes list is empty, don't filter events 103996330b99SSunitha Harish // send everything. 104026f6976fSEd Tanous if (!entry->resourceTypes.empty()) 104196330b99SSunitha Harish { 10423174e4dfSEd Tanous for (const auto& resource : entry->resourceTypes) 104396330b99SSunitha Harish { 104496330b99SSunitha Harish if (resType == resource) 104596330b99SSunitha Harish { 104696330b99SSunitha Harish BMCWEB_LOG_INFO << "ResourceType " << resource 104796330b99SSunitha Harish << " found in the subscribed list"; 104896330b99SSunitha Harish isSubscribed = true; 104996330b99SSunitha Harish break; 105096330b99SSunitha Harish } 105196330b99SSunitha Harish } 105296330b99SSunitha Harish } 105396330b99SSunitha Harish else // resourceTypes list is empty. 105496330b99SSunitha Harish { 105596330b99SSunitha Harish isSubscribed = true; 105696330b99SSunitha Harish } 105796330b99SSunitha Harish if (isSubscribed) 105896330b99SSunitha Harish { 1059*613dabeaSEd Tanous nlohmann::json msgJson; 1060*613dabeaSEd Tanous 1061*613dabeaSEd Tanous msgJson["@odata.type"] = "#Event.v1_4_0.Event"; 1062*613dabeaSEd Tanous msgJson["Name"] = "Event Log"; 1063*613dabeaSEd Tanous msgJson["Id"] = eventId; 1064*613dabeaSEd Tanous msgJson["Events"] = eventRecord; 1065f52c03c1SCarson Labrado 1066f52c03c1SCarson Labrado std::string strMsg = msgJson.dump( 1067f52c03c1SCarson Labrado 2, ' ', true, nlohmann::json::error_handler_t::replace); 1068f52c03c1SCarson Labrado entry->sendEvent(strMsg); 106996330b99SSunitha Harish eventId++; // increament the eventId 107096330b99SSunitha Harish } 107196330b99SSunitha Harish else 107296330b99SSunitha Harish { 107396330b99SSunitha Harish BMCWEB_LOG_INFO << "Not subscribed to this resource"; 107496330b99SSunitha Harish } 107596330b99SSunitha Harish } 107696330b99SSunitha Harish } 10775738de59SAsmitha Karunanithi void sendBroadcastMsg(const std::string& broadcastMsg) 10785738de59SAsmitha Karunanithi { 10795738de59SAsmitha Karunanithi for (const auto& it : this->subscriptionsMap) 10805738de59SAsmitha Karunanithi { 10815738de59SAsmitha Karunanithi std::shared_ptr<Subscription> entry = it.second; 1082*613dabeaSEd Tanous nlohmann::json msgJson; 1083*613dabeaSEd Tanous msgJson["Timestamp"] = 1084*613dabeaSEd Tanous redfish::time_utils::getDateTimeOffsetNow().first; 1085*613dabeaSEd Tanous msgJson["OriginOfCondition"] = "/ibm/v1/HMC/BroadcastService"; 1086*613dabeaSEd Tanous msgJson["Name"] = "Broadcast Message"; 1087*613dabeaSEd Tanous msgJson["Message"] = broadcastMsg; 1088f52c03c1SCarson Labrado 1089f52c03c1SCarson Labrado std::string strMsg = msgJson.dump( 1090f52c03c1SCarson Labrado 2, ' ', true, nlohmann::json::error_handler_t::replace); 1091f52c03c1SCarson Labrado entry->sendEvent(strMsg); 10925738de59SAsmitha Karunanithi } 10935738de59SAsmitha Karunanithi } 109496330b99SSunitha Harish 10957f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 10962558979cSP Dheeraj Srujan Kumar 10972558979cSP Dheeraj Srujan Kumar void resetRedfishFilePosition() 10987f4eb588SAppaRao Puli { 10992558979cSP Dheeraj Srujan Kumar // Control would be here when Redfish file is created. 11002558979cSP Dheeraj Srujan Kumar // Reset File Position as new file is created 11012558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = 0; 11022558979cSP Dheeraj Srujan Kumar } 11032558979cSP Dheeraj Srujan Kumar 11042558979cSP Dheeraj Srujan Kumar void cacheRedfishLogFile() 11052558979cSP Dheeraj Srujan Kumar { 11062558979cSP Dheeraj Srujan Kumar // Open the redfish file and read till the last record. 11072558979cSP Dheeraj Srujan Kumar 11087f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 11097f4eb588SAppaRao Puli if (!logStream.good()) 11107f4eb588SAppaRao Puli { 11117f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed \n"; 11127f4eb588SAppaRao Puli return; 11137f4eb588SAppaRao Puli } 11147f4eb588SAppaRao Puli std::string logEntry; 11157f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 11167f4eb588SAppaRao Puli { 11172558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = logStream.tellg(); 11187f4eb588SAppaRao Puli } 11192558979cSP Dheeraj Srujan Kumar 11202558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "Next Log Position : " << redfishLogFilePosition; 11217f4eb588SAppaRao Puli } 11227f4eb588SAppaRao Puli 11237f4eb588SAppaRao Puli void readEventLogsFromFile() 11247f4eb588SAppaRao Puli { 11257f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 11267f4eb588SAppaRao Puli if (!logStream.good()) 11277f4eb588SAppaRao Puli { 11287f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed"; 11297f4eb588SAppaRao Puli return; 11307f4eb588SAppaRao Puli } 11317f4eb588SAppaRao Puli 11327f4eb588SAppaRao Puli std::vector<EventLogObjectsType> eventRecords; 11337f4eb588SAppaRao Puli 11347f4eb588SAppaRao Puli std::string logEntry; 11352558979cSP Dheeraj Srujan Kumar 11362558979cSP Dheeraj Srujan Kumar // Get the read pointer to the next log to be read. 11372558979cSP Dheeraj Srujan Kumar logStream.seekg(redfishLogFilePosition); 11382558979cSP Dheeraj Srujan Kumar 11397f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 11407f4eb588SAppaRao Puli { 11412558979cSP Dheeraj Srujan Kumar // Update Pointer position 11422558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = logStream.tellg(); 11432558979cSP Dheeraj Srujan Kumar 11442558979cSP Dheeraj Srujan Kumar std::string idStr; 11452558979cSP Dheeraj Srujan Kumar if (!event_log::getUniqueEntryID(logEntry, idStr)) 11467f4eb588SAppaRao Puli { 11477f4eb588SAppaRao Puli continue; 11487f4eb588SAppaRao Puli } 11497f4eb588SAppaRao Puli 1150e662eae8SEd Tanous if (!serviceEnabled || noOfEventLogSubscribers == 0) 11517f4eb588SAppaRao Puli { 11522558979cSP Dheeraj Srujan Kumar // If Service is not enabled, no need to compute 11532558979cSP Dheeraj Srujan Kumar // the remaining items below. 11542558979cSP Dheeraj Srujan Kumar // But, Loop must continue to keep track of Timestamp 11557f4eb588SAppaRao Puli continue; 11567f4eb588SAppaRao Puli } 11577f4eb588SAppaRao Puli 11587f4eb588SAppaRao Puli std::string timestamp; 11597f4eb588SAppaRao Puli std::string messageID; 11605e715de6SAppaRao Puli std::vector<std::string> messageArgs; 11617f4eb588SAppaRao Puli if (event_log::getEventLogParams(logEntry, timestamp, messageID, 11627f4eb588SAppaRao Puli messageArgs) != 0) 11637f4eb588SAppaRao Puli { 11647f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry params failed"; 11657f4eb588SAppaRao Puli continue; 11667f4eb588SAppaRao Puli } 11677f4eb588SAppaRao Puli 11687f4eb588SAppaRao Puli std::string registryName; 11697f4eb588SAppaRao Puli std::string messageKey; 11707f4eb588SAppaRao Puli event_log::getRegistryAndMessageKey(messageID, registryName, 11717f4eb588SAppaRao Puli messageKey); 11727f4eb588SAppaRao Puli if (registryName.empty() || messageKey.empty()) 11737f4eb588SAppaRao Puli { 11747f4eb588SAppaRao Puli continue; 11757f4eb588SAppaRao Puli } 11767f4eb588SAppaRao Puli 11777f4eb588SAppaRao Puli eventRecords.emplace_back(idStr, timestamp, messageID, registryName, 11787f4eb588SAppaRao Puli messageKey, messageArgs); 11797f4eb588SAppaRao Puli } 11807f4eb588SAppaRao Puli 1181e662eae8SEd Tanous if (!serviceEnabled || noOfEventLogSubscribers == 0) 11822558979cSP Dheeraj Srujan Kumar { 11832558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 11842558979cSP Dheeraj Srujan Kumar return; 11852558979cSP Dheeraj Srujan Kumar } 11862558979cSP Dheeraj Srujan Kumar 11872558979cSP Dheeraj Srujan Kumar if (eventRecords.empty()) 11882558979cSP Dheeraj Srujan Kumar { 11892558979cSP Dheeraj Srujan Kumar // No Records to send 11902558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 11912558979cSP Dheeraj Srujan Kumar return; 11922558979cSP Dheeraj Srujan Kumar } 11932558979cSP Dheeraj Srujan Kumar 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 { 12066a9f85f9SAppaRao Puli if (!inotifyConn) 12077f4eb588SAppaRao Puli { 12087f4eb588SAppaRao Puli return; 12097f4eb588SAppaRao Puli } 12107f4eb588SAppaRao Puli 12117f4eb588SAppaRao Puli static std::array<char, 1024> readBuffer; 12127f4eb588SAppaRao Puli 1213002d39b4SEd Tanous inotifyConn->async_read_some(boost::asio::buffer(readBuffer), 12147f4eb588SAppaRao Puli [&](const boost::system::error_code& ec, 12157f4eb588SAppaRao Puli const std::size_t& bytesTransferred) { 12167f4eb588SAppaRao Puli if (ec) 12177f4eb588SAppaRao Puli { 12187f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "Callback Error: " << ec.message(); 12197f4eb588SAppaRao Puli return; 12207f4eb588SAppaRao Puli } 12217f4eb588SAppaRao Puli std::size_t index = 0; 1222b792cc56SAppaRao Puli while ((index + iEventSize) <= bytesTransferred) 12237f4eb588SAppaRao Puli { 1224d3a9e084SEd Tanous struct inotify_event event 1225d3a9e084SEd Tanous {}; 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 12364f568f74SJiaqing Zhao std::string fileName(&readBuffer[index + iEventSize]); 12374f568f74SJiaqing Zhao if (fileName != "redfish") 1238b792cc56SAppaRao Puli { 1239b792cc56SAppaRao Puli index += (iEventSize + event.len); 1240b792cc56SAppaRao Puli continue; 1241b792cc56SAppaRao Puli } 1242b792cc56SAppaRao Puli 1243b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1244b792cc56SAppaRao Puli << "Redfish log file created/deleted. event.name: " 1245b792cc56SAppaRao Puli << fileName; 1246b792cc56SAppaRao Puli if (event.mask == IN_CREATE) 1247b792cc56SAppaRao Puli { 1248b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1249b792cc56SAppaRao Puli { 1250b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1251016761afSAppaRao Puli << "Remove and Add inotify watcher on " 1252016761afSAppaRao Puli "redfish event log file"; 1253016761afSAppaRao Puli // Remove existing inotify watcher and add 1254016761afSAppaRao Puli // with new redfish event log file. 1255016761afSAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1256016761afSAppaRao Puli fileWatchDesc = -1; 1257b792cc56SAppaRao Puli } 1258b792cc56SAppaRao Puli 1259b792cc56SAppaRao Puli fileWatchDesc = inotify_add_watch( 1260b792cc56SAppaRao Puli inotifyFd, redfishEventLogFile, IN_MODIFY); 1261b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1262b792cc56SAppaRao Puli { 1263002d39b4SEd Tanous BMCWEB_LOG_ERROR << "inotify_add_watch failed for " 1264b792cc56SAppaRao Puli "redfish log file."; 1265b792cc56SAppaRao Puli return; 1266b792cc56SAppaRao Puli } 1267b792cc56SAppaRao Puli 1268b792cc56SAppaRao Puli EventServiceManager::getInstance() 12692558979cSP Dheeraj Srujan Kumar .resetRedfishFilePosition(); 1270b792cc56SAppaRao Puli EventServiceManager::getInstance() 1271b792cc56SAppaRao Puli .readEventLogsFromFile(); 1272b792cc56SAppaRao Puli } 1273b792cc56SAppaRao Puli else if ((event.mask == IN_DELETE) || 1274b792cc56SAppaRao Puli (event.mask == IN_MOVED_TO)) 1275b792cc56SAppaRao Puli { 1276b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1277b792cc56SAppaRao Puli { 1278b792cc56SAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1279b792cc56SAppaRao Puli fileWatchDesc = -1; 1280b792cc56SAppaRao Puli } 1281b792cc56SAppaRao Puli } 1282b792cc56SAppaRao Puli } 1283b792cc56SAppaRao Puli else if (event.wd == fileWatchDesc) 1284b792cc56SAppaRao Puli { 1285b792cc56SAppaRao Puli if (event.mask == IN_MODIFY) 12867f4eb588SAppaRao Puli { 12877f4eb588SAppaRao Puli EventServiceManager::getInstance() 12887f4eb588SAppaRao Puli .readEventLogsFromFile(); 12897f4eb588SAppaRao Puli } 1290b792cc56SAppaRao Puli } 1291b792cc56SAppaRao Puli index += (iEventSize + event.len); 12927f4eb588SAppaRao Puli } 12937f4eb588SAppaRao Puli 12947f4eb588SAppaRao Puli watchRedfishEventLogFile(); 12957f4eb588SAppaRao Puli }); 12967f4eb588SAppaRao Puli } 12977f4eb588SAppaRao Puli 12987f4eb588SAppaRao Puli static int startEventLogMonitor(boost::asio::io_context& ioc) 12997f4eb588SAppaRao Puli { 130023a21a1cSEd Tanous inotifyConn.emplace(ioc); 1301b792cc56SAppaRao Puli inotifyFd = inotify_init1(IN_NONBLOCK); 1302b792cc56SAppaRao Puli if (inotifyFd == -1) 13037f4eb588SAppaRao Puli { 13047f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "inotify_init1 failed."; 13057f4eb588SAppaRao Puli return -1; 13067f4eb588SAppaRao Puli } 1307b792cc56SAppaRao Puli 1308b792cc56SAppaRao Puli // Add watch on directory to handle redfish event log file 1309b792cc56SAppaRao Puli // create/delete. 1310b792cc56SAppaRao Puli dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir, 1311b792cc56SAppaRao Puli IN_CREATE | IN_MOVED_TO | IN_DELETE); 1312b792cc56SAppaRao Puli if (dirWatchDesc == -1) 13137f4eb588SAppaRao Puli { 13147f4eb588SAppaRao Puli BMCWEB_LOG_ERROR 1315b792cc56SAppaRao Puli << "inotify_add_watch failed for event log directory."; 13167f4eb588SAppaRao Puli return -1; 13177f4eb588SAppaRao Puli } 13187f4eb588SAppaRao Puli 1319b792cc56SAppaRao Puli // Watch redfish event log file for modifications. 1320b792cc56SAppaRao Puli fileWatchDesc = 1321b792cc56SAppaRao Puli inotify_add_watch(inotifyFd, redfishEventLogFile, IN_MODIFY); 1322b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1323b792cc56SAppaRao Puli { 1324b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1325b792cc56SAppaRao Puli << "inotify_add_watch failed for redfish log file."; 1326b792cc56SAppaRao Puli // Don't return error if file not exist. 1327b792cc56SAppaRao Puli // Watch on directory will handle create/delete of file. 1328b792cc56SAppaRao Puli } 1329b792cc56SAppaRao Puli 13307f4eb588SAppaRao Puli // monitor redfish event log file 1331b792cc56SAppaRao Puli inotifyConn->assign(inotifyFd); 13327f4eb588SAppaRao Puli watchRedfishEventLogFile(); 13337f4eb588SAppaRao Puli 13347f4eb588SAppaRao Puli return 0; 13357f4eb588SAppaRao Puli } 13367f4eb588SAppaRao Puli 13377f4eb588SAppaRao Puli #endif 133859d494eeSPatrick Williams static void getReadingsForReport(sdbusplus::message_t& msg) 1339156d6b00SAppaRao Puli { 134056d2396dSEd Tanous if (msg.is_method_error()) 134156d2396dSEd Tanous { 134256d2396dSEd Tanous BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error"; 134356d2396dSEd Tanous return; 134456d2396dSEd Tanous } 134556d2396dSEd Tanous 1346c0353249SWludzik, Jozef sdbusplus::message::object_path path(msg.get_path()); 1347c0353249SWludzik, Jozef std::string id = path.filename(); 1348c0353249SWludzik, Jozef if (id.empty()) 1349156d6b00SAppaRao Puli { 1350c0353249SWludzik, Jozef BMCWEB_LOG_ERROR << "Failed to get Id from path"; 1351156d6b00SAppaRao Puli return; 1352156d6b00SAppaRao Puli } 1353156d6b00SAppaRao Puli 1354c0353249SWludzik, Jozef std::string interface; 1355b9d36b47SEd Tanous dbus::utility::DBusPropertiesMap props; 1356c0353249SWludzik, Jozef std::vector<std::string> invalidProps; 1357c0353249SWludzik, Jozef msg.read(interface, props, invalidProps); 1358c0353249SWludzik, Jozef 1359c0353249SWludzik, Jozef auto found = 1360c0353249SWludzik, Jozef std::find_if(props.begin(), props.end(), 1361c0353249SWludzik, Jozef [](const auto& x) { return x.first == "Readings"; }); 1362c0353249SWludzik, Jozef if (found == props.end()) 1363156d6b00SAppaRao Puli { 1364c0353249SWludzik, Jozef BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; 1365156d6b00SAppaRao Puli return; 1366156d6b00SAppaRao Puli } 1367156d6b00SAppaRao Puli 13681e1e598dSJonathan Doman const telemetry::TimestampReadings* readings = 13691e1e598dSJonathan Doman std::get_if<telemetry::TimestampReadings>(&found->second); 1370e662eae8SEd Tanous if (readings == nullptr) 13711e1e598dSJonathan Doman { 13721e1e598dSJonathan Doman BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; 13731e1e598dSJonathan Doman return; 13741e1e598dSJonathan Doman } 13751e1e598dSJonathan Doman 1376156d6b00SAppaRao Puli for (const auto& it : 1377156d6b00SAppaRao Puli EventServiceManager::getInstance().subscriptionsMap) 1378156d6b00SAppaRao Puli { 1379e05aec50SEd Tanous Subscription& entry = *it.second; 1380c0353249SWludzik, Jozef if (entry.eventFormatType == metricReportFormatType) 1381156d6b00SAppaRao Puli { 13821e1e598dSJonathan Doman entry.filterAndSendReports(id, *readings); 1383156d6b00SAppaRao Puli } 1384156d6b00SAppaRao Puli } 1385156d6b00SAppaRao Puli } 1386156d6b00SAppaRao Puli 1387156d6b00SAppaRao Puli void unregisterMetricReportSignal() 1388156d6b00SAppaRao Puli { 13897d1cc387SAppaRao Puli if (matchTelemetryMonitor) 13907d1cc387SAppaRao Puli { 1391156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister"; 1392156d6b00SAppaRao Puli matchTelemetryMonitor.reset(); 1393156d6b00SAppaRao Puli matchTelemetryMonitor = nullptr; 1394156d6b00SAppaRao Puli } 13957d1cc387SAppaRao Puli } 1396156d6b00SAppaRao Puli 1397156d6b00SAppaRao Puli void registerMetricReportSignal() 1398156d6b00SAppaRao Puli { 13997d1cc387SAppaRao Puli if (!serviceEnabled || matchTelemetryMonitor) 1400156d6b00SAppaRao Puli { 14017d1cc387SAppaRao Puli BMCWEB_LOG_DEBUG << "Not registering metric report signal."; 1402156d6b00SAppaRao Puli return; 1403156d6b00SAppaRao Puli } 1404156d6b00SAppaRao Puli 1405156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Register"; 1406c0353249SWludzik, Jozef std::string matchStr = "type='signal',member='PropertiesChanged'," 1407c0353249SWludzik, Jozef "interface='org.freedesktop.DBus.Properties'," 1408c0353249SWludzik, Jozef "arg0=xyz.openbmc_project.Telemetry.Report"; 1409156d6b00SAppaRao Puli 141059d494eeSPatrick Williams matchTelemetryMonitor = std::make_shared<sdbusplus::bus::match_t>( 141156d2396dSEd Tanous *crow::connections::systemBus, matchStr, getReadingsForReport); 1412156d6b00SAppaRao Puli } 141323a21a1cSEd Tanous }; 1414b52664e2SAppaRao Puli 1415b52664e2SAppaRao Puli } // namespace redfish 1416