Add support for configuring instrumentation

Author: ericallam

packages/cli-v3/package.json

@@ -93,7 +93,6 @@
     "@opentelemetry/sdk-trace-base": "^1.21.0",
     "@opentelemetry/sdk-trace-node": "^1.21.0",
     "@opentelemetry/semantic-conventions": "^1.21.0",
-    "@traceloop/instrumentation-openai": "^0.3.9",
     "@trigger.dev/core": "workspace:^2.3.18",
     "@types/degit": "^2.8.3",
     "chalk": "^5.2.0",

packages/cli-v3/src/commands/deploy.ts

@@ -42,7 +42,7 @@ import {
 import { logger } from "../utilities/logger.js";
 import { createTaskFileImports, gatherTaskFiles } from "../utilities/taskFiles";
 import { login } from "./login";
-import { bundleDependenciesPlugin } from "../utilities/build";
+import { bundleDependenciesPlugin, workerSetupImportConfigPlugin } from "../utilities/build";
 import { Glob } from "glob";
 
 const DeployCommandOptions = CommonCommandOptions.extend({
@@ -816,7 +816,7 @@ async function compileProject(
           TRIGGER_API_URL: `"${config.triggerUrl}"`,
           __PROJECT_CONFIG__: JSON.stringify(config),
         },
-        plugins: [bundleDependenciesPlugin(config)],
+        plugins: [bundleDependenciesPlugin(config), workerSetupImportConfigPlugin(configPath)],
       });
 
       if (result.errors.length > 0) {

packages/cli-v3/src/commands/dev.tsx

@@ -26,7 +26,7 @@ import { z } from "zod";
 import * as packageJson from "../../package.json";
 import { CliApiClient } from "../apiClient";
 import { CommonCommandOptions, commonOptions, wrapCommandAction } from "../cli/common.js";
-import { bundleDependenciesPlugin } from "../utilities/build";
+import { bundleDependenciesPlugin, workerSetupImportConfigPlugin } from "../utilities/build";
 import { chalkPurple } from "../utilities/colors";
 import { readConfig } from "../utilities/configFiles";
 import { readJSONFile } from "../utilities/fileSystem";
@@ -363,6 +363,7 @@ function useDev({
         },
         plugins: [
           bundleDependenciesPlugin(config),
+          workerSetupImportConfigPlugin(configPath),
           {
             name: "trigger.dev v3",
             setup(build) {

packages/cli-v3/src/utilities/build.ts

@@ -4,6 +4,38 @@ import type { Plugin } from "esbuild";
 import { extname, isAbsolute } from "node:path";
 import tsConfigPaths from "tsconfig-paths";
 import { logger } from "./logger";
+import { readFileSync } from "node:fs";
+
+export function workerSetupImportConfigPlugin(configPath?: string): Plugin {
+  return {
+    name: "trigger-worker-setup",
+    setup(build) {
+      if (!configPath) {
+        return;
+      }
+
+      build.onLoad({ filter: /worker-setup\.js$/ }, async (args) => {
+        let workerSetupContents = readFileSync(args.path, "utf-8");
+
+        workerSetupContents = workerSetupContents.replace(
+          "__SETUP_IMPORTED_PROJECT_CONFIG__",
+          `import * as setupImportedConfigExports from "${configPath}"; const setupImportedConfig = setupImportedConfigExports.config;`
+        );
+
+        logger.debug("Loading worker setup", {
+          args,
+          workerSetupContents,
+          configPath,
+        });
+
+        return {
+          contents: workerSetupContents,
+          loader: "js",
+        };
+      });
+    },
+  };
+}
 
 export function bundleDependenciesPlugin(config: ResolvedConfig): Plugin {
   const matchPath = config.tsconfigPath ? createMatchPath(config.tsconfigPath) : undefined;
@@ -16,26 +48,26 @@ export function bundleDependenciesPlugin(config: ResolvedConfig): Plugin {
   }
 
   return {
-    name: "bundle-dependencies",
+    name: "trigger-bundle-dependencies",
     setup(build) {
       build.onResolve({ filter: /.*/ }, (args) => {
         const resolvedPath = resolvePath(args.path);
 
-        logger.debug(`Checking if ${args.path} should be bundled or external`, {
+        logger.ignore(`Checking if ${args.path} should be bundled or external`, {
           ...args,
           resolvedPath,
         });
 
         if (!isBareModuleId(resolvedPath)) {
-          logger.debug(`Bundling ${args.path} because its not a bareModuleId`, {
+          logger.ignore(`Bundling ${args.path} because its not a bareModuleId`, {
             ...args,
           });
 
           return undefined; // let esbuild bundle it
         }
 
         if (args.path.startsWith("@trigger.dev/")) {
-          logger.debug(`Bundling ${args.path} because its a trigger.dev package`, {
+          logger.ignore(`Bundling ${args.path} because its a trigger.dev package`, {
             ...args,
           });
 
@@ -63,7 +95,7 @@ export function bundleDependenciesPlugin(config: ResolvedConfig): Plugin {
           }
         }
 
-        logger.debug(`Externalizing ${args.path}`, {
+        logger.ignore(`Externalizing ${args.path}`, {
           ...args,
         });
 

packages/cli-v3/src/utilities/configFiles.ts

@@ -131,7 +131,7 @@ export async function readConfig(
 
   const tempDir = await createTempDir();
 
-  const builtConfigFilePath = join(tempDir, "config.mjs");
+  const builtConfigFilePath = join(tempDir, "config.js");
   const builtConfigFileHref = pathToFileURL(builtConfigFilePath).href;
 
   logger.debug("Building config file", {
@@ -147,7 +147,7 @@ export async function readConfig(
     metafile: true,
     minify: false,
     write: true,
-    format: "esm",
+    format: "cjs",
     platform: "node",
     target: ["es2018", "node18"],
     outfile: builtConfigFilePath,

packages/cli-v3/src/utilities/logger.ts

@@ -55,6 +55,7 @@ export class Logger {
   columns = process.stdout.columns;
 
   debug = (...args: unknown[]) => this.doLog("debug", args);
+  ignore = (...args: unknown[]) => {};
   debugWithSanitization = (label: string, ...args: unknown[]) => {
     this.doLog("debug", [label, ...args]);
   };

packages/cli-v3/src/workers/dev/worker-facade.ts

@@ -6,7 +6,6 @@ import {
   type TracingSDK,
   type HandleErrorFunction,
 } from "@trigger.dev/core/v3";
-import "source-map-support/register.js";
 
 __WORKER_SETUP__;
 declare const __WORKER_SETUP__: unknown;

packages/cli-v3/src/workers/dev/worker-setup.ts

@@ -1,19 +1,24 @@
+import "source-map-support/register.js";
 import { Resource } from "@opentelemetry/resources";
-import { OpenAIInstrumentation } from "@traceloop/instrumentation-openai";
 import {
+  ProjectConfig,
   SemanticInternalAttributes,
   TracingDiagnosticLogLevel,
   TracingSDK,
   ZodMessageSender,
   childToWorkerMessages,
 } from "@trigger.dev/core/v3";
 
+__SETUP_IMPORTED_PROJECT_CONFIG__;
+declare const __SETUP_IMPORTED_PROJECT_CONFIG__: unknown;
+declare const setupImportedConfig: ProjectConfig | undefined;
+
 export const tracingSDK = new TracingSDK({
   url: process.env.OTEL_EXPORTER_OTLP_ENDPOINT ?? "http://0.0.0.0:4318",
   resource: new Resource({
     [SemanticInternalAttributes.CLI_VERSION]: "3.0.0",
   }),
-  instrumentations: [new OpenAIInstrumentation()],
+  instrumentations: setupImportedConfig?.instrumentations ?? [],
   diagLogLevel: (process.env.OTEL_LOG_LEVEL as TracingDiagnosticLogLevel) ?? "none",
 });
 

packages/cli-v3/src/workers/prod/worker-setup.ts

@@ -1,19 +1,21 @@
 import { Resource } from "@opentelemetry/resources";
-import { OpenAIInstrumentation } from "@traceloop/instrumentation-openai";
 import {
+  ProjectConfig,
   SemanticInternalAttributes,
   TracingDiagnosticLogLevel,
   TracingSDK,
-  ZodMessageSender,
-  childToWorkerMessages,
 } from "@trigger.dev/core/v3";
 
+__SETUP_IMPORTED_PROJECT_CONFIG__;
+declare const __SETUP_IMPORTED_PROJECT_CONFIG__: unknown;
+declare const setupImportedConfig: ProjectConfig | undefined;
+
 export const tracingSDK = new TracingSDK({
   url: process.env.OTEL_EXPORTER_OTLP_ENDPOINT ?? "http://0.0.0.0:4318",
   resource: new Resource({
     [SemanticInternalAttributes.CLI_VERSION]: "3.0.0",
   }),
-  instrumentations: [new OpenAIInstrumentation()],
+  instrumentations: setupImportedConfig?.instrumentations ?? [],
   diagLogLevel: (process.env.OTEL_LOG_LEVEL as TracingDiagnosticLogLevel) ?? "none",
 });
 

packages/core/src/v3/types/config.ts

@@ -1,4 +1,5 @@
 import { RetryOptions } from "../schemas";
+import type { InstrumentationOption } from "@opentelemetry/instrumentation";
 
 export interface ProjectConfig {
   project: string;
@@ -25,4 +26,9 @@ export interface ProjectConfig {
    * The path to your project's tsconfig.json file. Will use tsconfig.json in the project directory if not provided.
    */
   tsconfigPath?: string;
+
+  /**
+   * The OpenTelemetry instrumentations to enable
+   */
+  instrumentations?: InstrumentationOption[];
 }

pnpm-lock.yaml

@@ -14,7 +14,9 @@
     "start:stripe": "ts-node -r tsconfig-paths/register -r dotenv/config src/stripeUsage.ts"
   },
   "dependencies": {
+    "@opentelemetry/api": "^1.7.0",
     "@sindresorhus/slugify": "^2.2.1",
+    "@traceloop/instrumentation-openai": "^0.3.9",
     "@trigger.dev/sdk": "2.3.18",
     "msw": "^2.2.1",
     "openai": "^4.28.0",

references/v3-catalog/package.json

@@ -1,4 +1,5 @@
 import type { TriggerConfig } from "@trigger.dev/sdk/v3";
+import { OpenAIInstrumentation } from "@traceloop/instrumentation-openai";
 
 export { handleError } from "./src/handleError";
 
@@ -17,4 +18,5 @@ export const config: TriggerConfig = {
   additionalPackages: ["[email protected]"],
   additionalFiles: ["./wrangler/wrangler.toml"],
   dependenciesToBundle: [/@sindresorhus/, "escape-string-regexp"],
+  instrumentations: [new OpenAIInstrumentation()],
 };