[rush] Enhance performance data in telemetry payload

common/changes/@microsoft/rush/performance-marks_2025-07-03-20-39.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add performance measures around various operations, include performance entries in telemetry payload.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/reviews/api/rush-lib.api.md

@@ -23,6 +23,7 @@ import { JsonNull } from '@rushstack/node-core-library';
 import { JsonObject } from '@rushstack/node-core-library';
 import { LookupByPath } from '@rushstack/lookup-by-path';
 import { PackageNameParser } from '@rushstack/node-core-library';
+import type { PerformanceEntry as PerformanceEntry_2 } from 'node:perf_hooks';
 import type { StdioSummarizer } from '@rushstack/terminal';
 import { SyncHook } from 'tapable';
 import { SyncWaterfallHook } from 'tapable';
@@ -884,6 +885,7 @@ export interface ITelemetryData {
     readonly machineInfo?: ITelemetryMachineInfo;
     readonly name: string;
     readonly operationResults?: Record<string, ITelemetryOperationResult>;
+    readonly performanceEntries?: readonly PerformanceEntry_2[];
     readonly platform?: string;
     readonly result: 'Succeeded' | 'Failed';
     readonly rushVersion?: string;

libraries/rush-lib/src/api/Rush.ts

@@ -15,6 +15,7 @@ import { CommandLineMigrationAdvisor } from '../cli/CommandLineMigrationAdvisor'
 import { EnvironmentVariableNames } from './EnvironmentConfiguration';
 import type { IBuiltInPluginConfiguration } from '../pluginFramework/PluginLoader/BuiltInPluginLoader';
 import { RushPnpmCommandLine } from '../cli/RushPnpmCommandLine';
+import { measureAsyncFn } from '../utilities/performance';
 
 /**
  * Options to pass to the rush "launch" functions.
@@ -93,8 +94,9 @@ export class Rush {
       alreadyReportedNodeTooNewError: options.alreadyReportedNodeTooNewError,
       builtInPluginConfigurations: options.builtInPluginConfigurations
     });
+    // CommandLineParser.executeAsync() should never reject the promise
     // eslint-disable-next-line no-console
-    parser.executeAsync().catch(console.error); // CommandLineParser.executeAsync() should never reject the promise
+    measureAsyncFn('rush:parser:executeAsync', () => parser.executeAsync()).catch(console.error);
   }
 
   /**

libraries/rush-lib/src/cli/RushCommandLineParser.ts

@@ -65,6 +65,8 @@ import { InstallAutoinstallerAction } from './actions/InstallAutoinstallerAction
 import { LinkPackageAction } from './actions/LinkPackageAction';
 import { BridgePackageAction } from './actions/BridgePackageAction';
 
+import { measureAsyncFn } from '../utilities/performance';
+
 /**
  * Options for `RushCommandLineParser`.
  */
@@ -219,7 +221,9 @@ export class RushCommandLineParser extends CommandLineParser {
     this._terminalProvider.verboseEnabled = this._terminalProvider.debugEnabled =
       process.argv.indexOf('--debug') >= 0;
 
-    await this.pluginManager.tryInitializeUnassociatedPluginsAsync();
+    await measureAsyncFn('rush:initializeUnassociatedPlugins', () =>
+      this.pluginManager.tryInitializeUnassociatedPluginsAsync()
+    );
 
     return await super.executeAsync(args);
   }
@@ -298,7 +302,7 @@ export class RushCommandLineParser extends CommandLineParser {
     }
 
     try {
-      await super.onExecuteAsync();
+      await measureAsyncFn('rush:commandLineParser:onExecuteAsync', () => super.onExecuteAsync());
     } finally {
       if (this.telemetry) {
         this.flushTelemetry();

libraries/rush-lib/src/cli/actions/BaseInstallAction.ts

@@ -24,6 +24,7 @@ import { SUBSPACE_LONG_ARG_NAME, type SelectionParameterSet } from '../parsing/S
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { Subspace } from '../../api/Subspace';
 import { getVariantAsync, VARIANT_PARAMETER } from '../../api/Variants';
+import { measureAsyncFn } from '../../utilities/performance';
 
 /**
  * Temporary data structure used by `BaseInstallAction.runAsync()`
@@ -285,7 +286,9 @@ export abstract class BaseInstallAction extends BaseRushAction {
       installSuccessful = false;
       throw error;
     } finally {
-      await purgeManager.startDeleteAllAsync();
+      await measureAsyncFn('rush:installManager:startDeleteAllAsync', () =>
+        purgeManager.startDeleteAllAsync()
+      );
       stopwatch.stop();
 
       this._collectTelemetry(stopwatch, installManagerOptions, installSuccessful);
@@ -327,7 +330,7 @@ export abstract class BaseInstallAction extends BaseRushAction {
         installManagerOptions
       );
 
-    await installManager.doInstallAsync();
+    await measureAsyncFn('rush:installManager:doInstallAsync', () => installManager.doInstallAsync());
   }
 
   private _collectTelemetry(

libraries/rush-lib/src/cli/actions/BaseRushAction.ts

@@ -14,6 +14,9 @@ import { Utilities } from '../../utilities/Utilities';
 import type { RushGlobalFolder } from '../../api/RushGlobalFolder';
 import type { RushSession } from '../../pluginFramework/RushSession';
 import type { IRushCommand } from '../../pluginFramework/RushLifeCycle';
+import { measureAsyncFn } from '../../utilities/performance';
+
+const PERF_PREFIX: string = 'rush:action';
 
 export interface IBaseRushActionOptions extends ICommandLineActionOptions {
   /**
@@ -75,7 +78,7 @@ export abstract class BaseConfiglessRushAction extends CommandLineAction impleme
       this.terminal.write(`Starting "rush ${this.actionName}"\n`);
     }
 
-    return await this.runAsync();
+    await measureAsyncFn(`${PERF_PREFIX}:runAsync`, () => this.runAsync());
   }
 
   /**
@@ -121,15 +124,19 @@ export abstract class BaseRushAction extends BaseConfiglessRushAction {
 
     this._throwPluginErrorIfNeed();
 
-    await this.parser.pluginManager.tryInitializeAssociatedCommandPluginsAsync(this.actionName);
+    await measureAsyncFn(`${PERF_PREFIX}:initializePluginsAsync`, () =>
+      this.parser.pluginManager.tryInitializeAssociatedCommandPluginsAsync(this.actionName)
+    );
 
     this._throwPluginErrorIfNeed();
 
     const { hooks: sessionHooks } = this.rushSession;
-    if (sessionHooks.initialize.isUsed()) {
-      // Avoid the cost of compiling the hook if it wasn't tapped.
-      await sessionHooks.initialize.promise(this);
-    }
+    await measureAsyncFn(`${PERF_PREFIX}:initializePlugins`, async () => {
+      if (sessionHooks.initialize.isUsed()) {
+        // Avoid the cost of compiling the hook if it wasn't tapped.
+        await sessionHooks.initialize.promise(this);
+      }
+    });
 
     return super.onExecuteAsync();
   }

libraries/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts

@@ -20,6 +20,7 @@ import { Utilities } from '../../utilities/Utilities';
 import { Stopwatch } from '../../utilities/Stopwatch';
 import { Autoinstaller } from '../../logic/Autoinstaller';
 import type { IGlobalCommandConfig, IShellCommandTokenContext } from '../../api/CommandLineConfiguration';
+import { measureAsyncFn } from '../../utilities/performance';
 
 /**
  * Constructor parameters for GlobalScriptAction.
@@ -120,7 +121,9 @@ export class GlobalScriptAction extends BaseScriptAction<IGlobalCommandConfig> {
       this.commandLineConfiguration?.additionalPathFolders.slice() || [];
 
     if (this._autoinstallerName) {
-      await this._prepareAutoinstallerNameAsync();
+      await measureAsyncFn('rush:globalScriptAction:prepareAutoinstaller', () =>
+        this._prepareAutoinstallerNameAsync()
+      );
 
       const autoinstallerNameBinPath: string = path.join(this._autoinstallerFullPath, 'node_modules', '.bin');
       additionalPathFolders.push(autoinstallerNameBinPath);