1b52664e2SAppaRao Puli /* 2b52664e2SAppaRao Puli // Copyright (c) 2020 Intel Corporation 3b52664e2SAppaRao Puli // 4b52664e2SAppaRao Puli // Licensed under the Apache License, Version 2.0 (the "License"); 5b52664e2SAppaRao Puli // you may not use this file except in compliance with the License. 6b52664e2SAppaRao Puli // You may obtain a copy of the License at 7b52664e2SAppaRao Puli // 8b52664e2SAppaRao Puli // http://www.apache.org/licenses/LICENSE-2.0 9b52664e2SAppaRao Puli // 10b52664e2SAppaRao Puli // Unless required by applicable law or agreed to in writing, software 11b52664e2SAppaRao Puli // distributed under the License is distributed on an "AS IS" BASIS, 12b52664e2SAppaRao Puli // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13b52664e2SAppaRao Puli // See the License for the specific language governing permissions and 14b52664e2SAppaRao Puli // limitations under the License. 15b52664e2SAppaRao Puli */ 16b52664e2SAppaRao Puli #pragma once 17b52664e2SAppaRao Puli #include "node.hpp" 187f4eb588SAppaRao Puli #include "registries.hpp" 197f4eb588SAppaRao Puli #include "registries/base_message_registry.hpp" 207f4eb588SAppaRao Puli #include "registries/openbmc_message_registry.hpp" 217f4eb588SAppaRao Puli 227f4eb588SAppaRao Puli #include <sys/inotify.h> 23b52664e2SAppaRao Puli 24fb4fd5d4SZhenfei Tai #include <boost/asio/io_context.hpp> 25b52664e2SAppaRao Puli #include <boost/container/flat_map.hpp> 261214b7e7SGunnar Mills #include <error_messages.hpp> 271214b7e7SGunnar Mills #include <http_client.hpp> 284bbf237fSAppaRao Puli #include <server_sent_events.hpp> 291214b7e7SGunnar Mills #include <utils/json_utils.hpp> 301214b7e7SGunnar Mills 31b52664e2SAppaRao Puli #include <cstdlib> 32b52664e2SAppaRao Puli #include <ctime> 331bf712bcSAyushi Smriti #include <fstream> 34b52664e2SAppaRao Puli #include <memory> 35b52664e2SAppaRao Puli #include <variant> 36b52664e2SAppaRao Puli 37b52664e2SAppaRao Puli namespace redfish 38b52664e2SAppaRao Puli { 39156d6b00SAppaRao Puli 40156d6b00SAppaRao Puli using ReadingsObjType = 41156d6b00SAppaRao Puli std::vector<std::tuple<std::string, std::string, double, std::string>>; 427d1cc387SAppaRao Puli using EventServiceConfig = std::tuple<bool, uint32_t, uint32_t>; 43156d6b00SAppaRao Puli 44156d6b00SAppaRao Puli static constexpr const char* eventFormatType = "Event"; 45156d6b00SAppaRao Puli static constexpr const char* metricReportFormatType = "MetricReport"; 46156d6b00SAppaRao Puli 471bf712bcSAyushi Smriti static constexpr const char* eventServiceFile = 481bf712bcSAyushi Smriti "/var/lib/bmcweb/eventservice_config.json"; 491bf712bcSAyushi Smriti 507f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 517f4eb588SAppaRao Puli std::shared_ptr<boost::asio::posix::stream_descriptor> inotifyConn = nullptr; 52b792cc56SAppaRao Puli static constexpr const char* redfishEventLogDir = "/var/log"; 53b792cc56SAppaRao Puli static constexpr const char* redfishEventLogFile = "/var/log/redfish"; 54b792cc56SAppaRao Puli static constexpr const size_t iEventSize = sizeof(inotify_event); 55b792cc56SAppaRao Puli static int inotifyFd = -1; 56b792cc56SAppaRao Puli static int dirWatchDesc = -1; 57b792cc56SAppaRao Puli static int fileWatchDesc = -1; 587f4eb588SAppaRao Puli 597f4eb588SAppaRao Puli // <ID, timestamp, RedfishLogId, registryPrefix, MessageId, MessageArgs> 607f4eb588SAppaRao Puli using EventLogObjectsType = 617f4eb588SAppaRao Puli std::tuple<std::string, std::string, std::string, std::string, std::string, 625e715de6SAppaRao Puli std::vector<std::string>>; 637f4eb588SAppaRao Puli 647f4eb588SAppaRao Puli namespace message_registries 657f4eb588SAppaRao Puli { 667f4eb588SAppaRao Puli static const Message* 677f4eb588SAppaRao Puli getMsgFromRegistry(const std::string& messageKey, 687f4eb588SAppaRao Puli const boost::beast::span<const MessageEntry>& registry) 697f4eb588SAppaRao Puli { 707f4eb588SAppaRao Puli boost::beast::span<const MessageEntry>::const_iterator messageIt = 717f4eb588SAppaRao Puli std::find_if(registry.cbegin(), registry.cend(), 727f4eb588SAppaRao Puli [&messageKey](const MessageEntry& messageEntry) { 737f4eb588SAppaRao Puli return !messageKey.compare(messageEntry.first); 747f4eb588SAppaRao Puli }); 757f4eb588SAppaRao Puli if (messageIt != registry.cend()) 767f4eb588SAppaRao Puli { 777f4eb588SAppaRao Puli return &messageIt->second; 787f4eb588SAppaRao Puli } 797f4eb588SAppaRao Puli 807f4eb588SAppaRao Puli return nullptr; 817f4eb588SAppaRao Puli } 827f4eb588SAppaRao Puli 837f4eb588SAppaRao Puli static const Message* formatMessage(const std::string_view& messageID) 847f4eb588SAppaRao Puli { 857f4eb588SAppaRao Puli // Redfish MessageIds are in the form 867f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 877f4eb588SAppaRao Puli // the right Message 887f4eb588SAppaRao Puli std::vector<std::string> fields; 897f4eb588SAppaRao Puli fields.reserve(4); 907f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 917f4eb588SAppaRao Puli if (fields.size() != 4) 927f4eb588SAppaRao Puli { 937f4eb588SAppaRao Puli return nullptr; 947f4eb588SAppaRao Puli } 957f4eb588SAppaRao Puli std::string& registryName = fields[0]; 967f4eb588SAppaRao Puli std::string& messageKey = fields[3]; 977f4eb588SAppaRao Puli 987f4eb588SAppaRao Puli // Find the right registry and check it for the MessageKey 997f4eb588SAppaRao Puli if (std::string(base::header.registryPrefix) == registryName) 1007f4eb588SAppaRao Puli { 1017f4eb588SAppaRao Puli return getMsgFromRegistry( 1027f4eb588SAppaRao Puli messageKey, boost::beast::span<const MessageEntry>(base::registry)); 1037f4eb588SAppaRao Puli } 1047f4eb588SAppaRao Puli if (std::string(openbmc::header.registryPrefix) == registryName) 1057f4eb588SAppaRao Puli { 1067f4eb588SAppaRao Puli return getMsgFromRegistry( 1077f4eb588SAppaRao Puli messageKey, 1087f4eb588SAppaRao Puli boost::beast::span<const MessageEntry>(openbmc::registry)); 1097f4eb588SAppaRao Puli } 1107f4eb588SAppaRao Puli return nullptr; 1117f4eb588SAppaRao Puli } 1127f4eb588SAppaRao Puli } // namespace message_registries 1137f4eb588SAppaRao Puli 1147f4eb588SAppaRao Puli namespace event_log 1157f4eb588SAppaRao Puli { 1167f4eb588SAppaRao Puli bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, 1177f4eb588SAppaRao Puli const bool firstEntry = true) 1187f4eb588SAppaRao Puli { 1197f4eb588SAppaRao Puli static time_t prevTs = 0; 1207f4eb588SAppaRao Puli static int index = 0; 1217f4eb588SAppaRao Puli if (firstEntry) 1227f4eb588SAppaRao Puli { 1237f4eb588SAppaRao Puli prevTs = 0; 1247f4eb588SAppaRao Puli } 1257f4eb588SAppaRao Puli 1267f4eb588SAppaRao Puli // Get the entry timestamp 1277f4eb588SAppaRao Puli std::time_t curTs = 0; 1287f4eb588SAppaRao Puli std::tm timeStruct = {}; 1297f4eb588SAppaRao Puli std::istringstream entryStream(logEntry); 1307f4eb588SAppaRao Puli if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) 1317f4eb588SAppaRao Puli { 1327f4eb588SAppaRao Puli curTs = std::mktime(&timeStruct); 1337f4eb588SAppaRao Puli if (curTs == -1) 1347f4eb588SAppaRao Puli { 1357f4eb588SAppaRao Puli return false; 1367f4eb588SAppaRao Puli } 1377f4eb588SAppaRao Puli } 1387f4eb588SAppaRao Puli // If the timestamp isn't unique, increment the index 1397f4eb588SAppaRao Puli index = (curTs == prevTs) ? index + 1 : 0; 1407f4eb588SAppaRao Puli 1417f4eb588SAppaRao Puli // Save the timestamp 1427f4eb588SAppaRao Puli prevTs = curTs; 1437f4eb588SAppaRao Puli 1447f4eb588SAppaRao Puli entryID = std::to_string(curTs); 1457f4eb588SAppaRao Puli if (index > 0) 1467f4eb588SAppaRao Puli { 1477f4eb588SAppaRao Puli entryID += "_" + std::to_string(index); 1487f4eb588SAppaRao Puli } 1497f4eb588SAppaRao Puli return true; 1507f4eb588SAppaRao Puli } 1517f4eb588SAppaRao Puli 1527f4eb588SAppaRao Puli int getEventLogParams(const std::string& logEntry, std::string& timestamp, 1537f4eb588SAppaRao Puli std::string& messageID, 1545e715de6SAppaRao Puli std::vector<std::string>& messageArgs) 1557f4eb588SAppaRao Puli { 1567f4eb588SAppaRao Puli // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" 1577f4eb588SAppaRao Puli // First get the Timestamp 1587f4eb588SAppaRao Puli size_t space = logEntry.find_first_of(" "); 1597f4eb588SAppaRao Puli if (space == std::string::npos) 1607f4eb588SAppaRao Puli { 1617f4eb588SAppaRao Puli return -EINVAL; 1627f4eb588SAppaRao Puli } 1637f4eb588SAppaRao Puli timestamp = logEntry.substr(0, space); 1647f4eb588SAppaRao Puli // Then get the log contents 1657f4eb588SAppaRao Puli size_t entryStart = logEntry.find_first_not_of(" ", space); 1667f4eb588SAppaRao Puli if (entryStart == std::string::npos) 1677f4eb588SAppaRao Puli { 1687f4eb588SAppaRao Puli return -EINVAL; 1697f4eb588SAppaRao Puli } 1707f4eb588SAppaRao Puli std::string_view entry(logEntry); 1717f4eb588SAppaRao Puli entry.remove_prefix(entryStart); 1727f4eb588SAppaRao Puli // Use split to separate the entry into its fields 1737f4eb588SAppaRao Puli std::vector<std::string> logEntryFields; 1747f4eb588SAppaRao Puli boost::split(logEntryFields, entry, boost::is_any_of(","), 1757f4eb588SAppaRao Puli boost::token_compress_on); 1767f4eb588SAppaRao Puli // We need at least a MessageId to be valid 1777f4eb588SAppaRao Puli if (logEntryFields.size() < 1) 1787f4eb588SAppaRao Puli { 1797f4eb588SAppaRao Puli return -EINVAL; 1807f4eb588SAppaRao Puli } 1817f4eb588SAppaRao Puli messageID = logEntryFields[0]; 1827f4eb588SAppaRao Puli 1837f4eb588SAppaRao Puli // Get the MessageArgs from the log if there are any 1847f4eb588SAppaRao Puli if (logEntryFields.size() > 1) 1857f4eb588SAppaRao Puli { 1867f4eb588SAppaRao Puli std::string& messageArgsStart = logEntryFields[1]; 1877f4eb588SAppaRao Puli // If the first string is empty, assume there are no MessageArgs 1887f4eb588SAppaRao Puli if (!messageArgsStart.empty()) 1897f4eb588SAppaRao Puli { 1905e715de6SAppaRao Puli messageArgs.assign(logEntryFields.begin() + 1, 1915e715de6SAppaRao Puli logEntryFields.end()); 1927f4eb588SAppaRao Puli } 1937f4eb588SAppaRao Puli } 1947f4eb588SAppaRao Puli 1957f4eb588SAppaRao Puli return 0; 1967f4eb588SAppaRao Puli } 1977f4eb588SAppaRao Puli 1987f4eb588SAppaRao Puli void getRegistryAndMessageKey(const std::string& messageID, 1997f4eb588SAppaRao Puli std::string& registryName, 2007f4eb588SAppaRao Puli std::string& messageKey) 2017f4eb588SAppaRao Puli { 2027f4eb588SAppaRao Puli // Redfish MessageIds are in the form 2037f4eb588SAppaRao Puli // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find 2047f4eb588SAppaRao Puli // the right Message 2057f4eb588SAppaRao Puli std::vector<std::string> fields; 2067f4eb588SAppaRao Puli fields.reserve(4); 2077f4eb588SAppaRao Puli boost::split(fields, messageID, boost::is_any_of(".")); 2087f4eb588SAppaRao Puli if (fields.size() == 4) 2097f4eb588SAppaRao Puli { 2107f4eb588SAppaRao Puli registryName = fields[0]; 2117f4eb588SAppaRao Puli messageKey = fields[3]; 2127f4eb588SAppaRao Puli } 2137f4eb588SAppaRao Puli } 2147f4eb588SAppaRao Puli 2157f4eb588SAppaRao Puli int formatEventLogEntry(const std::string& logEntryID, 2167f4eb588SAppaRao Puli const std::string& messageID, 2175e715de6SAppaRao Puli const std::vector<std::string>& messageArgs, 2187f4eb588SAppaRao Puli std::string timestamp, const std::string customText, 2197f4eb588SAppaRao Puli nlohmann::json& logEntryJson) 2207f4eb588SAppaRao Puli { 2217f4eb588SAppaRao Puli // Get the Message from the MessageRegistry 2227f4eb588SAppaRao Puli const message_registries::Message* message = 2237f4eb588SAppaRao Puli message_registries::formatMessage(messageID); 2247f4eb588SAppaRao Puli 2257f4eb588SAppaRao Puli std::string msg; 2267f4eb588SAppaRao Puli std::string severity; 2277f4eb588SAppaRao Puli if (message != nullptr) 2287f4eb588SAppaRao Puli { 2297f4eb588SAppaRao Puli msg = message->message; 2307f4eb588SAppaRao Puli severity = message->severity; 2317f4eb588SAppaRao Puli } 2327f4eb588SAppaRao Puli 2337f4eb588SAppaRao Puli // Fill the MessageArgs into the Message 2347f4eb588SAppaRao Puli int i = 0; 2357f4eb588SAppaRao Puli for (const std::string& messageArg : messageArgs) 2367f4eb588SAppaRao Puli { 2377f4eb588SAppaRao Puli std::string argStr = "%" + std::to_string(++i); 2387f4eb588SAppaRao Puli size_t argPos = msg.find(argStr); 2397f4eb588SAppaRao Puli if (argPos != std::string::npos) 2407f4eb588SAppaRao Puli { 2417f4eb588SAppaRao Puli msg.replace(argPos, argStr.length(), messageArg); 2427f4eb588SAppaRao Puli } 2437f4eb588SAppaRao Puli } 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. 2487f4eb588SAppaRao Puli std::size_t dot = timestamp.find_first_of("."); 2497f4eb588SAppaRao Puli 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)}, 2607f4eb588SAppaRao Puli {"MessageId", std::move(messageID)}, 2617f4eb588SAppaRao Puli {"MessageArgs", std::move(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 27007941a88SAyushi Smriti 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 28307941a88SAyushi Smriti bool readSSEQueryParams(std::string sseFilter, std::string& formatType, 28407941a88SAyushi Smriti std::vector<std::string>& messageIds, 28507941a88SAyushi Smriti std::vector<std::string>& registryPrefixes, 28607941a88SAyushi Smriti std::vector<nlohmann::json>& metricReportDefinitions) 28707941a88SAyushi Smriti { 28807941a88SAyushi Smriti sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(), 28907941a88SAyushi Smriti isFilterQuerySpecialChar), 29007941a88SAyushi Smriti sseFilter.end()); 29107941a88SAyushi Smriti 29207941a88SAyushi Smriti std::vector<std::string> result; 29307941a88SAyushi Smriti boost::split(result, sseFilter, boost::is_any_of(" "), 29407941a88SAyushi Smriti boost::token_compress_on); 29507941a88SAyushi Smriti 29607941a88SAyushi Smriti BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size(); 29707941a88SAyushi Smriti 29807941a88SAyushi Smriti constexpr uint8_t divisor = 4; 29907941a88SAyushi Smriti constexpr uint8_t minTokenSize = 3; 30007941a88SAyushi Smriti if (result.size() % divisor != minTokenSize) 30107941a88SAyushi Smriti { 30207941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid SSE filter specified."; 30307941a88SAyushi Smriti return false; 30407941a88SAyushi Smriti } 30507941a88SAyushi Smriti 30607941a88SAyushi Smriti for (std::size_t i = 0; i < result.size(); i += divisor) 30707941a88SAyushi Smriti { 30807941a88SAyushi Smriti std::string& key = result[i]; 30907941a88SAyushi Smriti std::string& op = result[i + 1]; 31007941a88SAyushi Smriti std::string& value = result[i + 2]; 31107941a88SAyushi Smriti 31207941a88SAyushi Smriti if ((i + minTokenSize) < result.size()) 31307941a88SAyushi Smriti { 314*4e0453b1SGunnar Mills std::string& separator = result[i + minTokenSize]; 31507941a88SAyushi Smriti // SSE supports only "or" and "and" in query params. 316*4e0453b1SGunnar Mills if ((separator != "or") && (separator != "and")) 31707941a88SAyushi Smriti { 31807941a88SAyushi Smriti BMCWEB_LOG_ERROR 31907941a88SAyushi Smriti << "Invalid group operator in SSE query parameters"; 32007941a88SAyushi Smriti return false; 32107941a88SAyushi Smriti } 32207941a88SAyushi Smriti } 32307941a88SAyushi Smriti 32407941a88SAyushi Smriti // SSE supports only "eq" as per spec. 32507941a88SAyushi Smriti if (op != "eq") 32607941a88SAyushi Smriti { 32707941a88SAyushi Smriti BMCWEB_LOG_ERROR 32807941a88SAyushi Smriti << "Invalid assignment operator in SSE query parameters"; 32907941a88SAyushi Smriti return false; 33007941a88SAyushi Smriti } 33107941a88SAyushi Smriti 33207941a88SAyushi Smriti BMCWEB_LOG_DEBUG << key << " : " << value; 33307941a88SAyushi Smriti if (key == "EventFormatType") 33407941a88SAyushi Smriti { 33507941a88SAyushi Smriti formatType = value; 33607941a88SAyushi Smriti } 33707941a88SAyushi Smriti else if (key == "MessageId") 33807941a88SAyushi Smriti { 33907941a88SAyushi Smriti messageIds.push_back(value); 34007941a88SAyushi Smriti } 34107941a88SAyushi Smriti else if (key == "RegistryPrefix") 34207941a88SAyushi Smriti { 34307941a88SAyushi Smriti registryPrefixes.push_back(value); 34407941a88SAyushi Smriti } 34507941a88SAyushi Smriti else if (key == "MetricReportDefinition") 34607941a88SAyushi Smriti { 34707941a88SAyushi Smriti metricReportDefinitions.push_back(value); 34807941a88SAyushi Smriti } 34907941a88SAyushi Smriti else 35007941a88SAyushi Smriti { 35107941a88SAyushi Smriti BMCWEB_LOG_ERROR << "Invalid property(" << key 35207941a88SAyushi Smriti << ")in SSE filter query."; 35307941a88SAyushi Smriti return false; 35407941a88SAyushi Smriti } 35507941a88SAyushi Smriti } 35607941a88SAyushi Smriti return true; 35707941a88SAyushi Smriti } 35807941a88SAyushi Smriti 359b52664e2SAppaRao Puli class Subscription 360b52664e2SAppaRao Puli { 361b52664e2SAppaRao Puli public: 362b52664e2SAppaRao Puli std::string id; 363b52664e2SAppaRao Puli std::string destinationUrl; 364b52664e2SAppaRao Puli std::string protocol; 365b52664e2SAppaRao Puli std::string retryPolicy; 366b52664e2SAppaRao Puli std::string customText; 367b52664e2SAppaRao Puli std::string eventFormatType; 368b52664e2SAppaRao Puli std::string subscriptionType; 369b52664e2SAppaRao Puli std::vector<std::string> registryMsgIds; 370b52664e2SAppaRao Puli std::vector<std::string> registryPrefixes; 371b52664e2SAppaRao Puli std::vector<nlohmann::json> httpHeaders; // key-value pair 372156d6b00SAppaRao Puli std::vector<nlohmann::json> metricReportDefinitions; 373b52664e2SAppaRao Puli 374b52664e2SAppaRao Puli Subscription(const Subscription&) = delete; 375b52664e2SAppaRao Puli Subscription& operator=(const Subscription&) = delete; 376b52664e2SAppaRao Puli Subscription(Subscription&&) = delete; 377b52664e2SAppaRao Puli Subscription& operator=(Subscription&&) = delete; 378b52664e2SAppaRao Puli 379b52664e2SAppaRao Puli Subscription(const std::string& inHost, const std::string& inPort, 380b52664e2SAppaRao Puli const std::string& inPath, const std::string& inUriProto) : 3810b4bdd93SAppaRao Puli eventSeqNum(1), 3820b4bdd93SAppaRao Puli host(inHost), port(inPort), path(inPath), uriProto(inUriProto) 383b52664e2SAppaRao Puli { 384b52664e2SAppaRao Puli conn = std::make_shared<crow::HttpClient>( 385fe44eb0bSAyushi Smriti crow::connections::systemBus->get_io_context(), id, host, port, 386fe44eb0bSAyushi Smriti path); 387b52664e2SAppaRao Puli } 3884bbf237fSAppaRao Puli 3894bbf237fSAppaRao Puli Subscription(const std::shared_ptr<crow::Request::Adaptor>& adaptor) : 3904bbf237fSAppaRao Puli eventSeqNum(1) 3914bbf237fSAppaRao Puli { 3924bbf237fSAppaRao Puli sseConn = std::make_shared<crow::ServerSentEvents>(adaptor); 3934bbf237fSAppaRao Puli } 3944bbf237fSAppaRao Puli 395b52664e2SAppaRao Puli ~Subscription() 3961214b7e7SGunnar Mills {} 397b52664e2SAppaRao Puli 398b52664e2SAppaRao Puli void sendEvent(const std::string& msg) 399b52664e2SAppaRao Puli { 4004bbf237fSAppaRao Puli if (conn != nullptr) 4014bbf237fSAppaRao Puli { 402b52664e2SAppaRao Puli std::vector<std::pair<std::string, std::string>> reqHeaders; 403b52664e2SAppaRao Puli for (const auto& header : httpHeaders) 404b52664e2SAppaRao Puli { 405b52664e2SAppaRao Puli for (const auto& item : header.items()) 406b52664e2SAppaRao Puli { 407b52664e2SAppaRao Puli std::string key = item.key(); 408b52664e2SAppaRao Puli std::string val = item.value(); 409b52664e2SAppaRao Puli reqHeaders.emplace_back(std::pair(key, val)); 410b52664e2SAppaRao Puli } 411b52664e2SAppaRao Puli } 412b52664e2SAppaRao Puli conn->setHeaders(reqHeaders); 4132a5689a7SAppaRao Puli conn->sendData(msg); 414b52664e2SAppaRao Puli } 415b52664e2SAppaRao Puli 4164bbf237fSAppaRao Puli if (sseConn != nullptr) 4174bbf237fSAppaRao Puli { 4184bbf237fSAppaRao Puli sseConn->sendData(eventSeqNum, msg); 4194bbf237fSAppaRao Puli } 4204bbf237fSAppaRao Puli } 4214bbf237fSAppaRao Puli 4220b4bdd93SAppaRao Puli void sendTestEventLog() 4230b4bdd93SAppaRao Puli { 4240b4bdd93SAppaRao Puli nlohmann::json logEntryArray; 4250b4bdd93SAppaRao Puli logEntryArray.push_back({}); 4260b4bdd93SAppaRao Puli nlohmann::json& logEntryJson = logEntryArray.back(); 4270b4bdd93SAppaRao Puli 4280b4bdd93SAppaRao Puli logEntryJson = {{"EventId", "TestID"}, 4290b4bdd93SAppaRao Puli {"EventType", "Event"}, 4300b4bdd93SAppaRao Puli {"Severity", "OK"}, 4310b4bdd93SAppaRao Puli {"Message", "Generated test event"}, 4320b4bdd93SAppaRao Puli {"MessageId", "OpenBMC.0.1.TestEventLog"}, 4330b4bdd93SAppaRao Puli {"MessageArgs", nlohmann::json::array()}, 4340b4bdd93SAppaRao Puli {"EventTimestamp", crow::utility::dateTimeNow()}, 4350b4bdd93SAppaRao Puli {"Context", customText}}; 4360b4bdd93SAppaRao Puli 4370b4bdd93SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 4380b4bdd93SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 4390b4bdd93SAppaRao Puli {"Name", "Event Log"}, 4400b4bdd93SAppaRao Puli {"Events", logEntryArray}}; 4410b4bdd93SAppaRao Puli 4420b4bdd93SAppaRao Puli this->sendEvent(msg.dump()); 4430b4bdd93SAppaRao Puli this->eventSeqNum++; 4440b4bdd93SAppaRao Puli } 4450b4bdd93SAppaRao Puli 4467f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 4477f4eb588SAppaRao Puli void filterAndSendEventLogs( 4487f4eb588SAppaRao Puli const std::vector<EventLogObjectsType>& eventRecords) 4497f4eb588SAppaRao Puli { 4507f4eb588SAppaRao Puli nlohmann::json logEntryArray; 4517f4eb588SAppaRao Puli for (const EventLogObjectsType& logEntry : eventRecords) 4527f4eb588SAppaRao Puli { 4537f4eb588SAppaRao Puli const std::string& idStr = std::get<0>(logEntry); 4547f4eb588SAppaRao Puli const std::string& timestamp = std::get<1>(logEntry); 4557f4eb588SAppaRao Puli const std::string& messageID = std::get<2>(logEntry); 4567f4eb588SAppaRao Puli const std::string& registryName = std::get<3>(logEntry); 4577f4eb588SAppaRao Puli const std::string& messageKey = std::get<4>(logEntry); 4585e715de6SAppaRao Puli const std::vector<std::string>& messageArgs = std::get<5>(logEntry); 4597f4eb588SAppaRao Puli 4607f4eb588SAppaRao Puli // If registryPrefixes list is empty, don't filter events 4617f4eb588SAppaRao Puli // send everything. 4627f4eb588SAppaRao Puli if (registryPrefixes.size()) 4637f4eb588SAppaRao Puli { 4647f4eb588SAppaRao Puli auto obj = std::find(registryPrefixes.begin(), 4657f4eb588SAppaRao Puli registryPrefixes.end(), registryName); 4667f4eb588SAppaRao Puli if (obj == registryPrefixes.end()) 4677f4eb588SAppaRao Puli { 4687f4eb588SAppaRao Puli continue; 4697f4eb588SAppaRao Puli } 4707f4eb588SAppaRao Puli } 4717f4eb588SAppaRao Puli 4727f4eb588SAppaRao Puli // If registryMsgIds list is empty, don't filter events 4737f4eb588SAppaRao Puli // send everything. 4747f4eb588SAppaRao Puli if (registryMsgIds.size()) 4757f4eb588SAppaRao Puli { 4767f4eb588SAppaRao Puli auto obj = std::find(registryMsgIds.begin(), 4777f4eb588SAppaRao Puli registryMsgIds.end(), messageKey); 4787f4eb588SAppaRao Puli if (obj == registryMsgIds.end()) 4797f4eb588SAppaRao Puli { 4807f4eb588SAppaRao Puli continue; 4817f4eb588SAppaRao Puli } 4827f4eb588SAppaRao Puli } 4837f4eb588SAppaRao Puli 4847f4eb588SAppaRao Puli logEntryArray.push_back({}); 4857f4eb588SAppaRao Puli nlohmann::json& bmcLogEntry = logEntryArray.back(); 4867f4eb588SAppaRao Puli if (event_log::formatEventLogEntry(idStr, messageID, messageArgs, 4877f4eb588SAppaRao Puli timestamp, customText, 4887f4eb588SAppaRao Puli bmcLogEntry) != 0) 4897f4eb588SAppaRao Puli { 4907f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry failed"; 4917f4eb588SAppaRao Puli continue; 4927f4eb588SAppaRao Puli } 4937f4eb588SAppaRao Puli } 4947f4eb588SAppaRao Puli 4957f4eb588SAppaRao Puli if (logEntryArray.size() < 1) 4967f4eb588SAppaRao Puli { 4977f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "No log entries available to be transferred."; 4987f4eb588SAppaRao Puli return; 4997f4eb588SAppaRao Puli } 5007f4eb588SAppaRao Puli 5017f4eb588SAppaRao Puli nlohmann::json msg = {{"@odata.type", "#Event.v1_4_0.Event"}, 5027f4eb588SAppaRao Puli {"Id", std::to_string(eventSeqNum)}, 5037f4eb588SAppaRao Puli {"Name", "Event Log"}, 5047f4eb588SAppaRao Puli {"Events", logEntryArray}}; 5057f4eb588SAppaRao Puli 5067f4eb588SAppaRao Puli this->sendEvent(msg.dump()); 5077f4eb588SAppaRao Puli this->eventSeqNum++; 5087f4eb588SAppaRao Puli } 5097f4eb588SAppaRao Puli #endif 5107f4eb588SAppaRao Puli 511156d6b00SAppaRao Puli void filterAndSendReports(const std::string& id, 512156d6b00SAppaRao Puli const std::string& readingsTs, 513156d6b00SAppaRao Puli const ReadingsObjType& readings) 514156d6b00SAppaRao Puli { 515156d6b00SAppaRao Puli std::string metricReportDef = 516156d6b00SAppaRao Puli "/redfish/v1/TelemetryService/MetricReportDefinitions/" + id; 517156d6b00SAppaRao Puli 518156d6b00SAppaRao Puli // Empty list means no filter. Send everything. 519156d6b00SAppaRao Puli if (metricReportDefinitions.size()) 520156d6b00SAppaRao Puli { 521156d6b00SAppaRao Puli if (std::find(metricReportDefinitions.begin(), 522156d6b00SAppaRao Puli metricReportDefinitions.end(), 523156d6b00SAppaRao Puli metricReportDef) == metricReportDefinitions.end()) 524156d6b00SAppaRao Puli { 525156d6b00SAppaRao Puli return; 526156d6b00SAppaRao Puli } 527156d6b00SAppaRao Puli } 528156d6b00SAppaRao Puli 529156d6b00SAppaRao Puli nlohmann::json metricValuesArray = nlohmann::json::array(); 530156d6b00SAppaRao Puli for (const auto& it : readings) 531156d6b00SAppaRao Puli { 532156d6b00SAppaRao Puli metricValuesArray.push_back({}); 533156d6b00SAppaRao Puli nlohmann::json& entry = metricValuesArray.back(); 534156d6b00SAppaRao Puli 535156d6b00SAppaRao Puli entry = {{"MetricId", std::get<0>(it)}, 536156d6b00SAppaRao Puli {"MetricProperty", std::get<1>(it)}, 537156d6b00SAppaRao Puli {"MetricValue", std::to_string(std::get<2>(it))}, 538156d6b00SAppaRao Puli {"Timestamp", std::get<3>(it)}}; 539156d6b00SAppaRao Puli } 540156d6b00SAppaRao Puli 541156d6b00SAppaRao Puli nlohmann::json msg = { 542156d6b00SAppaRao Puli {"@odata.id", "/redfish/v1/TelemetryService/MetricReports/" + id}, 543156d6b00SAppaRao Puli {"@odata.type", "#MetricReport.v1_3_0.MetricReport"}, 544156d6b00SAppaRao Puli {"Id", id}, 545156d6b00SAppaRao Puli {"Name", id}, 546156d6b00SAppaRao Puli {"Timestamp", readingsTs}, 547156d6b00SAppaRao Puli {"MetricReportDefinition", {{"@odata.id", metricReportDef}}}, 548156d6b00SAppaRao Puli {"MetricValues", metricValuesArray}}; 549156d6b00SAppaRao Puli 550156d6b00SAppaRao Puli this->sendEvent(msg.dump()); 551156d6b00SAppaRao Puli } 552156d6b00SAppaRao Puli 553fe44eb0bSAyushi Smriti void updateRetryConfig(const uint32_t retryAttempts, 554fe44eb0bSAyushi Smriti const uint32_t retryTimeoutInterval) 555fe44eb0bSAyushi Smriti { 556fe44eb0bSAyushi Smriti conn->setRetryConfig(retryAttempts, retryTimeoutInterval); 557fe44eb0bSAyushi Smriti } 558fe44eb0bSAyushi Smriti 559fe44eb0bSAyushi Smriti void updateRetryPolicy() 560fe44eb0bSAyushi Smriti { 561fe44eb0bSAyushi Smriti conn->setRetryPolicy(retryPolicy); 562fe44eb0bSAyushi Smriti } 563fe44eb0bSAyushi Smriti 564b52664e2SAppaRao Puli private: 5650b4bdd93SAppaRao Puli uint64_t eventSeqNum; 566b52664e2SAppaRao Puli std::string host; 567b52664e2SAppaRao Puli std::string port; 568b52664e2SAppaRao Puli std::string path; 569b52664e2SAppaRao Puli std::string uriProto; 5704bbf237fSAppaRao Puli std::shared_ptr<crow::HttpClient> conn = nullptr; 5714bbf237fSAppaRao Puli std::shared_ptr<crow::ServerSentEvents> sseConn = nullptr; 572b52664e2SAppaRao Puli }; 573b52664e2SAppaRao Puli 5741bf712bcSAyushi Smriti static constexpr const bool defaultEnabledState = true; 5751bf712bcSAyushi Smriti static constexpr const uint32_t defaultRetryAttempts = 3; 5761bf712bcSAyushi Smriti static constexpr const uint32_t defaultRetryInterval = 30; 5771bf712bcSAyushi Smriti static constexpr const char* defaulEventFormatType = "Event"; 5781bf712bcSAyushi Smriti static constexpr const char* defaulSubscriptionType = "RedfishEvent"; 5791bf712bcSAyushi Smriti static constexpr const char* defaulRetryPolicy = "TerminateAfterRetries"; 5801bf712bcSAyushi Smriti 581b52664e2SAppaRao Puli class EventServiceManager 582b52664e2SAppaRao Puli { 583b52664e2SAppaRao Puli private: 5847d1cc387SAppaRao Puli bool serviceEnabled; 5857d1cc387SAppaRao Puli uint32_t retryAttempts; 5867d1cc387SAppaRao Puli uint32_t retryTimeoutInterval; 5877d1cc387SAppaRao Puli 588b52664e2SAppaRao Puli EventServiceManager(const EventServiceManager&) = delete; 589b52664e2SAppaRao Puli EventServiceManager& operator=(const EventServiceManager&) = delete; 590b52664e2SAppaRao Puli EventServiceManager(EventServiceManager&&) = delete; 591b52664e2SAppaRao Puli EventServiceManager& operator=(EventServiceManager&&) = delete; 592b52664e2SAppaRao Puli 5937d1cc387SAppaRao Puli EventServiceManager() : 5947d1cc387SAppaRao Puli noOfEventLogSubscribers(0), noOfMetricReportSubscribers(0) 595b52664e2SAppaRao Puli { 5961bf712bcSAyushi Smriti // Load config from persist store. 5971bf712bcSAyushi Smriti initConfig(); 598b52664e2SAppaRao Puli } 599b52664e2SAppaRao Puli 6007f4eb588SAppaRao Puli std::string lastEventTStr; 6017d1cc387SAppaRao Puli size_t noOfEventLogSubscribers; 602156d6b00SAppaRao Puli size_t noOfMetricReportSubscribers; 603156d6b00SAppaRao Puli std::shared_ptr<sdbusplus::bus::match::match> matchTelemetryMonitor; 604b52664e2SAppaRao Puli boost::container::flat_map<std::string, std::shared_ptr<Subscription>> 605b52664e2SAppaRao Puli subscriptionsMap; 606b52664e2SAppaRao Puli 607b52664e2SAppaRao Puli public: 608b52664e2SAppaRao Puli static EventServiceManager& getInstance() 609b52664e2SAppaRao Puli { 610b52664e2SAppaRao Puli static EventServiceManager handler; 611b52664e2SAppaRao Puli return handler; 612b52664e2SAppaRao Puli } 613b52664e2SAppaRao Puli 6141bf712bcSAyushi Smriti void loadDefaultConfig() 6151bf712bcSAyushi Smriti { 6161bf712bcSAyushi Smriti serviceEnabled = defaultEnabledState; 6171bf712bcSAyushi Smriti retryAttempts = defaultRetryAttempts; 6181bf712bcSAyushi Smriti retryTimeoutInterval = defaultRetryInterval; 6191bf712bcSAyushi Smriti } 6201bf712bcSAyushi Smriti 6211bf712bcSAyushi Smriti void initConfig() 6221bf712bcSAyushi Smriti { 6231bf712bcSAyushi Smriti std::ifstream eventConfigFile(eventServiceFile); 6241bf712bcSAyushi Smriti if (!eventConfigFile.good()) 6251bf712bcSAyushi Smriti { 6261bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService config not exist"; 6271bf712bcSAyushi Smriti loadDefaultConfig(); 6281bf712bcSAyushi Smriti return; 6291bf712bcSAyushi Smriti } 6301bf712bcSAyushi Smriti auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false); 6311bf712bcSAyushi Smriti if (jsonData.is_discarded()) 6321bf712bcSAyushi Smriti { 6331bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "EventService config parse error."; 6341bf712bcSAyushi Smriti loadDefaultConfig(); 6351bf712bcSAyushi Smriti return; 6361bf712bcSAyushi Smriti } 6371bf712bcSAyushi Smriti 6381bf712bcSAyushi Smriti nlohmann::json jsonConfig; 6391bf712bcSAyushi Smriti if (json_util::getValueFromJsonObject(jsonData, "Configuration", 6401bf712bcSAyushi Smriti jsonConfig)) 6411bf712bcSAyushi Smriti { 6421bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonConfig, "ServiceEnabled", 6431bf712bcSAyushi Smriti serviceEnabled)) 6441bf712bcSAyushi Smriti { 6451bf712bcSAyushi Smriti serviceEnabled = defaultEnabledState; 6461bf712bcSAyushi Smriti } 6471bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 6481bf712bcSAyushi Smriti jsonConfig, "DeliveryRetryAttempts", retryAttempts)) 6491bf712bcSAyushi Smriti { 6501bf712bcSAyushi Smriti retryAttempts = defaultRetryAttempts; 6511bf712bcSAyushi Smriti } 6521bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 6531bf712bcSAyushi Smriti jsonConfig, "DeliveryRetryIntervalSeconds", 6541bf712bcSAyushi Smriti retryTimeoutInterval)) 6551bf712bcSAyushi Smriti { 6561bf712bcSAyushi Smriti retryTimeoutInterval = defaultRetryInterval; 6571bf712bcSAyushi Smriti } 6581bf712bcSAyushi Smriti } 6591bf712bcSAyushi Smriti else 6601bf712bcSAyushi Smriti { 6611bf712bcSAyushi Smriti loadDefaultConfig(); 6621bf712bcSAyushi Smriti } 6631bf712bcSAyushi Smriti 6641bf712bcSAyushi Smriti nlohmann::json subscriptionsList; 6651bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonData, "Subscriptions", 6661bf712bcSAyushi Smriti subscriptionsList)) 6671bf712bcSAyushi Smriti { 6681bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService: Subscriptions not exist."; 6691bf712bcSAyushi Smriti return; 6701bf712bcSAyushi Smriti } 6711bf712bcSAyushi Smriti 6721bf712bcSAyushi Smriti for (nlohmann::json& jsonObj : subscriptionsList) 6731bf712bcSAyushi Smriti { 6741bf712bcSAyushi Smriti std::string protocol; 6751bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "Protocol", 6761bf712bcSAyushi Smriti protocol)) 6771bf712bcSAyushi Smriti { 6781bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "Invalid subscription Protocol exist."; 6791bf712bcSAyushi Smriti continue; 6801bf712bcSAyushi Smriti } 6814bbf237fSAppaRao Puli 6824bbf237fSAppaRao Puli std::string subscriptionType; 6834bbf237fSAppaRao Puli if (!json_util::getValueFromJsonObject(jsonObj, "SubscriptionType", 6844bbf237fSAppaRao Puli subscriptionType)) 6854bbf237fSAppaRao Puli { 6864bbf237fSAppaRao Puli subscriptionType = defaulSubscriptionType; 6874bbf237fSAppaRao Puli } 6884bbf237fSAppaRao Puli // SSE connections are initiated from client 6894bbf237fSAppaRao Puli // and can't be re-established from server. 6904bbf237fSAppaRao Puli if (subscriptionType == "SSE") 6914bbf237fSAppaRao Puli { 6924bbf237fSAppaRao Puli BMCWEB_LOG_DEBUG 6934bbf237fSAppaRao Puli << "The subscription type is SSE, so skipping."; 6944bbf237fSAppaRao Puli continue; 6954bbf237fSAppaRao Puli } 6964bbf237fSAppaRao Puli 6971bf712bcSAyushi Smriti std::string destination; 6981bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "Destination", 6991bf712bcSAyushi Smriti destination)) 7001bf712bcSAyushi Smriti { 7011bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "Invalid subscription destination exist."; 7021bf712bcSAyushi Smriti continue; 7031bf712bcSAyushi Smriti } 7041bf712bcSAyushi Smriti std::string host; 7051bf712bcSAyushi Smriti std::string urlProto; 7061bf712bcSAyushi Smriti std::string port; 7071bf712bcSAyushi Smriti std::string path; 7081bf712bcSAyushi Smriti bool status = 7091bf712bcSAyushi Smriti validateAndSplitUrl(destination, urlProto, host, port, path); 7101bf712bcSAyushi Smriti 7111bf712bcSAyushi Smriti if (!status) 7121bf712bcSAyushi Smriti { 7131bf712bcSAyushi Smriti BMCWEB_LOG_ERROR 7141bf712bcSAyushi Smriti << "Failed to validate and split destination url"; 7151bf712bcSAyushi Smriti continue; 7161bf712bcSAyushi Smriti } 7171bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = 7181bf712bcSAyushi Smriti std::make_shared<Subscription>(host, port, path, urlProto); 7191bf712bcSAyushi Smriti 7201bf712bcSAyushi Smriti subValue->destinationUrl = destination; 7211bf712bcSAyushi Smriti subValue->protocol = protocol; 7224bbf237fSAppaRao Puli subValue->subscriptionType = subscriptionType; 7231bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject( 7241bf712bcSAyushi Smriti jsonObj, "DeliveryRetryPolicy", subValue->retryPolicy)) 7251bf712bcSAyushi Smriti { 7261bf712bcSAyushi Smriti subValue->retryPolicy = defaulRetryPolicy; 7271bf712bcSAyushi Smriti } 7281bf712bcSAyushi Smriti if (!json_util::getValueFromJsonObject(jsonObj, "EventFormatType", 7291bf712bcSAyushi Smriti subValue->eventFormatType)) 7301bf712bcSAyushi Smriti { 7311bf712bcSAyushi Smriti subValue->eventFormatType = defaulEventFormatType; 7321bf712bcSAyushi Smriti } 7331bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "Context", 7341bf712bcSAyushi Smriti subValue->customText); 7351bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "MessageIds", 7361bf712bcSAyushi Smriti subValue->registryMsgIds); 7371bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "RegistryPrefixes", 7381bf712bcSAyushi Smriti subValue->registryPrefixes); 7391bf712bcSAyushi Smriti json_util::getValueFromJsonObject(jsonObj, "HttpHeaders", 7401bf712bcSAyushi Smriti subValue->httpHeaders); 7411bf712bcSAyushi Smriti json_util::getValueFromJsonObject( 7421bf712bcSAyushi Smriti jsonObj, "MetricReportDefinitions", 7431bf712bcSAyushi Smriti subValue->metricReportDefinitions); 7441bf712bcSAyushi Smriti 7451bf712bcSAyushi Smriti std::string id = addSubscription(subValue, false); 7461bf712bcSAyushi Smriti if (id.empty()) 7471bf712bcSAyushi Smriti { 7481bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Failed to add subscription"; 7491bf712bcSAyushi Smriti } 7501bf712bcSAyushi Smriti } 7511bf712bcSAyushi Smriti return; 7521bf712bcSAyushi Smriti } 7531bf712bcSAyushi Smriti 754b52664e2SAppaRao Puli void updateSubscriptionData() 755b52664e2SAppaRao Puli { 756b52664e2SAppaRao Puli // Persist the config and subscription data. 7571bf712bcSAyushi Smriti nlohmann::json jsonData; 7581bf712bcSAyushi Smriti 7591bf712bcSAyushi Smriti nlohmann::json& configObj = jsonData["Configuration"]; 7601bf712bcSAyushi Smriti configObj["ServiceEnabled"] = serviceEnabled; 7611bf712bcSAyushi Smriti configObj["DeliveryRetryAttempts"] = retryAttempts; 7621bf712bcSAyushi Smriti configObj["DeliveryRetryIntervalSeconds"] = retryTimeoutInterval; 7631bf712bcSAyushi Smriti 7641bf712bcSAyushi Smriti nlohmann::json& subListArray = jsonData["Subscriptions"]; 7651bf712bcSAyushi Smriti subListArray = nlohmann::json::array(); 7661bf712bcSAyushi Smriti 7671bf712bcSAyushi Smriti for (const auto& it : subscriptionsMap) 7681bf712bcSAyushi Smriti { 7691bf712bcSAyushi Smriti std::shared_ptr<Subscription> subValue = it.second; 7704bbf237fSAppaRao Puli // Don't preserve SSE connections. Its initiated from 7714bbf237fSAppaRao Puli // client side and can't be re-established from server. 7724bbf237fSAppaRao Puli if (subValue->subscriptionType == "SSE") 7734bbf237fSAppaRao Puli { 7744bbf237fSAppaRao Puli BMCWEB_LOG_DEBUG 7754bbf237fSAppaRao Puli << "The subscription type is SSE, so skipping."; 7764bbf237fSAppaRao Puli continue; 7774bbf237fSAppaRao Puli } 7781bf712bcSAyushi Smriti 7794bbf237fSAppaRao Puli nlohmann::json entry; 7801bf712bcSAyushi Smriti entry["Context"] = subValue->customText; 7811bf712bcSAyushi Smriti entry["DeliveryRetryPolicy"] = subValue->retryPolicy; 7821bf712bcSAyushi Smriti entry["Destination"] = subValue->destinationUrl; 7831bf712bcSAyushi Smriti entry["EventFormatType"] = subValue->eventFormatType; 7841bf712bcSAyushi Smriti entry["HttpHeaders"] = subValue->httpHeaders; 7851bf712bcSAyushi Smriti entry["MessageIds"] = subValue->registryMsgIds; 7861bf712bcSAyushi Smriti entry["Protocol"] = subValue->protocol; 7871bf712bcSAyushi Smriti entry["RegistryPrefixes"] = subValue->registryPrefixes; 7881bf712bcSAyushi Smriti entry["SubscriptionType"] = subValue->subscriptionType; 7891bf712bcSAyushi Smriti entry["MetricReportDefinitions"] = 7901bf712bcSAyushi Smriti subValue->metricReportDefinitions; 7911bf712bcSAyushi Smriti 7921bf712bcSAyushi Smriti subListArray.push_back(entry); 7931bf712bcSAyushi Smriti } 7941bf712bcSAyushi Smriti 7951bf712bcSAyushi Smriti const std::string tmpFile(std::string(eventServiceFile) + "_tmp"); 7961bf712bcSAyushi Smriti std::ofstream ofs(tmpFile, std::ios::out); 7971bf712bcSAyushi Smriti const auto& writeData = jsonData.dump(); 7981bf712bcSAyushi Smriti ofs << writeData; 7991bf712bcSAyushi Smriti ofs.close(); 8001bf712bcSAyushi Smriti 8011bf712bcSAyushi Smriti BMCWEB_LOG_DEBUG << "EventService config updated to file."; 8021bf712bcSAyushi Smriti if (std::rename(tmpFile.c_str(), eventServiceFile) != 0) 8031bf712bcSAyushi Smriti { 8041bf712bcSAyushi Smriti BMCWEB_LOG_ERROR << "Error in renaming temporary file: " 8051bf712bcSAyushi Smriti << tmpFile.c_str(); 8061bf712bcSAyushi Smriti } 807b52664e2SAppaRao Puli } 808b52664e2SAppaRao Puli 8097d1cc387SAppaRao Puli EventServiceConfig getEventServiceConfig() 8107d1cc387SAppaRao Puli { 8117d1cc387SAppaRao Puli return {serviceEnabled, retryAttempts, retryTimeoutInterval}; 8127d1cc387SAppaRao Puli } 8137d1cc387SAppaRao Puli 8147d1cc387SAppaRao Puli void setEventServiceConfig(const EventServiceConfig& cfg) 8157d1cc387SAppaRao Puli { 8167d1cc387SAppaRao Puli bool updateConfig = false; 817fe44eb0bSAyushi Smriti bool updateRetryCfg = false; 8187d1cc387SAppaRao Puli 8197d1cc387SAppaRao Puli if (serviceEnabled != std::get<0>(cfg)) 8207d1cc387SAppaRao Puli { 8217d1cc387SAppaRao Puli serviceEnabled = std::get<0>(cfg); 8227d1cc387SAppaRao Puli if (serviceEnabled && noOfMetricReportSubscribers) 8237d1cc387SAppaRao Puli { 8247d1cc387SAppaRao Puli registerMetricReportSignal(); 8257d1cc387SAppaRao Puli } 8267d1cc387SAppaRao Puli else 8277d1cc387SAppaRao Puli { 8287d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8297d1cc387SAppaRao Puli } 8307d1cc387SAppaRao Puli updateConfig = true; 8317d1cc387SAppaRao Puli } 8327d1cc387SAppaRao Puli 8337d1cc387SAppaRao Puli if (retryAttempts != std::get<1>(cfg)) 8347d1cc387SAppaRao Puli { 8357d1cc387SAppaRao Puli retryAttempts = std::get<1>(cfg); 8367d1cc387SAppaRao Puli updateConfig = true; 837fe44eb0bSAyushi Smriti updateRetryCfg = true; 8387d1cc387SAppaRao Puli } 8397d1cc387SAppaRao Puli 8407d1cc387SAppaRao Puli if (retryTimeoutInterval != std::get<2>(cfg)) 8417d1cc387SAppaRao Puli { 8427d1cc387SAppaRao Puli retryTimeoutInterval = std::get<2>(cfg); 8437d1cc387SAppaRao Puli updateConfig = true; 844fe44eb0bSAyushi Smriti updateRetryCfg = true; 8457d1cc387SAppaRao Puli } 8467d1cc387SAppaRao Puli 8477d1cc387SAppaRao Puli if (updateConfig) 8487d1cc387SAppaRao Puli { 8497d1cc387SAppaRao Puli updateSubscriptionData(); 8507d1cc387SAppaRao Puli } 851fe44eb0bSAyushi Smriti 852fe44eb0bSAyushi Smriti if (updateRetryCfg) 853fe44eb0bSAyushi Smriti { 854fe44eb0bSAyushi Smriti // Update the changed retry config to all subscriptions 855fe44eb0bSAyushi Smriti for (const auto& it : 856fe44eb0bSAyushi Smriti EventServiceManager::getInstance().subscriptionsMap) 857fe44eb0bSAyushi Smriti { 858fe44eb0bSAyushi Smriti std::shared_ptr<Subscription> entry = it.second; 859fe44eb0bSAyushi Smriti entry->updateRetryConfig(retryAttempts, retryTimeoutInterval); 860fe44eb0bSAyushi Smriti } 861fe44eb0bSAyushi Smriti } 8627d1cc387SAppaRao Puli } 8637d1cc387SAppaRao Puli 8647d1cc387SAppaRao Puli void updateNoOfSubscribersCount() 8657d1cc387SAppaRao Puli { 8667d1cc387SAppaRao Puli size_t eventLogSubCount = 0; 8677d1cc387SAppaRao Puli size_t metricReportSubCount = 0; 8687d1cc387SAppaRao Puli for (const auto& it : subscriptionsMap) 8697d1cc387SAppaRao Puli { 8707d1cc387SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 8717d1cc387SAppaRao Puli if (entry->eventFormatType == eventFormatType) 8727d1cc387SAppaRao Puli { 8737d1cc387SAppaRao Puli eventLogSubCount++; 8747d1cc387SAppaRao Puli } 8757d1cc387SAppaRao Puli else if (entry->eventFormatType == metricReportFormatType) 8767d1cc387SAppaRao Puli { 8777d1cc387SAppaRao Puli metricReportSubCount++; 8787d1cc387SAppaRao Puli } 8797d1cc387SAppaRao Puli } 8807d1cc387SAppaRao Puli 8817d1cc387SAppaRao Puli noOfEventLogSubscribers = eventLogSubCount; 8827d1cc387SAppaRao Puli if (noOfMetricReportSubscribers != metricReportSubCount) 8837d1cc387SAppaRao Puli { 8847d1cc387SAppaRao Puli noOfMetricReportSubscribers = metricReportSubCount; 8857d1cc387SAppaRao Puli if (noOfMetricReportSubscribers) 8867d1cc387SAppaRao Puli { 8877d1cc387SAppaRao Puli registerMetricReportSignal(); 8887d1cc387SAppaRao Puli } 8897d1cc387SAppaRao Puli else 8907d1cc387SAppaRao Puli { 8917d1cc387SAppaRao Puli unregisterMetricReportSignal(); 8927d1cc387SAppaRao Puli } 8937d1cc387SAppaRao Puli } 8947d1cc387SAppaRao Puli } 8957d1cc387SAppaRao Puli 896b52664e2SAppaRao Puli std::shared_ptr<Subscription> getSubscription(const std::string& id) 897b52664e2SAppaRao Puli { 898b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 899b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 900b52664e2SAppaRao Puli { 901b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id; 902b52664e2SAppaRao Puli return nullptr; 903b52664e2SAppaRao Puli } 904b52664e2SAppaRao Puli std::shared_ptr<Subscription> subValue = obj->second; 905b52664e2SAppaRao Puli return subValue; 906b52664e2SAppaRao Puli } 907b52664e2SAppaRao Puli 9081bf712bcSAyushi Smriti std::string addSubscription(const std::shared_ptr<Subscription> subValue, 9091bf712bcSAyushi Smriti const bool updateFile = true) 910b52664e2SAppaRao Puli { 911b52664e2SAppaRao Puli std::srand(static_cast<uint32_t>(std::time(0))); 912b52664e2SAppaRao Puli std::string id; 913b52664e2SAppaRao Puli 914b52664e2SAppaRao Puli int retry = 3; 915b52664e2SAppaRao Puli while (retry) 916b52664e2SAppaRao Puli { 917b52664e2SAppaRao Puli id = std::to_string(std::rand()); 918b52664e2SAppaRao Puli auto inserted = subscriptionsMap.insert(std::pair(id, subValue)); 919b52664e2SAppaRao Puli if (inserted.second) 920b52664e2SAppaRao Puli { 921b52664e2SAppaRao Puli break; 922b52664e2SAppaRao Puli } 923b52664e2SAppaRao Puli --retry; 924b52664e2SAppaRao Puli }; 925b52664e2SAppaRao Puli 926b52664e2SAppaRao Puli if (retry <= 0) 927b52664e2SAppaRao Puli { 928b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Failed to generate random number"; 929b52664e2SAppaRao Puli return std::string(""); 930b52664e2SAppaRao Puli } 931b52664e2SAppaRao Puli 9327d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 9331bf712bcSAyushi Smriti 9341bf712bcSAyushi Smriti if (updateFile) 9351bf712bcSAyushi Smriti { 936b52664e2SAppaRao Puli updateSubscriptionData(); 9371bf712bcSAyushi Smriti } 9387f4eb588SAppaRao Puli 9397f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 9407f4eb588SAppaRao Puli if (lastEventTStr.empty()) 9417f4eb588SAppaRao Puli { 9427f4eb588SAppaRao Puli cacheLastEventTimestamp(); 9437f4eb588SAppaRao Puli } 9447f4eb588SAppaRao Puli #endif 945fe44eb0bSAyushi Smriti // Update retry configuration. 946fe44eb0bSAyushi Smriti subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval); 947fe44eb0bSAyushi Smriti subValue->updateRetryPolicy(); 948fe44eb0bSAyushi Smriti 949b52664e2SAppaRao Puli return id; 950b52664e2SAppaRao Puli } 951b52664e2SAppaRao Puli 952b52664e2SAppaRao Puli bool isSubscriptionExist(const std::string& id) 953b52664e2SAppaRao Puli { 954b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 955b52664e2SAppaRao Puli if (obj == subscriptionsMap.end()) 956b52664e2SAppaRao Puli { 957b52664e2SAppaRao Puli return false; 958b52664e2SAppaRao Puli } 959b52664e2SAppaRao Puli return true; 960b52664e2SAppaRao Puli } 961b52664e2SAppaRao Puli 962b52664e2SAppaRao Puli void deleteSubscription(const std::string& id) 963b52664e2SAppaRao Puli { 964b52664e2SAppaRao Puli auto obj = subscriptionsMap.find(id); 965b52664e2SAppaRao Puli if (obj != subscriptionsMap.end()) 966b52664e2SAppaRao Puli { 967b52664e2SAppaRao Puli subscriptionsMap.erase(obj); 9687d1cc387SAppaRao Puli updateNoOfSubscribersCount(); 969b52664e2SAppaRao Puli updateSubscriptionData(); 970b52664e2SAppaRao Puli } 971b52664e2SAppaRao Puli } 972b52664e2SAppaRao Puli 973b52664e2SAppaRao Puli size_t getNumberOfSubscriptions() 974b52664e2SAppaRao Puli { 975b52664e2SAppaRao Puli return subscriptionsMap.size(); 976b52664e2SAppaRao Puli } 977b52664e2SAppaRao Puli 978b52664e2SAppaRao Puli std::vector<std::string> getAllIDs() 979b52664e2SAppaRao Puli { 980b52664e2SAppaRao Puli std::vector<std::string> idList; 981b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 982b52664e2SAppaRao Puli { 983b52664e2SAppaRao Puli idList.emplace_back(it.first); 984b52664e2SAppaRao Puli } 985b52664e2SAppaRao Puli return idList; 986b52664e2SAppaRao Puli } 987b52664e2SAppaRao Puli 988b52664e2SAppaRao Puli bool isDestinationExist(const std::string& destUrl) 989b52664e2SAppaRao Puli { 990b52664e2SAppaRao Puli for (const auto& it : subscriptionsMap) 991b52664e2SAppaRao Puli { 992b52664e2SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 993b52664e2SAppaRao Puli if (entry->destinationUrl == destUrl) 994b52664e2SAppaRao Puli { 995b52664e2SAppaRao Puli BMCWEB_LOG_ERROR << "Destination exist already" << destUrl; 996b52664e2SAppaRao Puli return true; 997b52664e2SAppaRao Puli } 998b52664e2SAppaRao Puli } 999b52664e2SAppaRao Puli return false; 1000b52664e2SAppaRao Puli } 10010b4bdd93SAppaRao Puli 10020b4bdd93SAppaRao Puli void sendTestEventLog() 10030b4bdd93SAppaRao Puli { 10040b4bdd93SAppaRao Puli for (const auto& it : this->subscriptionsMap) 10050b4bdd93SAppaRao Puli { 10060b4bdd93SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 10070b4bdd93SAppaRao Puli entry->sendTestEventLog(); 10080b4bdd93SAppaRao Puli } 10090b4bdd93SAppaRao Puli } 1010e9a14131SAppaRao Puli 10117f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 10127f4eb588SAppaRao Puli void cacheLastEventTimestamp() 10137f4eb588SAppaRao Puli { 10147f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 10157f4eb588SAppaRao Puli if (!logStream.good()) 10167f4eb588SAppaRao Puli { 10177f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed \n"; 10187f4eb588SAppaRao Puli return; 10197f4eb588SAppaRao Puli } 10207f4eb588SAppaRao Puli std::string logEntry; 10217f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 10227f4eb588SAppaRao Puli { 10237f4eb588SAppaRao Puli size_t space = logEntry.find_first_of(" "); 10247f4eb588SAppaRao Puli if (space == std::string::npos) 10257f4eb588SAppaRao Puli { 10267f4eb588SAppaRao Puli // Shouldn't enter here but lets skip it. 10277f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid log entry found."; 10287f4eb588SAppaRao Puli continue; 10297f4eb588SAppaRao Puli } 10307f4eb588SAppaRao Puli lastEventTStr = logEntry.substr(0, space); 10317f4eb588SAppaRao Puli } 10327f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Last Event time stamp set: " << lastEventTStr; 10337f4eb588SAppaRao Puli } 10347f4eb588SAppaRao Puli 10357f4eb588SAppaRao Puli void readEventLogsFromFile() 10367f4eb588SAppaRao Puli { 10377f4eb588SAppaRao Puli if (!serviceEnabled || !noOfEventLogSubscribers) 10387f4eb588SAppaRao Puli { 10397f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions."; 10407f4eb588SAppaRao Puli return; 10417f4eb588SAppaRao Puli } 10427f4eb588SAppaRao Puli std::ifstream logStream(redfishEventLogFile); 10437f4eb588SAppaRao Puli if (!logStream.good()) 10447f4eb588SAppaRao Puli { 10457f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << " Redfish log file open failed"; 10467f4eb588SAppaRao Puli return; 10477f4eb588SAppaRao Puli } 10487f4eb588SAppaRao Puli 10497f4eb588SAppaRao Puli std::vector<EventLogObjectsType> eventRecords; 10507f4eb588SAppaRao Puli 10517f4eb588SAppaRao Puli bool startLogCollection = false; 10527f4eb588SAppaRao Puli bool firstEntry = true; 10537f4eb588SAppaRao Puli 10547f4eb588SAppaRao Puli std::string logEntry; 10557f4eb588SAppaRao Puli while (std::getline(logStream, logEntry)) 10567f4eb588SAppaRao Puli { 10577f4eb588SAppaRao Puli if (!startLogCollection) 10587f4eb588SAppaRao Puli { 10597f4eb588SAppaRao Puli if (boost::starts_with(logEntry, lastEventTStr)) 10607f4eb588SAppaRao Puli { 10617f4eb588SAppaRao Puli startLogCollection = true; 10627f4eb588SAppaRao Puli } 10637f4eb588SAppaRao Puli continue; 10647f4eb588SAppaRao Puli } 10657f4eb588SAppaRao Puli 10667f4eb588SAppaRao Puli std::string idStr; 10677f4eb588SAppaRao Puli if (!event_log::getUniqueEntryID(logEntry, idStr, firstEntry)) 10687f4eb588SAppaRao Puli { 10697f4eb588SAppaRao Puli continue; 10707f4eb588SAppaRao Puli } 10717f4eb588SAppaRao Puli firstEntry = false; 10727f4eb588SAppaRao Puli 10737f4eb588SAppaRao Puli std::string timestamp; 10747f4eb588SAppaRao Puli std::string messageID; 10755e715de6SAppaRao Puli std::vector<std::string> messageArgs; 10767f4eb588SAppaRao Puli if (event_log::getEventLogParams(logEntry, timestamp, messageID, 10777f4eb588SAppaRao Puli messageArgs) != 0) 10787f4eb588SAppaRao Puli { 10797f4eb588SAppaRao Puli BMCWEB_LOG_DEBUG << "Read eventLog entry params failed"; 10807f4eb588SAppaRao Puli continue; 10817f4eb588SAppaRao Puli } 10827f4eb588SAppaRao Puli 10837f4eb588SAppaRao Puli std::string registryName; 10847f4eb588SAppaRao Puli std::string messageKey; 10857f4eb588SAppaRao Puli event_log::getRegistryAndMessageKey(messageID, registryName, 10867f4eb588SAppaRao Puli messageKey); 10877f4eb588SAppaRao Puli if (registryName.empty() || messageKey.empty()) 10887f4eb588SAppaRao Puli { 10897f4eb588SAppaRao Puli continue; 10907f4eb588SAppaRao Puli } 10917f4eb588SAppaRao Puli 10927f4eb588SAppaRao Puli lastEventTStr = timestamp; 10937f4eb588SAppaRao Puli eventRecords.emplace_back(idStr, timestamp, messageID, registryName, 10947f4eb588SAppaRao Puli messageKey, messageArgs); 10957f4eb588SAppaRao Puli } 10967f4eb588SAppaRao Puli 10977f4eb588SAppaRao Puli for (const auto& it : this->subscriptionsMap) 10987f4eb588SAppaRao Puli { 10997f4eb588SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 11007f4eb588SAppaRao Puli if (entry->eventFormatType == "Event") 11017f4eb588SAppaRao Puli { 11027f4eb588SAppaRao Puli entry->filterAndSendEventLogs(eventRecords); 11037f4eb588SAppaRao Puli } 11047f4eb588SAppaRao Puli } 11057f4eb588SAppaRao Puli } 11067f4eb588SAppaRao Puli 11077f4eb588SAppaRao Puli static void watchRedfishEventLogFile() 11087f4eb588SAppaRao Puli { 11097f4eb588SAppaRao Puli if (inotifyConn == nullptr) 11107f4eb588SAppaRao Puli { 11117f4eb588SAppaRao Puli return; 11127f4eb588SAppaRao Puli } 11137f4eb588SAppaRao Puli 11147f4eb588SAppaRao Puli static std::array<char, 1024> readBuffer; 11157f4eb588SAppaRao Puli 11167f4eb588SAppaRao Puli inotifyConn->async_read_some( 11177f4eb588SAppaRao Puli boost::asio::buffer(readBuffer), 11187f4eb588SAppaRao Puli [&](const boost::system::error_code& ec, 11197f4eb588SAppaRao Puli const std::size_t& bytesTransferred) { 11207f4eb588SAppaRao Puli if (ec) 11217f4eb588SAppaRao Puli { 11227f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "Callback Error: " << ec.message(); 11237f4eb588SAppaRao Puli return; 11247f4eb588SAppaRao Puli } 11257f4eb588SAppaRao Puli std::size_t index = 0; 1126b792cc56SAppaRao Puli while ((index + iEventSize) <= bytesTransferred) 11277f4eb588SAppaRao Puli { 11287f4eb588SAppaRao Puli struct inotify_event event; 1129b792cc56SAppaRao Puli std::memcpy(&event, &readBuffer[index], iEventSize); 1130b792cc56SAppaRao Puli if (event.wd == dirWatchDesc) 1131b792cc56SAppaRao Puli { 1132b792cc56SAppaRao Puli if ((event.len == 0) || 1133b792cc56SAppaRao Puli (index + iEventSize + event.len > bytesTransferred)) 1134b792cc56SAppaRao Puli { 1135b792cc56SAppaRao Puli index += (iEventSize + event.len); 1136b792cc56SAppaRao Puli continue; 1137b792cc56SAppaRao Puli } 1138b792cc56SAppaRao Puli 1139b792cc56SAppaRao Puli std::string fileName(&readBuffer[index + iEventSize], 1140b792cc56SAppaRao Puli event.len); 1141b792cc56SAppaRao Puli if (std::strcmp(fileName.c_str(), "redfish") != 0) 1142b792cc56SAppaRao Puli { 1143b792cc56SAppaRao Puli index += (iEventSize + event.len); 1144b792cc56SAppaRao Puli continue; 1145b792cc56SAppaRao Puli } 1146b792cc56SAppaRao Puli 1147b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1148b792cc56SAppaRao Puli << "Redfish log file created/deleted. event.name: " 1149b792cc56SAppaRao Puli << fileName; 1150b792cc56SAppaRao Puli if (event.mask == IN_CREATE) 1151b792cc56SAppaRao Puli { 1152b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1153b792cc56SAppaRao Puli { 1154b792cc56SAppaRao Puli BMCWEB_LOG_DEBUG 1155b792cc56SAppaRao Puli << "Redfish log file is already on " 1156b792cc56SAppaRao Puli "inotify_add_watch."; 1157b792cc56SAppaRao Puli return; 1158b792cc56SAppaRao Puli } 1159b792cc56SAppaRao Puli 1160b792cc56SAppaRao Puli fileWatchDesc = inotify_add_watch( 1161b792cc56SAppaRao Puli inotifyFd, redfishEventLogFile, IN_MODIFY); 1162b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1163b792cc56SAppaRao Puli { 1164b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1165b792cc56SAppaRao Puli << "inotify_add_watch failed for " 1166b792cc56SAppaRao Puli "redfish log file."; 1167b792cc56SAppaRao Puli return; 1168b792cc56SAppaRao Puli } 1169b792cc56SAppaRao Puli 1170b792cc56SAppaRao Puli EventServiceManager::getInstance() 1171b792cc56SAppaRao Puli .cacheLastEventTimestamp(); 1172b792cc56SAppaRao Puli EventServiceManager::getInstance() 1173b792cc56SAppaRao Puli .readEventLogsFromFile(); 1174b792cc56SAppaRao Puli } 1175b792cc56SAppaRao Puli else if ((event.mask == IN_DELETE) || 1176b792cc56SAppaRao Puli (event.mask == IN_MOVED_TO)) 1177b792cc56SAppaRao Puli { 1178b792cc56SAppaRao Puli if (fileWatchDesc != -1) 1179b792cc56SAppaRao Puli { 1180b792cc56SAppaRao Puli inotify_rm_watch(inotifyFd, fileWatchDesc); 1181b792cc56SAppaRao Puli fileWatchDesc = -1; 1182b792cc56SAppaRao Puli } 1183b792cc56SAppaRao Puli } 1184b792cc56SAppaRao Puli } 1185b792cc56SAppaRao Puli else if (event.wd == fileWatchDesc) 1186b792cc56SAppaRao Puli { 1187b792cc56SAppaRao Puli if (event.mask == IN_MODIFY) 11887f4eb588SAppaRao Puli { 11897f4eb588SAppaRao Puli EventServiceManager::getInstance() 11907f4eb588SAppaRao Puli .readEventLogsFromFile(); 11917f4eb588SAppaRao Puli } 1192b792cc56SAppaRao Puli } 1193b792cc56SAppaRao Puli index += (iEventSize + event.len); 11947f4eb588SAppaRao Puli } 11957f4eb588SAppaRao Puli 11967f4eb588SAppaRao Puli watchRedfishEventLogFile(); 11977f4eb588SAppaRao Puli }); 11987f4eb588SAppaRao Puli } 11997f4eb588SAppaRao Puli 12007f4eb588SAppaRao Puli static int startEventLogMonitor(boost::asio::io_context& ioc) 12017f4eb588SAppaRao Puli { 12027f4eb588SAppaRao Puli inotifyConn = 12037f4eb588SAppaRao Puli std::make_shared<boost::asio::posix::stream_descriptor>(ioc); 1204b792cc56SAppaRao Puli inotifyFd = inotify_init1(IN_NONBLOCK); 1205b792cc56SAppaRao Puli if (inotifyFd == -1) 12067f4eb588SAppaRao Puli { 12077f4eb588SAppaRao Puli BMCWEB_LOG_ERROR << "inotify_init1 failed."; 12087f4eb588SAppaRao Puli return -1; 12097f4eb588SAppaRao Puli } 1210b792cc56SAppaRao Puli 1211b792cc56SAppaRao Puli // Add watch on directory to handle redfish event log file 1212b792cc56SAppaRao Puli // create/delete. 1213b792cc56SAppaRao Puli dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir, 1214b792cc56SAppaRao Puli IN_CREATE | IN_MOVED_TO | IN_DELETE); 1215b792cc56SAppaRao Puli if (dirWatchDesc == -1) 12167f4eb588SAppaRao Puli { 12177f4eb588SAppaRao Puli BMCWEB_LOG_ERROR 1218b792cc56SAppaRao Puli << "inotify_add_watch failed for event log directory."; 12197f4eb588SAppaRao Puli return -1; 12207f4eb588SAppaRao Puli } 12217f4eb588SAppaRao Puli 1222b792cc56SAppaRao Puli // Watch redfish event log file for modifications. 1223b792cc56SAppaRao Puli fileWatchDesc = 1224b792cc56SAppaRao Puli inotify_add_watch(inotifyFd, redfishEventLogFile, IN_MODIFY); 1225b792cc56SAppaRao Puli if (fileWatchDesc == -1) 1226b792cc56SAppaRao Puli { 1227b792cc56SAppaRao Puli BMCWEB_LOG_ERROR 1228b792cc56SAppaRao Puli << "inotify_add_watch failed for redfish log file."; 1229b792cc56SAppaRao Puli // Don't return error if file not exist. 1230b792cc56SAppaRao Puli // Watch on directory will handle create/delete of file. 1231b792cc56SAppaRao Puli } 1232b792cc56SAppaRao Puli 12337f4eb588SAppaRao Puli // monitor redfish event log file 1234b792cc56SAppaRao Puli inotifyConn->assign(inotifyFd); 12357f4eb588SAppaRao Puli watchRedfishEventLogFile(); 12367f4eb588SAppaRao Puli 12377f4eb588SAppaRao Puli return 0; 12387f4eb588SAppaRao Puli } 12397f4eb588SAppaRao Puli 12407f4eb588SAppaRao Puli #endif 12417f4eb588SAppaRao Puli 1242156d6b00SAppaRao Puli void getMetricReading(const std::string& service, 1243156d6b00SAppaRao Puli const std::string& objPath, const std::string& intf) 1244156d6b00SAppaRao Puli { 1245156d6b00SAppaRao Puli std::size_t found = objPath.find_last_of("/"); 1246156d6b00SAppaRao Puli if (found == std::string::npos) 1247156d6b00SAppaRao Puli { 1248156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid objPath received"; 1249156d6b00SAppaRao Puli return; 1250156d6b00SAppaRao Puli } 1251156d6b00SAppaRao Puli 1252156d6b00SAppaRao Puli std::string idStr = objPath.substr(found + 1); 1253156d6b00SAppaRao Puli if (idStr.empty()) 1254156d6b00SAppaRao Puli { 1255156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Invalid ID in objPath"; 1256156d6b00SAppaRao Puli return; 1257156d6b00SAppaRao Puli } 1258156d6b00SAppaRao Puli 1259156d6b00SAppaRao Puli crow::connections::systemBus->async_method_call( 1260156d6b00SAppaRao Puli [idStr{std::move(idStr)}]( 1261156d6b00SAppaRao Puli const boost::system::error_code ec, 1262156d6b00SAppaRao Puli boost::container::flat_map< 1263156d6b00SAppaRao Puli std::string, std::variant<std::string, ReadingsObjType>>& 1264156d6b00SAppaRao Puli resp) { 1265156d6b00SAppaRao Puli if (ec) 1266156d6b00SAppaRao Puli { 1267156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG 1268156d6b00SAppaRao Puli << "D-Bus call failed to GetAll metric readings."; 1269156d6b00SAppaRao Puli return; 1270156d6b00SAppaRao Puli } 1271156d6b00SAppaRao Puli 1272156d6b00SAppaRao Puli const std::string* timestampPtr = 1273156d6b00SAppaRao Puli std::get_if<std::string>(&resp["Timestamp"]); 1274156d6b00SAppaRao Puli if (!timestampPtr) 1275156d6b00SAppaRao Puli { 1276156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Failed to Get timestamp."; 1277156d6b00SAppaRao Puli return; 1278156d6b00SAppaRao Puli } 1279156d6b00SAppaRao Puli 1280156d6b00SAppaRao Puli ReadingsObjType* readingsPtr = 1281156d6b00SAppaRao Puli std::get_if<ReadingsObjType>(&resp["Readings"]); 1282156d6b00SAppaRao Puli if (!readingsPtr) 1283156d6b00SAppaRao Puli { 1284156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Failed to Get Readings property."; 1285156d6b00SAppaRao Puli return; 1286156d6b00SAppaRao Puli } 1287156d6b00SAppaRao Puli 1288156d6b00SAppaRao Puli if (!readingsPtr->size()) 1289156d6b00SAppaRao Puli { 1290156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "No metrics report to be transferred"; 1291156d6b00SAppaRao Puli return; 1292156d6b00SAppaRao Puli } 1293156d6b00SAppaRao Puli 1294156d6b00SAppaRao Puli for (const auto& it : 1295156d6b00SAppaRao Puli EventServiceManager::getInstance().subscriptionsMap) 1296156d6b00SAppaRao Puli { 1297156d6b00SAppaRao Puli std::shared_ptr<Subscription> entry = it.second; 1298156d6b00SAppaRao Puli if (entry->eventFormatType == metricReportFormatType) 1299156d6b00SAppaRao Puli { 1300156d6b00SAppaRao Puli entry->filterAndSendReports(idStr, *timestampPtr, 1301156d6b00SAppaRao Puli *readingsPtr); 1302156d6b00SAppaRao Puli } 1303156d6b00SAppaRao Puli } 1304156d6b00SAppaRao Puli }, 1305156d6b00SAppaRao Puli service, objPath, "org.freedesktop.DBus.Properties", "GetAll", 1306156d6b00SAppaRao Puli intf); 1307156d6b00SAppaRao Puli } 1308156d6b00SAppaRao Puli 1309156d6b00SAppaRao Puli void unregisterMetricReportSignal() 1310156d6b00SAppaRao Puli { 13117d1cc387SAppaRao Puli if (matchTelemetryMonitor) 13127d1cc387SAppaRao Puli { 1313156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister"; 1314156d6b00SAppaRao Puli matchTelemetryMonitor.reset(); 1315156d6b00SAppaRao Puli matchTelemetryMonitor = nullptr; 1316156d6b00SAppaRao Puli } 13177d1cc387SAppaRao Puli } 1318156d6b00SAppaRao Puli 1319156d6b00SAppaRao Puli void registerMetricReportSignal() 1320156d6b00SAppaRao Puli { 13217d1cc387SAppaRao Puli if (!serviceEnabled || matchTelemetryMonitor) 1322156d6b00SAppaRao Puli { 13237d1cc387SAppaRao Puli BMCWEB_LOG_DEBUG << "Not registering metric report signal."; 1324156d6b00SAppaRao Puli return; 1325156d6b00SAppaRao Puli } 1326156d6b00SAppaRao Puli 1327156d6b00SAppaRao Puli BMCWEB_LOG_DEBUG << "Metrics report signal - Register"; 1328156d6b00SAppaRao Puli std::string matchStr( 1329156d6b00SAppaRao Puli "type='signal',member='ReportUpdate', " 1330156d6b00SAppaRao Puli "interface='xyz.openbmc_project.MonitoringService.Report'"); 1331156d6b00SAppaRao Puli 1332156d6b00SAppaRao Puli matchTelemetryMonitor = std::make_shared<sdbusplus::bus::match::match>( 1333156d6b00SAppaRao Puli *crow::connections::systemBus, matchStr, 1334156d6b00SAppaRao Puli [this](sdbusplus::message::message& msg) { 1335156d6b00SAppaRao Puli if (msg.is_method_error()) 1336156d6b00SAppaRao Puli { 1337156d6b00SAppaRao Puli BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error"; 1338156d6b00SAppaRao Puli return; 1339156d6b00SAppaRao Puli } 1340156d6b00SAppaRao Puli 1341156d6b00SAppaRao Puli std::string service = msg.get_sender(); 1342156d6b00SAppaRao Puli std::string objPath = msg.get_path(); 1343156d6b00SAppaRao Puli std::string intf = msg.get_interface(); 1344156d6b00SAppaRao Puli getMetricReading(service, objPath, intf); 1345156d6b00SAppaRao Puli }); 1346156d6b00SAppaRao Puli } 13471bf712bcSAyushi Smriti 13481bf712bcSAyushi Smriti bool validateAndSplitUrl(const std::string& destUrl, std::string& urlProto, 13491bf712bcSAyushi Smriti std::string& host, std::string& port, 13501bf712bcSAyushi Smriti std::string& path) 13511bf712bcSAyushi Smriti { 13521bf712bcSAyushi Smriti // Validate URL using regex expression 13531bf712bcSAyushi Smriti // Format: <protocol>://<host>:<port>/<path> 13541bf712bcSAyushi Smriti // protocol: http/https 13551bf712bcSAyushi Smriti const std::regex urlRegex( 13561bf712bcSAyushi Smriti "(http|https)://([^/\\x20\\x3f\\x23\\x3a]+):?([0-9]*)(/" 13571bf712bcSAyushi Smriti "([^\\x20\\x23\\x3f]*\\x3f?([^\\x20\\x23\\x3f])*)?)"); 13581bf712bcSAyushi Smriti std::cmatch match; 13591bf712bcSAyushi Smriti if (!std::regex_match(destUrl.c_str(), match, urlRegex)) 13601bf712bcSAyushi Smriti { 13611bf712bcSAyushi Smriti BMCWEB_LOG_INFO << "Dest. url did not match "; 13621bf712bcSAyushi Smriti return false; 13631bf712bcSAyushi Smriti } 13641bf712bcSAyushi Smriti 13651bf712bcSAyushi Smriti urlProto = std::string(match[1].first, match[1].second); 13661bf712bcSAyushi Smriti if (urlProto == "http") 13671bf712bcSAyushi Smriti { 13681bf712bcSAyushi Smriti #ifndef BMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING 13691bf712bcSAyushi Smriti return false; 13701bf712bcSAyushi Smriti #endif 13711bf712bcSAyushi Smriti } 13721bf712bcSAyushi Smriti 13731bf712bcSAyushi Smriti host = std::string(match[2].first, match[2].second); 13741bf712bcSAyushi Smriti port = std::string(match[3].first, match[3].second); 13751bf712bcSAyushi Smriti path = std::string(match[4].first, match[4].second); 13761bf712bcSAyushi Smriti if (port.empty()) 13771bf712bcSAyushi Smriti { 13781bf712bcSAyushi Smriti if (urlProto == "http") 13791bf712bcSAyushi Smriti { 13801bf712bcSAyushi Smriti port = "80"; 13811bf712bcSAyushi Smriti } 13821bf712bcSAyushi Smriti else 13831bf712bcSAyushi Smriti { 13841bf712bcSAyushi Smriti port = "443"; 13851bf712bcSAyushi Smriti } 13861bf712bcSAyushi Smriti } 13871bf712bcSAyushi Smriti if (path.empty()) 13881bf712bcSAyushi Smriti { 13891bf712bcSAyushi Smriti path = "/"; 13901bf712bcSAyushi Smriti } 13911bf712bcSAyushi Smriti return true; 13921bf712bcSAyushi Smriti } 13937f4eb588SAppaRao Puli }; // namespace redfish 1394b52664e2SAppaRao Puli 1395b52664e2SAppaRao Puli } // namespace redfish 1396