Eric Allam
8f3a28effb
* pythonExtension and python runtime improvements * Adding streaming support * Use writeFileSync * Restructure extension docs and add python extension docs * Fix broken link * Update docs/config/extensions/overview.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/config/extensions/aptGet.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/config/extensions/custom.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Add environment variable support --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
351 lines
12 KiB
Plaintext
351 lines
12 KiB
Plaintext
---
|
|
title: "The trigger.config.ts file"
|
|
sidebarTitle: "trigger.config.ts"
|
|
description: "This file is used to configure your project and how it's built."
|
|
---
|
|
|
|
import ScrapingWarning from "/snippets/web-scraping-warning.mdx";
|
|
import BundlePackages from "/snippets/bundle-packages.mdx";
|
|
|
|
The `trigger.config.ts` file is used to configure your Trigger.dev project. It is a TypeScript file at the root of your project that exports a default configuration object. Here's an example:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
// Your project ref (you can see it on the Project settings page in the dashboard)
|
|
project: "<project ref>",
|
|
//The paths for your trigger folders
|
|
dirs: ["./trigger"],
|
|
retries: {
|
|
//If you want to retry a task in dev mode (when using the CLI)
|
|
enabledInDev: false,
|
|
//the default retry settings. Used if you don't specify on a task.
|
|
default: {
|
|
maxAttempts: 3,
|
|
minTimeoutInMs: 1000,
|
|
maxTimeoutInMs: 10000,
|
|
factor: 2,
|
|
randomize: true,
|
|
},
|
|
},
|
|
});
|
|
```
|
|
|
|
The config file handles a lot of things, like:
|
|
|
|
- Specifying where your trigger tasks are located using the `dirs` option.
|
|
- Setting the default retry settings.
|
|
- Configuring OpenTelemetry instrumentations.
|
|
- Customizing the build process.
|
|
- Adding global task lifecycle functions.
|
|
|
|
<Note>
|
|
The config file is bundled with your project, so code imported in the config file is also bundled,
|
|
which can have an effect on build times and cold start duration. One important qualification is
|
|
anything defined in the `build` config is automatically stripped out of the config file, and
|
|
imports used inside build config with be tree-shaken out.
|
|
</Note>
|
|
|
|
## Dirs
|
|
|
|
You can specify the directories where your tasks are located using the `dirs` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
dirs: ["./trigger"],
|
|
});
|
|
```
|
|
|
|
If you omit the `dirs` option, we will automatically detect directories that are named `trigger` in your project, but we recommend specifying the directories explicitly. The `dirs` option is an array of strings, so you can specify multiple directories if you have tasks in multiple locations.
|
|
|
|
We will search for TypeScript and JavaScript files in the specified directories and include them in the build process. We automatically exclude files that have `.test` or `.spec` in the name, but you can customize this by specifying glob patterns in the `ignorePatterns` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
dirs: ["./trigger"],
|
|
ignorePatterns: ["**/*.my-test.ts"],
|
|
});
|
|
```
|
|
|
|
## Lifecycle functions
|
|
|
|
You can add lifecycle functions to get notified when any task starts, succeeds, or fails using `onStart`, `onSuccess` and `onFailure`:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
onSuccess: async (payload, output, { ctx }) => {
|
|
console.log("Task succeeded", ctx.task.id);
|
|
},
|
|
onFailure: async (payload, error, { ctx }) => {
|
|
console.log("Task failed", ctx.task.id);
|
|
},
|
|
onStart: async (payload, { ctx }) => {
|
|
console.log("Task started", ctx.task.id);
|
|
},
|
|
init: async (payload, { ctx }) => {
|
|
console.log("I run before any task is run");
|
|
},
|
|
});
|
|
```
|
|
|
|
Read more about task lifecycle functions in the [tasks overview](/tasks/overview).
|
|
|
|
## Instrumentations
|
|
|
|
We use OpenTelemetry (OTEL) for our run logs. This means you get a lot of information about your tasks with no effort. But you probably want to add more information to your logs. For example, here's all the Prisma calls automatically logged:
|
|
|
|
|
|
|
|
Here we add Prisma and OpenAI instrumentations to your `trigger.config.ts` file.
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
import { PrismaInstrumentation } from "@prisma/instrumentation";
|
|
import { OpenAIInstrumentation } from "@traceloop/instrumentation-openai";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
telemetry: {
|
|
instrumentations: [new PrismaInstrumentation(), new OpenAIInstrumentation()],
|
|
},
|
|
});
|
|
```
|
|
|
|
There is a [huge library of instrumentations](https://opentelemetry.io/ecosystem/registry/?language=js) you can easily add to your project like this.
|
|
|
|
Some ones we recommend:
|
|
|
|
| Package | Description |
|
|
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
| `@opentelemetry/instrumentation-undici` | Logs all fetch calls (inc. Undici fetch) |
|
|
| `@opentelemetry/instrumentation-http` | Logs all HTTP calls |
|
|
| `@prisma/instrumentation` | Logs all Prisma calls, you need to [enable tracing](https://github.com/prisma/prisma/tree/main/packages/instrumentation) |
|
|
| `@traceloop/instrumentation-openai` | Logs all OpenAI calls |
|
|
|
|
<Note>
|
|
`@opentelemetry/instrumentation-fs` which logs all file system calls is currently not supported.
|
|
</Note>
|
|
|
|
## Runtime
|
|
|
|
We currently only officially support the `node` runtime, but you can try our experimental `bun` runtime by setting the `runtime` option in your config file:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
runtime: "bun",
|
|
});
|
|
```
|
|
|
|
See our [Bun guide](/guides/frameworks/bun) for more information.
|
|
|
|
## Default machine
|
|
|
|
You can specify the default machine for all tasks in your project:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
defaultMachine: "large-1x",
|
|
});
|
|
```
|
|
|
|
See our [machines documentation](/machines) for more information.
|
|
|
|
## Log level
|
|
|
|
You can set the log level for your project:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
logLevel: "debug",
|
|
});
|
|
```
|
|
|
|
The `logLevel` only determines which logs are sent to the Trigger.dev instance when using the `logger` API. All `console` based logs are always sent.
|
|
|
|
## Max duration
|
|
|
|
You can set the default `maxDuration` for all tasks in your project:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
maxDuration: 60, // 60 seconds
|
|
});
|
|
```
|
|
|
|
See our [maxDuration guide](/runs/max-duration) for more information.
|
|
|
|
## Build configuration
|
|
|
|
You can customize the build process using the `build` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
build: {
|
|
// Don't bundle these packages
|
|
external: ["header-generator"],
|
|
},
|
|
});
|
|
```
|
|
|
|
<Note>
|
|
The `trigger.config.ts` file is included in the bundle, but with the `build` configuration
|
|
stripped out. These means any imports only used inside the `build` configuration are also removed
|
|
from the final bundle.
|
|
</Note>
|
|
|
|
### External
|
|
|
|
All code is bundled by default, but you can exclude some packages from the bundle using the `external` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
build: {
|
|
external: ["header-generator"],
|
|
},
|
|
});
|
|
```
|
|
|
|
When a package is excluded from the bundle, it will be added to a dynamically generated package.json file in the build directory. The version of the package will be the same as the version found in your `node_modules` directory.
|
|
|
|
Each entry in the external should be a package name, not necessarily the import path. For example, if you want to exclude the `ai` package, but you are importing `ai/rsc`, you should just include `ai` in the `external` array:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
build: {
|
|
external: ["ai"],
|
|
},
|
|
});
|
|
```
|
|
|
|
<Note>
|
|
Any packages that install or build a native binary should be added to external, as native binaries
|
|
cannot be bundled. For example, `re2`, `sharp`, and `sqlite3` should be added to external.
|
|
</Note>
|
|
|
|
### JSX
|
|
|
|
You can customize the `jsx` options that are passed to `esbuild` using the `jsx` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
build: {
|
|
jsx: {
|
|
// Use the Fragment component instead of React.Fragment
|
|
fragment: "Fragment",
|
|
// Use the h function instead of React.createElement
|
|
factory: "h",
|
|
// Turn off automatic runtime
|
|
automatic: false,
|
|
},
|
|
},
|
|
});
|
|
```
|
|
|
|
By default we enabled [esbuild's automatic JSX runtime](https://esbuild.github.io/content-types/#auto-import-for-jsx) which means you don't need to import `React` in your JSX files. You can disable this by setting `automatic` to `false`.
|
|
|
|
See the [esbuild JSX documentation](https://esbuild.github.io/content-types/#jsx) for more information.
|
|
|
|
### Conditions
|
|
|
|
You can add custom [import conditions](https://esbuild.github.io/api/#conditions) to your build using the `conditions` option:
|
|
|
|
```ts trigger.config.ts
|
|
import { defineConfig } from "@trigger.dev/sdk/v3";
|
|
|
|
export default defineConfig({
|
|
project: "<project ref>",
|
|
// Your other config settings...
|
|
build: {
|
|
conditions: ["react-server"],
|
|
},
|
|
});
|
|
```
|
|
|
|
These conditions effect how imports are resolved during the build process. For example, the `react-server` condition will resolve `ai/rsc` to the server version of the `ai/rsc` export.
|
|
|
|
Custom conditions will also be passed to the `node` runtime when running your tasks.
|
|
|
|
### Extensions
|
|
|
|
Build extension allow you to hook into the build system and customize the build process or the resulting bundle and container image (in the case of deploying). You can use pre-built extensions by installing the `@trigger.dev/build` package into your `devDependencies`, or you can create your own.
|
|
|
|
#### additionalFiles
|
|
|
|
See the [additionalFiles documentation](/config/extensions/additionalFiles) for more information.
|
|
|
|
#### `additionalPackages`
|
|
|
|
See the [additionalPackages documentation](/config/extensions/additionalPackages) for more information.
|
|
|
|
#### `emitDecoratorMetadata`
|
|
|
|
See the [emitDecoratorMetadata documentation](/config/extensions/emitDecoratorMetadata) for more information.
|
|
|
|
#### Prisma
|
|
|
|
See the [prismaExtension documentation](/config/extensions/prismaExtension) for more information.
|
|
|
|
#### syncEnvVars
|
|
|
|
See the [syncEnvVars documentation](/config/extensions/syncEnvVars) for more information.
|
|
|
|
#### puppeteer
|
|
|
|
See the [puppeteer documentation](/config/extensions/puppeteer) for more information.
|
|
|
|
#### ffmpeg
|
|
|
|
See the [ffmpeg documentation](/config/extensions/ffmpeg) for more information.
|
|
|
|
#### esbuild plugins
|
|
|
|
See the [esbuild plugins documentation](/config/extensions/esbuildPlugin) for more information.
|
|
|
|
#### aptGet
|
|
|
|
See the [aptGet documentation](/config/extensions/aptGet) for more information.
|