Add UST Logging for Empty Trace

Summary: There was a request to have UST log when traces are empty. We make a special case in the logger to log when the desired string is encountered Differential Revision: D64559516
pytorch · Oct 17, 2024 · 987ffee · 987ffee
1 parent eb1713f
commit 987ffee
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/libkineto/include/ILoggerObserver.h b/libkineto/include/ILoggerObserver.h
@@ -15,6 +15,10 @@ constexpr char kWarmUpStage[] = "Warm Up";
 constexpr char kCollectionStage[] = "Collection";
 constexpr char kPostProcessingStage[] = "Post Processing";
 
+// Special string in UST for determining if traces are empty
+constexpr char kEmptyTrace[] =
+    "No Valid Trace Events (CPU/GPU) found. Outputting empty trace.";
+
 #if !USE_GOOGLE_LOG
 
 #include <map>

diff --git a/libkineto/src/CuptiActivityProfiler.cpp b/libkineto/src/CuptiActivityProfiler.cpp
@@ -375,8 +375,7 @@ void CuptiActivityProfiler::processTraceInternal(ActivityLogger& logger) {
   }
 #endif // HAS_ROCTRACER
   if (!traceNonEmpty()) {
-    LOG(WARNING)
-        << "No Valid Trace Events (CPU/GPU) found. Outputting empty trace.";
+    LOG(WARNING) << kEmptyTrace;
   }
 
   for (const auto& session : sessions_) {