structured logs: add targeted trace messages to logs (#260)

This adds a `To` field to the `kv` field of structured log messages.
Useful for structured log analysis involving the network simulator.

Author: MariusBgm

SilKit/source/core/participant/Participant_impl.hpp

@@ -1633,7 +1633,7 @@ template <typename SilKitMessageT>
 void Participant<SilKitConnectionT>::SendMsgImpl(const IServiceEndpoint* from, const std::string& targetParticipantName,
                                                  SilKitMessageT&& msg)
 {
-    TraceTx(GetLoggerInternal(), from, msg);
+    TraceTx(GetLoggerInternal(), from, targetParticipantName, msg);
     _connection.SendMsg(from, targetParticipantName, std::forward<SilKitMessageT>(msg));
 }
 

SilKit/source/services/logging/MessageTracing.hpp

@@ -71,11 +71,45 @@ void TraceTx(Logging::ILoggerInternal* logger, const Core::IServiceEndpoint* add
     }
 }
 
+// targeted messages
+template <class SilKitMessageT>
+void TraceTx(Logging::ILoggerInternal* logger, const Core::IServiceEndpoint* addr, const std::string_view target, const SilKitMessageT& msg)
+{
+    if (logger->GetLogLevel() == Logging::Level::Trace)
+    {
+        Logging::LoggerMessage lm{logger, Logging::Level::Trace};
+        lm.SetMessage("Send message");
+        lm.SetKeyValue(addr->GetServiceDescriptor());
+        lm.FormatKeyValue(Logging::Keys::msg, "{}", msg);
+        lm.FormatKeyValue(Logging::Keys::to, "{}", target);
+
+        auto virtualTimeStamp = GetTimestamp(msg);
+        if (virtualTimeStamp != std::chrono::nanoseconds::duration::min())
+        {
+                lm.FormatKeyValue(Logging::Keys::virtualTimeNS, "{}", virtualTimeStamp.count());
+        }
+        lm.Dispatch();
+    }
+}
 // Don't trace LogMessages - this could cause cycles!
-inline void TraceRx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, const Logging::LogMsg& /*msg*/) {}
-inline void TraceTx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, const Logging::LogMsg& /*msg*/) {}
+inline void TraceRx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/,
+                    const Logging::LogMsg& /*msg*/)
+{
+}
+inline void TraceTx(Logging::ILoggerInternal* /*logger*/, const Core::IServiceEndpoint* /*addr*/,
+             const std::string_view /*target*/, const Logging::LogMsg& /*msg*/)
+{
+}
+inline void TraceTx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/,
+                    const Logging::LogMsg& /*msg*/)
+{
+}
 
-inline void TraceRx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, Logging::LogMsg&& /*msg*/) {}
-inline void TraceTx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, Logging::LogMsg&& /*msg*/) {}
+inline void TraceRx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, Logging::LogMsg&& /*msg*/)
+{
+}
+inline void TraceTx(Logging::ILoggerInternal* /*logger*/, Core::IServiceEndpoint* /*addr*/, Logging::LogMsg&& /*msg*/)
+{
+}
 } // namespace Services
 } // namespace SilKit

SilKit/source/services/logging/StructuredLoggingKeys.hpp

@@ -6,6 +6,7 @@
 
 #include <atomic>
 #include <string>
+#include <string_view>
 
 namespace SilKit {
 namespace Services {
@@ -15,6 +16,7 @@ namespace Keys {
 const std::string virtualTimeNS{"VirtualTimeNS"};
 const std::string msg{"Msg"};
 const std::string from{"From"};
+constexpr std::string_view to{"To"};
 
 const std::string waitingTime{"WaitingTime"};
 const std::string executionTime{"ExecutionTime"};