dotcom-tool-kit 5.0.1-beta.7 → 5.1.0-beta.1

package/bin/run

@@ -10,13 +10,17 @@ const argv = require('minimist')(process.argv.slice(2), {
 })
 
 const { rootLogger } = require('@dotcom-tool-kit/logger')
+const { TelemetryProcess } = require('@dotcom-tool-kit/telemetry')
 const { formatError } = require('../lib/messages')
 
 async function main() {
+  const metricsProcess = new TelemetryProcess(rootLogger)
+  const environment = process.env.CI ? 'ci' : 'local'
+  const metrics = metricsProcess.root({ environment })
   try {
     if (argv.install) {
       const installHooks = require('../lib/install').default
-      await installHooks(rootLogger)
+      await installHooks(rootLogger, metrics)
     } else if (argv.listPlugins) {
       const { listPlugins } = require('../lib')
       await listPlugins(rootLogger)
@@ -25,7 +29,7 @@ async function main() {
       await printConfig(rootLogger)
     } else if (argv.printMergedOptions) {
       const { printMergedOptions } = require('../lib')
-      await printMergedOptions(rootLogger)
+      await printMergedOptions(rootLogger, metrics)
     } else if (argv.help || argv._.length === 0) {
       const showHelp = require('../lib/help').default
       await showHelp(rootLogger, argv._)
@@ -39,14 +43,16 @@ async function main() {
         // the command becomes something like `dotcom-tool-kit test:staged --
         // index.js`. When this command is executed it runs the configured task
         // where the file path arguments would then be extracted.
-        await runCommands(rootLogger, argv._, argv['--'])
+        await runCommands(rootLogger, metrics, argv._, argv['--'])
       } else {
-        await runCommands(rootLogger, argv._)
+        await runCommands(rootLogger, metrics, argv._)
       }
     }
   } catch (error) {
     rootLogger.error(formatError(error), { skipFormat: true })
     process.exitCode = error.exitCode || 1
+  } finally {
+    metricsProcess.disconnect()
   }
 }
 

package/lib/index.d.ts

@@ -1,7 +1,8 @@
 import type { Logger } from 'winston';
+import { TelemetryRecorder } from '@dotcom-tool-kit/telemetry';
 export { runCommands } from './tasks';
 export { shouldDisableNativeFetch } from './fetch';
 export declare function listPlugins(logger: Logger): Promise<void>;
 export declare function printConfig(logger: Logger): Promise<void>;
-export declare function printMergedOptions(logger: Logger): Promise<void>;
+export declare function printMergedOptions(logger: Logger, metrics: TelemetryRecorder): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/D;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBtE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAMrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAE9D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/D;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBlG"}

package/lib/index.js

@@ -9,6 +9,7 @@ const config_1 = require("./config");
 const util_1 = tslib_1.__importDefault(require("util"));
 const messages_1 = require("./messages");
 const install_1 = require("./install");
+const telemetry_1 = require("./telemetry");
 var tasks_1 = require("./tasks");
 Object.defineProperty(exports, "runCommands", { enumerable: true, get: function () { return tasks_1.runCommands; } });
 var fetch_1 = require("./fetch");
@@ -24,9 +25,10 @@ async function printConfig(logger) {
     const config = await (0, config_1.loadConfig)(logger, { validate: false, root: process.cwd() });
     logger.info(util_1.default.inspect(config, { depth: null, colors: true }));
 }
-async function printMergedOptions(logger) {
+async function printMergedOptions(logger, metrics) {
     const config = await (0, config_1.loadConfig)(logger, { validate: true, root: process.cwd() });
-    const hookInstallations = (await (0, install_1.loadHookInstallations)(logger, config)).unwrap('invalid hooks');
+    (0, telemetry_1.enableTelemetry)(metrics, config.pluginOptions['app root'].options);
+    const hookInstallations = (await (0, install_1.loadHookInstallations)(logger, metrics, config)).unwrap('invalid hooks');
     const mergedOptions = {
         hooks: hookInstallations.map((h) => h.options),
         plugins: Object.fromEntries(Object.entries(config.pluginOptions).map(([pluginId, optionsForPlugin]) => [

package/lib/install.d.ts

@@ -3,8 +3,9 @@ import type { ValidConfig } from '@dotcom-tool-kit/config';
 import { Hook } from '@dotcom-tool-kit/base';
 import { Validated } from '@dotcom-tool-kit/validated';
 import { HookModule } from './plugin/reduce-installations';
+import { TelemetryRecorder } from '@dotcom-tool-kit/telemetry';
 export declare const loadHookEntrypoints: (logger: Logger, config: ValidConfig) => Promise<Validated<Record<string, HookModule>>>;
-export declare const loadHookInstallations: (logger: Logger, config: ValidConfig) => Promise<Validated<Hook[]>>;
-export declare function checkInstall(logger: Logger, config: ValidConfig): Promise<void>;
-export default function installHooks(logger: Logger): Promise<ValidConfig>;
+export declare const loadHookInstallations: (logger: Logger, metrics: TelemetryRecorder, config: ValidConfig) => Promise<Validated<Hook[]>>;
+export declare function checkInstall(logger: Logger, metrics: TelemetryRecorder, config: ValidConfig): Promise<void>;
+export default function installHooks(logger: Logger, metrics: TelemetryRecorder): Promise<ValidConfig>;
 //# sourceMappingURL=install.d.ts.map

package/lib/install.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAa,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AACvF,OAAO,EAAE,UAAU,EAAiC,MAAM,+BAA+B,CAAA;AAuBzF,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,EACd,QAAQ,WAAW,KAClB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAa/C,CAAA;AAED,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,EACd,QAAQ,WAAW,KAClB,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAkC3B,CAAA;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBrF;AAED,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAiD/E"}
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAa,MAAM,uBAAuB,CAAA;AAEvD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AACvF,OAAO,EAAE,UAAU,EAAiC,MAAM,+BAA+B,CAAA;AAOzF,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAmB9D,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,EACd,QAAQ,WAAW,KAClB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAa/C,CAAA;AAED,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,EACd,SAAS,iBAAiB,EAC1B,QAAQ,WAAW,KAClB,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAwC3B,CAAA;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAED,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAwD3G"}

package/lib/install.js

@@ -17,6 +17,8 @@ const conflict_1 = require("@dotcom-tool-kit/conflict");
 const messages_1 = require("./messages");
 const entry_point_1 = require("./plugin/entry-point");
 const init_1 = require("./init");
+const systemCode_1 = require("./systemCode");
+const telemetry_1 = require("./telemetry");
 // implementation of the Array#every method that supports asynchronous predicates
 async function asyncEvery(arr, pred) {
     for (const val of arr) {
@@ -39,7 +41,7 @@ const loadHookEntrypoints = async (logger, config) => {
     return hookResultEntries.map((hookEntries) => Object.fromEntries(hookEntries));
 };
 exports.loadHookEntrypoints = loadHookEntrypoints;
-const loadHookInstallations = async (logger, config) => {
+const loadHookInstallations = async (logger, metrics, config) => {
     const hookClassResults = await (0, exports.loadHookEntrypoints)(logger, config);
     const installationResults = hookClassResults.flatMap((hookClasses) => (0, reduce_installations_1.reducePluginHookInstallations)(logger, config, hookClasses, config.plugins['app root']));
     const installationsWithoutConflicts = installationResults.flatMap((installations) => {
@@ -54,16 +56,16 @@ const loadHookInstallations = async (logger, config) => {
     return installationsWithoutConflicts.map((installations) => {
         return installations.map(({ hookConstructor, forHook, options }) => {
             const hookPlugin = config.hooks[forHook].plugin;
-            return new hookConstructor(logger, forHook, options, config.pluginOptions[hookPlugin.id]?.options);
+            return new hookConstructor(logger, forHook, options, config.pluginOptions[hookPlugin.id]?.options, metrics);
         });
     });
 };
 exports.loadHookInstallations = loadHookInstallations;
-async function checkInstall(logger, config) {
+async function checkInstall(logger, metrics, config) {
     if (!(await (0, hash_1.hasConfigChanged)(logger, config))) {
         return;
     }
-    const hooks = (await (0, exports.loadHookInstallations)(logger, config)).unwrap('hooks were found to be invalid when checking install');
+    const hooks = (await (0, exports.loadHookInstallations)(logger, metrics, config)).unwrap('hooks were found to be invalid when checking install');
     const uninstalledHooks = await asyncFilter(hooks, async (hook) => {
         return !(await hook.isInstalled());
     });
@@ -74,11 +76,17 @@ async function checkInstall(logger, config) {
     }
     await (0, hash_1.updateHashes)(config);
 }
-async function installHooks(logger) {
+async function installHooks(logger, metrics) {
     const config = await (0, config_1.loadConfig)(logger, { root: process.cwd() });
+    (0, telemetry_1.enableTelemetry)(metrics, config.pluginOptions['app root'].options);
     await (0, init_1.runInit)(logger, config);
+    const systemCode = await (0, systemCode_1.guessSystemCode)(config);
+    let scoped = metrics;
+    if (systemCode) {
+        scoped = metrics.scoped({ systemCode });
+    }
     const errors = [];
-    const hooks = (await (0, exports.loadHookInstallations)(logger, config)).unwrap('hooks were found to be invalid when installing');
+    const hooks = (await (0, exports.loadHookInstallations)(logger, scoped, config)).unwrap('hooks were found to be invalid when installing');
     // group hooks without an installGroup separately so that their check()
     // method runs independently
     const groups = (0, groupBy_1.default)(hooks, (hook) => hook.installGroup ?? '__' + hook.id);

package/lib/systemCode.d.ts

@@ -0,0 +1,3 @@
+import type { ValidConfig } from '@dotcom-tool-kit/config';
+export declare function guessSystemCode(config: ValidConfig): Promise<string | undefined>;
+//# sourceMappingURL=systemCode.d.ts.map

package/lib/systemCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemCode.d.ts","sourceRoot":"","sources":["../src/systemCode.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAM1D,wBAAsB,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAmBtF"}

package/lib/systemCode.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guessSystemCode = guessSystemCode;
+const promises_1 = require("node:fs/promises");
+async function guessSystemCode(config) {
+    const systemCodeFromRoot = (config.pluginOptions['app root']?.options).systemCode;
+    if (systemCodeFromRoot) {
+        return systemCodeFromRoot;
+    }
+    const systemCodeFromDoppler = (config.pluginOptions['@dotcom-tool-kit/doppler']?.options).project;
+    if (systemCodeFromDoppler && !systemCodeFromDoppler.startsWith('repo_')) {
+        return systemCodeFromDoppler;
+    }
+    try {
+        const packageJson = JSON.parse(await (0, promises_1.readFile)('package.json', 'utf8'));
+        if (packageJson.name) {
+            return `npm:${packageJson.name}`;
+        }
+    }
+    catch { }
+}

package/lib/tasks.d.ts

@@ -4,13 +4,14 @@ import { Validated } from '@dotcom-tool-kit/validated';
 import type { Logger } from 'winston';
 import { OptionsForTask } from '@dotcom-tool-kit/plugin';
 import type { ReadonlyDeep } from 'type-fest';
+import { type TelemetryRecorder } from '@dotcom-tool-kit/telemetry';
 export type ErrorSummary = {
     task: string;
     error: Error;
 };
-export declare function loadTasks(logger: Logger, tasks: OptionsForTask[], config: ReadonlyDeep<ValidConfig>): Promise<Validated<Task[]>>;
+export declare function loadTasks(logger: Logger, tasks: OptionsForTask[], config: ReadonlyDeep<ValidConfig>, metrics?: TelemetryRecorder): Promise<Validated<Task[]>>;
 export declare function handleTaskErrors(errors: ErrorSummary[], command: string): void;
-export declare function runTasks(logger: Logger, config: ValidConfig, tasks: Task[], command: string, files?: string[]): Promise<void>;
-export declare function runCommandsFromConfig(logger: Logger, config: ValidConfig, commands: string[], files?: string[]): Promise<void>;
-export declare function runCommands(logger: Logger, commands: string[], files?: string[]): Promise<void>;
+export declare function runTasks(logger: Logger, metrics: TelemetryRecorder, config: ValidConfig, tasks: Task[], command: string, files?: string[]): Promise<void>;
+export declare function runCommandsFromConfig(logger: Logger, config: ValidConfig, commands: string[], files?: string[], metrics?: TelemetryRecorder): Promise<void>;
+export declare function runCommands(logger: Logger, metrics: TelemetryRecorder, commands: string[], files?: string[]): Promise<void>;
 //# sourceMappingURL=tasks.d.ts.map

package/lib/tasks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAmB,MAAM,uBAAuB,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AACvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAUrC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,cAAc,EAAE,EACvB,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,GAChC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAiC5B;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,MAAM,QAQvE;AAED,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EAAE,iBA8BjB;AAED,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CA6Bf;AAED,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrG"}
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAmB,MAAM,uBAAuB,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AACvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAYrC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,KAAK,iBAAiB,EAAuB,MAAM,4BAA4B,CAAA;AAExF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,cAAc,EAAE,EACvB,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,EAIjC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAmC5B;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,MAAM,QAQvE;AAED,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EAAE,iBAiCjB;AAED,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,EAIhB,OAAO,GAAE,iBAA6C,GACrD,OAAO,CAAC,IAAI,CAAC,CA+Bf;AAED,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/lib/tasks.js

@@ -16,9 +16,16 @@ const logger_1 = require("@dotcom-tool-kit/logger");
 const fetch_1 = require("./fetch");
 const init_1 = require("./init");
 const messages_1 = require("./messages");
+const systemCode_1 = require("./systemCode");
+const telemetry_1 = require("./telemetry");
 const schemas_1 = require("@dotcom-tool-kit/schemas");
 const pluralize_1 = tslib_1.__importDefault(require("pluralize"));
-async function loadTasks(logger, tasks, config) {
+const telemetry_2 = require("@dotcom-tool-kit/telemetry");
+async function loadTasks(logger, tasks, config, 
+// TODO:IM:20251215 make this a required parameter in the next major version.
+// this function is currently used by the parallel plugin and so
+// can't be changed yet.
+metrics) {
     const taskResults = await Promise.all(tasks.map(async ({ task: taskId, options, plugin }) => {
         const entryPoint = config.tasks[taskId];
         const taskResult = await (0, entry_point_1.importEntryPoint)(base_1.Task, entryPoint);
@@ -30,7 +37,8 @@ async function loadTasks(logger, tasks, config) {
                 data: mergedOptions
             };
             if (parsedOptions.success) {
-                const task = new taskModule.baseClass(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data, plugin);
+                const scoped = metrics?.scoped({ plugin: entryPoint.plugin.id });
+                const task = new taskModule.baseClass(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data, plugin, scoped);
                 return (0, validated_1.valid)(task);
             }
             else {
@@ -46,15 +54,17 @@ function handleTaskErrors(errors, command) {
         return error;
     }), `${(0, pluralize_1.default)('error', errors.length, true)} running tasks for ${logger_1.styles.command(command)}`);
 }
-async function runTasks(logger, config, tasks, command, files) {
+async function runTasks(logger, metrics, config, tasks, command, files) {
     const errors = [];
     if (tasks.length === 0) {
         logger.warn(`no task configured for ${command}: skipping assignment...`);
     }
     for (const task of tasks) {
+        const scoped = metrics.scoped({ task: task.id });
         try {
             logger.info(logger_1.styles.taskHeader(`running ${logger_1.styles.task(task.id)} task`));
             await task.run({ files, command, cwd: config.root, config });
+            scoped.recordEvent('tasks.completed', { success: true });
         }
         catch (error) {
             // if there's an exit code, that's a request from the task to exit early
@@ -67,32 +77,45 @@ async function runTasks(logger, config, tasks, command, files) {
                 task: task.id,
                 error: error
             });
+            scoped.recordEvent('tasks.completed', { success: false });
         }
     }
     if (errors.length > 0) {
         handleTaskErrors(errors, command);
     }
 }
-async function runCommandsFromConfig(logger, config, commands, files) {
+async function runCommandsFromConfig(logger, config, commands, files, 
+// TODO:IM:20251215 make this a required parameter in the next major version.
+// this function is currently used by the monorepo plugin and so can't be
+// changed yet.
+metrics = new telemetry_2.MockTelemetryClient()) {
     await (0, init_1.runInit)(logger, config);
-    await (0, install_1.checkInstall)(logger, config);
+    await (0, install_1.checkInstall)(logger, metrics, config);
     if ((0, fetch_1.shouldDisableNativeFetch)(config.pluginOptions['app root'].options) &&
         !process.execArgv.includes('--no-experimental-fetch')) {
         process.execArgv.push('--no-experimental-fetch');
     }
     const commandTasks = (0, validated_1.reduceValidated)(await Promise.all(commands.map(async (command) => {
         const tasks = config.commandTasks[command]?.tasks ?? [];
-        const validatedTaskInstances = await loadTasks(logger, tasks, config);
+        const scoped = metrics.scoped({ command });
+        const validatedTaskInstances = await loadTasks(logger, tasks, config, scoped);
         return validatedTaskInstances.map((taskInstances) => ({ command, tasks: taskInstances }));
     }))).unwrap('tasks are invalid!');
     // at this point we no longer need to update the config, so freeze it before
     // passing it into task run contexts so that plugins can't do crimes
     Object.freeze(config);
     for (const { command, tasks } of commandTasks) {
-        await runTasks(logger, config, tasks, command, files);
+        const scoped = metrics.scoped({ command });
+        await runTasks(logger, scoped, config, tasks, command, files);
     }
 }
-async function runCommands(logger, commands, files) {
+async function runCommands(logger, metrics, commands, files) {
     const config = await (0, config_1.loadConfig)(logger, { root: process.cwd() });
-    return runCommandsFromConfig(logger, config, commands, files);
+    (0, telemetry_1.enableTelemetry)(metrics, config.pluginOptions['app root'].options);
+    const systemCode = await (0, systemCode_1.guessSystemCode)(config);
+    let scoped = metrics;
+    if (systemCode) {
+        scoped = metrics.scoped({ systemCode });
+    }
+    return runCommandsFromConfig(logger, config, commands, files, scoped);
 }

package/lib/telemetry.d.ts

@@ -0,0 +1,4 @@
+import type { RootOptions } from '@dotcom-tool-kit/plugin/src/root-schema';
+import type { TelemetryProcess, TelemetryRecorder } from '@dotcom-tool-kit/telemetry';
+export declare function enableTelemetry(metrics: TelemetryProcess | TelemetryRecorder, options: RootOptions): void;
+//# sourceMappingURL=telemetry.d.ts.map

package/lib/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAA;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAKrF,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,iBAAiB,EAAE,OAAO,EAAE,WAAW,QAIlG"}

package/lib/telemetry.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableTelemetry = enableTelemetry;
+// TODO:IM:20260113 in the future this type signature could be changed to allow
+// enabling telemetry even without a valid config (and the root options derived
+// from it,) so that we can track metrics related to invalid configurations.
+function enableTelemetry(metrics, options) {
+    if (options.enableTelemetry) {
+        metrics.enable();
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "5.0.1-beta.7",
+  "version": "5.1.0-beta.1",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -30,14 +30,15 @@
     "zod": "^3.24.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "^2.0.1-beta.1",
-    "@dotcom-tool-kit/config": "^2.0.0",
-    "@dotcom-tool-kit/conflict": "^2.0.0",
+    "@dotcom-tool-kit/base": "^2.1.0-beta.1",
+    "@dotcom-tool-kit/config": "^2.0.1-beta.1",
+    "@dotcom-tool-kit/conflict": "^2.0.1-beta.1",
     "@dotcom-tool-kit/error": "^5.0.0",
     "@dotcom-tool-kit/logger": "^5.0.0",
-    "@dotcom-tool-kit/plugin": "^2.0.0",
+    "@dotcom-tool-kit/plugin": "^2.1.0-beta.1",
     "@dotcom-tool-kit/schemas": "^1.9.0",
     "@dotcom-tool-kit/state": "^5.0.0",
+    "@dotcom-tool-kit/telemetry": "^1.0.0",
     "@dotcom-tool-kit/validated": "^2.0.0",
     "endent": "^2.1.0",
     "lodash": "^4.17.21",