Set keyword flags on all tracelog events (#10098)

Set keyword flags on all events so those sharing a provider with
telemetry do not fire unless tracing is enabled

## PR Checklist
* [x] Closes #10093 
* [x] I work here
* [x] Tests passed
* [x] Documentation added in `til.h` about how keywords work and at the
  only other site of keywords we define in the Host project tracing
  files.

## Detailed Description of the Pull Request / Additional comments
I initially thought that we would need to split providers here to
accomplish this... but @DHowett helped me realize that might be a lot of
additional metadata and bloat binary size. So with help from a friend
from fundamentals, I realized that we could use Keywords to
differentiate here. We can no longer define 0 keywords as that
represents an any/all scenario. Every `TraceLoggingWrite` event now
needs a keyword. When our events have a keyword, they're not included in
any trace. Additionally, when we have an explicit keyword to check that
is different from the ones used for the telemetry pipeline, we can
ensure that we only do "hard work" to generate debug trace data when an
"ALL" type listener like TraceView or Windows Performance Recorder with
our profiles is listening to these providers for ALL keyworded events. 

## Validation Steps Performed
- [x] - Built with full release build config to confirm performance is
  worse than dev builds BECAUSE of the telemetry event collector camping
  our provider and triggering full trace event generation on shared
  providers.
- [x] - Built with full release build config to enable statistics
  collection and validated trace event collection is excluded and trace
  event short-circuits work with this change.
- [x] - Checked that TraceView still sees both telemetry and tracing
  events
- [x] - Checked that WPR with our .wprp profile sees both telemetry and
  tracing events

src/ConsolePerf.wprp

@@ -43,6 +43,7 @@
         <EventProvider Id="EventProvider-Microsoft.Windows.Console.Server" Name="1A541C01-589A-496E-85A7-A9E02170166D"/>
         <EventProvider Id="EventProvider-Microsoft.Windows.Console.VirtualTerminal.Parser" Name="c9ba2a84-d3ca-5e19-2bd6-776a0910cb9d"/>
         <EventProvider Id="EventProvider-Microsoft.Windows.Console.Render.VtEngine" Name="c9ba2a95-d3ca-5e19-2bd6-776a0910cb9d"/>
+        <EventProvider Id="EventProvider-Microsoft.Windows.Console.UIA" Name="e7ebce59-2161-572d-b263-2f16a6afb9e5"/>
         <!-- Now define some profiles. We'll call them by ID when collecting. Also, the Base is where it is inheriting from and is a .wprpi file built... -->
         <!-- ... into WPR automatically. Go look in the WPR install directory or in the documentation to find it. -->
         <Profile Id="ConsolePerfProfile.Verbose.File" Base="GeneralProfile.Light.File" LoggingMode="File" Name="ConsolePerfProfile" DetailLevel="Verbose" Description="Console Performance default profile">
@@ -66,6 +67,7 @@
                         <EventProviderId Value="EventProvider-Microsoft.Windows.Console.Server"/>
                         <EventProviderId Value="EventProvider-Microsoft.Windows.Console.VirtualTerminal.Parser"/>
                         <EventProviderId Value="EventProvider-Microsoft.Windows.Console.Render.VtEngine"/>
+                        <EventProviderId Value="EventProvider-Microsoft.Windows.Console.UIA"/>
                     </EventProviders>
                 </EventCollectorId>
             </Collectors>

src/Terminal.wprp

@@ -11,6 +11,7 @@
     <EventProvider Id="EventProvider_TerminalApp" Name="24a1622f-7da7-5c77-3303-d850bd1ab2ed" />
     <EventProvider Id="EventProvider_TerminalWin32Host" Name="56c06166-2e2e-5f4d-7ff3-74f4b78c87d6" />
     <EventProvider Id="EventProvider_TerminalRemoting" Name="d6f04aad-629f-539a-77c1-73f5c3e4aa7b" />
+    <EventProvider Id="EventProvider_TerminalDirectX" Name="c93e739e-ae50-5a14-78e7-f171e947535d" />
     <Profile Id="Terminal.Verbose.File" Name="Terminal" Description="Terminal" LoggingMode="File" DetailLevel="Verbose">
       <Collectors>
         <EventCollectorId Value="EventCollector_Terminal">
@@ -21,6 +22,7 @@
             <EventProviderId Value="EventProvider_TerminalApp" />
             <EventProviderId Value="EventProvider_TerminalWin32Host" />
             <EventProviderId Value="EventProvider_TerminalRemoting" />
+            <EventProviderId Value="EventProvider_TerminalDirectX" />
           </EventProviders>
         </EventCollectorId>
       </Collectors>

src/cascadia/Remoting/Monarch.cpp

@@ -84,14 +84,16 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                               "Monarch_AddPeasant",
                               TraceLoggingUInt64(providedID, "providedID", "the provided ID for the peasant"),
                               TraceLoggingUInt64(newPeasantsId, "peasantID", "the ID of the new peasant"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
             return newPeasantsId;
         }
         catch (...)
         {
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_AddPeasant_Failed",
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
             // We can only get into this try/catch if the peasant died on us. So
             // the return value doesn't _really_ matter. They're not about to
@@ -234,7 +236,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         {
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_HandleActivatePeasant_Failed",
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         }
     }
 
@@ -260,7 +263,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                               "Monarch_RemovedPeasantFromDesktop",
                               TraceLoggingUInt64(peasantID, "peasantID", "The ID of the peasant"),
                               TraceLoggingGuid(result->DesktopID(), "desktopGuid", "The GUID of the previous desktop the window was on"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
             _mruPeasants.erase(result);
         }
@@ -297,7 +301,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           TraceLoggingUInt64(localArgs->PeasantID(), "peasantID", "the ID of the activated peasant"),
                           TraceLoggingGuid(desktopGuid, "desktopGuid", "The GUID of the desktop the window is on"),
                           TraceLoggingInt64(newLastActiveTime, "newLastActiveTime", "The provided localArgs->ActivatedTime()"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     }
 
     // Method Description:
@@ -334,7 +339,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
 
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_getMostRecentPeasantID_NoPeasants",
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
             return 0;
         }
 
@@ -368,7 +374,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                                                      "peasantID",
                                                      "We thought this peasant was the MRU one, but it was actually already dead."),
                                   TraceLoggingGuid(mruWindowArgs.DesktopID(), "desktopGuid", "The GUID of the desktop the window is on"),
-                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                                  TraceLoggingKeyword(TIL_KEYWORD_TRACE));
                 // We'll go through the loop again. We removed the current one
                 // at positionInList, so the next one in positionInList will be
                 // a new, different peasant.
@@ -407,7 +414,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                                       TraceLoggingBool(onCurrentDesktop,
                                                        "onCurrentDesktop",
                                                        "true if this window was in fact on the current desktop"),
-                                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
                     return mruWindowArgs.PeasantID();
                 }
                 // If this window wasn't on the current desktop, another one
@@ -419,7 +427,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                 TraceLoggingWrite(g_hRemotingProvider,
                                   "Monarch_getMostRecentPeasantID_Found",
                                   TraceLoggingUInt64(mruWindowArgs.PeasantID(), "peasantID", "The ID of the MRU peasant"),
-                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                                  TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
                 return mruWindowArgs.PeasantID();
             }
@@ -431,7 +440,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         // will use this to create a new window.
         TraceLoggingWrite(g_hRemotingProvider,
                           "Monarch_getMostRecentPeasantID_NotFound",
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
         return 0;
     }
@@ -466,7 +476,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         TraceLoggingWrite(g_hRemotingProvider,
                           "Monarch_ProposeCommandline",
                           TraceLoggingInt64(targetWindow, "targetWindow", "The window ID the args specified"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
         // If there's a valid ID returned, then let's try and find the peasant
         // that goes with it. Alternatively, if we were given a magic windowing
@@ -505,7 +516,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                               TraceLoggingInt64(windowID,
                                                 "windowID",
                                                 "The actual peasant ID we evaluated the window ID as"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
             // If_getMostRecentPeasantID returns 0 above, then we couldn't find
             // a matching window for that style of windowing. _getPeasant will
@@ -544,7 +556,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                                   TraceLoggingBoolean(!result->ShouldCreateWindow(),
                                                       "succeeded",
                                                       "true if we successfully dispatched the commandline to the peasant"),
-                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                                  TraceLoggingKeyword(TIL_KEYWORD_TRACE));
                 return *result;
             }
             else if (windowID > 0)
@@ -559,7 +572,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                                                      "peasantID",
                                                      "the ID of the peasant the commandline waws intended for"),
                                   TraceLoggingBoolean(false, "foundMatch", "true if we found a peasant with that ID"),
-                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                                  TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                                  TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
                 auto result{ winrt::make_self<Remoting::implementation::ProposeCommandlineResult>(true) };
                 result->Id(windowID);
@@ -572,7 +586,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
         TraceLoggingWrite(g_hRemotingProvider,
                           "Monarch_ProposeCommandline_NewWindow",
                           TraceLoggingInt64(targetWindow, "targetWindow", "The provided ID"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
         // In this case, no usable ID was provided. Return { true, nullopt }
         auto result = winrt::make_self<Remoting::implementation::ProposeCommandlineResult>(true);
@@ -634,7 +649,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_identifyWindows_Failed",
                               TraceLoggingInt64(id, "peasantID", "The ID of the peasant which we could not identify"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         };
         _forAllPeasantsIgnoringTheDead(callback, onError);
     }
@@ -674,7 +690,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                               "Monarch_renameRequested",
                               TraceLoggingWideString(name.c_str(), "name", "The newly proposed name"),
                               TraceLoggingInt64(successfullyRenamed, "successfullyRenamed", "true if the peasant is allowed to rename themselves to that name."),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         }
         catch (...)
         {
@@ -683,7 +700,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
             // they're the only one who cares about the result.
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_renameRequested_Failed",
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         }
     }
 
@@ -733,7 +751,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
             TraceLoggingWrite(g_hRemotingProvider,
                               "Monarch_SummonWindow_Failed",
                               TraceLoggingWideString(searchedForName.c_str(), "searchedForName", "The name of the window we tried to summon"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         }
     }
 }

src/cascadia/Remoting/Peasant.cpp

@@ -55,7 +55,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           "Peasant_ExecuteCommandline",
                           TraceLoggingUInt64(GetID(), "peasantID", "Our ID"),
                           TraceLoggingWideString(args.CurrentDirectory().c_str(), "directory", "the provided cwd"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
         // Raise an event with these args. The AppHost will listen for this
         // event to know when to take these args and dispatch them to a
@@ -102,7 +103,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           "Peasant_ActivateWindow",
                           TraceLoggingUInt64(GetID(), "peasantID", "Our ID"),
                           TraceLoggingBoolean(successfullyNotified, "successfullyNotified", "true if we successfully notified the monarch"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     }
 
     // Method Description:
@@ -135,7 +137,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           "Peasant_Summon",
                           TraceLoggingUInt64(GetID(), "peasantID", "Our ID"),
                           TraceLoggingUInt64(localCopy.MoveToCurrentDesktop(), "MoveToCurrentDesktop", "true if we should move to the current desktop"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
         _SummonRequestedHandlers(*this, localCopy);
     }
@@ -184,7 +187,8 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           "Peasant_RequestIdentifyWindows",
                           TraceLoggingUInt64(GetID(), "peasantID", "Our ID"),
                           TraceLoggingBoolean(successfullyNotified, "successfullyNotified", "true if we successfully notified the monarch"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     }
 
     void Peasant::RequestRename(const winrt::Microsoft::Terminal::Remoting::RenameRequestArgs& args)
@@ -215,6 +219,7 @@ namespace winrt::Microsoft::Terminal::Remoting::implementation
                           TraceLoggingWideString(args.NewName().c_str(), "newName", "The proposed name"),
                           TraceLoggingBoolean(args.Succeeded(), "succeeded", "true if the monarch ok'd this new name for us."),
                           TraceLoggingBoolean(successfullyNotified, "successfullyNotified", "true if we successfully notified the monarch"),
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE));
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     }
 }