Logging enhancement / fixes (#1419)

* Instance in logging output

* Fix: Trigger that previous log lines are shown in the Log UI

Author: Lord-Grey

assets/webconfig/js/content_logging.js

@@ -121,8 +121,8 @@ $(document).ready(function () {
     if (messages.length != 0) {
 
       for (var idx = 0; idx < messages.length; idx++) {
-        var app_name = messages[idx].appName;
         var logger_name = messages[idx].loggerName;
+        var logger_subname = messages[idx].loggerSubName;
         var function_ = messages[idx].function;
         var line = messages[idx].line;
         var file_name = messages[idx].fileName;
@@ -136,7 +136,18 @@ $(document).ready(function () {
         }
 
         var date = new Date(parseInt(utime));
-        var newLogLine = date.toISOString() + " [" + app_name + " " + logger_name + "] (" + level_string + ") " + debug + msg;
+        var subComponent = "";
+        if (window.serverInfo.instance.length > 1) {
+          if (logger_subname.startsWith("I")) {
+            var instanceNum = logger_subname.substring(1);
+            if (window.serverInfo.instance[instanceNum]) {
+              subComponent = window.serverInfo.instance[instanceNum].friendly_name;
+            } else {
+              subComponent = instanceNum;
+            }
+          }
+        }
+        var newLogLine = date.toISOString() + " [" + logger_name + (subComponent ? "|" + subComponent : "") + "] (" + level_string + ") " + debug + msg;
 
         $("#logmessages").append("<code>" + newLogLine + "</code>\n");
       }

include/hyperion/Hyperion.h

@@ -256,7 +256,7 @@ public slots:
 	/// @brief Get a pointer to the priorityMuxer instance
 	/// @return      PriorityMuxer instance pointer
 	///
-	PriorityMuxer* getMuxerInstance() { return &_muxer; }
+	PriorityMuxer* getMuxerInstance() { return _muxer; }
 
 	///
 	/// @brief enable/disable automatic/priorized source selection
@@ -340,7 +340,7 @@ public slots:
 	/// @brief Get the component Register
 	/// return Component register pointer
 	///
-	ComponentRegister & getComponentRegister() { return _componentRegister; }
+	ComponentRegister* getComponentRegister() { return _componentRegister; }
 
 	///
 	/// @brief Called from components to update their current state. DO NOT CALL FROM USERS
@@ -511,7 +511,7 @@ private slots:
 	SettingsManager* _settingsManager;
 
 	/// Register that holds component states
-	ComponentRegister _componentRegister;
+	ComponentRegister* _componentRegister;
 
 	/// The specifiation of the led frame construction and picture integration
 	LedString _ledString;
@@ -522,7 +522,7 @@ private slots:
 	std::vector<ColorOrder> _ledStringColorOrder;
 
 	/// The priority muxer
-	PriorityMuxer _muxer;
+	PriorityMuxer* _muxer;
 
 	/// The adjustment from raw colors to led colors
 	MultiColorAdjustment * _raw2ledAdjustment;

include/leddevice/LedDevice.h

@@ -152,6 +152,13 @@ class LedDevice : public QObject
 	///
 	static void printLedValues(const std::vector<ColorRgb>& ledValues);
 
+	///
+	/// @brief Set the common logger for LED-devices.
+	///
+	/// @param[in] log The logger to be used
+	///
+	void setLogger(Logger* log) { _log = log; }
+
 public slots:
 
 	///

include/utils/Logger.h

@@ -54,8 +54,8 @@ class Logger : public QObject
 
 	struct T_LOG_MESSAGE
 	{
-		QString      appName;
 		QString      loggerName;
+		QString      loggerSubName;
 		QString      function;
 		unsigned int line;
 		QString      fileName;
@@ -65,22 +65,22 @@ class Logger : public QObject
 		QString      levelString;
 	};
 
-	static Logger*  getInstance(const QString & name = "", LogLevel minLevel=Logger::INFO);
-	static void     deleteInstance(const QString & name = "");
-	static void     setLogLevel(LogLevel level, const QString & name = "");
-	static LogLevel getLogLevel(const QString & name = "");
+	static Logger*  getInstance(const QString & name = "", const QString & subName = "__", LogLevel minLevel=Logger::INFO);
+	static void     deleteInstance(const QString & name = "", const QString & subName = "__");
+	static void     setLogLevel(LogLevel level, const QString & name = "", const QString & subName = "__");
+	static LogLevel getLogLevel(const QString & name = "", const QString & subName = "__");
 
 	void     Message(LogLevel level, const char* sourceFile, const char* func, unsigned int line, const char* fmt, ...);
 	void     setMinLevel(LogLevel level) { _minLevel = static_cast<int>(level); }
 	LogLevel getMinLevel() const { return static_cast<LogLevel>(int(_minLevel)); }
 	QString  getName() const { return _name; }
-	QString  getAppName() const { return _appname; }
+	QString  getSubName() const { return _subname; }
 
 signals:
 	void newLogMessage(Logger::T_LOG_MESSAGE);
 
 protected:
-	Logger(const QString & name="", LogLevel minLevel = INFO);
+	Logger(const QString & name="", const QString & subName = "__", LogLevel minLevel = INFO);
 	~Logger() override;
 
 private:
@@ -95,12 +95,12 @@ class Logger : public QObject
 	static QAtomicInteger<int>   GLOBAL_MIN_LOG_LEVEL;
 
 	const QString                _name;
-	const QString                _appname;
+	const QString                _subname;
 	const bool                   _syslogEnabled;
 	const unsigned               _loggerId;
 
 	/* Only non-const member, hence the atomic */
-	QAtomicInteger<int> _minLevel;
+	QAtomicInteger<int>			 _minLevel;
 };
 
 class LoggerManager : public QObject

include/utils/hyperion.h

@@ -44,12 +44,12 @@ namespace hyperion {
 					}
 				};
 				hyperion->setColor(PriorityMuxer::FG_PRIORITY, fg_color, fg_duration_ms);
-				Info(Logger::getInstance("HYPERION"),"Initial foreground color set (%d %d %d)",fg_color.at(0).red,fg_color.at(0).green,fg_color.at(0).blue);
+				Info(Logger::getInstance("HYPERION","I"+QString::number(hyperion->getInstanceIndex())),"Initial foreground color set (%d %d %d)",fg_color.at(0).red,fg_color.at(0).green,fg_color.at(0).blue);
 			}
 			else
 			{
 				int result = hyperion->setEffect(fgEffectConfig, PriorityMuxer::FG_PRIORITY, fg_duration_ms);
-				Info(Logger::getInstance("HYPERION"),"Initial foreground effect '%s' %s", QSTRING_CSTR(fgEffectConfig), ((result == 0) ? "started" : "failed"));
+				Info(Logger::getInstance("HYPERION","I"+QString::number(hyperion->getInstanceIndex())),"Initial foreground effect '%s' %s", QSTRING_CSTR(fgEffectConfig), ((result == 0) ? "started" : "failed"));
 			}
 		}
 		#undef FGCONFIG_ARRAY

libsrc/api/API.cpp

@@ -72,6 +72,8 @@ API::API(Logger *log, bool localConnection, QObject *parent)
 
 void API::init()
 {
+	assert(_hyperion);
+
     bool apiAuthRequired = _authManager->isAuthRequired();
 
     // For security we block external connections if default PW is set

libsrc/api/JsonAPI.cpp

@@ -617,7 +617,7 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject &message, const QString
 
 	// get available components
 	QJsonArray component;
-	std::map<hyperion::Components, bool> components = _hyperion->getComponentRegister().getRegister();
+	std::map<hyperion::Components, bool> components = _hyperion->getComponentRegister()->getRegister();
 	for (auto comp : components)
 	{
 		QJsonObject item;
@@ -1154,7 +1154,9 @@ void JsonAPI::handleLoggingCommand(const QJsonObject &message, const QString &co
 			{
 				_streaming_logging_reply["command"] = command + "-update";
 				connect(LoggerManager::getInstance(), &LoggerManager::newLogMessage, this, &JsonAPI::incommingLogMessage);
-				Debug(_log, "log streaming activated for client %s", _peerAddress.toStdString().c_str()); // needed to trigger log sending
+
+				emit incommingLogMessage (Logger::T_LOG_MESSAGE{}); // needed to trigger log sending
+				Debug(_log, "log streaming activated for client %s", _peerAddress.toStdString().c_str());
 			}
 		}
 		else if (subcommand == "stop")
@@ -1783,22 +1785,26 @@ void JsonAPI::incommingLogMessage(const Logger::T_LOG_MESSAGE &msg)
 		const QList<Logger::T_LOG_MESSAGE> *logBuffer = LoggerManager::getInstance()->getLogMessageBuffer();
 		for (int i = 0; i < logBuffer->length(); i++)
 		{
-			message["appName"] = logBuffer->at(i).appName;
-			message["loggerName"] = logBuffer->at(i).loggerName;
-			message["function"] = logBuffer->at(i).function;
-			message["line"] = QString::number(logBuffer->at(i).line);
-			message["fileName"] = logBuffer->at(i).fileName;
-			message["message"] = logBuffer->at(i).message;
-			message["levelString"] = logBuffer->at(i).levelString;
-			message["utime"] = QString::number(logBuffer->at(i).utime);
-
-			messageArray.append(message);
+			//Only present records of the current log-level
+			if ( logBuffer->at(i).level >= _log->getLogLevel())
+			{
+				message["loggerName"] = logBuffer->at(i).loggerName;
+				message["loggerSubName"] = logBuffer->at(i).loggerSubName;
+				message["function"] = logBuffer->at(i).function;
+				message["line"] = QString::number(logBuffer->at(i).line);
+				message["fileName"] = logBuffer->at(i).fileName;
+				message["message"] = logBuffer->at(i).message;
+				message["levelString"] = logBuffer->at(i).levelString;
+				message["utime"] = QString::number(logBuffer->at(i).utime);
+
+				messageArray.append(message);
+			}
 		}
 	}
 	else
 	{
-		message["appName"] = msg.appName;
 		message["loggerName"] = msg.loggerName;
+		message["loggerSubName"] = msg.loggerSubName;
 		message["function"] = msg.function;
 		message["line"] = QString::number(msg.line);
 		message["fileName"] = msg.fileName;

libsrc/api/JsonCB.cpp

@@ -156,6 +156,7 @@ void JsonCB::resetSubscriptions()
 
 void JsonCB::setSubscriptionsTo(Hyperion* hyperion)
 {
+	assert(hyperion);
 	//std::cout << "JsonCB::setSubscriptions for instance [" << static_cast<int>(hyperion->getInstanceIndex()) << "] " << std::endl;
 
 	// get current subs
@@ -166,7 +167,7 @@ void JsonCB::setSubscriptionsTo(Hyperion* hyperion)
 
 	// update pointer
 	_hyperion = hyperion;
-	_componentRegister = &_hyperion->getComponentRegister();
+	_componentRegister = _hyperion->getComponentRegister();
 	_prioMuxer = _hyperion->getMuxerInstance();
 
 	// re-apply subs

libsrc/blackborder/BlackBorderProcessor.cpp

@@ -69,7 +69,7 @@ void BlackBorderProcessor::handleSettingsUpdate(settings::type type, const QJson
 				_detector = new BlackBorderDetector(newThreshold);
 			}
 
-			Debug(Logger::getInstance("BLACKBORDER"), "Set mode to: %s", QSTRING_CSTR(_detectionMode));
+			Debug(Logger::getInstance("BLACKBORDER", "I"+QString::number(_hyperion->getInstanceIndex())), "Set mode to: %s", QSTRING_CSTR(_detectionMode));
 
 			// eval the comp state
 			handleCompStateChangeRequest(hyperion::COMP_BLACKBORDER, obj["enable"].toBool(true));

libsrc/effectengine/EffectEngine.cpp

@@ -19,9 +19,12 @@
 
 EffectEngine::EffectEngine(Hyperion * hyperion)
 	: _hyperion(hyperion)
-	, _log(Logger::getInstance("EFFECTENGINE"))
+	, _log(nullptr)
 	, _effectFileHandler(EffectFileHandler::getInstance())
 {
+	QString subComponent = hyperion->property("instance").toString();
+	_log= Logger::getInstance("EFFECTENGINE", subComponent);
+
 	Q_INIT_RESOURCE(EffectEngine);
 	qRegisterMetaType<hyperion::Components>("hyperion::Components");