Windows write to log if no debugger attached (#1098)

tomkaragounis · web-flow · commit 63cc083e3703 · 2023-02-10T12:49:04.000-08:00
* Windows write to log if no debugger attached

* Added a preprocessor directive to turn on disk logging on windows
diff --git a/docs/building-custom-SKU.md b/docs/building-custom-SKU.md
@@ -25,6 +25,7 @@ Build recipe must contain the following preprocessor definitions:
 | HAVE_MAT_JSONHPP | on | Build with [JSON for Modern C++ library](https://github.com/nlohmann/json) |
 | HAVE_MAT_ZLIB | on | Use zlib for HTTP requests compression. This option must always be turned on for any high-volume telemetry project |
 | HAVE_MAT_LOGGING | on | Enable internal SDK tracing / debug logging |
+| HAVE_MAT_WIN_LOG | off | Will log statements to disk on windows if trace enabled and HAVE_MAT_LOGGING defined |
 | HAVE_MAT_STORAGE | on | Enable SQLite persistent offline storage |
 | HAVE_MAT_NETDETECT | on | _Win32 Desktop only_: Use NLM COM object for network cost detection on Windows 8+ |
 | HAVE_MAT_SHORT_NS | off | Use short "MAT::" namespace instead of "Microsoft::Applications::Events::" to reduce the .DLL size |
diff --git a/lib/include/mat/config-MIP.h b/lib/include/mat/config-MIP.h
@@ -12,6 +12,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+#define HAVE_MAT_WIN_LOG
 #define HAVE_MAT_STORAGE
 #if defined(_WIN32)
 #define WIN_DESKTOP
diff --git a/lib/include/mat/config-MSIPC.h b/lib/include/mat/config-MSIPC.h
@@ -15,6 +15,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 #define WIN_DESKTOP
 #define HAVE_MAT_DEFAULT_HTTP_CLIENT
diff --git a/lib/include/mat/config-compact-dll.h b/lib/include/mat/config-compact-dll.h
@@ -13,6 +13,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 /* #define HAVE_MAT_LOGGING    */
+/* #define HAVE_MAT_WIN_LOG     */
 /* #define HAVE_MAT_STORAGE    */
 /* #define HAVE_MAT_NETDETECT  */
 /* #define HAVE_MAT_SHORT_NS   */
diff --git a/lib/include/mat/config-compact-exp.h b/lib/include/mat/config-compact-exp.h
@@ -13,6 +13,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 /* #define HAVE_MAT_LOGGING    */
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 /* #define HAVE_MAT_NETDETECT  */
 /* #define HAVE_MAT_SHORT_NS   */
diff --git a/lib/include/mat/config-compact-min.h b/lib/include/mat/config-compact-min.h
@@ -13,6 +13,7 @@
 /* #define HAVE_MAT_JSONHPP    */
 /* #define HAVE_MAT_ZLIB       */
 /* #define HAVE_MAT_LOGGING    */
+/* #define HAVE_MAT_WIN_LOG     */
 /* #define HAVE_MAT_STORAGE    */
 /* #define HAVE_MAT_NETDETECT  */
 /* #define HAVE_MAT_SHORT_NS   */
diff --git a/lib/include/mat/config-compact-noutc.h b/lib/include/mat/config-compact-noutc.h
@@ -13,6 +13,7 @@
 /* #define HAVE_MAT_JSONHPP     */
 /* #define HAVE_MAT_ZLIB        */
 /* #define HAVE_MAT_LOGGING     */
+/* #define HAVE_MAT_WIN_LOG     */
 /* #define HAVE_MAT_STORAGE     */
 /* #define HAVE_MAT_NETDETECT   */
 #define HAVE_MAT_SHORT_NS
diff --git a/lib/include/mat/config-compact.h b/lib/include/mat/config-compact.h
@@ -13,6 +13,7 @@
 /* #define HAVE_MAT_JSONHPP     */
 /* #define HAVE_MAT_ZLIB        */
 /* #define HAVE_MAT_LOGGING     */
+/* #define HAVE_MAT_WIN_LOG     */
 /* #define HAVE_MAT_STORAGE     */
 /* #define HAVE_MAT_NETDETECT   */
 #define HAVE_MAT_SHORT_NS
diff --git a/lib/include/mat/config-default-cs4.h b/lib/include/mat/config-default-cs4.h
@@ -23,6 +23,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 #define HAVE_MAT_DEFAULT_HTTP_CLIENT
 #define HAVE_MAT_LIVEEVENTINSPECTOR
diff --git a/lib/include/mat/config-default-exp.h b/lib/include/mat/config-default-exp.h
@@ -21,6 +21,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 #define HAVE_MAT_DEFAULT_HTTP_CLIENT
 #define HAVE_MAT_LIVEEVENTINSPECTOR
diff --git a/lib/include/mat/config-default.h b/lib/include/mat/config-default.h
@@ -23,6 +23,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 #define HAVE_MAT_DEFAULT_HTTP_CLIENT
 #define HAVE_MAT_LIVEEVENTINSPECTOR
diff --git a/lib/include/mat/config-net40.h b/lib/include/mat/config-net40.h
@@ -15,6 +15,7 @@
 #define HAVE_MAT_JSONHPP
 #define HAVE_MAT_ZLIB
 #define HAVE_MAT_LOGGING
+/* #define HAVE_MAT_WIN_LOG     */
 #define HAVE_MAT_STORAGE
 /*
 #if defined(_WIN32) && !defined(_WINRT_DLL)
diff --git a/lib/pal/PAL.cpp b/lib/pal/PAL.cpp
@@ -223,7 +223,19 @@ namespace PAL_NS_BEGIN {
 
             buffer[std::min<size_t>(len + 0, sizeof(buffer) - 2)] = '\n';
             buffer[std::min<size_t>(len + 1, sizeof(buffer) - 1)] = '\0';
+#ifdef HAVE_MAT_WIN_LOG
+            // Log to debug log file if enabled
+            debugLogMutex.lock();
+            if (debugLogStream->good())
+            {
+                (*debugLogStream) << buffer;
+                // flush is not very efficient, but needed to get realtime file updates
+                debugLogStream->flush();
+            }
+            debugLogMutex.unlock();
+#else
             ::OutputDebugStringA(buffer);
+#endif //HAVE_MAT_WIN_LOG
 #else
             auto now = std::chrono::system_clock::now();
             int64_t millis = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
