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 25fb4fd5d4SZhenfei Tai #include <boost/asio/io_context.hpp> 26b52664e2SAppaRao Puli #include <boost/container/flat_map.hpp> 27168e20c1SEd Tanous #include <dbus_utility.hpp> 281214b7e7SGunnar Mills #include <error_messages.hpp> 2928afb49cSJunLin Chen #include <event_service_store.hpp> 301214b7e7SGunnar Mills #include <http_client.hpp> 3128afb49cSJunLin Chen #include <persistent_data.hpp> 32fc76b8acSEd Tanous #include <random.hpp> 334bbf237fSAppaRao Puli #include <server_sent_events.hpp> 341214b7e7SGunnar Mills #include <utils/json_utils.hpp> 351214b7e7SGunnar Mills 36b52664e2SAppaRao Puli #include <cstdlib> 37b52664e2SAppaRao Puli #include <ctime> 381bf712bcSAyushi Smriti #include <fstream> 39b52664e2SAppaRao Puli #include <memory> 4026702d01SEd Tanous #include <span> 41b52664e2SAppaRao Puli 42b52664e2SAppaRao Puli namespace redfish 43b52664e2SAppaRao Puli { 44156d6b00SAppaRao Puli 45156d6b00SAppaRao Puli using ReadingsObjType = 4693f5d7c7SWludzik, Jozef std::vector<std::tuple<std::string, std::string, double, int32_t>>; 47156d6b00SAppaRao Puli 48156d6b00SAppaRao Puli static constexpr const char* eventFormatType = "Event"; 49156d6b00SAppaRao Puli static constexpr const char* metricReportFormatType = "MetricReport"; 50156d6b00SAppaRao Puli 511bf712bcSAyushi Smriti static constexpr const char* eventServiceFile = 521bf712bcSAyushi Smriti "/var/lib/bmcweb/eventservice_config.json"; 531bf712bcSAyushi Smriti 547f4eb588SAppaRao Puli namespace message_registries 557f4eb588SAppaRao Puli { 5626702d01SEd Tanous inline std::span<const MessageEntry> 57b304bd79SP Dheeraj Srujan Kumar getRegistryFromPrefix(const std::string& registryName) 58b304bd79SP Dheeraj Srujan Kumar { 59b304bd79SP Dheeraj Srujan Kumar if (task_event::header.registryPrefix == registryName) 60b304bd79SP Dheeraj Srujan Kumar { 6126702d01SEd Tanous return {task_event::registry}; 62b304bd79SP Dheeraj Srujan Kumar } 63b304bd79SP Dheeraj Srujan Kumar if (openbmc::header.registryPrefix == registryName) 64b304bd79SP Dheeraj Srujan Kumar { 6526702d01SEd Tanous return {openbmc::registry}; 66b304bd79SP Dheeraj Srujan Kumar } 67b304bd79SP Dheeraj Srujan Kumar if (base::header.registryPrefix == registryName) 68b304bd79SP Dheeraj Srujan Kumar { 6926702d01SEd Tanous return {base::registry}; 70b304bd79SP Dheeraj Srujan Kumar } 7126702d01SEd Tanous return {openbmc::registry}; 72b304bd79SP Dheeraj Srujan Kumar } 734642bf8fSGeorge Liu } // namespace message_registries 74b304bd79SP Dheeraj Srujan Kumar 754642bf8fSGeorge Liu #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 764642bf8fSGeorge Liu static std::optional<boost::asio::posix::stream_descriptor> inotifyConn; 774642bf8fSGeorge Liu static constexpr const char* redfishEventLogDir = "/var/log"; 784642bf8fSGeorge Liu static constexpr const char* redfishEventLogFile = "/var/log/redfish"; 794642bf8fSGeorge Liu static constexpr const size_t iEventSize = sizeof(inotify_event); 804642bf8fSGeorge Liu static int inotifyFd = -1; 814642bf8fSGeorge Liu static int dirWatchDesc = -1; 824642bf8fSGeorge Liu static int fileWatchDesc = -1; 834642bf8fSGeorge Liu 844642bf8fSGeorge Liu // <ID, timestamp, RedfishLogId, registryPrefix, MessageId, MessageArgs> 854642bf8fSGeorge Liu using EventLogObjectsType = 864642bf8fSGeorge Liu std::tuple<std::string, std::string, std::string, std::string, std::string, 874642bf8fSGeorge Liu std::vector<std::string>>; 884642bf8fSGeorge Liu 894642bf8fSGeorge Liu namespace message_registries 904642bf8fSGeorge Liu { 917f4eb588SAppaRao Puli static const Message* 927f4eb588SAppaRao Puli getMsgFromRegistry(const std::string& messageKey, 9326702d01SEd Tanous const std::span<const MessageEntry>& registry) 947f4eb588SAppaRao Puli { 9526702d01SEd Tanous std::span<const MessageEntry>::iterator messageIt = 9626702d01SEd Tanous std::find_if(registry.begin(), registry.end(), 977f4eb588SAppaRao Puli [&messageKey](const MessageEntry& messageEntry) { 98e662eae8SEd Tanous return messageKey.compare(messageEntry.first) == 0; 997f4eb588SAppaRao Puli }); 10026702d01SEd Tanous if (messageIt != registry.end()) 1017f4eb588SAppaRao Puli { 1027f4eb588SAppaRao Puli return &messageIt->second; 1037f4eb588SAppaRao Puli } 1047f4eb588SAppaRao Puli 1057f4eb588SAppaRao Puli return nullptr; 1067f4eb588SAppaRao Puli } 1077f4eb588SAppaRao Puli 1087f4eb588SAppaRao Puli static const Message* formatMessage(const std::string_view& messageID) 1097f4eb588SAppaRao Puli { 1107f4eb588SAppaRao Puli // Redfish MessageIds are in the form 1117f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 1127f4eb588SAppaRao Puli // the right Message 1137f4eb588SAppaRao Puli std::vector<std::string> fields; 1147f4eb588SAppaRao Puli fields.reserve(4); 1157f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 1167f4eb588SAppaRao Puli if (fields.size() != 4) 1177f4eb588SAppaRao Puli { 1187f4eb588SAppaRao Puli return nullptr; 1197f4eb588SAppaRao Puli } 1207f4eb588SAppaRao Puli std::string& registryName = fields[0]; 1217f4eb588SAppaRao Puli std::string& messageKey = fields[3]; 1227f4eb588SAppaRao Puli 1237f4eb588SAppaRao Puli // Find the right registry and check it for the MessageKey 124b304bd79SP Dheeraj Srujan Kumar return getMsgFromRegistry(messageKey, getRegistryFromPrefix(registryName)); 1257f4eb588SAppaRao Puli } 1267f4eb588SAppaRao Puli } // namespace message_registries 1277f4eb588SAppaRao Puli 1287f4eb588SAppaRao Puli namespace event_log 1297f4eb588SAppaRao Puli { 1302558979cSP Dheeraj Srujan Kumar inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID) 1317f4eb588SAppaRao Puli { 1327f4eb588SAppaRao Puli static time_t prevTs = 0; 1337f4eb588SAppaRao Puli static int index = 0; 1347f4eb588SAppaRao Puli 1357f4eb588SAppaRao Puli // Get the entry timestamp 1367f4eb588SAppaRao Puli std::time_t curTs = 0; 1377f4eb588SAppaRao Puli std::tm timeStruct = {}; 1387f4eb588SAppaRao Puli std::istringstream entryStream(logEntry); 1397f4eb588SAppaRao Puli if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 1407f4eb588SAppaRao Puli { 1417f4eb588SAppaRao Puli curTs = std::mktime(&timeStruct); 1427f4eb588SAppaRao Puli if (curTs == -1) 1437f4eb588SAppaRao Puli { 1447f4eb588SAppaRao Puli return false; 1457f4eb588SAppaRao Puli } 1467f4eb588SAppaRao Puli } 1477f4eb588SAppaRao Puli // If the timestamp isn't unique, increment the index 1487f4eb588SAppaRao Puli index = (curTs == prevTs) ? index + 1 : 0; 1497f4eb588SAppaRao Puli 1507f4eb588SAppaRao Puli // Save the timestamp 1517f4eb588SAppaRao Puli prevTs = curTs; 1527f4eb588SAppaRao Puli 1537f4eb588SAppaRao Puli entryID = std::to_string(curTs); 1547f4eb588SAppaRao Puli if (index > 0) 1557f4eb588SAppaRao Puli { 1567f4eb588SAppaRao Puli entryID += "_" + std::to_string(index); 1577f4eb588SAppaRao Puli } 1587f4eb588SAppaRao Puli return true; 1597f4eb588SAppaRao Puli } 1607f4eb588SAppaRao Puli 16123a21a1cSEd Tanous inline int getEventLogParams(const std::string& logEntry, 16223a21a1cSEd Tanous std::string& timestamp, std::string& messageID, 1635e715de6SAppaRao Puli std::vector<std::string>& messageArgs) 1647f4eb588SAppaRao Puli { 1657f4eb588SAppaRao Puli // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1667f4eb588SAppaRao Puli // First get the Timestamp 167f23b7296SEd Tanous size_t space = logEntry.find_first_of(' '); 1687f4eb588SAppaRao Puli if (space == std::string::npos) 1697f4eb588SAppaRao Puli { 1707f4eb588SAppaRao Puli return -EINVAL; 1717f4eb588SAppaRao Puli } 1727f4eb588SAppaRao Puli timestamp = logEntry.substr(0, space); 1737f4eb588SAppaRao Puli // Then get the log contents 174f23b7296SEd Tanous size_t entryStart = logEntry.find_first_not_of(' ', space); 1757f4eb588SAppaRao Puli if (entryStart == std::string::npos) 1767f4eb588SAppaRao Puli { 1777f4eb588SAppaRao Puli return -EINVAL; 1787f4eb588SAppaRao Puli } 1797f4eb588SAppaRao Puli std::string_view entry(logEntry); 1807f4eb588SAppaRao Puli entry.remove_prefix(entryStart); 1817f4eb588SAppaRao Puli // Use split to separate the entry into its fields 1827f4eb588SAppaRao Puli std::vector<std::string> logEntryFields; 1837f4eb588SAppaRao Puli boost::split(logEntryFields, entry, boost::is_any_of(","), 1847f4eb588SAppaRao Puli boost::token_compress_on); 1857f4eb588SAppaRao Puli // We need at least a MessageId to be valid 18626f6976fSEd Tanous if (logEntryFields.empty()) 1877f4eb588SAppaRao Puli { 1887f4eb588SAppaRao Puli return -EINVAL; 1897f4eb588SAppaRao Puli } 1907f4eb588SAppaRao Puli messageID = logEntryFields[0]; 1917f4eb588SAppaRao Puli 1927f4eb588SAppaRao Puli // Get the MessageArgs from the log if there are any 1937f4eb588SAppaRao Puli if (logEntryFields.size() > 1) 1947f4eb588SAppaRao Puli { 1957f4eb588SAppaRao Puli std::string& messageArgsStart = logEntryFields[1]; 1967f4eb588SAppaRao Puli // If the first string is empty, assume there are no MessageArgs 1977f4eb588SAppaRao Puli if (!messageArgsStart.empty()) 1987f4eb588SAppaRao Puli { 1995e715de6SAppaRao Puli messageArgs.assign(logEntryFields.begin() + 1, 2005e715de6SAppaRao Puli logEntryFields.end()); 2017f4eb588SAppaRao Puli } 2027f4eb588SAppaRao Puli } 2037f4eb588SAppaRao Puli 2047f4eb588SAppaRao Puli return 0; 2057f4eb588SAppaRao Puli } 2067f4eb588SAppaRao Puli 20723a21a1cSEd Tanous inline void getRegistryAndMessageKey(const std::string& messageID, 2087f4eb588SAppaRao Puli std::string& registryName, 2097f4eb588SAppaRao Puli std::string& messageKey) 2107f4eb588SAppaRao Puli { 2117f4eb588SAppaRao Puli // Redfish MessageIds are in the form 2127f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 2137f4eb588SAppaRao Puli // the right Message 2147f4eb588SAppaRao Puli std::vector<std::string> fields; 2157f4eb588SAppaRao Puli fields.reserve(4); 2167f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 2177f4eb588SAppaRao Puli if (fields.size() == 4) 2187f4eb588SAppaRao Puli { 2197f4eb588SAppaRao Puli registryName = fields[0]; 2207f4eb588SAppaRao Puli messageKey = fields[3]; 2217f4eb588SAppaRao Puli } 2227f4eb588SAppaRao Puli } 2237f4eb588SAppaRao Puli 22423a21a1cSEd Tanous inline int formatEventLogEntry(const std::string& logEntryID, 2257f4eb588SAppaRao Puli const std::string& messageID, 226c5ba4c27SEd Tanous const std::span<std::string_view> messageArgs, 22723a21a1cSEd Tanous std::string timestamp, 228b5a76932SEd Tanous const std::string& customText, 2297f4eb588SAppaRao Puli nlohmann::json& logEntryJson) 2307f4eb588SAppaRao Puli { 2317f4eb588SAppaRao Puli // Get the Message from the MessageRegistry 2327f4eb588SAppaRao Puli const message_registries::Message* message = 2337f4eb588SAppaRao Puli message_registries::formatMessage(messageID); 2347f4eb588SAppaRao Puli 2357f4eb588SAppaRao Puli std::string msg; 2367f4eb588SAppaRao Puli std::string severity; 2377f4eb588SAppaRao Puli if (message != nullptr) 2387f4eb588SAppaRao Puli { 2397f4eb588SAppaRao Puli msg = message->message; 2407f4eb588SAppaRao Puli severity = message->severity; 2417f4eb588SAppaRao Puli } 2427f4eb588SAppaRao Puli 243c5ba4c27SEd Tanous redfish::message_registries::fillMessageArgs(messageArgs, msg); 2447f4eb588SAppaRao Puli 2457f4eb588SAppaRao Puli // Get the Created time from the timestamp. The log timestamp is in 2467f4eb588SAppaRao Puli // RFC3339 format which matches the Redfish format except for the 2477f4eb588SAppaRao Puli // fractional seconds between the '.' and the '+', so just remove them. 248f23b7296SEd Tanous std::size_t dot = timestamp.find_first_of('.'); 249f23b7296SEd Tanous std::size_t plus = timestamp.find_first_of('+'); 2507f4eb588SAppaRao Puli if (dot != std::string::npos && plus != std::string::npos) 2517f4eb588SAppaRao Puli { 2527f4eb588SAppaRao Puli timestamp.erase(dot, plus - dot); 2537f4eb588SAppaRao Puli } 2547f4eb588SAppaRao Puli 2557f4eb588SAppaRao Puli // Fill in the log entry with the gathered data 2567f4eb588SAppaRao Puli logEntryJson = {{"EventId", logEntryID}, 2577f4eb588SAppaRao Puli {"EventType", "Event"}, 2587f4eb588SAppaRao Puli {"Severity", std::move(severity)}, 2597f4eb588SAppaRao Puli {"Message", std::move(msg)}, 260f23b7296SEd Tanous {"MessageId", messageID}, 261f23b7296SEd Tanous {"MessageArgs", messageArgs}, 2627f4eb588SAppaRao Puli {"EventTimestamp", std::move(timestamp)}, 2637f4eb588SAppaRao Puli {"Context", customText}}; 2647f4eb588SAppaRao Puli return 0; 2657f4eb588SAppaRao Puli } 2667f4eb588SAppaRao Puli 2677f4eb588SAppaRao Puli } // namespace event_log 2687f4eb588SAppaRao Puli #endif 2697f4eb588SAppaRao Puli 27023a21a1cSEd Tanous inline bool isFilterQuerySpecialChar(char c) 27107941a88SAyushi Smriti { 27207941a88SAyushi Smriti switch (c) 27307941a88SAyushi Smriti { 27407941a88SAyushi Smriti case '(': 27507941a88SAyushi Smriti case ')': 27607941a88SAyushi Smriti case '\'': 27707941a88SAyushi Smriti return true; 27807941a88SAyushi Smriti default: 27907941a88SAyushi Smriti return false; 28007941a88SAyushi Smriti } 28107941a88SAyushi Smriti } 28207941a88SAyushi Smriti 28323a21a1cSEd Tanous inline bool 28423a21a1cSEd Tanous readSSEQueryParams(std::string sseFilter, std::string& formatType, 28507941a88SAyushi Smriti std::vector<std::string>& messageIds, 28607941a88SAyushi Smriti std::vector<std::string>& registryPrefixes, 287144b6318SAppaRao Puli std::vector<std::string>& metricReportDefinitions) 28807941a88SAyushi Smriti { 28907941a88SAyushi Smriti sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(), 29007941a88SAyushi Smriti isFilterQuerySpecialChar), 29107941a88SAyushi Smriti sseFilter.end()); 29207941a88SAyushi Smriti 29307941a88SAyushi Smriti std::vector<std::string> result; 29407941a88SAyushi Smriti boost::split(result, sseFilter, boost::is_any_of(" "), 29507941a88SAyushi Smriti boost::token_compress_on); 29607941a88SAyushi Smriti 29707941a88SAyushi Smriti BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size(); 29807941a88SAyushi Smriti 29907941a88SAyushi Smriti constexpr uint8_t divisor = 4; 30007941a88SAyushi Smriti constexpr uint8_t minTokenSize = 3; 30107941a88SAyushi Smriti if (result.size() % divisor != minTokenSize) 30207941a88SAyushi Smriti { 30307941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid SSE filter specified."; 30407941a88SAyushi Smriti return false; 30507941a88SAyushi Smriti } 30607941a88SAyushi Smriti 30707941a88SAyushi Smriti for (std::size_t i = 0; i < result.size(); i += divisor) 30807941a88SAyushi Smriti { 30907941a88SAyushi Smriti std::string& key = result[i]; 31007941a88SAyushi Smriti std::string& op = result[i + 1]; 31107941a88SAyushi Smriti std::string& value = result[i + 2]; 31207941a88SAyushi Smriti 31307941a88SAyushi Smriti if ((i + minTokenSize) < result.size()) 31407941a88SAyushi Smriti { 3154e0453b1SGunnar Mills std::string& separator = result[i + minTokenSize]; 31607941a88SAyushi Smriti // SSE supports only "or" and "and" in query params. 3174e0453b1SGunnar Mills if ((separator != "or") && (separator != "and")) 31807941a88SAyushi Smriti { 31907941a88SAyushi Smriti BMCWEB_LOG_ERROR 32007941a88SAyushi Smriti << "Invalid group operator in SSE query parameters"; 32107941a88SAyushi Smriti return false; 32207941a88SAyushi Smriti } 32307941a88SAyushi Smriti } 32407941a88SAyushi Smriti 32507941a88SAyushi Smriti // SSE supports only "eq" as per spec. 32607941a88SAyushi Smriti if (op != "eq") 32707941a88SAyushi Smriti { 32807941a88SAyushi Smriti BMCWEB_LOG_ERROR 32907941a88SAyushi Smriti << "Invalid assignment operator in SSE query parameters"; 33007941a88SAyushi Smriti return false; 33107941a88SAyushi Smriti } 33207941a88SAyushi Smriti 33307941a88SAyushi Smriti BMCWEB_LOG_DEBUG << key << " : " << value; 33407941a88SAyushi Smriti if (key == "EventFormatType") 33507941a88SAyushi Smriti { 33607941a88SAyushi Smriti formatType = value; 33707941a88SAyushi Smriti } 33807941a88SAyushi Smriti else if (key == "MessageId") 33907941a88SAyushi Smriti { 34007941a88SAyushi Smriti messageIds.push_back(value); 34107941a88SAyushi Smriti } 34207941a88SAyushi Smriti else if (key == "RegistryPrefix") 34307941a88SAyushi Smriti { 34407941a88SAyushi Smriti registryPrefixes.push_back(value); 34507941a88SAyushi Smriti } 34607941a88SAyushi Smriti else if (key == "MetricReportDefinition") 34707941a88SAyushi Smriti { 34807941a88SAyushi Smriti metricReportDefinitions.push_back(value); 34907941a88SAyushi Smriti } 35007941a88SAyushi Smriti else 35107941a88SAyushi Smriti { 35207941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid property(" << key 35307941a88SAyushi Smriti << ")in SSE filter query."; 35407941a88SAyushi Smriti return false; 35507941a88SAyushi Smriti } 35607941a88SAyushi Smriti } 35707941a88SAyushi Smriti return true; 35807941a88SAyushi Smriti } 35907941a88SAyushi Smriti 36028afb49cSJunLin Chen class Subscription : public persistent_data::UserSubscription 361b52664e2SAppaRao Puli { 362b52664e2SAppaRao Puli public: 363b52664e2SAppaRao Puli Subscription(const Subscription&) = delete; 364b52664e2SAppaRao Puli Subscription& operator=(const Subscription&) = delete; 365b52664e2SAppaRao Puli Subscription(Subscription&&) = delete; 366b52664e2SAppaRao Puli Subscription& operator=(Subscription&&) = delete; 367b52664e2SAppaRao Puli 368b52664e2SAppaRao Puli Subscription(const std::string& inHost, const std::string& inPort, 369b52664e2SAppaRao Puli const std::string& inPath, const std::string& inUriProto) : 3700b4bdd93SAppaRao Puli eventSeqNum(1), 3710b4bdd93SAppaRao Puli host(inHost), port(inPort), path(inPath), uriProto(inUriProto) 372b52664e2SAppaRao Puli { 3737adb85acSSunitha Harish // Subscription constructor 374b52664e2SAppaRao Puli } 3754bbf237fSAppaRao Puli 37623e64207SEd Tanous Subscription(const std::shared_ptr<boost::beast::tcp_stream>& adaptor) : 3774bbf237fSAppaRao Puli eventSeqNum(1) 3784bbf237fSAppaRao Puli { 3794bbf237fSAppaRao Puli sseConn = std::make_shared<crow::ServerSentEvents>(adaptor); 3804bbf237fSAppaRao Puli } 3814bbf237fSAppaRao Puli 3829f616dd1SEd Tanous ~Subscription() = default; 383b52664e2SAppaRao Puli 3846ba8c82eSsunharis_in bool sendEvent(const std::string& msg) 385b52664e2SAppaRao Puli { 3866ba8c82eSsunharis_in persistent_data::EventServiceConfig eventServiceConfig = 3876ba8c82eSsunharis_in persistent_data::EventServiceStore::getInstance() 3886ba8c82eSsunharis_in .getEventServiceConfig(); 3896ba8c82eSsunharis_in if (!eventServiceConfig.enabled) 3906ba8c82eSsunharis_in { 3916ba8c82eSsunharis_in return false; 3926ba8c82eSsunharis_in } 3936ba8c82eSsunharis_in 3947adb85acSSunitha Harish if (conn == nullptr) 3954bbf237fSAppaRao Puli { 3967adb85acSSunitha Harish // create the HttpClient connection 3977adb85acSSunitha Harish conn = std::make_shared<crow::HttpClient>( 3987adb85acSSunitha Harish crow::connections::systemBus->get_io_context(), id, host, port, 3997adb85acSSunitha Harish path, httpHeaders); 400b52664e2SAppaRao Puli } 401b52664e2SAppaRao Puli 4027adb85acSSunitha Harish conn->sendData(msg); 4037adb85acSSunitha Harish eventSeqNum++; 4047adb85acSSunitha Harish 4054bbf237fSAppaRao Puli if (sseConn != nullptr) 4064bbf237fSAppaRao Puli { 4074bbf237fSAppaRao Puli sseConn->sendData(eventSeqNum, msg); 4084bbf237fSAppaRao Puli } 4096ba8c82eSsunharis_in return true; 4104bbf237fSAppaRao Puli } 4114bbf237fSAppaRao Puli 4126ba8c82eSsunharis_in bool sendTestEventLog() 4130b4bdd93SAppaRao Puli { 4140b4bdd93SAppaRao Puli nlohmann::json logEntryArray; 4150b4bdd93SAppaRao Puli logEntryArray.push_back({}); 4160b4bdd93SAppaRao Puli nlohmann::json& logEntryJson = logEntryArray.back(); 4170b4bdd93SAppaRao Puli 4187c8c4058STejas Patil logEntryJson = { 4197c8c4058STejas Patil {"EventId", "TestID"}, 4200b4bdd93SAppaRao Puli {"EventType", "Event"}, 4210b4bdd93SAppaRao Puli {"Severity", "OK"}, 4220b4bdd93SAppaRao Puli {"Message", "Generated test event"}, 4234a0bf539SManojkiran Eda {"MessageId", "OpenBMC.0.2.TestEventLog"}, 4240b4bdd93SAppaRao Puli {"MessageArgs", nlohmann::json::array()}, 4257c8c4058STejas Patil {"EventTimestamp", crow::utility::getDateTimeOffsetNow().first}, 4260b4bdd93SAppaRao Puli {"Context", customText}}; 4270b4bdd93SAppaRao Puli 4280b4bdd93SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 4290b4bdd93SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 4300b4bdd93SAppaRao Puli {"Name", "Event Log"}, 4310b4bdd93SAppaRao Puli {"Events", logEntryArray}}; 4320b4bdd93SAppaRao Puli 4336ba8c82eSsunharis_in return this->sendEvent( 43471f52d96SEd Tanous msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace)); 4350b4bdd93SAppaRao Puli } 4360b4bdd93SAppaRao Puli 4377f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 4387f4eb588SAppaRao Puli void filterAndSendEventLogs( 4397f4eb588SAppaRao Puli const std::vector<EventLogObjectsType>& eventRecords) 4407f4eb588SAppaRao Puli { 4417f4eb588SAppaRao Puli nlohmann::json logEntryArray; 4427f4eb588SAppaRao Puli for (const EventLogObjectsType& logEntry : eventRecords) 4437f4eb588SAppaRao Puli { 4447f4eb588SAppaRao Puli const std::string& idStr = std::get<0>(logEntry); 4457f4eb588SAppaRao Puli const std::string& timestamp = std::get<1>(logEntry); 4467f4eb588SAppaRao Puli const std::string& messageID = std::get<2>(logEntry); 4477f4eb588SAppaRao Puli const std::string& registryName = std::get<3>(logEntry); 4487f4eb588SAppaRao Puli const std::string& messageKey = std::get<4>(logEntry); 4495e715de6SAppaRao Puli const std::vector<std::string>& messageArgs = std::get<5>(logEntry); 4507f4eb588SAppaRao Puli 4517f4eb588SAppaRao Puli // If registryPrefixes list is empty, don't filter events 4527f4eb588SAppaRao Puli // send everything. 45326f6976fSEd Tanous if (!registryPrefixes.empty()) 4547f4eb588SAppaRao Puli { 4557f4eb588SAppaRao Puli auto obj = std::find(registryPrefixes.begin(), 4567f4eb588SAppaRao Puli registryPrefixes.end(), registryName); 4577f4eb588SAppaRao Puli if (obj == registryPrefixes.end()) 4587f4eb588SAppaRao Puli { 4597f4eb588SAppaRao Puli continue; 4607f4eb588SAppaRao Puli } 4617f4eb588SAppaRao Puli } 4627f4eb588SAppaRao Puli 4637f4eb588SAppaRao Puli // If registryMsgIds list is empty, don't filter events 4647f4eb588SAppaRao Puli // send everything. 46526f6976fSEd Tanous if (!registryMsgIds.empty()) 4667f4eb588SAppaRao Puli { 4677f4eb588SAppaRao Puli auto obj = std::find(registryMsgIds.begin(), 4687f4eb588SAppaRao Puli registryMsgIds.end(), messageKey); 4697f4eb588SAppaRao Puli if (obj == registryMsgIds.end()) 4707f4eb588SAppaRao Puli { 4717f4eb588SAppaRao Puli continue; 4727f4eb588SAppaRao Puli } 4737f4eb588SAppaRao Puli } 4747f4eb588SAppaRao Puli 475c5ba4c27SEd Tanous std::vector<std::string_view> messageArgsView(messageArgs.begin(), 476c5ba4c27SEd Tanous messageArgs.end()); 477c5ba4c27SEd Tanous 4787f4eb588SAppaRao Puli logEntryArray.push_back({}); 4797f4eb588SAppaRao Puli nlohmann::json& bmcLogEntry = logEntryArray.back(); 480c5ba4c27SEd Tanous if (event_log::formatEventLogEntry(idStr, messageID, 481c5ba4c27SEd Tanous messageArgsView, timestamp, 482c5ba4c27SEd Tanous customText, bmcLogEntry) != 0) 4837f4eb588SAppaRao Puli { 4847f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry failed"; 4857f4eb588SAppaRao Puli continue; 4867f4eb588SAppaRao Puli } 4877f4eb588SAppaRao Puli } 4887f4eb588SAppaRao Puli 48926f6976fSEd Tanous if (logEntryArray.empty()) 4907f4eb588SAppaRao Puli { 4917f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 4927f4eb588SAppaRao Puli return; 4937f4eb588SAppaRao Puli } 4947f4eb588SAppaRao Puli 4957f4eb588SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 4967f4eb588SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 4977f4eb588SAppaRao Puli {"Name", "Event Log"}, 4987f4eb588SAppaRao Puli {"Events", logEntryArray}}; 4997f4eb588SAppaRao Puli 50071f52d96SEd Tanous this->sendEvent( 50171f52d96SEd Tanous msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace)); 5027f4eb588SAppaRao Puli } 5037f4eb588SAppaRao Puli #endif 5047f4eb588SAppaRao Puli 505248d0230SEd Tanous void filterAndSendReports(const std::string& reportId, 5061e1e598dSJonathan Doman const telemetry::TimestampReadings& var) 507156d6b00SAppaRao Puli { 508c0353249SWludzik, Jozef std::string mrdUri = telemetry::metricReportDefinitionUri + ("/" + id); 509156d6b00SAppaRao Puli 510156d6b00SAppaRao Puli // Empty list means no filter. Send everything. 51126f6976fSEd Tanous if (!metricReportDefinitions.empty()) 512156d6b00SAppaRao Puli { 513156d6b00SAppaRao Puli if (std::find(metricReportDefinitions.begin(), 514156d6b00SAppaRao Puli metricReportDefinitions.end(), 515c0353249SWludzik, Jozef mrdUri) == metricReportDefinitions.end()) 516156d6b00SAppaRao Puli { 517156d6b00SAppaRao Puli return; 518156d6b00SAppaRao Puli } 519156d6b00SAppaRao Puli } 520156d6b00SAppaRao Puli 521c0353249SWludzik, Jozef nlohmann::json msg; 522248d0230SEd Tanous if (!telemetry::fillReport(msg, reportId, var)) 523156d6b00SAppaRao Puli { 524c0353249SWludzik, Jozef BMCWEB_LOG_ERROR << "Failed to fill the MetricReport for DBus " 525c0353249SWludzik, Jozef "Report with id " 526248d0230SEd Tanous << reportId; 527c0353249SWludzik, Jozef return; 528156d6b00SAppaRao Puli } 529156d6b00SAppaRao Puli 53071f52d96SEd Tanous this->sendEvent( 53171f52d96SEd Tanous msg.dump(2, ' ', true, nlohmann::json::error_handler_t::replace)); 532156d6b00SAppaRao Puli } 533156d6b00SAppaRao Puli 534fe44eb0bSAyushi Smriti void updateRetryConfig(const uint32_t retryAttempts, 535fe44eb0bSAyushi Smriti const uint32_t retryTimeoutInterval) 536fe44eb0bSAyushi Smriti { 53762de0c68SAppaRao Puli if (conn != nullptr) 53862de0c68SAppaRao Puli { 539fe44eb0bSAyushi Smriti conn->setRetryConfig(retryAttempts, retryTimeoutInterval); 540fe44eb0bSAyushi Smriti } 54162de0c68SAppaRao Puli } 542fe44eb0bSAyushi Smriti 543fe44eb0bSAyushi Smriti void updateRetryPolicy() 544fe44eb0bSAyushi Smriti { 54562de0c68SAppaRao Puli if (conn != nullptr) 54662de0c68SAppaRao Puli { 547fe44eb0bSAyushi Smriti conn->setRetryPolicy(retryPolicy); 548fe44eb0bSAyushi Smriti } 54962de0c68SAppaRao Puli } 550fe44eb0bSAyushi Smriti 5519eb808c1SEd Tanous uint64_t getEventSeqNum() const 55296330b99SSunitha Harish { 55396330b99SSunitha Harish return eventSeqNum; 55496330b99SSunitha Harish } 55596330b99SSunitha Harish 556b52664e2SAppaRao Puli private: 5570b4bdd93SAppaRao Puli uint64_t eventSeqNum; 558b52664e2SAppaRao Puli std::string host; 559b52664e2SAppaRao Puli std::string port; 560b52664e2SAppaRao Puli std::string path; 561b52664e2SAppaRao Puli std::string uriProto; 5624bbf237fSAppaRao Puli std::shared_ptr<crow::HttpClient> conn = nullptr; 5634bbf237fSAppaRao Puli std::shared_ptr<crow::ServerSentEvents> sseConn = nullptr; 564b52664e2SAppaRao Puli }; 565b52664e2SAppaRao Puli 566b52664e2SAppaRao Puli class EventServiceManager 567b52664e2SAppaRao Puli { 568b52664e2SAppaRao Puli private: 569d3a9e084SEd Tanous bool serviceEnabled = false; 570d3a9e084SEd Tanous uint32_t retryAttempts = 0; 571d3a9e084SEd Tanous uint32_t retryTimeoutInterval = 0; 5727d1cc387SAppaRao Puli 5739f616dd1SEd Tanous EventServiceManager() 574b52664e2SAppaRao Puli { 5751bf712bcSAyushi Smriti // Load config from persist store. 5761bf712bcSAyushi Smriti initConfig(); 577b52664e2SAppaRao Puli } 578b52664e2SAppaRao Puli 5792558979cSP Dheeraj Srujan Kumar std::streampos redfishLogFilePosition{0}; 5809f616dd1SEd Tanous size_t noOfEventLogSubscribers{0}; 5819f616dd1SEd Tanous size_t noOfMetricReportSubscribers{0}; 582156d6b00SAppaRao Puli std::shared_ptr<sdbusplus::bus::match::match> matchTelemetryMonitor; 583b52664e2SAppaRao Puli boost::container::flat_map<std::string, std::shared_ptr<Subscription>> 584b52664e2SAppaRao Puli subscriptionsMap; 585b52664e2SAppaRao Puli 5869f616dd1SEd Tanous uint64_t eventId{1}; 58796330b99SSunitha Harish 588b52664e2SAppaRao Puli public: 5899f616dd1SEd Tanous EventServiceManager(const EventServiceManager&) = delete; 5909f616dd1SEd Tanous EventServiceManager& operator=(const EventServiceManager&) = delete; 5919f616dd1SEd Tanous EventServiceManager(EventServiceManager&&) = delete; 5929f616dd1SEd Tanous EventServiceManager& operator=(EventServiceManager&&) = delete; 593ecd6a3a2SEd Tanous ~EventServiceManager() = default; 5949f616dd1SEd Tanous 595b52664e2SAppaRao Puli static EventServiceManager& getInstance() 596b52664e2SAppaRao Puli { 597b52664e2SAppaRao Puli static EventServiceManager handler; 598b52664e2SAppaRao Puli return handler; 599b52664e2SAppaRao Puli } 600b52664e2SAppaRao Puli 6011bf712bcSAyushi Smriti void initConfig() 6021bf712bcSAyushi Smriti { 60328afb49cSJunLin Chen loadOldBehavior(); 6041bf712bcSAyushi Smriti 60528afb49cSJunLin Chen persistent_data::EventServiceConfig eventServiceConfig = 60628afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 60728afb49cSJunLin Chen .getEventServiceConfig(); 6081bf712bcSAyushi Smriti 60928afb49cSJunLin Chen serviceEnabled = eventServiceConfig.enabled; 61028afb49cSJunLin Chen retryAttempts = eventServiceConfig.retryAttempts; 61128afb49cSJunLin Chen retryTimeoutInterval = eventServiceConfig.retryTimeoutInterval; 6121bf712bcSAyushi Smriti 61328afb49cSJunLin Chen for (const auto& it : persistent_data::EventServiceStore::getInstance() 61428afb49cSJunLin Chen .subscriptionsConfigMap) 6151bf712bcSAyushi Smriti { 61628afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> newSub = 61728afb49cSJunLin Chen it.second; 6184bbf237fSAppaRao Puli 6191bf712bcSAyushi Smriti std::string host; 6201bf712bcSAyushi Smriti std::string urlProto; 6211bf712bcSAyushi Smriti std::string port; 6221bf712bcSAyushi Smriti std::string path; 62328afb49cSJunLin Chen bool status = validateAndSplitUrl(newSub->destinationUrl, urlProto, 62428afb49cSJunLin Chen host, port, path); 6251bf712bcSAyushi Smriti 6261bf712bcSAyushi Smriti if (!status) 6271bf712bcSAyushi Smriti { 6281bf712bcSAyushi Smriti BMCWEB_LOG_ERROR 6291bf712bcSAyushi Smriti << "Failed to validate and split destination url"; 6301bf712bcSAyushi Smriti continue; 6311bf712bcSAyushi Smriti } 6321bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = 6331bf712bcSAyushi Smriti std::make_shared<Subscription>(host, port, path, urlProto); 6341bf712bcSAyushi Smriti 63528afb49cSJunLin Chen subValue->id = newSub->id; 63628afb49cSJunLin Chen subValue->destinationUrl = newSub->destinationUrl; 63728afb49cSJunLin Chen subValue->protocol = newSub->protocol; 63828afb49cSJunLin Chen subValue->retryPolicy = newSub->retryPolicy; 63928afb49cSJunLin Chen subValue->customText = newSub->customText; 64028afb49cSJunLin Chen subValue->eventFormatType = newSub->eventFormatType; 64128afb49cSJunLin Chen subValue->subscriptionType = newSub->subscriptionType; 64228afb49cSJunLin Chen subValue->registryMsgIds = newSub->registryMsgIds; 64328afb49cSJunLin Chen subValue->registryPrefixes = newSub->registryPrefixes; 64428afb49cSJunLin Chen subValue->resourceTypes = newSub->resourceTypes; 64528afb49cSJunLin Chen subValue->httpHeaders = newSub->httpHeaders; 64628afb49cSJunLin Chen subValue->metricReportDefinitions = newSub->metricReportDefinitions; 6471bf712bcSAyushi Smriti 64828afb49cSJunLin Chen if (subValue->id.empty()) 6491bf712bcSAyushi Smriti { 6501bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Failed to add subscription"; 6511bf712bcSAyushi Smriti } 65228afb49cSJunLin Chen subscriptionsMap.insert(std::pair(subValue->id, subValue)); 65328afb49cSJunLin Chen 65428afb49cSJunLin Chen updateNoOfSubscribersCount(); 65528afb49cSJunLin Chen 65628afb49cSJunLin Chen #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 6572558979cSP Dheeraj Srujan Kumar 6582558979cSP Dheeraj Srujan Kumar cacheRedfishLogFile(); 6592558979cSP Dheeraj Srujan Kumar 66028afb49cSJunLin Chen #endif 66128afb49cSJunLin Chen // Update retry configuration. 66228afb49cSJunLin Chen subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 66328afb49cSJunLin Chen subValue->updateRetryPolicy(); 6641bf712bcSAyushi Smriti } 6651bf712bcSAyushi Smriti } 6661bf712bcSAyushi Smriti 66728afb49cSJunLin Chen void loadOldBehavior() 668b52664e2SAppaRao Puli { 66928afb49cSJunLin Chen std::ifstream eventConfigFile(eventServiceFile); 67028afb49cSJunLin Chen if (!eventConfigFile.good()) 6711bf712bcSAyushi Smriti { 67228afb49cSJunLin Chen BMCWEB_LOG_DEBUG << "Old eventService config not exist"; 67328afb49cSJunLin Chen return; 67428afb49cSJunLin Chen } 67528afb49cSJunLin Chen auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false); 67628afb49cSJunLin Chen if (jsonData.is_discarded()) 6774bbf237fSAppaRao Puli { 67828afb49cSJunLin Chen BMCWEB_LOG_ERROR << "Old eventService config parse error."; 67928afb49cSJunLin Chen return; 68028afb49cSJunLin Chen } 68128afb49cSJunLin Chen 68228afb49cSJunLin Chen for (const auto& item : jsonData.items()) 68328afb49cSJunLin Chen { 68428afb49cSJunLin Chen if (item.key() == "Configuration") 68528afb49cSJunLin Chen { 68628afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 68728afb49cSJunLin Chen .getEventServiceConfig() 68828afb49cSJunLin Chen .fromJson(item.value()); 68928afb49cSJunLin Chen } 69028afb49cSJunLin Chen else if (item.key() == "Subscriptions") 69128afb49cSJunLin Chen { 69228afb49cSJunLin Chen for (const auto& elem : item.value()) 69328afb49cSJunLin Chen { 69428afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> 69528afb49cSJunLin Chen newSubscription = 69628afb49cSJunLin Chen persistent_data::UserSubscription::fromJson(elem, 69728afb49cSJunLin Chen true); 69828afb49cSJunLin Chen if (newSubscription == nullptr) 69928afb49cSJunLin Chen { 70028afb49cSJunLin Chen BMCWEB_LOG_ERROR << "Problem reading subscription " 70128afb49cSJunLin Chen "from old persistent store"; 7024bbf237fSAppaRao Puli continue; 7034bbf237fSAppaRao Puli } 7041bf712bcSAyushi Smriti 70528afb49cSJunLin Chen std::uniform_int_distribution<uint32_t> dist(0); 70628afb49cSJunLin Chen bmcweb::OpenSSLGenerator gen; 7071bf712bcSAyushi Smriti 70828afb49cSJunLin Chen std::string id; 7091bf712bcSAyushi Smriti 71028afb49cSJunLin Chen int retry = 3; 711e662eae8SEd Tanous while (retry != 0) 7121bf712bcSAyushi Smriti { 71328afb49cSJunLin Chen id = std::to_string(dist(gen)); 71428afb49cSJunLin Chen if (gen.error()) 7157d1cc387SAppaRao Puli { 71628afb49cSJunLin Chen retry = 0; 71728afb49cSJunLin Chen break; 71828afb49cSJunLin Chen } 71928afb49cSJunLin Chen newSubscription->id = id; 72028afb49cSJunLin Chen auto inserted = 72128afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 72228afb49cSJunLin Chen .subscriptionsConfigMap.insert( 72328afb49cSJunLin Chen std::pair(id, newSubscription)); 72428afb49cSJunLin Chen if (inserted.second) 72528afb49cSJunLin Chen { 72628afb49cSJunLin Chen break; 72728afb49cSJunLin Chen } 72828afb49cSJunLin Chen --retry; 7297d1cc387SAppaRao Puli } 7307d1cc387SAppaRao Puli 73128afb49cSJunLin Chen if (retry <= 0) 73228afb49cSJunLin Chen { 73328afb49cSJunLin Chen BMCWEB_LOG_ERROR 73428afb49cSJunLin Chen << "Failed to generate random number from old " 73528afb49cSJunLin Chen "persistent store"; 73628afb49cSJunLin Chen continue; 73728afb49cSJunLin Chen } 73828afb49cSJunLin Chen } 73928afb49cSJunLin Chen } 74028afb49cSJunLin Chen 74128afb49cSJunLin Chen persistent_data::getConfig().writeData(); 74228afb49cSJunLin Chen std::remove(eventServiceFile); 74328afb49cSJunLin Chen BMCWEB_LOG_DEBUG << "Remove old eventservice config"; 74428afb49cSJunLin Chen } 74528afb49cSJunLin Chen } 74628afb49cSJunLin Chen 7479eb808c1SEd Tanous void updateSubscriptionData() const 74828afb49cSJunLin Chen { 74928afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 75028afb49cSJunLin Chen .eventServiceConfig.enabled = serviceEnabled; 75128afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 75228afb49cSJunLin Chen .eventServiceConfig.retryAttempts = retryAttempts; 75328afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 75428afb49cSJunLin Chen .eventServiceConfig.retryTimeoutInterval = retryTimeoutInterval; 75528afb49cSJunLin Chen 75628afb49cSJunLin Chen persistent_data::getConfig().writeData(); 75728afb49cSJunLin Chen } 75828afb49cSJunLin Chen 75928afb49cSJunLin Chen void setEventServiceConfig(const persistent_data::EventServiceConfig& cfg) 7607d1cc387SAppaRao Puli { 7617d1cc387SAppaRao Puli bool updateConfig = false; 762fe44eb0bSAyushi Smriti bool updateRetryCfg = false; 7637d1cc387SAppaRao Puli 76428afb49cSJunLin Chen if (serviceEnabled != cfg.enabled) 7657d1cc387SAppaRao Puli { 76628afb49cSJunLin Chen serviceEnabled = cfg.enabled; 767e662eae8SEd Tanous if (serviceEnabled && noOfMetricReportSubscribers != 0U) 7687d1cc387SAppaRao Puli { 7697d1cc387SAppaRao Puli registerMetricReportSignal(); 7707d1cc387SAppaRao Puli } 7717d1cc387SAppaRao Puli else 7727d1cc387SAppaRao Puli { 7737d1cc387SAppaRao Puli unregisterMetricReportSignal(); 7747d1cc387SAppaRao Puli } 7757d1cc387SAppaRao Puli updateConfig = true; 7767d1cc387SAppaRao Puli } 7777d1cc387SAppaRao Puli 77828afb49cSJunLin Chen if (retryAttempts != cfg.retryAttempts) 7797d1cc387SAppaRao Puli { 78028afb49cSJunLin Chen retryAttempts = cfg.retryAttempts; 7817d1cc387SAppaRao Puli updateConfig = true; 782fe44eb0bSAyushi Smriti updateRetryCfg = true; 7837d1cc387SAppaRao Puli } 7847d1cc387SAppaRao Puli 78528afb49cSJunLin Chen if (retryTimeoutInterval != cfg.retryTimeoutInterval) 7867d1cc387SAppaRao Puli { 78728afb49cSJunLin Chen retryTimeoutInterval = cfg.retryTimeoutInterval; 7887d1cc387SAppaRao Puli updateConfig = true; 789fe44eb0bSAyushi Smriti updateRetryCfg = true; 7907d1cc387SAppaRao Puli } 7917d1cc387SAppaRao Puli 7927d1cc387SAppaRao Puli if (updateConfig) 7937d1cc387SAppaRao Puli { 7947d1cc387SAppaRao Puli updateSubscriptionData(); 7957d1cc387SAppaRao Puli } 796fe44eb0bSAyushi Smriti 797fe44eb0bSAyushi Smriti if (updateRetryCfg) 798fe44eb0bSAyushi Smriti { 799fe44eb0bSAyushi Smriti // Update the changed retry config to all subscriptions 800fe44eb0bSAyushi Smriti for (const auto& it : 801fe44eb0bSAyushi Smriti EventServiceManager::getInstance().subscriptionsMap) 802fe44eb0bSAyushi Smriti { 803fe44eb0bSAyushi Smriti std::shared_ptr<Subscription> entry = it.second; 804fe44eb0bSAyushi Smriti entry->updateRetryConfig(retryAttempts, retryTimeoutInterval); 805fe44eb0bSAyushi Smriti } 806fe44eb0bSAyushi Smriti } 8077d1cc387SAppaRao Puli } 8087d1cc387SAppaRao Puli 8097d1cc387SAppaRao Puli void updateNoOfSubscribersCount() 8107d1cc387SAppaRao Puli { 8117d1cc387SAppaRao Puli size_t eventLogSubCount = 0; 8127d1cc387SAppaRao Puli size_t metricReportSubCount = 0; 8137d1cc387SAppaRao Puli for (const auto& it : subscriptionsMap) 8147d1cc387SAppaRao Puli { 8157d1cc387SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 8167d1cc387SAppaRao Puli if (entry->eventFormatType == eventFormatType) 8177d1cc387SAppaRao Puli { 8187d1cc387SAppaRao Puli eventLogSubCount++; 8197d1cc387SAppaRao Puli } 8207d1cc387SAppaRao Puli else if (entry->eventFormatType == metricReportFormatType) 8217d1cc387SAppaRao Puli { 8227d1cc387SAppaRao Puli metricReportSubCount++; 8237d1cc387SAppaRao Puli } 8247d1cc387SAppaRao Puli } 8257d1cc387SAppaRao Puli 8267d1cc387SAppaRao Puli noOfEventLogSubscribers = eventLogSubCount; 8277d1cc387SAppaRao Puli if (noOfMetricReportSubscribers != metricReportSubCount) 8287d1cc387SAppaRao Puli { 8297d1cc387SAppaRao Puli noOfMetricReportSubscribers = metricReportSubCount; 830e662eae8SEd Tanous if (noOfMetricReportSubscribers != 0U) 8317d1cc387SAppaRao Puli { 8327d1cc387SAppaRao Puli registerMetricReportSignal(); 8337d1cc387SAppaRao Puli } 8347d1cc387SAppaRao Puli else 8357d1cc387SAppaRao Puli { 8367d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8377d1cc387SAppaRao Puli } 8387d1cc387SAppaRao Puli } 8397d1cc387SAppaRao Puli } 8407d1cc387SAppaRao Puli 841b52664e2SAppaRao Puli std::shared_ptr<Subscription> getSubscription(const std::string& id) 842b52664e2SAppaRao Puli { 843b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 844b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 845b52664e2SAppaRao Puli { 846b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id; 847b52664e2SAppaRao Puli return nullptr; 848b52664e2SAppaRao Puli } 849b52664e2SAppaRao Puli std::shared_ptr<Subscription> subValue = obj->second; 850b52664e2SAppaRao Puli return subValue; 851b52664e2SAppaRao Puli } 852b52664e2SAppaRao Puli 853b5a76932SEd Tanous std::string addSubscription(const std::shared_ptr<Subscription>& subValue, 8541bf712bcSAyushi Smriti const bool updateFile = true) 855b52664e2SAppaRao Puli { 856fc76b8acSEd Tanous 857fc76b8acSEd Tanous std::uniform_int_distribution<uint32_t> dist(0); 858fc76b8acSEd Tanous bmcweb::OpenSSLGenerator gen; 859fc76b8acSEd Tanous 860b52664e2SAppaRao Puli std::string id; 861b52664e2SAppaRao Puli 862b52664e2SAppaRao Puli int retry = 3; 863e662eae8SEd Tanous while (retry != 0) 864b52664e2SAppaRao Puli { 865fc76b8acSEd Tanous id = std::to_string(dist(gen)); 866fc76b8acSEd Tanous if (gen.error()) 867fc76b8acSEd Tanous { 868fc76b8acSEd Tanous retry = 0; 869fc76b8acSEd Tanous break; 870fc76b8acSEd Tanous } 871b52664e2SAppaRao Puli auto inserted = subscriptionsMap.insert(std::pair(id, subValue)); 872b52664e2SAppaRao Puli if (inserted.second) 873b52664e2SAppaRao Puli { 874b52664e2SAppaRao Puli break; 875b52664e2SAppaRao Puli } 876b52664e2SAppaRao Puli --retry; 87723a21a1cSEd Tanous } 878b52664e2SAppaRao Puli 879b52664e2SAppaRao Puli if (retry <= 0) 880b52664e2SAppaRao Puli { 881b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Failed to generate random number"; 882abb93cddSEd Tanous return ""; 883b52664e2SAppaRao Puli } 884b52664e2SAppaRao Puli 88528afb49cSJunLin Chen std::shared_ptr<persistent_data::UserSubscription> newSub = 88628afb49cSJunLin Chen std::make_shared<persistent_data::UserSubscription>(); 88728afb49cSJunLin Chen newSub->id = id; 88828afb49cSJunLin Chen newSub->destinationUrl = subValue->destinationUrl; 88928afb49cSJunLin Chen newSub->protocol = subValue->protocol; 89028afb49cSJunLin Chen newSub->retryPolicy = subValue->retryPolicy; 89128afb49cSJunLin Chen newSub->customText = subValue->customText; 89228afb49cSJunLin Chen newSub->eventFormatType = subValue->eventFormatType; 89328afb49cSJunLin Chen newSub->subscriptionType = subValue->subscriptionType; 89428afb49cSJunLin Chen newSub->registryMsgIds = subValue->registryMsgIds; 89528afb49cSJunLin Chen newSub->registryPrefixes = subValue->registryPrefixes; 89628afb49cSJunLin Chen newSub->resourceTypes = subValue->resourceTypes; 89728afb49cSJunLin Chen newSub->httpHeaders = subValue->httpHeaders; 89828afb49cSJunLin Chen newSub->metricReportDefinitions = subValue->metricReportDefinitions; 89928afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 90028afb49cSJunLin Chen .subscriptionsConfigMap.emplace(newSub->id, newSub); 90128afb49cSJunLin Chen 9027d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 9031bf712bcSAyushi Smriti 9041bf712bcSAyushi Smriti if (updateFile) 9051bf712bcSAyushi Smriti { 906b52664e2SAppaRao Puli updateSubscriptionData(); 9071bf712bcSAyushi Smriti } 9087f4eb588SAppaRao Puli 9097f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 9102558979cSP Dheeraj Srujan Kumar if (redfishLogFilePosition != 0) 9117f4eb588SAppaRao Puli { 9122558979cSP Dheeraj Srujan Kumar cacheRedfishLogFile(); 9137f4eb588SAppaRao Puli } 9147f4eb588SAppaRao Puli #endif 915fe44eb0bSAyushi Smriti // Update retry configuration. 916fe44eb0bSAyushi Smriti subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 917fe44eb0bSAyushi Smriti subValue->updateRetryPolicy(); 918fe44eb0bSAyushi Smriti 919b52664e2SAppaRao Puli return id; 920b52664e2SAppaRao Puli } 921b52664e2SAppaRao Puli 922b52664e2SAppaRao Puli bool isSubscriptionExist(const std::string& id) 923b52664e2SAppaRao Puli { 924b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 925b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 926b52664e2SAppaRao Puli { 927b52664e2SAppaRao Puli return false; 928b52664e2SAppaRao Puli } 929b52664e2SAppaRao Puli return true; 930b52664e2SAppaRao Puli } 931b52664e2SAppaRao Puli 932b52664e2SAppaRao Puli void deleteSubscription(const std::string& id) 933b52664e2SAppaRao Puli { 934b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 935b52664e2SAppaRao Puli if (obj != subscriptionsMap.end()) 936b52664e2SAppaRao Puli { 937b52664e2SAppaRao Puli subscriptionsMap.erase(obj); 93828afb49cSJunLin Chen auto obj2 = persistent_data::EventServiceStore::getInstance() 93928afb49cSJunLin Chen .subscriptionsConfigMap.find(id); 94028afb49cSJunLin Chen persistent_data::EventServiceStore::getInstance() 94128afb49cSJunLin Chen .subscriptionsConfigMap.erase(obj2); 9427d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 943b52664e2SAppaRao Puli updateSubscriptionData(); 944b52664e2SAppaRao Puli } 945b52664e2SAppaRao Puli } 946b52664e2SAppaRao Puli 947b52664e2SAppaRao Puli size_t getNumberOfSubscriptions() 948b52664e2SAppaRao Puli { 949b52664e2SAppaRao Puli return subscriptionsMap.size(); 950b52664e2SAppaRao Puli } 951b52664e2SAppaRao Puli 952b52664e2SAppaRao Puli std::vector<std::string> getAllIDs() 953b52664e2SAppaRao Puli { 954b52664e2SAppaRao Puli std::vector<std::string> idList; 955b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 956b52664e2SAppaRao Puli { 957b52664e2SAppaRao Puli idList.emplace_back(it.first); 958b52664e2SAppaRao Puli } 959b52664e2SAppaRao Puli return idList; 960b52664e2SAppaRao Puli } 961b52664e2SAppaRao Puli 962b52664e2SAppaRao Puli bool isDestinationExist(const std::string& destUrl) 963b52664e2SAppaRao Puli { 964b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 965b52664e2SAppaRao Puli { 966b52664e2SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 967b52664e2SAppaRao Puli if (entry->destinationUrl == destUrl) 968b52664e2SAppaRao Puli { 969b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Destination exist already" << destUrl; 970b52664e2SAppaRao Puli return true; 971b52664e2SAppaRao Puli } 972b52664e2SAppaRao Puli } 973b52664e2SAppaRao Puli return false; 974b52664e2SAppaRao Puli } 9750b4bdd93SAppaRao Puli 9766ba8c82eSsunharis_in bool sendTestEventLog() 9770b4bdd93SAppaRao Puli { 9780b4bdd93SAppaRao Puli for (const auto& it : this->subscriptionsMap) 9790b4bdd93SAppaRao Puli { 9800b4bdd93SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 9816ba8c82eSsunharis_in if (!entry->sendTestEventLog()) 9826ba8c82eSsunharis_in { 9836ba8c82eSsunharis_in return false; 9840b4bdd93SAppaRao Puli } 9850b4bdd93SAppaRao Puli } 9866ba8c82eSsunharis_in return true; 9876ba8c82eSsunharis_in } 988e9a14131SAppaRao Puli 98996330b99SSunitha Harish void sendEvent(const nlohmann::json& eventMessageIn, 99096330b99SSunitha Harish const std::string& origin, const std::string& resType) 99196330b99SSunitha Harish { 992*dbb59d4dSEd Tanous if (!serviceEnabled || (noOfEventLogSubscribers == 0U)) 9936ba8c82eSsunharis_in { 9946ba8c82eSsunharis_in BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 9956ba8c82eSsunharis_in return; 9966ba8c82eSsunharis_in } 99796330b99SSunitha Harish nlohmann::json eventRecord = nlohmann::json::array(); 99896330b99SSunitha Harish nlohmann::json eventMessage = eventMessageIn; 99996330b99SSunitha Harish // MemberId is 0 : since we are sending one event record. 100096330b99SSunitha Harish uint64_t memberId = 0; 100196330b99SSunitha Harish 100296330b99SSunitha Harish nlohmann::json event = { 100396330b99SSunitha Harish {"EventId", eventId}, 100496330b99SSunitha Harish {"MemberId", memberId}, 10057c8c4058STejas Patil {"EventTimestamp", crow::utility::getDateTimeOffsetNow().first}, 100696330b99SSunitha Harish {"OriginOfCondition", origin}}; 100796330b99SSunitha Harish for (nlohmann::json::iterator it = event.begin(); it != event.end(); 100896330b99SSunitha Harish ++it) 100996330b99SSunitha Harish { 101096330b99SSunitha Harish eventMessage[it.key()] = it.value(); 101196330b99SSunitha Harish } 101296330b99SSunitha Harish eventRecord.push_back(eventMessage); 101396330b99SSunitha Harish 101496330b99SSunitha Harish for (const auto& it : this->subscriptionsMap) 101596330b99SSunitha Harish { 101696330b99SSunitha Harish std::shared_ptr<Subscription> entry = it.second; 101796330b99SSunitha Harish bool isSubscribed = false; 101896330b99SSunitha Harish // Search the resourceTypes list for the subscription. 101996330b99SSunitha Harish // If resourceTypes list is empty, don't filter events 102096330b99SSunitha Harish // send everything. 102126f6976fSEd Tanous if (!entry->resourceTypes.empty()) 102296330b99SSunitha Harish { 10233174e4dfSEd Tanous for (const auto& resource : entry->resourceTypes) 102496330b99SSunitha Harish { 102596330b99SSunitha Harish if (resType == resource) 102696330b99SSunitha Harish { 102796330b99SSunitha Harish BMCWEB_LOG_INFO << "ResourceType " << resource 102896330b99SSunitha Harish << " found in the subscribed list"; 102996330b99SSunitha Harish isSubscribed = true; 103096330b99SSunitha Harish break; 103196330b99SSunitha Harish } 103296330b99SSunitha Harish } 103396330b99SSunitha Harish } 103496330b99SSunitha Harish else // resourceTypes list is empty. 103596330b99SSunitha Harish { 103696330b99SSunitha Harish isSubscribed = true; 103796330b99SSunitha Harish } 103896330b99SSunitha Harish if (isSubscribed) 103996330b99SSunitha Harish { 104096330b99SSunitha Harish nlohmann::json msgJson = { 104196330b99SSunitha Harish {"@odata.type", "#Event.v1_4_0.Event"}, 104296330b99SSunitha Harish {"Name", "Event Log"}, 104396330b99SSunitha Harish {"Id", eventId}, 104496330b99SSunitha Harish {"Events", eventRecord}}; 104571f52d96SEd Tanous entry->sendEvent(msgJson.dump( 104671f52d96SEd Tanous 2, ' ', true, nlohmann::json::error_handler_t::replace)); 104796330b99SSunitha Harish eventId++; // increament the eventId 104896330b99SSunitha Harish } 104996330b99SSunitha Harish else 105096330b99SSunitha Harish { 105196330b99SSunitha Harish BMCWEB_LOG_INFO << "Not subscribed to this resource"; 105296330b99SSunitha Harish } 105396330b99SSunitha Harish } 105496330b99SSunitha Harish } 10555738de59SAsmitha Karunanithi void sendBroadcastMsg(const std::string& broadcastMsg) 10565738de59SAsmitha Karunanithi { 10575738de59SAsmitha Karunanithi for (const auto& it : this->subscriptionsMap) 10585738de59SAsmitha Karunanithi { 10595738de59SAsmitha Karunanithi std::shared_ptr<Subscription> entry = it.second; 10605738de59SAsmitha Karunanithi nlohmann::json msgJson = { 10617c8c4058STejas Patil {"Timestamp", crow::utility::getDateTimeOffsetNow().first}, 10625738de59SAsmitha Karunanithi {"OriginOfCondition", "/ibm/v1/HMC/BroadcastService"}, 10635738de59SAsmitha Karunanithi {"Name", "Broadcast Message"}, 10645738de59SAsmitha Karunanithi {"Message", broadcastMsg}}; 106571f52d96SEd Tanous entry->sendEvent(msgJson.dump( 106671f52d96SEd Tanous 2, ' ', true, nlohmann::json::error_handler_t::replace)); 10675738de59SAsmitha Karunanithi } 10685738de59SAsmitha Karunanithi } 106996330b99SSunitha Harish 10707f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 10712558979cSP Dheeraj Srujan Kumar 10722558979cSP Dheeraj Srujan Kumar void resetRedfishFilePosition() 10737f4eb588SAppaRao Puli { 10742558979cSP Dheeraj Srujan Kumar // Control would be here when Redfish file is created. 10752558979cSP Dheeraj Srujan Kumar // Reset File Position as new file is created 10762558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = 0; 10772558979cSP Dheeraj Srujan Kumar } 10782558979cSP Dheeraj Srujan Kumar 10792558979cSP Dheeraj Srujan Kumar void cacheRedfishLogFile() 10802558979cSP Dheeraj Srujan Kumar { 10812558979cSP Dheeraj Srujan Kumar // Open the redfish file and read till the last record. 10822558979cSP Dheeraj Srujan Kumar 10837f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 10847f4eb588SAppaRao Puli if (!logStream.good()) 10857f4eb588SAppaRao Puli { 10867f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed \n"; 10877f4eb588SAppaRao Puli return; 10887f4eb588SAppaRao Puli } 10897f4eb588SAppaRao Puli std::string logEntry; 10907f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 10917f4eb588SAppaRao Puli { 10922558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = logStream.tellg(); 10937f4eb588SAppaRao Puli } 10942558979cSP Dheeraj Srujan Kumar 10952558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "Next Log Position : " << redfishLogFilePosition; 10967f4eb588SAppaRao Puli } 10977f4eb588SAppaRao Puli 10987f4eb588SAppaRao Puli void readEventLogsFromFile() 10997f4eb588SAppaRao Puli { 11007f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 11017f4eb588SAppaRao Puli if (!logStream.good()) 11027f4eb588SAppaRao Puli { 11037f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed"; 11047f4eb588SAppaRao Puli return; 11057f4eb588SAppaRao Puli } 11067f4eb588SAppaRao Puli 11077f4eb588SAppaRao Puli std::vector<EventLogObjectsType> eventRecords; 11087f4eb588SAppaRao Puli 11097f4eb588SAppaRao Puli std::string logEntry; 11102558979cSP Dheeraj Srujan Kumar 11112558979cSP Dheeraj Srujan Kumar // Get the read pointer to the next log to be read. 11122558979cSP Dheeraj Srujan Kumar logStream.seekg(redfishLogFilePosition); 11132558979cSP Dheeraj Srujan Kumar 11147f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 11157f4eb588SAppaRao Puli { 11162558979cSP Dheeraj Srujan Kumar // Update Pointer position 11172558979cSP Dheeraj Srujan Kumar redfishLogFilePosition = logStream.tellg(); 11182558979cSP Dheeraj Srujan Kumar 11192558979cSP Dheeraj Srujan Kumar std::string idStr; 11202558979cSP Dheeraj Srujan Kumar if (!event_log::getUniqueEntryID(logEntry, idStr)) 11217f4eb588SAppaRao Puli { 11227f4eb588SAppaRao Puli continue; 11237f4eb588SAppaRao Puli } 11247f4eb588SAppaRao Puli 1125e662eae8SEd Tanous if (!serviceEnabled || noOfEventLogSubscribers == 0) 11267f4eb588SAppaRao Puli { 11272558979cSP Dheeraj Srujan Kumar // If Service is not enabled, no need to compute 11282558979cSP Dheeraj Srujan Kumar // the remaining items below. 11292558979cSP Dheeraj Srujan Kumar // But, Loop must continue to keep track of Timestamp 11307f4eb588SAppaRao Puli continue; 11317f4eb588SAppaRao Puli } 11327f4eb588SAppaRao Puli 11337f4eb588SAppaRao Puli std::string timestamp; 11347f4eb588SAppaRao Puli std::string messageID; 11355e715de6SAppaRao Puli std::vector<std::string> messageArgs; 11367f4eb588SAppaRao Puli if (event_log::getEventLogParams(logEntry, timestamp, messageID, 11377f4eb588SAppaRao Puli messageArgs) != 0) 11387f4eb588SAppaRao Puli { 11397f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry params failed"; 11407f4eb588SAppaRao Puli continue; 11417f4eb588SAppaRao Puli } 11427f4eb588SAppaRao Puli 11437f4eb588SAppaRao Puli std::string registryName; 11447f4eb588SAppaRao Puli std::string messageKey; 11457f4eb588SAppaRao Puli event_log::getRegistryAndMessageKey(messageID, registryName, 11467f4eb588SAppaRao Puli messageKey); 11477f4eb588SAppaRao Puli if (registryName.empty() || messageKey.empty()) 11487f4eb588SAppaRao Puli { 11497f4eb588SAppaRao Puli continue; 11507f4eb588SAppaRao Puli } 11517f4eb588SAppaRao Puli 11527f4eb588SAppaRao Puli eventRecords.emplace_back(idStr, timestamp, messageID, registryName, 11537f4eb588SAppaRao Puli messageKey, messageArgs); 11547f4eb588SAppaRao Puli } 11557f4eb588SAppaRao Puli 1156e662eae8SEd Tanous if (!serviceEnabled || noOfEventLogSubscribers == 0) 11572558979cSP Dheeraj Srujan Kumar { 11582558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 11592558979cSP Dheeraj Srujan Kumar return; 11602558979cSP Dheeraj Srujan Kumar } 11612558979cSP Dheeraj Srujan Kumar 11622558979cSP Dheeraj Srujan Kumar if (eventRecords.empty()) 11632558979cSP Dheeraj Srujan Kumar { 11642558979cSP Dheeraj Srujan Kumar // No Records to send 11652558979cSP Dheeraj Srujan Kumar BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 11662558979cSP Dheeraj Srujan Kumar return; 11672558979cSP Dheeraj Srujan Kumar } 11682558979cSP Dheeraj Srujan Kumar 11697f4eb588SAppaRao Puli for (const auto& it : this->subscriptionsMap) 11707f4eb588SAppaRao Puli { 11717f4eb588SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 11727f4eb588SAppaRao Puli if (entry->eventFormatType == "Event") 11737f4eb588SAppaRao Puli { 11747f4eb588SAppaRao Puli entry->filterAndSendEventLogs(eventRecords); 11757f4eb588SAppaRao Puli } 11767f4eb588SAppaRao Puli } 11777f4eb588SAppaRao Puli } 11787f4eb588SAppaRao Puli 11797f4eb588SAppaRao Puli static void watchRedfishEventLogFile() 11807f4eb588SAppaRao Puli { 11816a9f85f9SAppaRao Puli if (!inotifyConn) 11827f4eb588SAppaRao Puli { 11837f4eb588SAppaRao Puli return; 11847f4eb588SAppaRao Puli } 11857f4eb588SAppaRao Puli 11867f4eb588SAppaRao Puli static std::array<char, 1024> readBuffer; 11877f4eb588SAppaRao Puli 11887f4eb588SAppaRao Puli inotifyConn->async_read_some( 11897f4eb588SAppaRao Puli boost::asio::buffer(readBuffer), 11907f4eb588SAppaRao Puli [&](const boost::system::error_code& ec, 11917f4eb588SAppaRao Puli const std::size_t& bytesTransferred) { 11927f4eb588SAppaRao Puli if (ec) 11937f4eb588SAppaRao Puli { 11947f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "Callback Error: " << ec.message(); 11957f4eb588SAppaRao Puli return; 11967f4eb588SAppaRao Puli } 11977f4eb588SAppaRao Puli std::size_t index = 0; 1198b792cc56SAppaRao Puli while ((index + iEventSize) <= bytesTransferred) 11997f4eb588SAppaRao Puli { 1200d3a9e084SEd Tanous struct inotify_event event 1201d3a9e084SEd Tanous {}; 1202b792cc56SAppaRao Puli std::memcpy(&event, &readBuffer[index], iEventSize); 1203b792cc56SAppaRao Puli if (event.wd == dirWatchDesc) 1204b792cc56SAppaRao Puli { 1205b792cc56SAppaRao Puli if ((event.len == 0) || 1206b792cc56SAppaRao Puli (index + iEventSize + event.len > bytesTransferred)) 1207b792cc56SAppaRao Puli { 1208b792cc56SAppaRao Puli index += (iEventSize + event.len); 1209b792cc56SAppaRao Puli continue; 1210b792cc56SAppaRao Puli } 1211b792cc56SAppaRao Puli 1212b792cc56SAppaRao Puli std::string fileName(&readBuffer[index + iEventSize], 1213b792cc56SAppaRao Puli event.len); 1214b792cc56SAppaRao Puli if (std::strcmp(fileName.c_str(), "redfish") != 0) 1215b792cc56SAppaRao Puli { 1216b792cc56SAppaRao Puli index += (iEventSize + event.len); 1217b792cc56SAppaRao Puli continue; 1218b792cc56SAppaRao Puli } 1219b792cc56SAppaRao Puli 1220b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1221b792cc56SAppaRao Puli << "Redfish log file created/deleted. event.name: " 1222b792cc56SAppaRao Puli << fileName; 1223b792cc56SAppaRao Puli if (event.mask == IN_CREATE) 1224b792cc56SAppaRao Puli { 1225b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1226b792cc56SAppaRao Puli { 1227b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1228016761afSAppaRao Puli << "Remove and Add inotify watcher on " 1229016761afSAppaRao Puli "redfish event log file"; 1230016761afSAppaRao Puli // Remove existing inotify watcher and add 1231016761afSAppaRao Puli // with new redfish event log file. 1232016761afSAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1233016761afSAppaRao Puli fileWatchDesc = -1; 1234b792cc56SAppaRao Puli } 1235b792cc56SAppaRao Puli 1236b792cc56SAppaRao Puli fileWatchDesc = inotify_add_watch( 1237b792cc56SAppaRao Puli inotifyFd, redfishEventLogFile, IN_MODIFY); 1238b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1239b792cc56SAppaRao Puli { 1240b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1241b792cc56SAppaRao Puli << "inotify_add_watch failed for " 1242b792cc56SAppaRao Puli "redfish log file."; 1243b792cc56SAppaRao Puli return; 1244b792cc56SAppaRao Puli } 1245b792cc56SAppaRao Puli 1246b792cc56SAppaRao Puli EventServiceManager::getInstance() 12472558979cSP Dheeraj Srujan Kumar .resetRedfishFilePosition(); 1248b792cc56SAppaRao Puli EventServiceManager::getInstance() 1249b792cc56SAppaRao Puli .readEventLogsFromFile(); 1250b792cc56SAppaRao Puli } 1251b792cc56SAppaRao Puli else if ((event.mask == IN_DELETE) || 1252b792cc56SAppaRao Puli (event.mask == IN_MOVED_TO)) 1253b792cc56SAppaRao Puli { 1254b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1255b792cc56SAppaRao Puli { 1256b792cc56SAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1257b792cc56SAppaRao Puli fileWatchDesc = -1; 1258b792cc56SAppaRao Puli } 1259b792cc56SAppaRao Puli } 1260b792cc56SAppaRao Puli } 1261b792cc56SAppaRao Puli else if (event.wd == fileWatchDesc) 1262b792cc56SAppaRao Puli { 1263b792cc56SAppaRao Puli if (event.mask == IN_MODIFY) 12647f4eb588SAppaRao Puli { 12657f4eb588SAppaRao Puli EventServiceManager::getInstance() 12667f4eb588SAppaRao Puli .readEventLogsFromFile(); 12677f4eb588SAppaRao Puli } 1268b792cc56SAppaRao Puli } 1269b792cc56SAppaRao Puli index += (iEventSize + event.len); 12707f4eb588SAppaRao Puli } 12717f4eb588SAppaRao Puli 12727f4eb588SAppaRao Puli watchRedfishEventLogFile(); 12737f4eb588SAppaRao Puli }); 12747f4eb588SAppaRao Puli } 12757f4eb588SAppaRao Puli 12767f4eb588SAppaRao Puli static int startEventLogMonitor(boost::asio::io_context& ioc) 12777f4eb588SAppaRao Puli { 127823a21a1cSEd Tanous inotifyConn.emplace(ioc); 1279b792cc56SAppaRao Puli inotifyFd = inotify_init1(IN_NONBLOCK); 1280b792cc56SAppaRao Puli if (inotifyFd == -1) 12817f4eb588SAppaRao Puli { 12827f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "inotify_init1 failed."; 12837f4eb588SAppaRao Puli return -1; 12847f4eb588SAppaRao Puli } 1285b792cc56SAppaRao Puli 1286b792cc56SAppaRao Puli // Add watch on directory to handle redfish event log file 1287b792cc56SAppaRao Puli // create/delete. 1288b792cc56SAppaRao Puli dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir, 1289b792cc56SAppaRao Puli IN_CREATE | IN_MOVED_TO | IN_DELETE); 1290b792cc56SAppaRao Puli if (dirWatchDesc == -1) 12917f4eb588SAppaRao Puli { 12927f4eb588SAppaRao Puli BMCWEB_LOG_ERROR 1293b792cc56SAppaRao Puli << "inotify_add_watch failed for event log directory."; 12947f4eb588SAppaRao Puli return -1; 12957f4eb588SAppaRao Puli } 12967f4eb588SAppaRao Puli 1297b792cc56SAppaRao Puli // Watch redfish event log file for modifications. 1298b792cc56SAppaRao Puli fileWatchDesc = 1299b792cc56SAppaRao Puli inotify_add_watch(inotifyFd, redfishEventLogFile, IN_MODIFY); 1300b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1301b792cc56SAppaRao Puli { 1302b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1303b792cc56SAppaRao Puli << "inotify_add_watch failed for redfish log file."; 1304b792cc56SAppaRao Puli // Don't return error if file not exist. 1305b792cc56SAppaRao Puli // Watch on directory will handle create/delete of file. 1306b792cc56SAppaRao Puli } 1307b792cc56SAppaRao Puli 13087f4eb588SAppaRao Puli // monitor redfish event log file 1309b792cc56SAppaRao Puli inotifyConn->assign(inotifyFd); 13107f4eb588SAppaRao Puli watchRedfishEventLogFile(); 13117f4eb588SAppaRao Puli 13127f4eb588SAppaRao Puli return 0; 13137f4eb588SAppaRao Puli } 13147f4eb588SAppaRao Puli 13157f4eb588SAppaRao Puli #endif 1316c0353249SWludzik, Jozef void getReadingsForReport(sdbusplus::message::message& msg) 1317156d6b00SAppaRao Puli { 1318c0353249SWludzik, Jozef sdbusplus::message::object_path path(msg.get_path()); 1319c0353249SWludzik, Jozef std::string id = path.filename(); 1320c0353249SWludzik, Jozef if (id.empty()) 1321156d6b00SAppaRao Puli { 1322c0353249SWludzik, Jozef BMCWEB_LOG_ERROR << "Failed to get Id from path"; 1323156d6b00SAppaRao Puli return; 1324156d6b00SAppaRao Puli } 1325156d6b00SAppaRao Puli 1326c0353249SWludzik, Jozef std::string interface; 1327168e20c1SEd Tanous std::vector<std::pair<std::string, dbus::utility::DbusVariantType>> 1328c0353249SWludzik, Jozef props; 1329c0353249SWludzik, Jozef std::vector<std::string> invalidProps; 1330c0353249SWludzik, Jozef msg.read(interface, props, invalidProps); 1331c0353249SWludzik, Jozef 1332c0353249SWludzik, Jozef auto found = 1333c0353249SWludzik, Jozef std::find_if(props.begin(), props.end(), 1334c0353249SWludzik, Jozef [](const auto& x) { return x.first == "Readings"; }); 1335c0353249SWludzik, Jozef if (found == props.end()) 1336156d6b00SAppaRao Puli { 1337c0353249SWludzik, Jozef BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; 1338156d6b00SAppaRao Puli return; 1339156d6b00SAppaRao Puli } 1340156d6b00SAppaRao Puli 13411e1e598dSJonathan Doman const telemetry::TimestampReadings* readings = 13421e1e598dSJonathan Doman std::get_if<telemetry::TimestampReadings>(&found->second); 1343e662eae8SEd Tanous if (readings == nullptr) 13441e1e598dSJonathan Doman { 13451e1e598dSJonathan Doman BMCWEB_LOG_INFO << "Failed to get Readings from Report properties"; 13461e1e598dSJonathan Doman return; 13471e1e598dSJonathan Doman } 13481e1e598dSJonathan Doman 1349156d6b00SAppaRao Puli for (const auto& it : 1350156d6b00SAppaRao Puli EventServiceManager::getInstance().subscriptionsMap) 1351156d6b00SAppaRao Puli { 1352e05aec50SEd Tanous Subscription& entry = *it.second; 1353c0353249SWludzik, Jozef if (entry.eventFormatType == metricReportFormatType) 1354156d6b00SAppaRao Puli { 13551e1e598dSJonathan Doman entry.filterAndSendReports(id, *readings); 1356156d6b00SAppaRao Puli } 1357156d6b00SAppaRao Puli } 1358156d6b00SAppaRao Puli } 1359156d6b00SAppaRao Puli 1360156d6b00SAppaRao Puli void unregisterMetricReportSignal() 1361156d6b00SAppaRao Puli { 13627d1cc387SAppaRao Puli if (matchTelemetryMonitor) 13637d1cc387SAppaRao Puli { 1364156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister"; 1365156d6b00SAppaRao Puli matchTelemetryMonitor.reset(); 1366156d6b00SAppaRao Puli matchTelemetryMonitor = nullptr; 1367156d6b00SAppaRao Puli } 13687d1cc387SAppaRao Puli } 1369156d6b00SAppaRao Puli 1370156d6b00SAppaRao Puli void registerMetricReportSignal() 1371156d6b00SAppaRao Puli { 13727d1cc387SAppaRao Puli if (!serviceEnabled || matchTelemetryMonitor) 1373156d6b00SAppaRao Puli { 13747d1cc387SAppaRao Puli BMCWEB_LOG_DEBUG << "Not registering metric report signal."; 1375156d6b00SAppaRao Puli return; 1376156d6b00SAppaRao Puli } 1377156d6b00SAppaRao Puli 1378156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Register"; 1379c0353249SWludzik, Jozef std::string matchStr = "type='signal',member='PropertiesChanged'," 1380c0353249SWludzik, Jozef "interface='org.freedesktop.DBus.Properties'," 1381c0353249SWludzik, Jozef "arg0=xyz.openbmc_project.Telemetry.Report"; 1382156d6b00SAppaRao Puli 1383156d6b00SAppaRao Puli matchTelemetryMonitor = std::make_shared<sdbusplus::bus::match::match>( 1384156d6b00SAppaRao Puli *crow::connections::systemBus, matchStr, 1385156d6b00SAppaRao Puli [this](sdbusplus::message::message& msg) { 1386156d6b00SAppaRao Puli if (msg.is_method_error()) 1387156d6b00SAppaRao Puli { 1388156d6b00SAppaRao Puli BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error"; 1389156d6b00SAppaRao Puli return; 1390156d6b00SAppaRao Puli } 1391156d6b00SAppaRao Puli 1392c0353249SWludzik, Jozef getReadingsForReport(msg); 1393156d6b00SAppaRao Puli }); 1394156d6b00SAppaRao Puli } 13951bf712bcSAyushi Smriti 13961bf712bcSAyushi Smriti bool validateAndSplitUrl(const std::string& destUrl, std::string& urlProto, 13971bf712bcSAyushi Smriti std::string& host, std::string& port, 13981bf712bcSAyushi Smriti std::string& path) 13991bf712bcSAyushi Smriti { 14001bf712bcSAyushi Smriti // Validate URL using regex expression 14011bf712bcSAyushi Smriti // Format: <protocol>://<host>:<port>/<path> 14021bf712bcSAyushi Smriti // protocol: http/https 14031bf712bcSAyushi Smriti const std::regex urlRegex( 14041bf712bcSAyushi Smriti "(http|https)://([^/\\x20\\x3f\\x23\\x3a]+):?([0-9]*)(/" 14051bf712bcSAyushi Smriti "([^\\x20\\x23\\x3f]*\\x3f?([^\\x20\\x23\\x3f])*)?)"); 14061bf712bcSAyushi Smriti std::cmatch match; 14071bf712bcSAyushi Smriti if (!std::regex_match(destUrl.c_str(), match, urlRegex)) 14081bf712bcSAyushi Smriti { 14091bf712bcSAyushi Smriti BMCWEB_LOG_INFO << "Dest. url did not match "; 14101bf712bcSAyushi Smriti return false; 14111bf712bcSAyushi Smriti } 14121bf712bcSAyushi Smriti 14131bf712bcSAyushi Smriti urlProto = std::string(match[1].first, match[1].second); 14141bf712bcSAyushi Smriti if (urlProto == "http") 14151bf712bcSAyushi Smriti { 14161bf712bcSAyushi Smriti #ifndef BMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING 14171bf712bcSAyushi Smriti return false; 14181bf712bcSAyushi Smriti #endif 14191bf712bcSAyushi Smriti } 14201bf712bcSAyushi Smriti 14211bf712bcSAyushi Smriti host = std::string(match[2].first, match[2].second); 14221bf712bcSAyushi Smriti port = std::string(match[3].first, match[3].second); 14231bf712bcSAyushi Smriti path = std::string(match[4].first, match[4].second); 14241bf712bcSAyushi Smriti if (port.empty()) 14251bf712bcSAyushi Smriti { 14261bf712bcSAyushi Smriti if (urlProto == "http") 14271bf712bcSAyushi Smriti { 14281bf712bcSAyushi Smriti port = "80"; 14291bf712bcSAyushi Smriti } 14301bf712bcSAyushi Smriti else 14311bf712bcSAyushi Smriti { 14321bf712bcSAyushi Smriti port = "443"; 14331bf712bcSAyushi Smriti } 14341bf712bcSAyushi Smriti } 14351bf712bcSAyushi Smriti if (path.empty()) 14361bf712bcSAyushi Smriti { 14371bf712bcSAyushi Smriti path = "/"; 14381bf712bcSAyushi Smriti } 14391bf712bcSAyushi Smriti return true; 14401bf712bcSAyushi Smriti } 144123a21a1cSEd Tanous }; 1442b52664e2SAppaRao Puli 1443b52664e2SAppaRao Puli } // namespace redfish 1444